Query Topology (v3.5)

POST 
/v3.5/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 NetworkLinkV3N5[]
Links
Array [
admin_up boolean
Admin Up
anynet_link_id string
Anynet Link Id
cost int32
Cost
description string
Description
elem_interface_id string
Elem Interface Id
element_id string
Element Id
id string
Id
in_use boolean
In Use
name string
Name
network string
Network
path_id string
Path Id
sep_id string
Sep Id
sep_name string
Sep Name
source_circuit_name string
Source Circuit Name
source_elem_if_id string
Source Elem If Id
source_node_id string
Source Node Id
source_site_name string
Source Site Name
source_wan_if_id string
Source Wan If Id
source_wan_network string
Source Wan Network
source_wan_nw_id string
Source Wan Nw Id
status string
Status
sub_type string
Sub Type
tags string[]
Tags
target_circuit_name string
Target Circuit Name
target_elem_if_id string
Target Elem If Id
target_node_id string
Target Node Id
target_serviceendpoint_id string
Target Serviceendpoint Id
target_serviceendpoint_name string
Target Serviceendpoint Name
target_site_name string
Target Site Name
target_wan_if_id string
Target Wan If Id
target_wan_network string
Target Wan Network
target_wan_nw_id string
Target Wan Nw Id
tenant_id string
Tenant Id
type string
Type
vpnlink_configuration VPNLinkConfiguration
Vpnlink Configuration
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[]
Vpnlinks
wan_if_id string
Wan If Id
wan_nw_id string
Wan Nw Id
wan_nw_name string
Wan Nw Name
]
nodes NetworkNodeV3N5[]
Nodes
Array [
address Address
Address
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
Elem Hw Id
id string
Id
is_sase boolean
Is Sase
location Location
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
Name
role string
Role
sase_properties SaseServiceEndpointProperties
Sase Properties
active boolean
Active
lqm_enabled boolean
Lqm Enabled
site_id string
Site Id
spoke_cluster_elem_status string
Spoke Cluster Elem Status
state string
State
tenant_id string
Tenant Id
type string
Type
]
type string

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

Type

Example (from schema)

{
  "links": [
    {
      "admin_up": true,
      "anynet_link_id": "string",
      "cost": 0,
      "description": "string",
      "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",
      "is_sase": true,
      "location": {
        "latitude": 0,
        "longitude": 0
      },
      "name": "string",
      "role": "string",
      "sase_properties": {
        "active": true,
        "lqm_enabled": true
      },
      "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...