Skip to content

wan_links

Overview

API to add, modify, delete, and get configuration for WAN links

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags

  • wan_links : Operations related to wan_links

Paths

POST operation for wan_links

POST /wan_links

Description

Use this operation to add wan links

Responses

HTTP Code Description Schema
200 Resource successfully added wan_links_post_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • wan_links

GET /wan_links

Description

Use this operation to get the list of wan links

Responses

HTTP Code Description Schema
200 API Successfully executed wan_links_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • wan_links

PUT /wan_links

Description

Use this operation to modify a wan link

Parameters

Type Name Schema
Body body
optional
wan_links_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added wan_links_put_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • wan_links

DELETE /wan_links/{deletePathParam}

Description

Use this operation to delete a wan link

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added wan_links_delete_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • wan_links

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

access_interfaces

List of Access Interfaces associated with the wan links group.

Type : < access_interfaces > array

access_interfaces

Name Description Schema
conduit_mode
optional
Determines the priority for Virtual Path traffic on this WAN Link. If set to 'exclude', the Access Interface will only be used for Internet and Intranet traffic enum (primary, secondary, exclude)
enable_proxy_arp
optional
If enabled, the Virtual WAN appliance will reply to ARP requests for the Gateway IP Address when the gateway is unreachable boolean
gateway_mac_addr_binding
optional
If enabled, the source MAC address of packets received on Internet or Intranet services must match the gateway MAC address boolean
gw_ip_addr
optional
The IP Address of the Gateway router. You cannot configure the Gateway IP Address when the Virtual Appliance is configured to use DHCP Client mode. string
name
optional
Access Interface name string
virtual_interface_name
optional
Virtual Interface Name string
virtual_ip_addr
optional
The IP Address for the Access Interface Endpoint on the WAN. You cannot configure the IP Address when the Virtual Appliance is configured to use DHCP Client mode. string

access_type

The type of network connected to the WAN link

Type : enum (public_internet, private_intranet, private_mpls)

enable_public_ip_learning

Enable public IP learning

Type : boolean

lan_to_wan_permitted_rate

LAN to WAN Permitted rate in Kbps

Type : integer

lan_to_wan_physical_rate

LAN to WAN Physical rate in Kbps

Type : integer

mpls_queues

List of MPLS Queues associated with the wan links group.

Type : < mpls_queues > array

mpls_queues

Name Description Schema
congestion_threshold
optional
The amount of congestion (in microseconds) after which the MPLS Queue will throttle packet transmission to avoid further congestion integer
dscp_tag
optional
The DSCP tag for the MPLS queue
Default : "DEFAULT"
enum (DEFAULT, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef)
lan_to_wan_bulk_eligibility
optional
Allows paths from this WAN Link to transmit bulk traffic. If disabled, these paths will still be considered eligible if no other paths are available boolean
lan_to_wan_interactive_eligibility
optional
Allows paths from this WAN Link to transmit interactive traffic. If disabled, these paths will still be considered eligible if no other paths are available boolean
lan_to_wan_permitted_rate_kbps
optional
The available or allowed rate for LAN to WAN traffic integer
lan_to_wan_realtime_eligibility
optional
Allows paths from this WAN Link to transmit realtime traffic. If disabled, these paths will still be considered eligible if no other paths are available boolean
mpls_queue_name
optional
The name of the MPLS Queue string
no_retag
optional
If enabled, DCSP tags using unmatched Queue will not get retagged to the unmatched Queue tag for LAN to WAN intranet traffic boolean
tracking_ip_address
optional
A virtual IP address that can be pinged to determine the state of the MPLS Queue string
unmatched
optional
If enabled, DSCP tags not matched by other MPLS Queues will use this queue boolean
wan_to_lan_bulk_eligibility
optional
Allows paths to this WAN Link to transmit bulk traffic. If disabled, these paths will still be considered eligible if no other paths are available boolean
wan_to_lan_interactive_eligibility
optional
Allows paths to this WAN Link to transmit interactive traffic. If disabled, these paths will still be considered eligible if no other paths are available. boolean
wan_to_lan_permitted_rate_kbps
optional
The available or allowed rate for WAN to LAN traffic integer
wan_to_lan_realtime_eligibility
optional
Allows paths to this WAN Link to transmit realtime traffic. If disabled, these paths will still be considered eligible if no other paths are available. boolean

mtu_size

Maximum taranfer unit size

Type : integer

package_name

Config package name using which the wan_links API operation should be performed.

Type : string

public_ip

Public IP Address of WAN Links

Type : string

site_name

Site Name

Type : string

wan_link_name

WAN Link name

Type : string

wan_link_template_name

WAN Link template name

Type : string

Name Schema
access_interfaces
optional
access_interfaces
access_type
optional
access_type
enable_public_ip_learning
optional
enable_public_ip_learning
lan_to_wan_permitted_rate
optional
lan_to_wan_permitted_rate
lan_to_wan_physical_rate
optional
lan_to_wan_physical_rate
mpls_queues
optional
mpls_queues
mtu_size
optional
mtu_size
package_name
optional
package_name
public_ip
optional
public_ip
site_name
optional
site_name
wan_link_name
optional
wan_link_name
wan_link_template_name
optional
wan_link_template_name
wan_to_lan_permitted_rate
optional
wan_to_lan_permitted_rate
wan_to_lan_physical_rate
optional
wan_to_lan_physical_rate

wan_links_delete_success_schema

Name Schema
wan_links
optional
wan_links

wan_links

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

wan_links_post_success_schema

Name Schema
wan_links
optional
wan_links

wan_links

Name Description Schema
message
optional
Example : "resource added succesfully" string

wan_links_put_success_schema

Name Schema
wan_links
optional
wan_links

wan_links

Name Description Schema
message
optional
Example : "resource modified succesfully" string

wan_links_request_schema

Name Schema
wan_links
optional
wan_links

wan_links_response_schema

Type : < wan_links_response_schema > array

wan_links_response_schema

Name Schema
access_interfaces
optional
access_interfaces
access_type
optional
access_type
enable_public_ip_learning
optional
enable_public_ip_learning
lan_to_wan_permitted_rate
optional
lan_to_wan_permitted_rate
lan_to_wan_physical_rate
optional
lan_to_wan_physical_rate
mpls_queues
optional
mpls_queues
mtu_size
optional
mtu_size
package_name
optional
package_name
public_ip
optional
public_ip
site_name
optional
site_name
wan_link_name
optional
wan_link_name
wan_link_template_name
optional
wan_link_template_name
wan_to_lan_permitted_rate
optional
wan_to_lan_permitted_rate
wan_to_lan_physical_rate
optional
wan_to_lan_physical_rate

wan_to_lan_permitted_rate

WAN to LAN Permitted rate in Kbps

Type : integer

wan_to_lan_physical_rate

WAN to LAN Physical rate in Kbps

Type : integer