/admin/admin.cgi

This is some documentation.

add_edge_interface_move_maintenances

Creates a list interface maintenances.

circuit_id

Circuit IDs of the circuits on original_interface.

name

Name of the new maintenance.

orig_interface_id Required

Interface ID of the original interface.

temp_interface_id Required

Interface ID of the temporary interface.

add_mpls_switch

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

controller Required

ip_address Required

latitude Required

longitude Required

model

name Required

port Required

short_name Required

sw_ver

vendor

add_remote_link

interface_id Required

name Required

urn Required

vlan_tag_range Required

add_user

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

auth_name Required

email_address Required

family_name Required

first_name Required

status

add_user_to_workgroup

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

role Required

user_id Required

workgroup_id

add_workgroup

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

external_id

name Required

type

confirm_link

Approves a link.

link_id Required

name Required

confirm_node

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

Approves a node.

bulk_barrier Required

default_drop Required

default_forward Required

latitude Required

longitude Required

max_flows Required

name Required

node_id Required

tx_delay_ms Required

vlan_range Required

decom_link

link_id Required

decom_node

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

Decommissions a node.

node_id Required

decom_workgroup

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

workgroup_id Required

delete_user

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

user_id Required

deny_device

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

dpid

ipv4_addr

node_id

deny_link

interface_a_id

interface_z_id

link_id Required

edit_remote_link

interface_id

link_id Required

name

urn

vlan_tag_range

edit_user

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

auth_name

email_address

family_name

first_name

status

type

user_id Required

edit_workgroup

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

Update the workgroup identified by workgroup_id. At least one other argument must be provided.

external_id

max_circuit_endpoints

max_circuits

max_mac_address_per_end

name

type

workgroup_id Required

get_circuits_on_interface

interface_id Required

get_diff_text

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

Returns diff text for the specified node.

node_id Required

Node ID of the diff to lookup.

get_diffs

Returns diff information for each node.

approved

Filters diff information by approved state.

get_edge_interface_move_maintenances

Returns a list interface maintenances.

get_endpoints_in_review

Returns a list of endpoints that require admin review.

get_pending_links

Returns a list of links to be approved.

get_pending_nodes

Returns a list of nodes to be approved.

get_remote_devices

get_remote_links

get_topology

get_users

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

get_users_in_workgroup

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

workgroup_id

get_workgroups

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

user_id

insert_node_in_path

link_id Required

is_new_node_in_path

link Required

is_ok_to_decom_link

link_id Required

move_edge_interface_circuits

Moves an interface's circuits.

circuit_id

Circuit IDs of the circuits on original_interface.

new_interface_id Required

Interface ID of the temporary interface.

orig_interface_id Required

Interface ID of the original interface.

move_interface_configuration

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

Moves an interface's entire configuration.

new_interface_id Required

Interface ID of the temporary interface.

orig_interface_id Required

Interface ID of the original interface.

remove_remote_link

link_id Required

remove_user_from_workgroup

user_id Required

workgroup_id

revert_edge_interface_move_maintenance

Reverts an interface maintenance.

maintenance_id

Maintenance ID of the maintenance to revert.

review_endpoint

Approve or deny an endpoint in review.

approve Required

Set to 1 for approval or 0 for denial.

circuit_ep_id

Circuit ID of the Endpoint

skip_cloud_provisioning

If set to 1 cloud provider configurations will not be performed.

vrf_ep_id

VRF ID of the Endpoint

set_diff_approval

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

Approves or rejects a large diff.

approved Required

Filters diff information by approved state.

node_id Required

Node ID of the diff to lookup.

submit_topology

update_cache

Rewrites a node's circuit cache file.

node_id

Node ID of the network device.

update_interface

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

Updates an interface.

description

interface_id Required

mpls_vlan_tag_range

vlan_tag_range

update_interface_owner

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