dynamic_virtual_path_provisioning¶
Overview¶
API to get and modify the provisioning parameters of an individual dynamic virtual path enabled on a particular wan link.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- dynamic_virtual_path_provisioning : Operations related to dynamic_virtual_path_provisioning
Paths¶
Get operation for dynamic_virtual_path_provisioning¶
GET /dynamic_virtual_path_provisioning
Description¶
Use this operation to get the provisioning parameters of an individual dynamic virtual path enabled on a particular wan link.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | dynamic_virtual_path_provisioning_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_provisioning
PUT operation for dynamic_virtual_path_provisioning¶
PUT /dynamic_virtual_path_provisioning
Description¶
Use this operation to modify the the provisioning parameters of an individual dynamic virtual path enabled on a particular wan link.
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
dynamic_virtual_path_provisioning_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | dynamic_virtual_path_provisioning_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¶
- dynamic_virtual_path_provisioning
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
dynamic_virtual_path_provisioning¶
| Name | Schema |
|---|---|
| id optional |
id |
| lan_to_wan_maximum_allowed_bitrate optional |
lan_to_wan_maximum_allowed_bitrate |
| lan_to_wan_minimum_reserved_bitrate optional |
lan_to_wan_minimum_reserved_bitrate |
| package_name optional |
package_name |
| site_name optional |
site_name |
| wan_to_lan_maximum_allowed_bitrate optional |
wan_to_lan_maximum_allowed_bitrate |
| wan_to_lan_minimum_reserved_bitrate optional |
wan_to_lan_minimum_reserved_bitrate |
dynamic_virtual_path_provisioning_delete_success_schema¶
| Name | Schema |
|---|---|
| dynamic_virtual_path_provisioning optional |
dynamic_virtual_path_provisioning |
dynamic_virtual_path_provisioning
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
dynamic_virtual_path_provisioning_post_success_schema¶
| Name | Schema |
|---|---|
| dynamic_virtual_path_provisioning optional |
dynamic_virtual_path_provisioning |
dynamic_virtual_path_provisioning
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
dynamic_virtual_path_provisioning_put_success_schema¶
| Name | Schema |
|---|---|
| dynamic_virtual_path_provisioning optional |
dynamic_virtual_path_provisioning |
dynamic_virtual_path_provisioning
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
dynamic_virtual_path_provisioning_request_schema¶
| Name | Schema |
|---|---|
| dynamic_virtual_path_provisioning optional |
dynamic_virtual_path_provisioning |
dynamic_virtual_path_provisioning_response_schema¶
Type : < dynamic_virtual_path_provisioning_response_schema > array
dynamic_virtual_path_provisioning_response_schema
| Name | Schema |
|---|---|
| id optional |
id |
| lan_to_wan_fair_bitrate optional |
lan_to_wan_fair_bitrate |
| lan_to_wan_maximum_allowed_bitrate optional |
lan_to_wan_maximum_allowed_bitrate |
| lan_to_wan_maximum_allowed_bitrate_for_all optional |
lan_to_wan_maximum_allowed_bitrate_for_all |
| lan_to_wan_minimum_reserved_bitrate optional |
lan_to_wan_minimum_reserved_bitrate |
| lan_to_wan_minimum_reserved_bitrate_for_all optional |
lan_to_wan_minimum_reserved_bitrate_for_all |
| package_name optional |
package_name |
| possible_dynamic_virtual_paths optional |
possible_dynamic_virtual_paths |
| site_name optional |
site_name |
| wan_link_name optional |
wan_link_name |
| wan_to_lan_fair_bitrate optional |
wan_to_lan_fair_bitrate |
| wan_to_lan_maximum_allowed_bitrate optional |
wan_to_lan_maximum_allowed_bitrate |
| wan_to_lan_maximum_allowed_bitrate_for_all optional |
wan_to_lan_maximum_allowed_bitrate_for_all |
| wan_to_lan_minimum_reserved_bitrate optional |
wan_to_lan_minimum_reserved_bitrate |
| wan_to_lan_minimum_reserved_bitrate_for_all optional |
wan_to_lan_minimum_reserved_bitrate_for_all |
id¶
Auto-generated ID to uniquely identify the service provisioning.
Type : integer
lan_to_wan_fair_bitrate¶
The fair bit rate for an individual dynamic virtual path in LAN to WAN direction, based on its shares of group set in the service provisioning. Includes the Min rate, and will not exceed the Max rate.
Type : integer
lan_to_wan_maximum_allowed_bitrate¶
The maximum bandwidth an individual dynamic virtual path is allowed to utilize in LAN to WAN direction. (A value of 0 implies no limit.)
Type : integer
lan_to_wan_maximum_allowed_bitrate_for_all¶
The total maximum bandwidth for all dynamic virtual paths in LAN to WAN direction (Max rate multiplied by possible dynamic virtual paths).
Type : integer
lan_to_wan_minimum_reserved_bitrate¶
The minimum bandwidth for an individual dynamic visrtual path in LAN to WAN direction.
Type : integer
lan_to_wan_minimum_reserved_bitrate_for_all¶
The total minimum bandwidth for all dynamic virtual paths in LAN to WAN direction (Min rate multiplied by possible dynamic virtual paths).
Type : integer
package_name¶
Config package name using which the site API operation should be performed.
Type : string
possible_dynamic_virtual_paths¶
The number of dynamic conduits that could exist simultaneously, based on the current configuration.
Type : string
site_name¶
Site Name
Type : string
wan_link_name¶
The WAN Link name
Type : string
wan_to_lan_fair_bitrate¶
The fair bit rate for an individual dynamic virtual path in WAN to LAN direction, based on its shares of group set in the service provisioning. Includes the Min rate, and will not exceed the Max rate.
Type : integer
wan_to_lan_maximum_allowed_bitrate¶
The maximum bandwidth an individual dynamic virtual path is allowed to utilize in WAN to LAN direction. (A value of 0 implies no limit.)
Type : integer
wan_to_lan_maximum_allowed_bitrate_for_all¶
The total maximum bandwidth for all dynamic virtual paths in WAN to LAN direction (Max rate multiplied by possible dynamic virtual paths).
Type : integer
wan_to_lan_minimum_reserved_bitrate¶
The minimum bandwidth for an individual dynamic visrtual path in WAN to LAN direction.
Type : integer
wan_to_lan_minimum_reserved_bitrate_for_all¶
The total minimum bandwidth for all dynamic virtual paths in WAN to LAN direction (Min rate multiplied by possible dynamic virtual paths).
Type : integer