Get Site WAN Interfaces (v2.4)

Get all the WAN interfaces for the site.

Path Parameters

• tenant_id string required

  The tenant ID.

• site_id string required

  ID of the site. More details on the site can be retrieved by querying the sites API.

Responses

• 200

---

Successful Operation

application/json

• Schema
• Example (from schema)

---

Schema

• count int32

  The total number of responses.

• id string

  The ID of the response.

• type string

  The type of response.

• items WANInterfaceV2N4[]

  Array [

  bfd_mode string required

  Possible values: [aggressive, non_aggressive]

  Allowed values: aggressive - For fast failure detection of links. This mode is the default mode and is recommended by Prisma SD-WAN. non_aggressive - when you want to reduce the amount of probe traffic, or for links that are subjected to high loss or poor quality.

  bw_config_mode string

  Possible values: [auto, manual, manual_bwm_disabled]

  The bandwidth config mode.

  bwc_enabled boolean

  Bwc Enabled

  cost integer

  Cost value for the site WAN interface should be within range 0-1024.

  description

  The description of the WAN interface config (size max = 256).

  id string

  The ID.

  label_id string

  The WAN interface label or Circuit label ID. This can be retrieved using the waninterfacelabels API.

  link_bw_down double

  The circuit downstream capacity in MB.

  link_bw_up double

  The circuit upstream capacity in MB.

  lqm_config LQMConfig

  The link quality monitoring parameters.

  hub_site_ids string[]

  List of DC Site IDs.

  inter_packet_gap int32

  Allowed values: 50-300 milliseconds.

  statistic string

  Possible values: [min, max, avg]

  WAN interface LQM config statistics.

  lqm_enabled boolean

  The link quality monitoring parameters.

  name string

  The name of the WAN interface config (size max = 128).

  network_id string

  The network ID.

  tags string[]

  An information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed.

  ]

{
  "count": 0,
  "id": "string",
  "type": "string",
  "items": [
    {
      "bfd_mode": "aggressive",
      "bw_config_mode": "auto",
      "bwc_enabled": true,
      "cost": 0,
      "id": "string",
      "label_id": "string",
      "link_bw_down": 0,
      "link_bw_up": 0,
      "lqm_config": {
        "hub_site_ids": [
          "string"
        ],
        "inter_packet_gap": 0,
        "statistic": "min"
      },
      "lqm_enabled": true,
      "name": "string",
      "network_id": "string",
      "tags": [
        "string"
      ]
    }
  ]
}

Loading...