REST API for SCC QoS v2.0

Resource: class

QoS Class

http://{device}/api/cmc.qos/2.0/classes/items/{id}

JSON

{
  "id": integer,
  "qos_profile_id": number,
  "name": string,
  "parent_id": number,
  "is_leaf": boolean,
  "is_default_class": boolean
}

{
  "id": integer,
  "qos_profile_id": number,
  "name": string,
  "parent_id": number,
  "is_leaf": boolean,
  "is_default_class": boolean
}

Property Name	Type	Description	Notes
class	<object>	QoS Class	Required properties: [name, qos_profile_id, parent_id];
id	<integer>	Class ID	Read-only; Minimum 1;
class.qos_profile_id	<number>	Reference to the QoS Profile
name	<string>	Class Name	Pattern: '^(\S.*)?\S$';
class.parent_id	<number>	Reference to the Parent Class ID
class.is_leaf	<boolean>	Is this class a leaf class or inner class?	Read-only; Optional;
class.is_default_class	<boolean>	Is this class the default class in the QoS Profile?	Read-only; Optional;

Links

class: get

Get the data representation of a QoS Class.

GET http://{device}/api/cmc.qos/2.0/classes/items/{id}

Response Body

Returns a class data object.

class: set

Replace the data representation of a QoS Class.

PUT http://{device}/api/cmc.qos/2.0/classes/items/{id}

Request Body

Provide a class data object.

Response Body

Returns a class data object.

class: delete

Delete a QoS Class instance indexed by the ID.

DELETE http://{device}/api/cmc.qos/2.0/classes/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

class: instances

Related resource

classes

class: qos_profile

Related resource

qos_profile

Variables

Related var	Data value for replacement
id	0/qos_profile_id

class: parent

Related resource

class

Variables

Related var	Data value for replacement
id	0/parent_id

Resource: classes

List of QoS Class IDs and names.

http://{device}/api/cmc.qos/2.0/classes{?name,qos_profile_id}

JSON

[
  {
    "id": integer,
    "qos_profile_id": number,
    "name": string,
    "parent_id": number,
    "is_leaf": boolean,
    "is_default_class": boolean
  }
]

[
  {
    "id": integer,
    "qos_profile_id": number,
    "name": string,
    "parent_id": number,
    "is_leaf": boolean,
    "is_default_class": boolean
  }
]

Property Name	Type	Description	Notes
classes	<array of <object>>	List of QoS Class IDs and names.
classes[items]	<object>
id	<integer>	Class ID	Read-only; Minimum 1;
classes[items].qos_profile_id	<number>	Reference to the QoS Profile	Optional;
name	<string>	Class Name	Pattern: '^(\S.*)?\S$';
classes[items].parent_id	<number>	Reference to the Parent Class ID	Optional;
classes[items].is_leaf	<boolean>	Is this class a leaf class or inner class?	Read-only; Optional;
classes[items].is_default_class	<boolean>	Is this class the default class in the QoS Profile?	Read-only; Optional;

Links

classes: set

Delete all the Class instances (except for default root class in default class set).

PUT http://{device}/api/cmc.qos/2.0/classes{?name,qos_profile_id}

Request Body

Provide an empty_collection data object.

Response Body

On success, the server does not provide any body in the responses.

classes: get

GET http://{device}/api/cmc.qos/2.0/classes{?name,qos_profile_id}

Response Body

Returns a classes data object.

classes: create

POST http://{device}/api/cmc.qos/2.0/classes{?name,qos_profile_id}

Request Body

Provide a class data object.

Response Body

Returns a class data object.

Resource: queue_type

QoS Queue

http://{device}/api/cmc.qos/2.0/queue_types/items/{id}

JSON

{
  "id": integer,
  "name": string
}

{
  "id": integer,
  "name": string
}

Property Name	Type	Description	Notes
queue_type	<object>	QoS Queue	Required properties: [name];
id	<integer>	Queue Type ID	Read-only; Minimum 1;
name	<string>	Queue Type Name	Pattern: '^[a-zA-Z0-9_-]+$';

Links

queue_type: get

GET http://{device}/api/cmc.qos/2.0/queue_types/items/{id}

Response Body

Returns a queue_type data object.

Relations

queue_type: instances

Related resource

queue_types

Resource: queue_types

List of QoS Queues

http://{device}/api/cmc.qos/2.0/queue_types{?name}

JSON

[
  {
    "id": integer,
    "name": string
  }
]

[
  {
    "id": integer,
    "name": string
  }
]

Property Name	Type	Description	Notes
queue_types	<array of <object>>	List of QoS Queues
queue_types[items]	<object>
id	<integer>	Queue Type ID	Read-only; Minimum 1;
name	<string>	Queue Type Name	Pattern: '^[a-zA-Z0-9_-]+$';

Links

queue_types: get

GET http://{device}/api/cmc.qos/2.0/queue_types{?name}

Response Body

Returns a queue_types data object.

Resource: qos_profile

QoS Profile

http://{device}/api/cmc.qos/2.0/qos_profiles/items/{id}

JSON

{
  "id": integer,
  "name": string,
  "is_built_in": boolean,
  "classes_tree": {
    "id": integer,
    "name": string,
    "is_default_class": boolean,
    "children": [ classes_tree ]
  }
}

{
  "id": integer,
  "name": string,
  "is_built_in": boolean,
  "classes_tree": {
    "id": integer,
    "name": string,
    "is_default_class": boolean,
    "children": [ classes_tree ]
  }
}

Property Name	Type	Description	Notes
qos_profile	<object>	QoS Profile	Required properties: [name];
id	<integer>	QoS Profile ID	Read-only; Minimum 1;
name	<string>	QoS Profile Name	Pattern: '^(\S.*)?\S$';
qos_profile.is_built_in	<boolean>	This tells if qos-profile is built-in or not.	Read-only; Optional;
classes_tree	<object>		Read-only;
id	<integer>	Class ID	Read-only; Minimum 1;
name	<string>	Class Name	Pattern: '^(\S.*)?\S$';
classes_tree.is_default_class	<boolean>	Is this class the default class in the tree?	Read-only; Optional;
classes_tree.children	<array of <classes_tree>>		Read-only; Optional;
classes_tree.children[items]	<classes_tree>

Links

qos_profile: get

Get the data representation of a QoS Class Set.

GET http://{device}/api/cmc.qos/2.0/qos_profiles/items/{id}

Response Body

Returns a qos_profile data object.

qos_profile: set

Modifies qos_profile. This change will not affect qos_policy.

PUT http://{device}/api/cmc.qos/2.0/qos_profiles/items/{id}

Request Body

Provide a qos_profile data object.

Response Body

Returns a qos_profile data object.

qos_profile: delete

Delete a QoS Class Set instance indexed by the ID.

DELETE http://{device}/api/cmc.qos/2.0/qos_profiles/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

qos_profile: instances

Related resource

qos_profiles

Resource: qos_profiles

List of QoS Profile IDs and names.

http://{device}/api/cmc.qos/2.0/qos_profiles{?all_src_sites,name,dest_site_id,src_site_type_id,src_site_id,dest_site_type_id,all_dest_sites}

JSON

[
  {
    "id": integer,
    "name": string,
    "is_built_in": boolean
  }
]

[
  {
    "id": integer,
    "name": string,
    "is_built_in": boolean
  }
]

Property Name	Type	Description	Notes
qos_profiles	<array of <object>>	List of QoS Profile IDs and names.
qos_profiles[items]	<object>
id	<integer>	QoS Profile ID	Read-only; Minimum 1;
name	<string>	QoS Profile Name	Pattern: '^(\S.*)?\S$';
qos_profiles[items].is_built_in	<boolean>	This tells if a qos-profile built_in or not.	Read-only; Optional;

Links

qos_profiles: get

GET http://{device}/api/cmc.qos/2.0/qos_profiles{?all_src_sites,name,dest_site_id,src_site_type_id,src_site_id,dest_site_type_id,all_dest_sites}

Response Body

Returns a qos_profiles data object.

qos_profiles: set

Delete all the Class Set instances (except for default class set).

PUT http://{device}/api/cmc.qos/2.0/qos_profiles{?all_src_sites,name,dest_site_id,src_site_type_id,src_site_id,dest_site_type_id,all_dest_sites}

Request Body

Provide an empty_collection data object.

Response Body

On success, the server does not provide any body in the responses.

qos_profiles: create

Creates qos_profile. This change will not affect qos_policy.

POST http://{device}/api/cmc.qos/2.0/qos_profiles{?all_src_sites,name,dest_site_id,src_site_type_id,src_site_id,dest_site_type_id,all_dest_sites}

Request Body

Provide a qos_profile data object.

Response Body

Returns a qos_profile data object.

qos_profiles: copy

POST http://{device}/api/cmc.qos/2.0/qos_profiles/copy

Request Body

Provide a request body with the following structure:

JSON

{
  "name": string,
  "qos_profile_id": identifier
}

{
  "name": string,
  "qos_profile_id": identifier
}

Property Name	Type	Description	Notes
qos_profiles.links.copy.request	<object>		Required properties: [name, qos_profile_id];
name	<string>	QoS Profile Name	Pattern: '^(\S.*)?\S$';
qos_profiles.links.copy.request. qos_profile_id	<identifier>	Generic numeric identifier	Read-only;

Response Body

Returns a qos_profile data object.

Resource: uplink_variation

Uplink Variation

http://{device}/api/cmc.qos/2.0/uplink_variations/items/{id}

JSON

{
  "id": integer,
  "name": string,
  "uplink_type_id": multiple,
  "qos_profile_id": number,
  "class_params": [
    {
      "class_id": number,
      "ob_queue_type_id": number,
      "ob_queue_length": number,
      "ib_queue_length": number,
      "min_bw": number,
      "max_bw": number,
      "ls_weight": number,
      "dscp": integer,
      "priority": number,
      "connection_limit": number,
      "ib_flow_padding_enable": boolean,
      "ib_flow_padding_override": boolean,
      "ib_flow_padding_timeout": number,
      "ib_tcp_control_enable": boolean,
      "ib_tcp_control_override": boolean,
      "ib_tcp_control_fssdetect": number,
      "ib_tcp_control_idledetect": number,
      "ib_tcp_control_weight": number
    }
  ]
}

{
  "id": integer,
  "name": string,
  "uplink_type_id": multiple,
  "qos_profile_id": number,
  "class_params": [
    {
      "class_id": number,
      "ob_queue_type_id": number,
      "ob_queue_length": number,
      "ib_queue_length": number,
      "min_bw": number,
      "max_bw": number,
      "ls_weight": number,
      "dscp": integer,
      "priority": number,
      "connection_limit": number,
      "ib_flow_padding_enable": boolean,
      "ib_flow_padding_override": boolean,
      "ib_flow_padding_timeout": number,
      "ib_tcp_control_enable": boolean,
      "ib_tcp_control_override": boolean,
      "ib_tcp_control_fssdetect": number,
      "ib_tcp_control_idledetect": number,
      "ib_tcp_control_weight": number
    }
  ]
}

Property Name	Type	Description	Notes
uplink_variation	<object>	Uplink Variation	Required properties: [name, qos_profile_id, class_params];
id	<integer>	Uplink Variation ID	Read-only; Minimum 1;
name	<string>	Uplink Variation Name	Pattern: '^(\S.*)?\S$';
uplink_variation.uplink_type_id	<multiple>	Reference to the Uplink type	Optional;
uplink_variation.uplink_type_id.anyOf[0]	<identifier>	Generic numeric identifier	Read-only;
uplink_variation.uplink_type_id.anyOf[1]	<all>		Values: All;
uplink_variation.qos_profile_id	<number>	Reference to QoS Profile ID
uplink_variation.class_params	<array of <object>>	List of all QoS Class Parameters associated to this Uplink Variation
uplink_variation.class_params[items]	<object>	QoS Class Parameters	Required properties: [class_id];
uplink_variation.class_params[items]. class_id	<number>	Reference to the QoS Class
uplink_variation.class_params[items]. ob_queue_type_id	<number>	Reference to the Queue Type of an Outbound Class	Optional;
uplink_variation.class_params[items]. ob_queue_length	<number>	Length of the Outbound QoS Queue	Optional;
uplink_variation.class_params[items]. ib_queue_length	<number>	Length of the Inbound QoS Queue	Optional;
min_bw	<number>	Minimum Bandwidth	Range: 0 to 100;
max_bw	<number>	Maximum Bandwidth	Range: 0 to 100;
ls_weight	<number>	HFSC link share weight	Range: 0 to 100;
dscp	<integer>	Default DSCP	Range: 0 to 255;
uplink_variation.class_params[items]. priority	<number>	Latency Priority	Optional; Range: 1 to 6;
uplink_variation.class_params[items]. connection_limit	<number>	Maximum number of connections	Optional;
uplink_variation.class_params[items]. ib_flow_padding_enable	<boolean>	Enable/Disable inbound QoS Flow Padding feature, default is enabled.	Optional;
uplink_variation.class_params[items]. ib_flow_padding_override	<boolean>	Whether or not override the global Inbound QoS Flow Padding configuration.	Optional;
ib_flow_padding_timeout	<number>	Timeout for Deque/Link-Sharing Phantoms as a percentage fraction of average TCP round-trip time.	Range: 0 to 100;
uplink_variation.class_params[items]. ib_tcp_control_enable	<boolean>	Enable/Disable inbound QoS TCP Control feature, default is enabled.	Optional;
uplink_variation.class_params[items]. ib_tcp_control_override	<boolean>	Whether or not override the global Inbound QoS TCP Control configuration.	Optional;
ib_tcp_control_fssdetect	<number>	False slow start detection settings	Range: 0 to 100;
ib_tcp_control_idledetect	<number>	TCP idle restart detection settings	Range: 0 to 100;
ib_tcp_control_weight	<number>	TCP Slow-Start phantom weight as a percentage fraction of the real packet.	Range: 0 to 100;

Links

uplink_variation: get

GET http://{device}/api/cmc.qos/2.0/uplink_variations/items/{id}

Response Body

Returns an uplink_variation data object.

uplink_variation: set

PUT http://{device}/api/cmc.qos/2.0/uplink_variations/items/{id}

Request Body

Provide an uplink_variation data object.

Response Body

Returns an uplink_variation data object.

Relations

uplink_variation: instances

Related resource

uplink_variations

uplink_variation: qos_profile

Related resource

qos_profile

Variables

Related var	Data value for replacement
id	0/qos_profile_id

Resource: uplink_variations

List of Uplink Variations

http://{device}/api/cmc.qos/2.0/uplink_variations{?name,qos_profile_id}

JSON

[
  {
    "id": integer,
    "name": string
  }
]

[
  {
    "id": integer,
    "name": string
  }
]

Property Name	Type	Description	Notes
uplink_variations	<array of <object>>	List of Uplink Variations
uplink_variations[items]	<object>
id	<integer>	Uplink Variation ID	Read-only; Minimum 1;
name	<string>	Uplink Variation Name	Pattern: '^[a-zA-Z0-9_-]+$';

Links

uplink_variations: get

GET http://{device}/api/cmc.qos/2.0/uplink_variations{?name,qos_profile_id}

Response Body

Returns an uplink_variations data object.

uplink_variations: create

POST http://{device}/api/cmc.qos/2.0/uplink_variations{?name,qos_profile_id}

Request Body

Provide an uplink_variation data object.

Response Body

Returns an uplink_variation data object.

Resource: qos_policy

QoS Policy

http://{device}/api/cmc.qos/2.0/qos_policies/items/{id}

JSON

{
  "id": integer,
  "is_built_in": boolean,
  "src_site_id": [
    integer
  ],
  "src_site_type_id": [
    integer
  ],
  "all_src_sites": string,
  "dest_site_id": [
    integer
  ],
  "dest_site_type_id": [
    integer
  ],
  "all_dest_sites": string,
  "qos_profile_id": integer
}

{
  "id": integer,
  "is_built_in": boolean,
  "src_site_id": [
    integer
  ],
  "src_site_type_id": [
    integer
  ],
  "all_src_sites": string,
  "dest_site_id": [
    integer
  ],
  "dest_site_type_id": [
    integer
  ],
  "all_dest_sites": string,
  "qos_profile_id": integer
}

Property Name	Type	Description	Notes
qos_policy	<object>	QoS Policy	Required properties: [qos_profile_id];
id	<integer>	QoS policy id	Read-only; Minimum 1;
qos_policy.is_built_in	<boolean>	This tells if qos-policy is built-in or not	Read-only; Optional;
qos_policy.src_site_id	<array of <integer>>	Source Site ID	Optional;
qos_policy.src_site_id[items]	<integer>
qos_policy.src_site_type_id	<array of <integer>>	Source Site type ID	Optional;
qos_policy.src_site_type_id[items]	<integer>
all_src_sites	<string>	Representation for all the source sites	Values: All;
qos_policy.dest_site_id	<array of <integer>>	Destination Site ID	Optional;
qos_policy.dest_site_id[items]	<integer>
qos_policy.dest_site_type_id	<array of <integer>>	Destination Site type ID	Optional;
qos_policy.dest_site_type_id[items]	<integer>
all_dest_sites	<string>	Representation for all the destination sites	Values: All;
qos_policy.qos_profile_id	<integer>	Reference to QoS Profile ID

Links

qos_policy: get

GET http://{device}/api/cmc.qos/2.0/qos_policies/items/{id}

Response Body

Returns a qos_policy data object.

qos_policy: set

Modifies qos_policy. After modifying qos_policy, it is recommended to change 'name' in qos_profile with new 'src to dest'

PUT http://{device}/api/cmc.qos/2.0/qos_policies/items/{id}

Request Body

Provide a qos_policy data object.

Response Body

Returns a qos_policy data object.

qos_policy: delete

DELETE http://{device}/api/cmc.qos/2.0/qos_policies/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

qos_policy: instances

Related resource

qos_policies

qos_policy: qos_profile

Related resource

qos_profile

Variables

Related var	Data value for replacement
id	0/qos_profile_id

Resource: qos_policies

List of QoS Class Policies

http://{device}/api/cmc.qos/2.0/qos_policies{?all_src_sites,dest_site_id,qos_profile_id,src_site_type_id,src_site_id,dest_site_type_id,all_dest_sites}

JSON

[
  {
    "id": integer,
    "is_built_in": boolean,
    "src_site_id": [
      integer
    ],
    "src_site_type_id": [
      integer
    ],
    "all_src_sites": string,
    "dest_site_id": [
      integer
    ],
    "dest_site_type_id": [
      integer
    ],
    "all_dest_sites": string,
    "qos_profile_id": integer
  }
]

[
  {
    "id": integer,
    "is_built_in": boolean,
    "src_site_id": [
      integer
    ],
    "src_site_type_id": [
      integer
    ],
    "all_src_sites": string,
    "dest_site_id": [
      integer
    ],
    "dest_site_type_id": [
      integer
    ],
    "all_dest_sites": string,
    "qos_profile_id": integer
  }
]

Property Name	Type	Description	Notes
qos_policies	<array of <items>>	List of QoS Class Policies
items	<object>	QoS Policy	Required properties: [qos_profile_id];
id	<integer>	QoS policy id	Read-only; Minimum 1;
items.is_built_in	<boolean>	This tells if qos-policy is built-in or not	Read-only; Optional;
items.src_site_id	<array of <integer>>	Source Site ID	Optional;
items.src_site_id[items]	<integer>
items.src_site_type_id	<array of <integer>>	Source Site type ID	Optional;
items.src_site_type_id[items]	<integer>
all_src_sites	<string>	Representation for all the source sites	Values: All;
items.dest_site_id	<array of <integer>>	Destination Site ID	Optional;
items.dest_site_id[items]	<integer>
items.dest_site_type_id	<array of <integer>>	Destination Site type ID	Optional;
items.dest_site_type_id[items]	<integer>
all_dest_sites	<string>	Representation for all the destination sites	Values: All;
items.qos_profile_id	<integer>	Reference to QoS Profile ID

Links

qos_policies: get

GET http://{device}/api/cmc.qos/2.0/qos_policies{?all_src_sites,dest_site_id,qos_profile_id,src_site_type_id,src_site_id,dest_site_type_id,all_dest_sites}

Response Body

Returns a qos_policies data object.

qos_policies: set

Delete all the QoS policies.

PUT http://{device}/api/cmc.qos/2.0/qos_policies{?all_src_sites,dest_site_id,qos_profile_id,src_site_type_id,src_site_id,dest_site_type_id,all_dest_sites}

Request Body

Provide an empty_collection data object.

Response Body

On success, the server does not provide any body in the responses.

qos_policies: create

Creates new qos_policy. After creating qos_policy, it is recommended to change 'name' in qos_profile with new 'src to dest'.

POST http://{device}/api/cmc.qos/2.0/qos_policies{?all_src_sites,dest_site_id,qos_profile_id,src_site_type_id,src_site_id,dest_site_type_id,all_dest_sites}

Request Body

Provide a qos_policy data object.

Response Body

Returns a qos_policy data object.

Resource: qos_rules

List of QoS Rules

http://{device}/api/cmc.qos/2.0/qos_rules{?site_type_id,site_id,apptag_id,qos_profile_id,app_id}

JSON

[
  {
    "id": identifier,
    "qos_profile_id": integer,
    "app_id": multiple,
    "apptag_id": multiple,
    "dscp": integer,
    "class_id": multiple,
    "is_default": boolean,
    "position": integer
  }
]

[
  {
    "id": identifier,
    "qos_profile_id": integer,
    "app_id": multiple,
    "apptag_id": multiple,
    "dscp": integer,
    "class_id": multiple,
    "is_default": boolean,
    "position": integer
  }
]

Property Name	Type	Description	Notes
qos_rules	<array of <items>>	List of QoS Rules
items	<object>	Quality of Service (QoS) Rule object	Required properties: [qos_profile_id];
items.id	<identifier>	Generic numeric identifier	Read-only;
items.qos_profile_id	<integer>	ID of associated class set
items.app_id	<multiple>	Application ID. Either Application ID or ApplicationTag ID can be specified, not both.	Optional;
items.app_id.anyOf[0]	<integer>
items.app_id.anyOf[1]	<null>
items.apptag_id	<multiple>	ApplicationTag ID. Either Application ID or ApplicationTag ID can be specified, not both.	Optional;
items.apptag_id.anyOf[0]	<integer>
items.apptag_id.anyOf[1]	<null>
dscp	<integer>	DSCP value to be set for QoS marking.	Range: 0 to 255;
items.class_id	<multiple>	Class ID for shaping purposes	Optional;
items.class_id.anyOf[0]	<integer>
items.class_id.anyOf[1]	<null>
items.is_default	<boolean>		Read-only; Optional;
items.position	<integer>		Read-only; Optional;

Links

qos_rules: create

Create a new QoS Rule instance.

POST http://{device}/api/cmc.qos/2.0/qos_rules{?site_type_id,site_id,apptag_id,qos_profile_id,app_id}

Request Body

Provide a qos_rule data object.

Response Body

Returns a qos_rule data object.

qos_rules: get

Get a list of references to QoS Rule instances.

GET http://{device}/api/cmc.qos/2.0/qos_rules{?site_type_id,site_id,apptag_id,qos_profile_id,app_id}

Response Body

Returns a qos_rules data object.

qos_rules: set

Remove all QoS Rules.

PUT http://{device}/api/cmc.qos/2.0/qos_rules

Request Body

Provide an empty_collection data object.

Response Body

On success, the server does not provide any body in the responses.

qos_rules: move

Update the positions of the QoS rules.

PUT http://{device}/api/cmc.qos/2.0/qos_rules/move

Request Body

Provide a request body with the following structure:

JSON

[ identifier ]

[ identifier ]

Property Name	Type	Description	Notes
qos_rules.links.move.request	<array of <identifier>>
qos_rules.links.move.request[items]	<identifier>	Generic numeric identifier	Read-only;

Response Body

Returns a qos_rules data object.

Resource: qos_rule

Quality of Service (QoS) Rule object

http://{device}/api/cmc.qos/2.0/qos_rules/items/{id}

JSON

{
  "id": identifier,
  "qos_profile_id": integer,
  "app_id": multiple,
  "apptag_id": multiple,
  "dscp": integer,
  "class_id": multiple,
  "is_default": boolean,
  "position": integer
}

{
  "id": identifier,
  "qos_profile_id": integer,
  "app_id": multiple,
  "apptag_id": multiple,
  "dscp": integer,
  "class_id": multiple,
  "is_default": boolean,
  "position": integer
}

Property Name	Type	Description	Notes
qos_rule	<object>	Quality of Service (QoS) Rule object	Required properties: [qos_profile_id];
qos_rule.id	<identifier>	Generic numeric identifier	Read-only;
qos_rule.qos_profile_id	<integer>	ID of associated class set
qos_rule.app_id	<multiple>	Application ID. Either Application ID or ApplicationTag ID can be specified, not both.	Optional;
qos_rule.app_id.anyOf[0]	<integer>
qos_rule.app_id.anyOf[1]	<null>
qos_rule.apptag_id	<multiple>	ApplicationTag ID. Either Application ID or ApplicationTag ID can be specified, not both.	Optional;
qos_rule.apptag_id.anyOf[0]	<integer>
qos_rule.apptag_id.anyOf[1]	<null>
dscp	<integer>	DSCP value to be set for QoS marking.	Range: 0 to 255;
qos_rule.class_id	<multiple>	Class ID for shaping purposes	Optional;
qos_rule.class_id.anyOf[0]	<integer>
qos_rule.class_id.anyOf[1]	<null>
qos_rule.is_default	<boolean>		Read-only; Optional;
qos_rule.position	<integer>		Read-only; Optional;

Links

qos_rule: get

Retrieve a data representation of a QoS Rule.

GET http://{device}/api/cmc.qos/2.0/qos_rules/items/{id}

Response Body

Returns a qos_rule data object.

qos_rule: set

Replace the data representation for a QoS Rule

PUT http://{device}/api/cmc.qos/2.0/qos_rules/items/{id}

Request Body

Provide a qos_rule data object.

Response Body

Returns a qos_rule data object.

qos_rule: delete

Delete a QoS Rule instance.

DELETE http://{device}/api/cmc.qos/2.0/qos_rules/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

qos_rule: instances

Related resource

qos_rules

qos_rule: qos_profile

Related resource

qos_profile

Variables

Related var	Data value for replacement
id	0/qos_profile_id

qos_rule: class

Related resource

class

Variables

Related var	Data value for replacement
id	0/class_id

Resource: global_qos_config

Global QoS config

http://{device}/api/cmc.qos/2.0/global_qos_config

JSON

{
  "enable_ob_qos": boolean,
  "enable_ib_qos": boolean,
  "enable_shaping": boolean,
  "enable_dscp_marking": boolean
}

{
  "enable_ob_qos": boolean,
  "enable_ib_qos": boolean,
  "enable_shaping": boolean,
  "enable_dscp_marking": boolean
}

Property Name	Type	Description	Notes
global_qos_config	<object>	Global QoS config	Required properties: [enable_ob_qos, enable_ib_qos, enable_shaping, enable_dscp_marking];
global_qos_config.enable_ob_qos	<boolean>	Enable Outbound QoS
global_qos_config.enable_ib_qos	<boolean>	Enable Inbound QoS
global_qos_config.enable_shaping	<boolean>	Enable Shaping
global_qos_config.enable_dscp_marking	<boolean>	Enable DSCP Marking

Links

global_qos_config: get

Get global QoS configuration.

GET http://{device}/api/cmc.qos/2.0/global_qos_config

Response Body

Returns a global_qos_config data object.

global_qos_config: set

Modify global QoS configuration.

PUT http://{device}/api/cmc.qos/2.0/global_qos_config

Request Body

Provide a global_qos_config data object.

Response Body

Returns a global_qos_config data object.

Resource: site_qos_configs

List of site_qos_configs

http://{device}/api/cmc.qos/2.0/site_qos_configs{?site_type_id,site_id}

JSON

[
  {
    "id": integer,
    "site_id": integer,
    "site_type_id": integer,
    "enable_ob_qos": boolean,
    "enable_ib_qos": boolean,
    "enable_dscp_marking": boolean,
    "interfaces": [
      {
        "name": wan_interface,
        "value": boolean,
        <prop>: any
      }
    ],
    <prop>: any
  }
]

[
  {
    "id": integer,
    "site_id": integer,
    "site_type_id": integer,
    "enable_ob_qos": boolean,
    "enable_ib_qos": boolean,
    "enable_dscp_marking": boolean,
    "interfaces": [
      {
        "name": wan_interface,
        "value": boolean,
        <prop>: any
      }
    ],
    <prop>: any
  }
]

Property Name	Type	Description	Notes
site_qos_configs	<array of <object>>	List of site_qos_configs
site_qos_configs[items]	<object>
id	<integer>	Generic numeric identifier	Read-only; Minimum 1;
site_qos_configs[items].site_id	<integer>	Source Site ID	Optional;
site_qos_configs[items].site_type_id	<integer>	Source Site ID	Optional;
site_qos_configs[items].enable_ob_qos	<boolean>	Enable Outbound QoS	Optional;
site_qos_configs[items].enable_ib_qos	<boolean>	Enable Inbound QoS	Optional;
site_qos_configs[items]. enable_dscp_marking	<boolean>	Enable Shaping	Optional;
site_qos_configs[items].interfaces	<array of <object>>		Optional;
site_qos_configs[items].interfaces [items]	<object>
site_qos_configs[items].interfaces [items].name	<wan_interface>	wan interface	Pattern: '^wan\d_\d';
site_qos_configs[items].interfaces [items].value	<boolean>	Enable/Disable interface	Optional;
site_qos_configs[items].interfaces [items].<prop>	<any>		Optional;
site_qos_configs[items].<prop>	<any>		Optional;

Links

site_qos_configs: create

Create a new site_qos_config instance.

POST http://{device}/api/cmc.qos/2.0/site_qos_configs{?site_type_id,site_id}

Request Body

Provide a site_qos_config data object.

Response Body

Returns a site_qos_config data object.

site_qos_configs: get

Get a list of references to QoS Rule instances.

GET http://{device}/api/cmc.qos/2.0/site_qos_configs{?site_type_id,site_id}

Response Body

Returns a site_qos_configs data object.

Resource: site_qos_config

Site specific qos_config

http://{device}/api/cmc.qos/2.0/site_qos_configs/items/{id}

JSON

{
  "id": integer,
  "site_id": integer,
  "site_type_id": integer,
  "enable_ob_qos": boolean,
  "enable_ib_qos": boolean,
  "enable_dscp_marking": boolean,
  "interfaces": [
    {
      "name": multiple,
      "value": boolean
    }
  ]
}

{
  "id": integer,
  "site_id": integer,
  "site_type_id": integer,
  "enable_ob_qos": boolean,
  "enable_ib_qos": boolean,
  "enable_dscp_marking": boolean,
  "interfaces": [
    {
      "name": multiple,
      "value": boolean
    }
  ]
}

Property Name	Type	Description	Notes
site_qos_config	<object>	Site specific qos_config	Required properties: [enable_ob_qos, enable_ib_qos, enable_dscp_marking];
id	<integer>	Generic numeric identifier	Read-only; Minimum 1;
site_qos_config.site_id	<integer>	Source Site ID	Optional;
site_qos_config.site_type_id	<integer>	Source Site ID	Optional;
site_qos_config.enable_ob_qos	<boolean>	Enable Outbound QoS
site_qos_config.enable_ib_qos	<boolean>	Enable Inbound QoS
site_qos_config.enable_dscp_marking	<boolean>	Enable Shaping
site_qos_config.interfaces	<array of <object>>		Optional;
site_qos_config.interfaces[items]	<object>		Required properties: [name];
site_qos_config.interfaces[items].name	<multiple>	Name of Interface
site_qos_config.interfaces[items].name. oneOf[0]	<primary_interface>	primary interface	Pattern: 'primary';
site_qos_config.interfaces[items].name. oneOf[1]	<wan_interface>	wan interface	Pattern: '^wan\d_\d';
site_qos_config.interfaces[items].value	<boolean>	Enable/Disable interface	Optional;
site_qos_config.oneOf[0]	<object>		Required properties: [site_id];
site_qos_config.oneOf[0].<prop>	<any>		Optional;
site_qos_config.oneOf[1]	<object>		Required properties: [site_type_id];
site_qos_config.oneOf[1].<prop>	<any>		Optional;

Links

site_qos_config: get

Retrieve data representation of site_qos_config.

GET http://{device}/api/cmc.qos/2.0/site_qos_configs/items/{id}

Response Body

Returns a site_qos_config data object.

site_qos_config: set

Replace the data representation for a QoS Rule.

PUT http://{device}/api/cmc.qos/2.0/site_qos_configs/items/{id}

Request Body

Provide a site_qos_config data object.

Response Body

Returns a site_qos_config data object.

site_qos_config: delete

Delete an QoS Rule instance.

DELETE http://{device}/api/cmc.qos/2.0/site_qos_configs/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

site_qos_config: instances

Related resource

site_qos_configs

Resource: qos_policies_conflict

Find QoS Policy conflict

http://{device}/api/cmc.qos/2.0/qos_policies_conflict

JSON

[
  {
    "src_site_id": integer,
    "src_site_type_id": integer,
    "all_src_sites": all,
    "dest_site_id": integer,
    "dest_site_type_id": integer,
    "all_dest_sites": all,
    "qos_profile_id": integer,
    "qos_profile_name": string
  }
]

[
  {
    "src_site_id": integer,
    "src_site_type_id": integer,
    "all_src_sites": all,
    "dest_site_id": integer,
    "dest_site_type_id": integer,
    "all_dest_sites": all,
    "qos_profile_id": integer,
    "qos_profile_name": string
  }
]

Property Name	Type	Description	Notes
qos_policies_conflict	<array of <object>>	Find QoS Policy conflict
qos_policies_conflict[items]	<object>
qos_policies_conflict[items].src_site_id	<integer>		Optional;
qos_policies_conflict[items]. src_site_type_id	<integer>		Optional;
qos_policies_conflict[items]. all_src_sites	<all>		Values: All;
qos_policies_conflict[items]. dest_site_id	<integer>		Optional;
qos_policies_conflict[items]. dest_site_type_id	<integer>		Optional;
qos_policies_conflict[items]. all_dest_sites	<all>		Values: All;
qos_policies_conflict[items]. qos_profile_id	<integer>		Read-only; Optional;
qos_policies_conflict[items]. qos_profile_name	<string>		Read-only; Optional;
qos_policies_conflict[items].allOf[0]	<multiple>
qos_policies_conflict[items].allOf[0]. oneOf[0]	<object>		Required properties: [src_site_id];
qos_policies_conflict[items].allOf[0]. oneOf[0].<prop>	<any>		Optional;
qos_policies_conflict[items].allOf[0]. oneOf[1]	<object>		Required properties: [src_site_type_id];
qos_policies_conflict[items].allOf[0]. oneOf[1].<prop>	<any>		Optional;
qos_policies_conflict[items].allOf[0]. oneOf[2]	<object>		Required properties: [all_src_sites];
qos_policies_conflict[items].allOf[0]. oneOf[2].<prop>	<any>		Optional;
qos_policies_conflict[items].allOf[1]	<multiple>
qos_policies_conflict[items].allOf[1]. oneOf[0]	<object>		Required properties: [dest_site_id];
qos_policies_conflict[items].allOf[1]. oneOf[0].<prop>	<any>		Optional;
qos_policies_conflict[items].allOf[1]. oneOf[1]	<object>		Required properties: [dest_site_type_id];
qos_policies_conflict[items].allOf[1]. oneOf[1].<prop>	<any>		Optional;
qos_policies_conflict[items].allOf[1]. oneOf[2]	<object>		Required properties: [all_dest_sites];
qos_policies_conflict[items].allOf[1]. oneOf[2].<prop>	<any>		Optional;

Links

qos_policies_conflict: find

POST http://{device}/api/cmc.qos/2.0/qos_policies_conflict

Request Body

Provide a qos_policies_conflict data object.

Response Body

Returns a qos_policies_conflict data object.

Resource: appliance_shaper_ids

QoS shaper id and class names for a given appliance

http://{device}/api/cmc.qos/2.0/appliance_shaper_ids/{serial}/{direction}

JSON

{
  "serial": integer,
  "direction": string,
  "data": [
    {
      "shaper_id": integer,
      "class_name": string
    }
  ]
}

{
  "serial": integer,
  "direction": string,
  "data": [
    {
      "shaper_id": integer,
      "class_name": string
    }
  ]
}

Property Name	Type	Description	Notes
appliance_shaper_ids	<object>	QoS shaper id and class names for a given appliance
serial	<integer>	Serial number of the appliance.	Read-only; Minimum 1;
appliance_shaper_ids.direction	<string>		Optional; Values: outbound, inbound;
appliance_shaper_ids.data	<array of <object>>		Optional;
appliance_shaper_ids.data[items]	<object>		Required properties: [shaper_id, class_name];
shaper_id	<integer>	Reference to the Class.	Read-only; Minimum 1;
appliance_shaper_ids.data[items]. class_name	<string>	The class name of the QoS Rule.

Links

appliance_shaper_ids: get

Get a list of QoS class id's and names on an appliance.

GET http://{device}/api/cmc.qos/2.0/appliance_shaper_ids/{serial}/{direction}

Response Body

Returns an appliance_shaper_ids data object.

Type: identifier

Generic numeric identifier

JSON

integer

integer

Property Name	Type	Description	Notes
identifier	<integer>	Generic numeric identifier	Read-only; Minimum 1;

Type: dscp_rule

For extended DSCP fields. Used for the DSCP passed to the data-path. It can assume values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `reflect` or `preserve` the DSCP from innner to outer channel and the other way around.

JSON

integer

integer

Property Name	Type	Description	Notes
dscp_rule	<integer>	For extended DSCP fields. Used for the DSCP passed to the data-path. It can assume values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `reflect` or `preserve` the DSCP from innner to outer channel and the other way around.	Range: 0 to 255;

Type: empty_collection

Empty collection used to partially clear a collection

JSON

multiple

multiple

Property Name	Type	Description	Notes
empty_collection	<multiple>	Empty collection used to partially clear a collection
empty_collection.anyOf[0]	<array of <null>>		Maximum: 0 items;
empty_collection.anyOf[0][items]	<null>
empty_collection.anyOf[1]	<array of <string>>		1-1 items;
empty_collection.anyOf[1][items]	<string>

Type: wan_interface

wan interface

JSON

string

string

Property Name	Type	Description	Notes
wan_interface	<string>	wan interface	Pattern: '^wan\d_\d';

Type: primary_interface

primary interface

JSON

string

string

Property Name	Type	Description	Notes
primary_interface	<string>	primary interface	Pattern: 'primary';

Type: percentage

JSON

number

number

Property Name	Type	Description	Notes
percentage	<number>		Range: 0 to 100;

Type: name

Generic name field. Only alphanumeric '-' and '_' is allowed

JSON

string

string

Property Name	Type	Description	Notes
name	<string>	Generic name field. Only alphanumeric '-' and '_' is allowed	Pattern: '^[a-zA-Z0-9_-]+$';

Type: unrestricted_name

Generic name field, all characters allowed except for leading and trailing whitespace.

JSON

string

string

Property Name	Type	Description	Notes
unrestricted_name	<string>	Generic name field, all characters allowed except for leading and trailing whitespace.	Pattern: '^(\S.*)?\S$';

Type: all

JSON

string

string

Property Name	Type	Description	Notes
all	<string>		Values: All;

Type: classes_tree

JSON

{
  "id": integer,
  "name": string,
  "is_default_class": boolean,
  "children": [ classes_tree ]
}

{
  "id": integer,
  "name": string,
  "is_default_class": boolean,
  "children": [ classes_tree ]
}

Property Name	Type	Description	Notes
classes_tree	<object>
id	<integer>	Class ID	Read-only; Minimum 1;
name	<string>	Class Name	Pattern: '^(\S.*)?\S$';
classes_tree.is_default_class	<boolean>	Is this class the default class in the tree?	Optional;
classes_tree.children	<array of <classes_tree>>		Optional;
classes_tree.children[items]	<classes_tree>