service_provisioning¶
Overview¶
API to get the services enabled on the wan links by the current configuration and modify the corresponding bandwidth allocation settings.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- service_provisioning : Operations related to service_provisioning
Paths¶
Get operation for service_provisioning¶
GET /service_provisioning
Description¶
Use this operation to get the service provisioning details for each of the services enabled on the wan links.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | service_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¶
- service_provisioning
PUT operation for service_provisioning¶
PUT /service_provisioning
Description¶
Use this operation to modify the service provisioning settings for each of the services enabled on the wan links.
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
service_provisioning_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | service_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¶
- service_provisioning
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
id¶
Auto-generated ID to uniquely identify the service provisioning.
Type : integer
lan_to_wan_fair_bitrate¶
The fair bit rate of the Service, based on its shares out of all Services in the Group (LAN to WAN direction). Includes the Min rate, and will not exceed the Max rate.
Type : integer
lan_to_wan_maximum_allowed_bitrate¶
The maximum bandwidth the Service is allowed to utilize in LAN to WAN direction. (A value of 0 implies no limit.)
Type : integer
lan_to_wan_minimum_reserved_bitrate¶
The minimum bandwidth reserved exclusively for the Service in LAN to WAN direction.
Type : integer
lan_to_wan_rate_fair_share¶
The number of fair shares the Service should take out of its Group's eligible bandwidth in LAN to WAN direction.
Type : integer
package_name¶
Config package name using which the site API operation should be performed.
Type : string
provisioning_group_name¶
The provisioning group assigned to the service.
Type : string
service_name¶
The name of the Service.
Type : string
service_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 |
| lan_to_wan_rate_fair_share optional |
lan_to_wan_rate_fair_share |
| package_name optional |
package_name |
| provisioning_group_name optional |
provisioning_group_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 |
| wan_to_lan_rate_fair_share optional |
wan_to_lan_rate_fair_share |
service_provisioning_delete_success_schema¶
| Name | Schema |
|---|---|
| service_provisioning optional |
service_provisioning |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
service_provisioning_post_success_schema¶
| Name | Schema |
|---|---|
| service_provisioning optional |
service_provisioning |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
service_provisioning_put_success_schema¶
| Name | Schema |
|---|---|
| service_provisioning optional |
service_provisioning |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
service_provisioning_request_schema¶
| Name | Schema |
|---|---|
| service_provisioning optional |
service_provisioning |
service_provisioning_response_schema¶
Type : < service_provisioning_response_schema > array
service_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_minimum_reserved_bitrate optional |
lan_to_wan_minimum_reserved_bitrate |
| lan_to_wan_rate_fair_share optional |
lan_to_wan_rate_fair_share |
| package_name optional |
package_name |
| provisioning_group_name optional |
provisioning_group_name |
| service_name optional |
service_name |
| 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_minimum_reserved_bitrate optional |
wan_to_lan_minimum_reserved_bitrate |
| wan_to_lan_rate_fair_share optional |
wan_to_lan_rate_fair_share |
site_name¶
Site Name
Type : string
wan_link_name¶
The WAN Link name
Type : string
wan_to_lan_fair_bitrate¶
The fair bit rate of the Service, based on its shares out of all Services in the Group (WAN to LAN direction). Includes the Min rate, and will not exceed the Max rate.
Type : integer
wan_to_lan_maximum_allowed_bitrate¶
The maximum bandwidth the Service is allowed to utilize in WAN to LAN direction. (A value of 0 implies no limit.)
Type : integer
wan_to_lan_minimum_reserved_bitrate¶
The minimum bandwidth reserved exclusively for the Service in WAN to LAN direction.
Type : integer
wan_to_lan_rate_fair_share¶
The number of fair shares the Service should take out of its Group's eligible bandwidth in WAN to LAN direction.
Type : integer