provisioning_groups¶

Overview¶

API to get, modify, add and delete Provisioning Groups. A Provisioning Group is a container for an arbitrary collection of Services on any given WAN Link. They allow the user to allocate bandwidth at a high-level before drilling down to the individual Services within the Group for fine-tuning. They also provide a boundary for the automatic redistribution of bandwidth within the child Services of the Provisioning Group.

Version information¶

Version : v2

URI scheme¶

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

Tags¶

provisioning_groups : Operations related to provisioning_groups

Paths¶

POST operation for provisioning_groups¶

POST /provisioning_groups

Description¶

Use this operation to add a new provisioning group for a particular wan link.

Responses¶

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

Produces¶

application/json

Tags¶

provisioning_groups

Get operation for provisioning_groups¶

GET /provisioning_groups

Description¶

Use this operation to get the provisioning groups for each of the wan links.

Responses¶

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

provisioning_groups

PUT operation for provisioning_groups¶

PUT /provisioning_groups

Description¶

Use this operation to modify the fair shares of the provisioning group or rename the group.

Parameters¶

Type	Name	Schema
Body	body optional	provisioning_groups_request_schema

Responses¶

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

provisioning_groups

DELETE operation for provisioning_groups¶

DELETE /provisioning_groups/{deletePathParam}

Description¶

Use this operation to delete a provisioning group. The 'Default' group may not be deleted.

Parameters¶

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

Responses¶

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

provisioning_groups

Definitions¶

ErrorSchema¶

Name	Schema
errorcode optional	integer
errormessage optional	string

id¶

Auto-generated ID to uniquely identify the provisioning group.

Type : integer

lan_to_wan_fair_bitrate¶

The fair bit rate available to Services assigned to the Group, based on its Fair Shares out of all Groups (LAN to WAN direction). Includes the Min rate.

Type : integer

lan_to_wan_minimum_bitrate¶

The sum of the Min rates of all Services assigned to the Group in LAN to WAN direction.

Type : integer

lan_to_wan_rate_fair_share¶

The number of Fair Shares the Group should take out of the 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 name of the Group. The 'Default' group may not be renamed.

Type : string