Citrix

Produktdokumentation



Ganzes Dokument herunterladen

plugin_acc_rules

Oct. 21, 2015

Configuration of plugin acceleration rules.

Properties

Name Data Type Read-Only? Description
ruletype
<String>
No

Rule type to define if the rule is used to enable acceleration or exclude traffic

Possible values = [accelerate, exclude]

order
<Integer>
No

Order specifies the priority in which the rules are applied. Lower the order, higher the priority. If order is not provided in ADD or the order is bigger than order of the lowest rule, order is automatically truncated to be that of one more than the existing maximum.

Minimum value = 1

destsubnet
<String>
No

IP subnet for which the rule is defined. (IPv4/IPv6 string).

Bitmask = Optional (format IP[/bitmask])

portrange
<String>
No

Comma seprated port ranges for which the rule is defined.Eg. 3000,4000-5000,6000. For all ports use: all/All

Operations

Note:

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

ADD

Use this operation to add plugin acceleration rule

HTTP Method: POST

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

Request Headers:

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

Request Payload: JSON

{"plugin_acc_rules":{
"ruletype": <string_value>,
"order": <integer_value>,
"destsubnet": <string_value>,
"portrange": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"plugin_acc_rules":{
"ruletype": <string_value>,
"order": <integer_value>,
"destsubnet": <string_value>,
"portrange": <string_value>
}}

DELETE

Use this operation to remove plugin acceleration rule

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/plugin_acc_rules/ruletype=<STRING>,destsubnet=<IPADDRESS>

Request Headers:

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

Response Payload: EMPTY

GET (ALL)

Use this operation to get plugin acceleration rules

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"plugin_acc_rules": [{
"ruletype": <string_value>,
"order": <integer_value>,
"destsubnet": <string_value>,
"portrange": <string_value>
}, ...]}

GET

Use this operation to get plugin acceleration rules

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/plugin_acc_rules/ruletype=<STRING>,destsubnet=<IPADDRESS>

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"plugin_acc_rules":{
"ruletype": <string_value>,
"order": <integer_value>,
"destsubnet": <string_value>,
"portrange": <string_value>
}}

MODIFY

Use this operation to modify plugin acceleration rule

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/plugin_acc_rules/<ruletype>

Request Headers:

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

Request Payload: JSON

{"plugin_acc_rules":{
"ruletype": <string_value>,
"order": <integer_value>,
"destsubnet": <string_value>,
"portrange": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"plugin_acc_rules":{
"ruletype": <string_value>,
"order": <integer_value>,
"destsubnet": <string_value>,
"portrange": <string_value>
}}
Back to Top