config_editor_classes

config_editor_classes

Configuration Editor for API to add, modify, delete, and get configuration for Classes resource.

Read/write properties

initial_share_percent <Integer>

The maximum share of Virtual Path bandwidth during the Initial Period, as a percentage.

name <String>

The class name.

package_name <String>

Package name.

virtual_path_name <String>

Virtual Path for corresponding class.

initial_period <Integer>

Duration to apply the Initial Rate before switching to the Sustained Rate, in milliseconds.

id <Integer>

Class ID.

type <String>

Class traffic type. Possible values = [realtime,interactive,bulk]

sustained_share_percent <Integer>

The maximum share of Virtual Path bandwidth after the Initial Period, as a percentage.

site_name <String>

Site name for corresponding class.

initial_rate <Integer>

The maximum rate during the Initial Period, as a percentage or in kbps.

sustained_rate <Integer>

The maximum rate after the Initial Period, as a percent share of the Virtual Path or in kbps.

Read only properties

Operations

get (all) modify

[get (all)]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/config_editor_classes/package_name=<package_name>

Description: Use this operation to get the Classes settings

HTTP Method: GET

Response Payload: JSON

{"config_editor_classes":[{ "initial_share_percent":<Integer_value>

, "name":<String_value> , "package_name":<String_value> , "virtual_path_name":<String_value> , "initial_period":<Integer_value> , "id":<Integer_value> , "type":<String_value> , "sustained_share_percent":<Integer_value> , "site_name":<String_value> , "initial_rate":<Integer_value> , "sustained_rate":<Integer_value> }]}

[modify]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/config_editor_classes

Description: Use this operation to modify the Classes settings

HTTP Method: PUT

Request Payload: JSON

{"config_editor_classes":{ "initial_share_percent":<Integer_value> , "name":<String_value> , "package_name":<String_value> , "virtual_path_name":<String_value> , "initial_period":<Integer_value> , "id":<Integer_value> , "type":<String_value> , "sustained_share_percent":<Integer_value> , "site_name":<String_value> , "initial_rate":<Integer_value> , "sustained_rate":<Integer_value> }}

Response Payload: JSON

{ "config_editor_classes":[{ "initial_share_percent":<Integer_value>

, "name":<String_value> , "package_name":<String_value> , "virtual_path_name":<String_value> , "initial_period":<Integer_value> , "id":<Integer_value> , "type":<String_value> , "sustained_share_percent":<Integer_value> , "site_name":<String_value> , "initial_rate":<Integer_value> , "sustained_rate":<Integer_value> }]}

Was this article helpful?