This is some documentation.



edit_interface

edit_interface edits interface interface_id

cloud_interconnect_id

Physical interconnect ID used by connector

cloud_interconnect_type

Physical interconnect type of connector

interface_id Required

Identifier used to lookup the interface

mpls_vlan_tag_range

Comma separated list of VLAN ranges allowed on this interface

workgroup_id

Identifier of workgroup used to grant ownership of interface



get_available_vlans

returns a list of available vlan tags

circuit_id

VRF ID of the VRF being edited (if one is being edited)

interface_id Required

Interface ID to fetch details

vrf_id

VRF ID of the VRF being edited (if one is being edited)

workgroup_id Required

Workgroup ID to fetch details



get_interface

get_interface returns the requested interface

interface_id Required

InterfaceId of interface



get_interfaces

returns a list of interfaces for a node

node_id

Node ID to fetch details

workgroup_id

Workgroup ID to filter results



get_options

get_options returns provisioning options for interfaces



get_workgroup_interfaces

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

returns a list of available vlan tags

workgroup_id Required

Workgroup ID to fetch details



is_vlan_available

returns 1 or 0 if the vlan tag is available

interface_id Required

Interface ID to check and see if VLAN tag is available

vlan Required

VLAN to check and see if it is avaialble

workgroup_id Required

Workgroup ID to fetch details



migrate_interface

moves all entities, connections, and configuration from src_interface_id to dst_interface_id

dst_interface_id Required

Identifier used to lookup the interface

src_interface_id Required

Identifier used to lookup the interface