Skip to main content

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.

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

Successful Operation

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

Loading...