Update Site WAN Interface (v2.8)
PUT/v2.8/api/tenants/:tenant_id/sites/:site_id/waninterfaces/:wan_interface_id
Update the site WAN interface.
Request
Path Parameters
The tenant ID.
ID of the site. More details on the site can be retrieved by querying the sites API.
ID of the WAN interface.
- application/json
Body
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.
Possible values: [auto
, manual
, manual_bwm_disabled
]
The bandwidth config mode.
Bwc Enabled
Cost value for the site WAN interface should be within range 0-1024.
The description of the WAN interface config (size max = 256).
The ID.
l3_reachability WANL3Reachability
The WAN L3 reachability information.
The probe configuration IDs.
The default element used.
The WAN interface label or Circuit label ID. This can be retrieved using the waninterfacelabels API.
The circuit downstream capacity in MB.
The circuit upstream capacity in MB.
lqm_config LQMConfig
The link quality monitoring parameters.
List of DC Site IDs.
Allowed values: 50-300 milliseconds.
Possible values: [min
, max
, avg
]
WAN interface LQM config statistics.
The link quality monitoring parameters.
The name of the WAN interface config (size max = 128).
The network ID.
The probe profile ID.
An information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed.
Possible values: [PUBLIC_WAN
, PRIVATE_WAN
]
Type of WAN.
Indicates if the use for application reachability probe is selected.
Indicates if the use for controller connections is selected.
Indicates if the use for lqm for non hub paths is enabled.
vpnlink_configuration VPNLinkConfiguration
The configuration of the VPN link.
The VPN keep alive failure count (must be between 3 and 30).
The VPN keep alive timeout interval (must be between 100ms-1740,000ms).
Responses
- 200
- 400
- 404
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
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.
Possible values: [auto
, manual
, manual_bwm_disabled
]
The bandwidth config mode.
Bwc Enabled
Cost value for the site WAN interface should be within range 0-1024.
The description of the WAN interface config (size max = 256).
The ID.
l3_reachability WANL3Reachability
The WAN L3 reachability information.
The probe configuration IDs.
The default element used.
The WAN interface label or Circuit label ID. This can be retrieved using the waninterfacelabels API.
The circuit downstream capacity in MB.
The circuit upstream capacity in MB.
lqm_config LQMConfig
The link quality monitoring parameters.
List of DC Site IDs.
Allowed values: 50-300 milliseconds.
Possible values: [min
, max
, avg
]
WAN interface LQM config statistics.
The link quality monitoring parameters.
The name of the WAN interface config (size max = 128).
The network ID.
The probe profile ID.
An information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed.
Possible values: [PUBLIC_WAN
, PRIVATE_WAN
]
Type of WAN.
Indicates if the use for application reachability probe is selected.
Indicates if the use for controller connections is selected.
Indicates if the use for lqm for non hub paths is enabled.
vpnlink_configuration VPNLinkConfiguration
The configuration of the VPN link.
The VPN keep alive failure count (must be between 3 and 30).
The VPN keep alive timeout interval (must be between 100ms-1740,000ms).
{
"bfd_mode": "aggressive",
"bw_config_mode": "auto",
"bwc_enabled": true,
"cost": 0,
"id": "string",
"l3_reachability": {
"probe_config_ids": [
"string"
],
"use_element_default": true
},
"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",
"probe_profile_id": "string",
"tags": [
"string"
],
"type": "PUBLIC_WAN",
"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
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "WANINTERFACE_CONFIG_INVALID_SITE_ID"
},
{
"code": "WANINTERFACE_CONFIG_INVALID_NETWORK_ID"
},
{
"code": "WANINTERFACE_CONFIG_INVALID_BANDWIDTH"
},
{
"code": "WANINTERFACE_CONFIG_LABEL_NOT_FOUND"
},
{
"code": "WANINTERFACE_CONFIG_INVALID_LABEL"
},
{
"code": "WANINTERFACE_LQM_CONFIG_NOT_ALLOWED"
},
{
"code": "WANINTERFACE_LQM_CONFIG_INVALID_FIELDS"
},
{
"code": "WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS_SIZE"
},
{
"code": "WANINTERFACE_LQM_CONFIG_INVALID_HUB_SITE_IDS"
},
{
"code": "WANINTERFACE_LQM_CONFIG_INVALID_STATISTIC"
},
{
"code": "WANINTERFACE_LQM_CONFIG_DUPLICATE_HUB_SITE_IDS"
},
{
"code": "WANINTERFACE_LQM_CONFIG_INVALID_INTER_PACKET_GAP"
},
{
"code": "VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL"
},
{
"code": "VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT"
},
{
"code": "WANINTERFACE_USE_FOR_NON_HUB_PATHS_INVALID"
},
{
"code": "WANINTERFACE_USE_FOR_NON_HUB_PATHS_NOT_ALLOWED"
},
{
"code": "L3_REACHABILITY_MAX_PROBE_CONFIGS_LIMIT_EXCEEDED"
},
{
"code": "WANINTERFACE_PROBE_PROFILE_ALLOWED_ONLY_FOR_SPOKE_SITES"
},
{
"code": "WANINTERFACE_L3_REACHABILITY_ALLOWED_ONLY_FOR_SPOKE_SITES"
},
{
"code": "INVALID_PROBE_PROFILE"
},
{
"code": "L3_REACHABILITY_PROBE_CONFIGS_CANONT_BE_SET_ELEMENT_DEFAULT_CONFIGURED"
},
{
"code": "L3_REACHABILITY_PROBE_CONFIGS_REQUIRED_WHEN_ELEMENT_DEFAULT_NOT_USED"
},
{
"code": "PROBE_CONFIGS_CANNOT_BE_SPECIFIED_WITHOUT_PROBE_PROFILE"
},
{
"code": "WANINTERFACE_PROBE_PROFILE_DOES_NOT_CONTAIN_PROBE_CONFIGS"
},
{
"code": "WANINTERFACE_LABEL_PROBE_PROFILE_DOES_NOT_CONTAIN_PROBE_CONFIGS"
},
{
"code": "PROBE_CONFIG_VALID_L3_REACHABILITY_PROTOCOL_MISSING"
},
{
"code": "PROBE_CONFIG_VALID_L3_REACHABILITY_DIRECT_PATH_MISSING"
},
{
"code": "L3_REACHABILITY_MANDATORY_PROBE_PROFILES_MISMATCH"
}
]
}
}
Resource Not Found
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}