Skip to content

dynamic_virtual_path_default_set

Overview

API to add, modify, get, delete Dynamic Virtual Path Default Set

Version information

Version : v2

URI scheme

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

Tags

  • dynamic_virtual_path_default_set : Operations related to dynamic_virtual_path_default_set

Paths

POST operation for dynamic_virtual_path_default_set

POST /dynamic_virtual_path_default_set

Description

Use this operation to add Dynamic Virtual Path Default Set

Parameters

Type Name Schema
Body body
optional
dynamic_virtual_path_default_set_request_schema

Responses

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

Consumes

  • application/json

Produces

  • application/json

Tags

  • dynamic_virtual_path_default_set

Get operation for dynamic_virtual_path_default_set

GET /dynamic_virtual_path_default_set

Description

Use this operation to get the list of Dynamic Virtual Path Default Sets

Responses

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

  • dynamic_virtual_path_default_set

PUT operation for dynamic_virtual_path_default_set

PUT /dynamic_virtual_path_default_set

Description

Use this operation to modify Dynamic Virtual Path Default Set

Responses

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

Produces

  • application/json

Tags

  • dynamic_virtual_path_default_set

DELETE operation for dynamic_virtual_path_default_set

DELETE /dynamic_virtual_path_default_set/{deletePathParam}

Description

Use this operation to delete Dynamic Virtual Path Default Set

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added dynamic_virtual_path_default_set_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

  • dynamic_virtual_path_default_set

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

dynamic_virtual_path_default_set

Name Schema
dynamic_virtual_path_default_set_properties
optional
dynamic_virtual_path_default_set_properties
id
optional
id
name
optional
name
package_name
optional
package_name

dynamic_virtual_path_default_set_delete_success_schema

Name Schema
dynamic_virtual_path_default_set
optional
dynamic_virtual_path_default_set

dynamic_virtual_path_default_set

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

dynamic_virtual_path_default_set_post_success_schema

Name Schema
dynamic_virtual_path_default_set
optional
dynamic_virtual_path_default_set

dynamic_virtual_path_default_set

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

dynamic_virtual_path_default_set_properties

Dynamic Virtual Path Default Set properties

Name Description Schema
creation_sample_time
optional
The amount of time, in seconds, over which packet counts and bandwidth will be measured to determine if a Dynamic Virtual Path needs to be created between two sites integer
creation_throughput_kbps
optional
The threshold, in kbps, of total throughput between two sites, measured over the Sample Time, at which Dynamic Virtual Path will be triggered integer
creation_throughput_pps
optional
The threshold, in pps, of total throughput between two sites, measured over the Sample Time, at which Dynamic Virtual Path will be triggered integer
recreate_virtual_path_hold_time
optional
The time, in minutes, after which a Dynamic Virtual Path removed for being DEAD can be recreated string
removal_sample_time
optional
The amount of time, in minutes, over which packet counts and bandwidth will be measured to determine if a Dynamic Virtual Path needs to be removed between two sites integer
removal_throughput_kbps
optional
The threshold, in kbps, of total throughput between two sites, measured over the Sample Time, at which Dynamic Virtual Path will be removed integer
removal_throughput_pps
optional
The threshold, in pps, of total throughput between two sites, measured over the Sample Time, at which Dynamic Virtual Path will be removed integer
remove_virtual_path_down_wait_time
optional
The time, in minutes, after which a DEAD Dynamic Virtual Path will be removed integer
route_cost
optional
This Cost will be added to Routes learned via the Dynamic Virtual Path and can be any value from 0 to 65535 integer

dynamic_virtual_path_default_set_put_success_schema

Name Schema
dynamic_virtual_path_default_set
optional
dynamic_virtual_path_default_set

dynamic_virtual_path_default_set

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

dynamic_virtual_path_default_set_request_schema

Name Schema
dynamic_virtual_path_default_set
optional
dynamic_virtual_path_default_set

dynamic_virtual_path_default_set_response_schema

Type : < dynamic_virtual_path_default_set_response_schema > array

dynamic_virtual_path_default_set_response_schema

Name Schema
dynamic_virtual_path_default_set_properties
optional
dynamic_virtual_path_default_set_properties
id
optional
id
name
optional
name
package_name
optional
package_name

id

Auto-generated ID to uniquely identify Dynamic Virtual Path Default Set

Type : integer

name

The name for this Dynamic Virtual Path Default Set

Type : string

package_name

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

Type : string