Skip to main content

Update Site WAN Interface (v2.7)

Update the site WAN interface.

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.

  • wan_interface_id string required

    ID of the WAN interface.

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 required

    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 required

    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 required

    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 integer required

    The VPN keep alive failure count (must be between 3 and 30).

  • keep_alive_interval integer required

    The VPN keep alive timeout interval (must be between 100ms-1740,000ms).

Responses

Successful Operation


Schema
  • 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 required

    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 required

    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 required

    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 integer required

    The VPN keep alive failure count (must be between 3 and 30).

  • keep_alive_interval integer required

    The VPN keep alive timeout interval (must be between 100ms-1740,000ms).

Loading...