Query Topology (v3.4)

POST 
/v3.4/api/tenants/:tenant_id/topology

Query the topology elements of the tenant.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

links string[]

Query the anynet links.

links_only boolean

The anynet link ID. True/False.

location SiteLocation

The anynet link start and end location.

end Location

End

description

The decsription of the location.

latitude float

The latitude of the location. Max range = 90.

longitude float

The longitude of the location. Max range = 180.

start Location

Start

description

The decsription of the location.

latitude float

The latitude of the location. Max range = 90.

longitude float

The longitude of the location. Max range = 180.

nodes string[]

Nodes

servicelinks boolean

Servicelinks present. True/False.

site_id string

The site ID.

sites SiteEndpoints

The site endpoints.

ep1_id string

Ep1 Id

ep2_id string

Ep2 Id

stub_links boolean

Stub Links

type string

Possible values: [ANYNET, ANYNETPLUS, BASENET, PHYSICAL]

Anynet link type.

Responses

200

Successful Operation

application/json

Schema

Schema

links NetworkLinkV3N4[]
Query the anynet links.
Array [
admin_up boolean
The interface admin state.
anynet_link_id string
The anynet link ID..
cost int32
Cost
description
The anynet link description. Max size = 256.
elem_interface_id string
The element interface ID.
element_id string
The element ID.
id string
The ID.
in_use boolean
In Use
name string
The anynet link name. Max size = 128.
network string
Network
path_id string
Path Id
sep_id string
Sep Id
sep_name string
Sep Name
source_circuit_name string
The name of the source circuit.
source_elem_if_id string
The source element ID.
source_node_id string
The source node ID.
source_site_name string
The source site name.
source_wan_if_id string
The source WAN ID.
source_wan_network string
The source WAN network.
source_wan_nw_id string
The The source WAN network ID.
status string
The status of the link.
sub_type string
Sub Type
tags string[]
A information field that can be added to identify the anynet link. Maximum 10 unique tags of length 1024 each are allowed.
target_circuit_name string
The target circuit name.
target_elem_if_id string
The target element ID.
target_node_id string
The target node ID.
target_serviceendpoint_id string
Target Serviceendpoint Id
target_serviceendpoint_name string
Target Serviceendpoint Name
target_site_name string
The target site name.
target_wan_if_id string
The target WAN ID.
target_wan_network string
The target WAN network.
target_wan_nw_id string
The The target WAN network ID.
tenant_id string
The active user tenant ID.
type string
Anynet link type.
vpnlink_configuration VPNLinkConfiguration
The configuration of the VPN link.
keep_alive_failure_count integerrequired
The VPN keep alive failure count (must be between 3 and 30).
keep_alive_interval integerrequired
The VPN keep alive timeout interval (must be between 100ms-1740,000ms).
vpnlinks string[]
The VPN links info.
wan_if_id string
The WAN ID.
wan_nw_id string
The WAN network ID.
wan_nw_name string
The WAN network name.
]
nodes NetworkNode[]
Nodes
Array [
address Address
The network address details.
city string
The name of the city. Max size = 100.
country string
The name of the country. Max size = 100.
post_code string
The postal code. Max size = 100.
state string
The name of the state. Max size = 100.
street string
The name of the street. Max size = 100.
street2 string
The name of the street. Max size = 100.
elem_hw_id string
The element hardware ID.
id string
The ID.
location Location
The network node location.
description
The decsription of the location.
latitude float
The latitude of the location. Max range = 90.
longitude float
The longitude of the location. Max range = 180.
name string
The network name. Max size = 128.
role string
Role
site_id string
The site ID.
spoke_cluster_elem_status string
The spoke cluster element status.
state string
State
tenant_id string
The active user tenant ID.
type string
Anynet link type.
]
type string

Possible values: [ANYNET, ANYNETPLUS, BASENET, PHYSICAL]

Anynet link type.

Example (from schema)

{
  "links": [
    {
      "admin_up": true,
      "anynet_link_id": "string",
      "cost": 0,
      "elem_interface_id": "string",
      "element_id": "string",
      "id": "string",
      "in_use": true,
      "name": "string",
      "network": "string",
      "path_id": "string",
      "sep_id": "string",
      "sep_name": "string",
      "source_circuit_name": "string",
      "source_elem_if_id": "string",
      "source_node_id": "string",
      "source_site_name": "string",
      "source_wan_if_id": "string",
      "source_wan_network": "string",
      "source_wan_nw_id": "string",
      "status": "string",
      "sub_type": "string",
      "tags": [
        "string"
      ],
      "target_circuit_name": "string",
      "target_elem_if_id": "string",
      "target_node_id": "string",
      "target_serviceendpoint_id": "string",
      "target_serviceendpoint_name": "string",
      "target_site_name": "string",
      "target_wan_if_id": "string",
      "target_wan_network": "string",
      "target_wan_nw_id": "string",
      "tenant_id": "string",
      "type": "string",
      "vpnlink_configuration": {
        "keep_alive_failure_count": 0,
        "keep_alive_interval": 0
      },
      "vpnlinks": [
        "string"
      ],
      "wan_if_id": "string",
      "wan_nw_id": "string",
      "wan_nw_name": "string"
    }
  ],
  "nodes": [
    {
      "address": {
        "city": "string",
        "country": "string",
        "post_code": "string",
        "state": "string",
        "street": "string",
        "street2": "string"
      },
      "elem_hw_id": "string",
      "id": "string",
      "location": {
        "latitude": 0,
        "longitude": 0
      },
      "name": "string",
      "role": "string",
      "site_id": "string",
      "spoke_cluster_elem_status": "string",
      "state": "string",
      "tenant_id": "string",
      "type": "string"
    }
  ],
  "type": "ANYNET"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_INPUT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_TOPO_QUERY"
      },
      {
        "code": "INVALID_TOPOLOGY_STUB_LINKS_OPTION"
      },
      {
        "code": "TOPOLOGY_REBUILD_IN_PROGRESS"
      }
    ]
  }
}

Loading...