virtualpaths¶
Overview¶
API to add, modify, delete, and get virtual paths
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- virtualpaths : Operations related to virtualpaths
Paths¶
POST operation for virtualpaths¶
POST /virtualpaths
Description¶
Use this operation to add virtual paths
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | virtualpaths_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¶
- virtualpaths
Get operation for virtualpaths¶
GET /virtualpaths
Description¶
Use this operation to get the list of virtual paths
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | virtualpaths_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¶
- virtualpaths
PUT operation for virtualpaths¶
PUT /virtualpaths
Description¶
Use this operation to modify a virtual paths
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
virtualpaths_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | virtualpaths_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¶
- virtualpaths
DELETE operation for virtualpaths¶
DELETE /virtualpaths/{deletePathParam}
Description¶
Use this operation to delete a virtual paths
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | virtualpaths_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¶
- virtualpaths
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
local_site¶
Virtual Path Local Site configuration
Type : < local_site > array
| Name | Description | Schema |
|---|---|---|
| default_set optional |
Name of the Virtual Path Default Set that will be used to populate rules and classes for the Virtual Path on the Site | string |
| route_cost optional |
This Cost will be added to Routes learned via the Virtual Path | integer |
| tracking_ip_address optional |
Tracking IP Address | string |
local_site_name¶
Local Site name
Type : string
package_name¶
Config package name using which the wan_links API operation should be performed.
Type : string
paths¶
Path Configuration for Virtual Paths
Type : < paths > array
| Name | Description | Schema |
|---|---|---|
| bad_loss_sensitive optional |
If Bad Loss Sensitive is set to Enable, Paths will be marked BAD due to loss and will incur a Path scoring penalty. Setting this option to Disable may be useful when the loss of bandwidth is intolerable. Custom settings allow you to specify the percentage of loss over time required to mark a Path BAD. Default : "ENABLE" |
enum (ENABLE, DISABLE, CUSTOM) |
| enable_encryption optional |
If enabled, packets sent along this Path will be encrypted | boolean |
| from_site_name optional |
Source site for the new path | string |
| from_wan_link_name optional |
Source WAN link for the new path | string |
| instability_sensitive optional |
If you enable Instability Sensitive, latency penalties due to the Path being in a BAD state and other latency spikes are considered in the Path scoring algorithm Default : false |
boolean |
| ip_dscp_tagging optional |
The DSCP Tag to set in the IP header for Path traffic Default : "ANY" |
enum (ANY, DEFAULT, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef) |
| reverse_also optional |
Add reverse path configuration also | boolean |
| reverse_tracking_ip_address optional |
If Reverse Also is enabled, a virtual IP address on the Path that can be pinged to determine the state of the reverse Path | string |
| silence_period optional |
Specify silence duration before Path state transitions from GOOD to BAD. When not specified, the default is 150ms | integer |
| static_path optional |
Convert Path, and all other Paths associated by WAN Link, Generated by an Autopath Group, to a Static Path. This action cannot be undone | boolean |
| to_site_name optional |
Destination site for the new path | string |
| to_wan_link_name optional |
Destination WAN Link for the new path | string |
| tracking_ip_address optional |
A virtual IP address on the Path that can be pinged to determine the state of the Path | string |
remote_site¶
Virtual Path Remote Site configuration
Type : < remote_site > array
| Name | Description | Schema |
|---|---|---|
| default_set optional |
Name of the Virtual Path Default Set that will be used to populate rules and classes for the Virtual Path on the Site | string |
| route_cost optional |
This Cost will be added to Routes learned via the Virtual Path | integer |
| tracking_ip_address optional |
Tracking IP Address | string |
remote_site_name¶
Remote Site name
Type : string
reverse¶
It should create reverse virtual Path also
Type : boolean
virtualpaths¶
| Name | Schema |
|---|---|
| local_site optional |
local_site |
| local_site_name optional |
local_site_name |
| package_name optional |
package_name |
| paths optional |
paths |
| remote_site optional |
remote_site |
| remote_site_name optional |
remote_site_name |
| reverse optional |
reverse |
virtualpaths_delete_success_schema¶
| Name | Schema |
|---|---|
| virtualpaths optional |
virtualpaths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
virtualpaths_post_success_schema¶
| Name | Schema |
|---|---|
| virtualpaths optional |
virtualpaths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
virtualpaths_put_success_schema¶
| Name | Schema |
|---|---|
| virtualpaths optional |
virtualpaths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
virtualpaths_request_schema¶
| Name | Schema |
|---|---|
| virtualpaths optional |
virtualpaths |
virtualpaths_response_schema¶
Type : < virtualpaths_response_schema > array
| Name | Schema |
|---|---|
| local_site optional |
local_site |
| local_site_name optional |
local_site_name |
| package_name optional |
package_name |
| paths optional |
paths |
| remote_site optional |
remote_site |
| remote_site_name optional |
remote_site_name |
| reverse optional |
reverse |