wan_to_wan_forwarding¶
Overview¶
API to get, modify WAN to WAN Forwarding Settings.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- wan_to_wan_forwarding : Operations related to wan_to_wan_forwarding
Paths¶
Get operation for wan_to_wan_forwarding¶
GET /wan_to_wan_forwarding
Description¶
Use this operation to get the current values WAN to WAN Forwarding settings
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | wan_to_wan_forwarding_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_to_wan_forwarding
PUT operation for wan_to_wan_forwarding¶
PUT /wan_to_wan_forwarding
Description¶
Use this operation to modify the current values of WAN to WAN Forwarding settings
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
wan_to_wan_forwarding_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | wan_to_wan_forwarding_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_to_wan_forwarding
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
enable_site_as_intermediate_node¶
Set to true to enable site as an intermediate node. If enabled, this Site may serve as a mediator for the creation and destruction of Dynamic Virtual Paths between two or more Sites connected to this Site.
Type : boolean
enable_virtual_path_to_internet_or_intranet_forwarding¶
Set to true to enable virtual path to Internet/Intranet forwarding. Allows this Site to serve as a proxy for multi-hop Internet or Intranet traffic between adjacent Sites. Unlike WAN-to-WAN forwarding, enabling this option will not export internet/intranet routes to other sites.
Type : boolean
enable_virtual_path_to_virtual_path_forwarding¶
Set to true to enable virtual path to virtual path forwarding. Allows this Site to serve as a proxy for multi-hop Site-to-Site traffic between adjacent Sites. Unlike WAN-to-WAN forwarding, enabling this option will not export routes from site to site.
Type : boolean
enable_wan_to_wan_forwarding¶
Set to true to enable wan to wan forwarding. Allows this Site to serve as a proxy for multi-hop Site-to-Site, Internet or Intranet traffic between adjacent Sites. Exports Local, Intranet, Internet and learned local routes to members of the WAN to WAN forwarding group.
Type : boolean
package_name¶
Config package name using which the API operation should be performed.
Type : string
site_name¶
Site Name
Type : string
wan_to_wan_forwarding¶
| Name | Schema |
|---|---|
| enable_site_as_intermediate_node optional |
enable_site_as_intermediate_node |
| enable_virtual_path_to_internet_or_intranet_forwarding optional |
enable_virtual_path_to_internet_or_intranet_forwarding |
| enable_virtual_path_to_virtual_path_forwarding optional |
enable_virtual_path_to_virtual_path_forwarding |
| enable_wan_to_wan_forwarding optional |
enable_wan_to_wan_forwarding |
| package_name optional |
package_name |
| site_name optional |
site_name |
| wan_to_wan_forwarding_group optional |
wan_to_wan_forwarding_group |
wan_to_wan_forwarding_delete_success_schema¶
| Name | Schema |
|---|---|
| wan_to_wan_forwarding optional |
wan_to_wan_forwarding |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
wan_to_wan_forwarding_group¶
The WAN-to-WAN Forwarding Group used to determine which remote Sites can be used with this Site in WAN-to-WAN forwarding and Dynamic Virtual Paths
Type : string
wan_to_wan_forwarding_post_success_schema¶
| Name | Schema |
|---|---|
| wan_to_wan_forwarding optional |
wan_to_wan_forwarding |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
wan_to_wan_forwarding_put_success_schema¶
| Name | Schema |
|---|---|
| wan_to_wan_forwarding optional |
wan_to_wan_forwarding |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
wan_to_wan_forwarding_request_schema¶
| Name | Schema |
|---|---|
| wan_to_wan_forwarding optional |
wan_to_wan_forwarding |
wan_to_wan_forwarding_response_schema¶
Type : < wan_to_wan_forwarding_response_schema > array
wan_to_wan_forwarding_response_schema
| Name | Schema |
|---|---|
| enable_site_as_intermediate_node optional |
enable_site_as_intermediate_node |
| enable_virtual_path_to_internet_or_intranet_forwarding optional |
enable_virtual_path_to_internet_or_intranet_forwarding |
| enable_virtual_path_to_virtual_path_forwarding optional |
enable_virtual_path_to_virtual_path_forwarding |
| enable_wan_to_wan_forwarding optional |
enable_wan_to_wan_forwarding |
| package_name optional |
package_name |
| site_name optional |
site_name |
| wan_to_wan_forwarding_group optional |
wan_to_wan_forwarding_group |