virtual_path_wan_links¶

Overview¶

API to get, modify wan links for Virtual Paths

Version information¶

Version : v2

URI scheme¶

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

Tags¶

virtual_path_wan_links : Operations related to virtual_path_wan_links

Paths¶

POST operation for virtual_path_wan_links¶

POST /virtual_path_wan_links

Description¶

Use this operation to enable the Virtual Path service to use a particular wan link

Responses¶

HTTP Code	Description	Schema
200	Resource successfully added	virtual_path_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¶

virtual_path_wan_links

Get operation for virtual_path_wan_links¶

GET /virtual_path_wan_links

Description¶

Use this operation to get the wan links for Virtual Paths. Only enabled wan links are listed

Responses¶

HTTP Code	Description	Schema
200	API Successfully executed	virtual_path_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¶

virtual_path_wan_links

PUT operation for virtual_path_wan_links¶

PUT /virtual_path_wan_links

Description¶

Use this operation to modify wan links for a Virtual Path. This operation can only be used when the wan link is enabled for Virtual Path

Parameters¶

Type	Name	Schema
Body	body optional	virtual_path_wan_links_request_schema

Responses¶

HTTP Code	Description	Schema
200	Resource modified added	virtual_path_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¶

virtual_path_wan_links

DELETE operation for virtual_path_wan_links¶

DELETE /virtual_path_wan_links/{deletePathParam}

Description¶

Use this operation to disable the Virtual Path service to use a particular 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	virtual_path_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¶

virtual_path_wan_links

Definitions¶

ErrorSchema¶

Name	Schema
errorcode optional	integer
errormessage optional	string

active_mtu_detect¶

If enabled, all LAN to WAN Paths for the Virtual Path Service will be actively probed for MTU

Type : boolean

autopath_group¶

The group used to determine what paths may be automatically generated between this WAN Link and remote WAN Links and what default path settings to use. Use none for setting to None or Default for the Default value

Type : string

enable_udp_port_switching¶

If enabled, the WAN Link will alternate its UDP port at the specified interval

Type : boolean

id¶

Auto-generated ID to uniquely identify the WAN Link

Type : integer

package_name¶

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

Type : string

site_name¶

Site Name

Type : string

tunnel_header_size¶

The size, in bytes, of the tunnel header, if applicable

Type : integer

udp_port¶

The specified port will be used for LAN to WAN packets and required for WAN to LAN packets

Type : integer

udp_port_switching_alt_port¶

The alternate UDP port to be used when UDP Port Switching is enabled and active

Type : integer

udp_port_switching_interval¶

The interval, in minutes, that the WAN Link will alternate its UDP port

Type : integer

virtual_path_name¶

Virtual Path name to which the rule belongs

Type : string

virtual_path_wan_links¶

Name	Schema
active_mtu_detect optional	active_mtu_detect
autopath_group optional	autopath_group
enable_udp_port_switching optional	enable_udp_port_switching
id optional	id
package_name optional	package_name
site_name optional	site_name
tunnel_header_size optional	tunnel_header_size
udp_port optional	udp_port
udp_port_switching_alt_port optional	udp_port_switching_alt_port
udp_port_switching_interval optional	udp_port_switching_interval
virtual_path_name optional	virtual_path_name
wan_link_name optional	wan_link_name

virtual_path_wan_links_delete_success_schema¶

Name	Schema
virtual_path_wan_links optional	virtual_path_wan_links

virtual_path_wan_links

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

virtual_path_wan_links_post_success_schema¶

Name	Schema
virtual_path_wan_links optional	virtual_path_wan_links

virtual_path_wan_links

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

virtual_path_wan_links_put_success_schema¶

Name	Schema
virtual_path_wan_links optional	virtual_path_wan_links

virtual_path_wan_links

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

virtual_path_wan_links_request_schema¶

Name	Schema
virtual_path_wan_links optional	virtual_path_wan_links

virtual_path_wan_links_response_schema¶

Type : < virtual_path_wan_links_response_schema > array

virtual_path_wan_links_response_schema

Name	Schema
active_mtu_detect optional	active_mtu_detect
autopath_group optional	autopath_group
enable_udp_port_switching optional	enable_udp_port_switching
id optional	id
package_name optional	package_name
site_name optional	site_name
tunnel_header_size optional	tunnel_header_size
udp_port optional	udp_port
udp_port_switching_alt_port optional	udp_port_switching_alt_port
udp_port_switching_interval optional	udp_port_switching_interval
virtual_path_name optional	virtual_path_name
wan_link_name optional	wan_link_name

wan_link_name¶

The WAN Link name

Type : string