Update Site WAN Interface (v2.7)

PUT 
/v2.7/api/tenants/:tenant_id/sites/:site_id/waninterfaces/:wan_interface_id

Update the site WAN interface.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

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

wan_interface_id stringrequired

ID of the WAN interface.

application/json

Body

bfd_mode stringrequired

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 stringrequired

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 stringrequired

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 stringrequired

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.

type string

Possible values: [PUBLIC_WAN, PRIVATE_WAN]

Type of WAN.

use_for_application_reachability_probes boolean

Indicates if the use for application reachability probe is selected.

use_for_controller_connections boolean

Indicates if the use for controller connections is selected.

use_lqm_for_non_hub_paths boolean

Indicates if the use for lqm for non hub paths is enabled.

vpnlink_configuration VPNLinkConfiguration

The configuration of the VPN link.

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).

Responses

200

Successful Operation

application/json

Schema

Schema

bfd_mode stringrequired

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 stringrequired

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 stringrequired

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 stringrequired

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.

type string

Possible values: [PUBLIC_WAN, PRIVATE_WAN]

Type of WAN.

use_for_application_reachability_probes boolean

Indicates if the use for application reachability probe is selected.

use_for_controller_connections boolean

Indicates if the use for controller connections is selected.

use_lqm_for_non_hub_paths boolean

Use Lqm For Non Hub Paths

vpnlink_configuration VPNLinkConfiguration

The configuration of the VPN link.

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).

Example (from schema)

{
  "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"
  ],
  "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
  }
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "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"
      }
    ]
  }
}

404

Resource Not Found

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Loading...