path
path
Configuration Editor for Paths configuration for virtual paths resource.
Read/write properties
from_wan_link_name <String>
Source WAN link for the new path.
ip_dscp_tagging <String>
The DSCP Tag to set in the IP header for Path traffic. Possible values = [ANY,DEFAULT,af11,af12,af13,af21,af22,af23,af31,af32,af33,af41,af42,af43,cs1,cs2,cs3,cs4,cs5,cs6,cs7,ef]
tracking_ip_address <String>
A virtual IP address on the Path that can be pinged to determine the state of the Path.
reverse_tracking_ip_address <String>
If Reverse Also is enabled, a virtual IP address on the Path that can be pinged to determine the state of the reverse Path.
bad_loss_sensitive <String>
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. . Possible values = [ENABLE,DISABLE,CUSTOM]
from_site_name <String>
Source site for the new path.
package_name <String>
Package corresponding to the API operation.
instability_sensitive <Boolean>
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.
virtual_path_name <String>
Name of virtual path to which the path belongs.
enable_encryption <Boolean>
If enabled, packets sent along this Path will be encrypted.
to_site_name <String>
Destination site for the new path.
silence_period <Integer>
Specify silence duration before Path state transitions from GOOD to BAD. When not specified, the default is 150ms. Possible values = [500,750,1000,10000,20000,30000,40000,50000,60000]
static_path <Boolean>
Convert Path, and all other Paths associated by WAN Link, Generated by an Autopath Group, to a Static Path. This action cannot be undone.
to_wan_link_name <String>
Destination WAN Link for the new path.
reverse_also <Boolean>
Add reverse path configuration also.
Read only properties
Operations
[add]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/path
Description: Use this operation to add paths
HTTP Method: POST
Request Payload: JSON
{"path": { "from_wan_link_name":<String_value> , "ip_dscp_tagging":<String_value> , "tracking_ip_address":<String_value> , "reverse_tracking_ip_address":<String_value> , "bad_loss_sensitive":<String_value> , "from_site_name":<String_value> , "package_name":<String_value> , "instability_sensitive":<Boolean_value> , "virtual_path_name":<String_value> , "enable_encryption":<Boolean_value> , "to_site_name":<String_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }}
Response Payload: JSON
{ "path":{ "from_wan_link_name":<String_value>
, "ip_dscp_tagging":<String_value> , "tracking_ip_address":<String_value> , "reverse_tracking_ip_address":<String_value> , "bad_loss_sensitive":<String_value> , "from_site_name":<String_value> , "package_name":<String_value> , "instability_sensitive":<Boolean_value> , "virtual_path_name":<String_value> , "enable_encryption":<Boolean_value> , "to_site_name":<String_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }]}
[delete]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/path/to_wan_link_name=<String>,to_site_name=<String>,virtual_path_name=<String>,package_name=<String>,from_site_name=<String>,from_wan_link_name=<String>
Description: Use this operation to delete a path
HTTP Method: DELETE
Response Payload: JSON
{ "errorcode": 0, "message": "Done", "severity": <String;_value> }
[get (all)]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/path/package_name=<package_name>
Description: Use this operation to get the Path configuration for a particular virtual path
HTTP Method: GET
Response Payload: JSON
{"path":[{ "from_wan_link_name":<String_value>
, "ip_dscp_tagging":<String_value> , "tracking_ip_address":<String_value> , "reverse_tracking_ip_address":<String_value> , "bad_loss_sensitive":<String_value> , "from_site_name":<String_value> , "package_name":<String_value> , "instability_sensitive":<Boolean_value> , "virtual_path_name":<String_value> , "enable_encryption":<Boolean_value> , "to_site_name":<String_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }]}
[modify]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/path
Description: Use this operation to modify a path
HTTP Method: PUT
Request Payload: JSON
{"path":{ "from_wan_link_name":<String_value> , "ip_dscp_tagging":<String_value> , "tracking_ip_address":<String_value> , "reverse_tracking_ip_address":<String_value> , "bad_loss_sensitive":<String_value> , "from_site_name":<String_value> , "package_name":<String_value> , "instability_sensitive":<Boolean_value> , "virtual_path_name":<String_value> , "enable_encryption":<Boolean_value> , "to_site_name":<String_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }}
Response Payload: JSON
{ "path":[{ "from_wan_link_name":<String_value>
, "ip_dscp_tagging":<String_value> , "tracking_ip_address":<String_value> , "reverse_tracking_ip_address":<String_value> , "bad_loss_sensitive":<String_value> , "from_site_name":<String_value> , "package_name":<String_value> , "instability_sensitive":<Boolean_value> , "virtual_path_name":<String_value> , "enable_encryption":<Boolean_value> , "to_site_name":<String_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }]}