ADC NITRO APIs

cmppolicy

August 17, 2023

Contributed by:

Configuration for compression policy resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
name		Read-write	Name of the HTTP compression policy. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Can be changed after the policy is created. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my cmp policy” or ‘my cmp policy’). Minimum length = 1
rule		Read-write	Expression that determines which HTTP requests or responses match the compression policy. The following requirements apply only to the Citrix ADC CLI If the expression includes one or more spaces, enclose the entire expression in double quotation marks. If the expression itself includes double quotation marks, escape the quotations by using the \ character. Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.
resaction		Read-write	The built-in or user-defined compression action to apply to the response when the policy matches a request or response. Minimum length = 1
newname		Read-write	New name for the compression policy. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Choose a name that reflects the function that the policy performs. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my cmp policy” or ‘my cmp policy’). Minimum length = 1
expressiontype		Read-only	Type of policy (Classic/Advanced) . Possible values = Classic Policy, Advanced Policy
reqaction		Read-only	The compression action to be performed on requests.
hits		Read-only	Number of hits.
txbytes		Read-only	Number of bytes transferred.
rxbytes		Read-only	Number of bytes received.
clientttlb		Read-only	Total client TTLB value.
clienttransactions		Read-only	Number of client transactions.
serverttlb		Read-only	Total server TTLB value.
servertransactions		Read-only	Number of server transactions.
description		Read-only	Description of the policy.
builtin	<String[]>	Read-only	Flag to determine if compression policy is builtin or not. Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature		Read-only	The feature to be checked while applying this config.
isdefault		Read-only	A value of true is returned if it is a default policy.
__count		Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
UPDATE
GET (ALL)
GET
COUNT
RENAME

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:*

Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"cmppolicy":{
<b>      "name":<String_value>,
</b><b>      "rule":<String_value>,
</b><b>      "resaction":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy/ name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"cmppolicy":{
<b>      "name":<String_value>,
</b>      "rule":<String_value>,
      "resaction":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

rename

URL: http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy? action=rename

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"cmppolicy":{
<b>      "name":<String_value>,
</b><b>      "newname":<String_value>
</b>}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of cmppolicy resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy? view=summary

Use this query-parameter to get the summary output of cmppolicy resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy? pagesize=#no;pageno=#no

Use this query-parameter to get the cmppolicy resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "cmppolicy": [ {
      "name":<String_value>,
      "expressiontype":<String_value>,
      "rule":<String_value>,
      "reqaction":<String_value>,
      "resaction":<String_value>,
      "hits":<Double_value>,
      "txbytes":<Double_value>,
      "rxbytes":<Double_value>,
      "clientttlb":<Double_value>,
      "clienttransactions":<Double_value>,
      "serverttlb":<Double_value>,
      "servertransactions":<Double_value>,
      "description":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "isdefault":<Boolean_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of cmppolicy resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "cmppolicy": [ {
      "name":<String_value>,
      "expressiontype":<String_value>,
      "rule":<String_value>,
      "reqaction":<String_value>,
      "resaction":<String_value>,
      "hits":<Double_value>,
      "txbytes":<Double_value>,
      "rxbytes":<Double_value>,
      "clientttlb":<Double_value>,
      "clienttransactions":<Double_value>,
      "serverttlb":<Double_value>,
      "servertransactions":<Double_value>,
      "description":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "isdefault":<Boolean_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/cmppolicy? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "cmppolicy": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

cmppolicy

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

cmppolicy

Properties

Operations

add

delete

update

rename

get (all)

get

count

In this article