Product Documentation

qos_policies

Oct 21, 2015

Traffic shaping policies

Properties

Name Data Type Read-Only? Description
priorityenabled
<Boolean>
Yes

Control switch for enabling/disabling priorities.

Possible values = [true, false]

limitbandwidth
<Boolean>
No

Control switch for enabling/disabling bandwidth limiting.

Possible values = [true, false]

enabled
<Boolean>
No

Enable/disable the link

Possible values = [true, false]

bandwidthlimittype
<String>
No

Bandwidth limit format, if percentage bandwidth limit in percentage, if Absolute bandwidht limit in bps. If limitbandwidth is false, bandwidhtlimittype will display Disabled as its value.

Possible values = [Percentage, Absolute]

maxbandwidthoutpercent
<Integer>
No

Maximum outgoing bandwidth for the QoS policy (in percent)

Minimum value = 0

Maximum value = 100

optimizeforvoice
<Boolean>
No

Enable/disable optimizing for voice.

Possible values = [true, false]

icapriorityenabled
<Boolean>
No

Enable/disable priority based on ICA channels

Possible values = [true, false]

modified
<Boolean>
Yes

Policy has been modified or not

Possible values = [true, false]

maxbandwidthinabsolute
<Integer>
No

Maximum incoming bandwidth for the QoS policy (in bps)

Minimum value = 56000

Maximum value = 1000000000

icadiffservenabled
<Boolean>
No

Enable/disable priority based on ICA differential services

Possible values = [true, false]

diffservenabled
<Boolean>
No

Control switch for policy differetial services.

Possible values = [true, false]

maxbandwidthoutabsolute
<Integer>
No

Maximum outgoing bandwidth for the QoS policy (in bps)

Minimum value = 56000

Maximum value = 1000000000

priority
<Integer>
No

Differential services priority

Minimum value = 1

Maximum value = 256

name
<String>
No

Name of the policy

Minimum length = 1

diffserv
<String>
No

Differential services priority

Valid char set = ^DSCP ([6][0-3]|[1-5][0-9]|[0]\?[1-9])

maxbandwidthinpercent
<Integer>
No

Maximum incoming bandwidth for the QoS policy (in percent)

Minimum value = 0

Maximum value = 100

icadiffservices
<Object>
No
Traffic Shaping DiffServ/TOS for different type of ICA Traffic
icadiffservices.multistreaminteractive
<String>
No

ICA differential services multistream interactive traffic priority

Valid char set = ^DSCP ([6][0-3]|[1-5][0-9]|[0]\?[1-9])

icadiffservices.multistreamrealtime
<String>
No

ICA differential services multistream real-time traffic priority

Valid char set = ^DSCP ([6][0-3]|[1-5][0-9]|[0]\?[1-9])

icadiffservices.multistreambackground
<String>
No

ICA differential services multistream background traffic priority

Valid char set = ^DSCP ([6][0-3]|[1-5][0-9]|[0]\?[1-9])

icadiffservices.singlestreamallpriorities
<String>
No

ICA differential services single traffic priority

Valid char set = ^DSCP ([6][0-3]|[1-5][0-9]|[0]\?[1-9])

icadiffservices.multistreambulktransfer
<String>
No

ICA differential services multistream real-time traffic priority

Valid char set = ^DSCP ([6][0-3]|[1-5][0-9]|[0]\?[1-9])

icapriorities
<Object>
No
ICA priorities for different ICA Tag
icapriorities.interactive
<Integer>
No

ICA interactive traffic priority

Minimum value = 1

Maximum value = 256

icapriorities.realtime
<Integer>
No

ICA real-time traffic priority

Minimum value = 1

Maximum value = 256

icapriorities.bulktransfer
<Integer>
No

ICA bulk transfer traffic priority

Minimum value = 1

Maximum value = 256

icapriorities.background
<Integer>
No

ICA background traffic priority

Minimum value = 1

Maximum value = 256

propertyflags
<String>
Yes

Flag to identify the property of link

policyid
<Integer>
Yes

Policy ID unique for every policy and mapped with name

Operations

Hinweis

Mandatory parameters are marked in red and placeholder content is marked in <green>.

ADD

Use this operation to create a policy

HTTP Method: POST

URL: https://<cb_ip_address>/cb/nitro/v1/config/qos_policies

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.qos_policies+json

Request Payload: JSON

{"qos_policies":{
"limitbandwidth": <boolean_value>,
"enabled": <boolean_value>,
"bandwidthlimittype": <string_value>,
"maxbandwidthoutpercent": <integer_value>,
"optimizeforvoice": <boolean_value>,
"icapriorityenabled": <boolean_value>,
"maxbandwidthinabsolute": <integer_value>,
"icadiffservenabled": <boolean_value>,
"diffservenabled": <boolean_value>,
"maxbandwidthoutabsolute": <integer_value>,
"priority": <integer_value>,
"name": <string_value>,
"diffserv": <string_value>,
"maxbandwidthinpercent": <integer_value>,
"icadiffservices": {
"multistreaminteractive": <string_value>,
"multistreamrealtime": <string_value>,
"multistreambackground": <string_value>,
"singlestreamallpriorities": <string_value>,
"multistreambulktransfer": <string_value>
},
"icapriorities": {
"interactive": <integer_value>,
"realtime": <integer_value>,
"bulktransfer": <integer_value>,
"background": <integer_value>
}
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.qos_policies+json

Response Payload: JSON

{"qos_policies":{
"priorityenabled": <boolean_value>,
"limitbandwidth": <boolean_value>,
"enabled": <boolean_value>,
"bandwidthlimittype": <string_value>,
"maxbandwidthoutpercent": <integer_value>,
"optimizeforvoice": <boolean_value>,
"icapriorityenabled": <boolean_value>,
"modified": <boolean_value>,
"maxbandwidthinabsolute": <integer_value>,
"icadiffservenabled": <boolean_value>,
"diffservenabled": <boolean_value>,
"maxbandwidthoutabsolute": <integer_value>,
"priority": <integer_value>,
"name": <string_value>,
"diffserv": <string_value>,
"maxbandwidthinpercent": <integer_value>,
"icadiffservices": {
"multistreaminteractive": <string_value>,
"multistreamrealtime": <string_value>,
"multistreambackground": <string_value>,
"singlestreamallpriorities": <string_value>,
"multistreambulktransfer": <string_value>
},
"icapriorities": {
"interactive": <integer_value>,
"realtime": <integer_value>,
"bulktransfer": <integer_value>,
"background": <integer_value>
},
"propertyflags": <string_value>,
"policyid": <integer_value>
}}

DELETE

Use this operation to delete a policy by policy name

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/qos_policies/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>

Response Payload: EMPTY

GET (ALL)

Use this operation to get list of traffic shaping policies

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/qos_policies

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.qos_policies_list+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.qos_policies_list+json

Response Payload: JSON

{"qos_policies": [{
"priorityenabled": <boolean_value>,
"limitbandwidth": <boolean_value>,
"enabled": <boolean_value>,
"bandwidthlimittype": <string_value>,
"maxbandwidthoutpercent": <integer_value>,
"optimizeforvoice": <boolean_value>,
"icapriorityenabled": <boolean_value>,
"modified": <boolean_value>,
"maxbandwidthinabsolute": <integer_value>,
"icadiffservenabled": <boolean_value>,
"diffservenabled": <boolean_value>,
"maxbandwidthoutabsolute": <integer_value>,
"priority": <integer_value>,
"name": <string_value>,
"diffserv": <string_value>,
"maxbandwidthinpercent": <integer_value>,
"icadiffservices": {
"multistreaminteractive": <string_value>,
"multistreamrealtime": <string_value>,
"multistreambackground": <string_value>,
"singlestreamallpriorities": <string_value>,
"multistreambulktransfer": <string_value>
"multistreaminteractive": <string_value>,
"multistreamrealtime": <string_value>,
"multistreambackground": <string_value>,
"singlestreamallpriorities": <string_value>,
"multistreambulktransfer": <string_value>
},
"icapriorities": {
"interactive": <integer_value>,
"realtime": <integer_value>,
"bulktransfer": <integer_value>,
"background": <integer_value>
"interactive": <integer_value>,
"realtime": <integer_value>,
"bulktransfer": <integer_value>,
"background": <integer_value>
},
"propertyflags": <string_value>,
"policyid": <integer_value>
}, ...]}

GET

Use this operation to get list of traffic shaping policies

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/qos_policies/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.qos_policies+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.qos_policies+json

Response Payload: JSON

{"qos_policies":{
"priorityenabled": <boolean_value>,
"limitbandwidth": <boolean_value>,
"enabled": <boolean_value>,
"bandwidthlimittype": <string_value>,
"maxbandwidthoutpercent": <integer_value>,
"optimizeforvoice": <boolean_value>,
"icapriorityenabled": <boolean_value>,
"modified": <boolean_value>,
"maxbandwidthinabsolute": <integer_value>,
"icadiffservenabled": <boolean_value>,
"diffservenabled": <boolean_value>,
"maxbandwidthoutabsolute": <integer_value>,
"priority": <integer_value>,
"name": <string_value>,
"diffserv": <string_value>,
"maxbandwidthinpercent": <integer_value>,
"icadiffservices": {
"multistreaminteractive": <string_value>,
"multistreamrealtime": <string_value>,
"multistreambackground": <string_value>,
"singlestreamallpriorities": <string_value>,
"multistreambulktransfer": <string_value>
"multistreaminteractive": <string_value>,
"multistreamrealtime": <string_value>,
"multistreambackground": <string_value>,
"singlestreamallpriorities": <string_value>,
"multistreambulktransfer": <string_value>
},
"icapriorities": {
"interactive": <integer_value>,
"realtime": <integer_value>,
"bulktransfer": <integer_value>,
"background": <integer_value>
"interactive": <integer_value>,
"realtime": <integer_value>,
"bulktransfer": <integer_value>,
"background": <integer_value>
},
"propertyflags": <string_value>,
"policyid": <integer_value>
}}

MODIFY

Use this operation to modify a policy

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/qos_policies/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.qos_policies+json

Request Payload: JSON

{"qos_policies":{
"limitbandwidth": <boolean_value>,
"enabled": <boolean_value>,
"bandwidthlimittype": <string_value>,
"maxbandwidthoutpercent": <integer_value>,
"optimizeforvoice": <boolean_value>,
"icapriorityenabled": <boolean_value>,
"maxbandwidthinabsolute": <integer_value>,
"icadiffservenabled": <boolean_value>,
"diffservenabled": <boolean_value>,
"maxbandwidthoutabsolute": <integer_value>,
"priority": <integer_value>,
"name": <string_value>,
"diffserv": <string_value>,
"maxbandwidthinpercent": <integer_value>,
"icadiffservices": {
"multistreaminteractive": <string_value>,
"multistreamrealtime": <string_value>,
"multistreambackground": <string_value>,
"singlestreamallpriorities": <string_value>,
"multistreambulktransfer": <string_value>
},
"icapriorities": {
"interactive": <integer_value>,
"realtime": <integer_value>,
"bulktransfer": <integer_value>,
"background": <integer_value>
}
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.qos_policies+json

Response Payload: JSON

{"qos_policies":{
"priorityenabled": <boolean_value>,
"limitbandwidth": <boolean_value>,
"enabled": <boolean_value>,
"bandwidthlimittype": <string_value>,
"maxbandwidthoutpercent": <integer_value>,
"optimizeforvoice": <boolean_value>,
"icapriorityenabled": <boolean_value>,
"modified": <boolean_value>,
"maxbandwidthinabsolute": <integer_value>,
"icadiffservenabled": <boolean_value>,
"diffservenabled": <boolean_value>,
"maxbandwidthoutabsolute": <integer_value>,
"priority": <integer_value>,
"name": <string_value>,
"diffserv": <string_value>,
"maxbandwidthinpercent": <integer_value>,
"icadiffservices": {
"multistreaminteractive": <string_value>,
"multistreamrealtime": <string_value>,
"multistreambackground": <string_value>,
"singlestreamallpriorities": <string_value>,
"multistreambulktransfer": <string_value>
},
"icapriorities": {
"interactive": <integer_value>,
"realtime": <integer_value>,
"bulktransfer": <integer_value>,
"background": <integer_value>
},
"propertyflags": <string_value>,
"policyid": <integer_value>
}}