This is some documentation.



generate_clr

generates a human readable Circuit Layout Record describing the given circuit.

circuit_id Required

The circuit_id of the circuit to have the CLR generated for.

raw

Generate flow rule view of the circuit for every node.



get_all_link_status

returns a list of all active links and their operational status.

type

The type of links that shall be included.



get_all_node_status

This method has been deprecated in favor of node.cgi?method=get_nodes.

returns a list of all active nodes and their operational status.

type

The type of nodes that shall be included in the map.



get_all_resources_for_workgroup

returns a list of all resources (endpoints) for which the workgroup has access

workgroup_id Required

The workgroup ID that the user wants to get the list of resources.



get_circuit_details

This method has been deprecated in favor of circuit.cgi?method=get.

returns all of the details for a given circuit

circuit_id Required

The id of the circuit to fetch details for.



get_circuit_details_by_external_identifier

finds the circuit based on some external id

external_identifier Required

external identifier when the circuit was created or last modified.



get_circuit_history

returns a list of network events that have affected this circuit

circuit_id Required

The id of the circuit fetch network events for.



get_circuit_scheduled_events

returns a list of scheduled circuit events.

circuit_id Required

The id of the circuit fetch scheduled events for.



get_circuits_by_interface_id

returns a list of circuits on an interface

interface_id Required

The interface ID for which the user wants the circuit details.



get_existing_circuits

This method has been deprecated in favor of circuit.cgi?method=get.

returns a list of circuits for the given workgroup

endpoint_node_id

Filters the results to circuits that terminate on the specified node_id

path_node_id

Filters the results for circuits that traverse the node of the node_id given

workgroup_id Required

The workgroup ID that the user is currently participating in.



get_interface

This method has been deprecated in favor of interface.cgi?method=get_interface.

returns the interface details

interface_id Required

The interface ID for which the user wants the details.



get_link_by_name

returns a link details given the name of the link.

name Required

The name of the link.



get_maps

returns a JSON object representing the network layout

link_type

The type of links that shall be included in the map.

workgroup_id

The workgroup ID that the user is currently participating in.



get_node_interfaces

This method has been deprecated in favor of interface.cgi?method=get_interfaces.

returns a list of interfaces on the given node

node Required

Name of the node to get a list of available interfaces for.

show_down

Show down interfaces on the node.

show_trunk

Show down interfaces on the node.

type

Type of interfaces to return.

workgroup_id

The workgroup ID that the user is currently participating in.



get_nodes

This method has been deprecated in favor of node.cgi?method=get_nodes.

returns a list of nodes

type

The type of nodes that shall be included in the map.



get_shortest_path

returns the shortest contiguous path between the given nodes

link

A list of links to avoid when doing the shortest path calculation

node Required

An array of node names to connect together with the shortest path.

type Required

type of circuit we are building



get_users

This method has been deprecated in favor of user.cgi?method=get_users.

returns all the users in the database



get_vlan_tag_range

returns a vlan tag range for a node on an interface in a workgroup

interface Required

Name of the interface for which the vlan tag range is requested for.

node Required

Name of the node for which the vlan tag range is requested for.

workgroup_id Required

The ID of the workgroup for which the vlan tag range is requested for.



get_workgroup_interfaces

This method has been deprecated in favor of interface.cgi?method=get_interfaces.

returns a list of interfaces in a workgroup.

workgroup_id Required

The workgroup ID that the user is currently participating in.



get_workgroup_members

This method has been deprecated in favor of workgroup.cgi?method=get_workgroup_users.

descr

order_by

Specify how the workgroups should be ordered.

workgroup_id Required

The workgroup ID that the user is currently participating in.



get_workgroups

This method has been deprecated in favor of user.cgi?method=get_current.

returns a list of workgroups the logged in user has access to



is_vlan_tag_available

returns the availability of the vlan tag for a given node and interface

inner_vlan

The inner vlan tag to check the availability of on the node/interface combination.

interface Required

The name of the interface to check the vlan tags availability.

node Required

The name of the node the interface is on.

vlan Required

The vlan tag to check the availability of on the node/interface combination.

workgroup_id

The workgroup ID that the user wants to check if vlan_tag is available.



is_within_circuit_endpoint_limit

Checks that number of circuits in a workgroup on an endpoint are within the specified limit

endpoint_num Required

The number for which the endpoints allowed on the circuit is checked for.

workgroup_id Required

The ID of the workgroup for which the circuit limit check is requested for..



is_within_circuit_limit

Checks that number of circuits in a workgroup are within the specified limit

workgroup_id Required

The ID of the workgroup for which the circuit limit check is requested for..



is_within_mac_limit

Returns if a new mac address can be added on node’s interface

interface Required

Interface on the node for which the mac address limit check is requested for.

mac_address Required

List of mac addresses that may need to added.

node Required

Name of the node for which the mac address limit check is requested for.

workgroup_id Required

The ID of the workgroup for which the mac limit check is requested for.



send_email

sends an email o behalf of user from the OESS application

body Required

The body of the email.

subject Required

The subject of the email.