virtualpaths
virtualpaths
Configuration Editor for API to add, modify, delete, and get virtual paths resource.
Read/write properties
local_site_name <String>
Local Site name. Minimum length = 1
local_site <virtual_path_site[]>
Virtual Path Local Site configuration.
dynamic_virtual_path <dynamic_virtual_path_obj[]>
Dynamic Virtual Path configuration.
remote_site_name <String>
Remote Site name. Minimum length = 1
package_name <String>
Config package name using which the wan_links API operation should be performed.. Minimum length = 1 Maximum length = 141
paths <path_obj[]>
Path Configuration for Virtual Paths.
reverse <Boolean>
It should create reverse virtual Path also.
remote_site <virtual_path_site[]>
Virtual Path Remote Site configuration.
Read only properties
Operations
[add]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/virtualpaths
Description: Use this operation to add virtual paths
HTTP Method: POST
Request Payload: JSON
{"virtualpaths": { "local_site_name":<String_value> , "local_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }] , "dynamic_virtual_path":[{ "maximum_dynamic_virtual_path":<Integer_value> , "enable_dynamic_virtual_path":<Boolean_value> }] , "remote_site_name":<String_value> , "package_name":<String_value> , "paths":[{ "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> , "instability_sensitive":<Boolean_value> , "to_site_name":<String_value> , "enable_encryption":<Boolean_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }] , "reverse":<Boolean_value> , "remote_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }] }}
Response Payload: JSON
{ "virtualpaths":{ "local_site_name":<String_value>
, "local_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }], "dynamic_virtual_path":[{ "maximum_dynamic_virtual_path":<Integer_value> , "enable_dynamic_virtual_path":<Boolean_value> }], "remote_site_name":<String_value> , "package_name":<String_value> , "paths":[{ "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> , "instability_sensitive":<Boolean_value> , "to_site_name":<String_value> , "enable_encryption":<Boolean_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }], "reverse":<Boolean_value> , "remote_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }]}]}
[delete]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/virtualpaths/package_name=<String>,remote_site_name=<String>,local_site_name=<String>
Description: Use this operation to delete a virtual paths
HTTP Method: DELETE
Response Payload: JSON
{ "errorcode": 0, "message": "Done", "severity": <String;_value> }
[get (all)]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/virtualpaths/package_name=<package_name>
Description: Use this operation to get the list of virtual paths
HTTP Method: GET
Response Payload: JSON
{"virtualpaths":[{ "local_site_name":<String_value>
, "local_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }], "dynamic_virtual_path":[{ "maximum_dynamic_virtual_path":<Integer_value> , "enable_dynamic_virtual_path":<Boolean_value> }], "remote_site_name":<String_value> , "package_name":<String_value> , "paths":[{ "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> , "instability_sensitive":<Boolean_value> , "to_site_name":<String_value> , "enable_encryption":<Boolean_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }], "reverse":<Boolean_value> , "remote_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }]}]}
[modify]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/virtualpaths
Description: Use this operation to modify a virtual paths
HTTP Method: PUT
Request Payload: JSON
{"virtualpaths":{ "local_site_name":<String_value> , "local_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }] , "dynamic_virtual_path":[{ "maximum_dynamic_virtual_path":<Integer_value> , "enable_dynamic_virtual_path":<Boolean_value> }] , "remote_site_name":<String_value> , "package_name":<String_value> , "paths":[{ "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> , "instability_sensitive":<Boolean_value> , "to_site_name":<String_value> , "enable_encryption":<Boolean_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }] , "reverse":<Boolean_value> , "remote_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }] }}
Response Payload: JSON
{ "virtualpaths":[{ "local_site_name":<String_value>
, "local_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }], "dynamic_virtual_path":[{ "maximum_dynamic_virtual_path":<Integer_value> , "enable_dynamic_virtual_path":<Boolean_value> }], "remote_site_name":<String_value> , "package_name":<String_value> , "paths":[{ "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> , "instability_sensitive":<Boolean_value> , "to_site_name":<String_value> , "enable_encryption":<Boolean_value> , "silence_period":<Integer_value> , "static_path":<Boolean_value> , "to_wan_link_name":<String_value> , "reverse_also":<Boolean_value> }], "reverse":<Boolean_value> , "remote_site":[{ "route_cost":<Integer_value> , "default_set":<String_value> , "tracking_ip_address":<String_value> }]}]}