Query DB for WAN Interface Labels (v2.4)
Query the DB for WAN interface labels that match query parameters.
Path Parameters
- tenant_id string required
The ID of the tenant.
- application/json
Request Body
- 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
The bwc parameters.
- cost integer
Cost value for the site WAN interface should be within range 0-1024.
- description
The description of the WAN interface config.
- 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 int32Allowed values: 50-300 milliseconds.
statistic stringPossible 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.
- network_id string
The network ID.
- tags string[]
An information field that can be added to identify the WAN interface. Maximum 10 unique tags of length 1024 each are allowed.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- count int32
The count of the query list.
- deleted_count int64
The deleted number of queries.
- deleted_ids string[]
The deleted query IDs.
- description
Description of the query. Max size = 256.
- id string
The ID.
- next_query object
Details of the next query.
- tenant_id string
- total_count int64
Total number of queries.
items WANInterfaceLabelQueryFilterV2N4[]
Array [bwc_enabled booleanThe bwc parameters.
descriptionThe description of the WAN interface label. Maz size = 256.
id stringThe ID of the WAN interface label.
label stringThe label of the WAN interface.
lqm_enabled booleanThe link quality monitoring parameters.
name stringThe name of the WAN interface label. Max size = 128.
tags string[]An information field that can be added to identify the WAN interface label. Maximum 10 unique tags of length 1024 each are allowed.
use_for_application_reachability_probes booleanIndicates if the use for application reachability probe is selected.
use_for_controller_connections booleanIndicates if the use for controller connections is selected.
use_lqm_for_non_hub_paths booleanIndicates if the use for lqm for non hub paths is enabled.
vpnlink_configuration VPNLinkConfiguration
The configuration of the VPN link.
keep_alive_failure_count integer requiredThe VPN keep alive failure count (must be between 3 and 30).
keep_alive_interval integer requiredThe VPN keep alive timeout interval (must be between 100ms-1740,000ms).
]
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"bwc_enabled": true,
"id": "string",
"label": "string",
"lqm_enabled": true,
"name": "string",
"tags": [
"string"
],
"use_for_application_reachability_probes": true,
"use_for_controller_connections": true,
"use_lqm_for_non_hub_paths": true,
"vpnlink_configuration": {
"keep_alive_failure_count": 0,
"keep_alive_interval": 0
}
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "BAD_REQUEST"
}
]
}
}