Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

cmpparameter

August 17, 2023
Contributed by: 
C

Configuration for CMP parameter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
cmplevel Read-write Specify a compression level. Available settings function as follows
  • Optimal - Corresponds to a gzip GZIP level of 5-7.
  • Best speed - Corresponds to a gzip level of 1.
  • Best compression - Corresponds to a gzip level of 9. Default value: optimal Possible values = optimal, bestspeed, bestcompression
    		•
    quantumsize Read-write Minimum quantum of data to be filled before compression begins.

    Default value: 57344

    Minimum value = 8

    Maximum value = 63488
    servercmp Read-write Allow the server to send compressed data to the Citrix ADC. With the default setting, the Citrix ADC appliance handles all compression.

    Default value: ON

    Possible values = ON, OFF
    heurexpiry Read-write Heuristic basefile expiry.

    Default value: OFF

    Possible values = ON, OFF
    heurexpirythres Read-write Threshold compression ratio for heuristic basefile expiry, multiplied by 100. For example, to set the threshold ratio to 1.25, specify 125.

    Default value: 100

    Minimum value = 1

    Maximum value = 1000
    heurexpiryhistwt Read-write For heuristic basefile expiry, weightage to be given to historical delta compression ratio, specified as percentage. For example, to give 25% weightage to historical ratio (and therefore 75% weightage to the ratio for current delta compression transaction), specify 25.

    Default value: 50

    Minimum value = 1

    Maximum value = 100
    minressize Read-write Smallest response size, in bytes, to be compressed.
    cmpbypasspct Read-write Citrix ADC CPU threshold after which compression is not performed. Range: 0 - 100.

    Default value: 100

    Minimum value = 0

    Maximum value = 100
    cmponpush Read-write Citrix ADC does not wait for the quantum to be filled before starting to compress data. Upon receipt of a packet with a PUSH flag, the appliance immediately begins compression of the accumulated packets.

    Default value: DISABLED

    Possible values = ENABLED, DISABLED
    policytype Read-write Type of policy. Available settings function as follows
  • Classic - Classic policies evaluate basic characteristics of traffic and other data. Deprecated.
  • Advanced - Advanced policies (which have been renamed as default syntax policies) can perform the same type of evaluations as classic policies. They also enable you to analyze more data (for example, the body of an HTTP request) and to configure more operations in the policy rule (for example, transforming data in the body of a request into an HTTP header). Possible values = CLASSIC, ADVANCED
    		•
    addvaryheader Read-write Control insertion of the Vary header in HTTP responses compressed by Citrix ADC. Intermediate caches store different versions of the response for different values of the headers present in the Vary response header.

    Default value: DISABLED

    Possible values = ENABLED, DISABLED
    varyheadervalue Read-write The value of the HTTP Vary header for compressed responses. If this argument is not specified, a default value of “Accept-Encoding” will be used.

    Minimum length = 1
    externalcache Read-write Enable insertion of Cache-Control: private response directive to indicate response message is intended for a single user and must not be cached by a shared or proxy cache.

    Default value: NO

    Possible values = YES, NO
    builtin <String[]> Read-only Flag to determine whether compression is default or not.

    Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
    feature Read-only The feature to be checked while applying this config.

    Operations

    (click to see Properties )

    • UPDATE
    • UNSET
    • GET (ALL)

    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

    update

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

    HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"cmpparameter":{
      "cmplevel":<String_value>,
      "quantumsize":<Double_value>,
      "servercmp":<String_value>,
      "heurexpiry":<String_value>,
      "heurexpirythres":<Double_value>,
      "heurexpiryhistwt":<Double_value>,
      "minressize":<Double_value>,
      "cmpbypasspct":<Double_value>,
      "cmponpush":<String_value>,
      "policytype":<String_value>,
      "addvaryheader":<String_value>,
      "varyheadervalue":<String_value>,
      "externalcache":<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

    unset

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

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"cmpparameter":{
      "policytype":true,
      "cmplevel":true,
      "quantumsize":true,
      "servercmp":true,
      "heurexpiry":true,
      "heurexpirythres":true,
      "heurexpiryhistwt":true,
      "minressize":true,
      "cmpbypasspct":true,
      "cmponpush":true,
      "addvaryheader":true,
      "varyheadervalue":true,
      "externalcache":true
}}

<!--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/cmpparameter

    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: 

    
{ "cmpparameter": [ {
      "cmplevel":<String_value>,
      "quantumsize":<Double_value>,
      "servercmp":<String_value>,
      "heurexpiry":<String_value>,
      "heurexpirythres":<Double_value>,
      "heurexpiryhistwt":<Double_value>,
      "minressize":<Double_value>,
      "cmpbypasspct":<Double_value>,
      "cmponpush":<String_value>,
      "policytype":<String_value>,
      "addvaryheader":<String_value>,
      "varyheadervalue":<String_value>,
      "externalcache":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

<!--NeedCopy-->
    cmpparameter
    August 17, 2023
    Contributed by: 
    C
    August 17, 2023
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.