Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

cmp-action

June 28, 2023
Contributed by: 
C

The following operations can be performed on “cmp-action”:

rm unset set rename add show

rm cmp action

Removes the specified compression action.

Synopsis

rm cmp action

Arguments

name Name of the action to be removed.

Example

rm cmp action cmp_action_name

unset cmp action

Use this command to remove cmp action settings.Refer to the set cmp action command for meanings of the arguments.

Synopsis

unset cmp action -addVaryHeader

set cmp action

Modifies the specified parameters of a compression action.

Synopsis

set cmp action [-cmpType ] [-addVaryHeader -varyHeaderValue ]

Arguments

name Name of the compression action. 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 action is added.

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 action” or ‘my cmp action’).

cmpType Type of compression performed by this action. Available settings function as follows:

  • COMPRESS - Apply GZIP or DEFLATE compression to the response, depending on the request header. Prefer GZIP.
  • GZIP - Apply GZIP compression.
  • DEFLATE - Apply DEFLATE compression.
  • NOCOMPRESS - Do not compress the response if the request matches a policy that uses this action.

Possible values: compress, gzip, deflate, nocompress

addVaryHeader 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.

Possible values: GLOBAL, DISABLED, ENABLED Default value: GLOBAL

varyHeaderValue The value of the HTTP Vary header for compressed responses.

Example

set cmp action cmpact1 -addVaryHeader ENABLED -varyHeaderValue User-Agent

rename cmp action

Renames a compression action.

Synopsis

rename cmp action @ @

Arguments

name Existing name of the action.

newName New name for the compression action. 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 can be correlated with the function that the action 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 action” or ‘my cmp action’).

Example

rename cmp policy oldname newname

add cmp action

Creates a compression action. Note: User-defined compression actions supplement the built-in compression actions. The built-in compression actions, NOCOMPRESS, COMPRESS, GZIP, and DEFLATE, are always available. Available settings functions as follows:

  • NOCOMPRESS - Disables compression for data that matches the associated policy.
  • COMPRESS - Enable GZIP or DEFLATE compression, depending on which is supported by the browser.
  • GZIP - Enable GZIP compression. For browsers that do not support GZIP, compression is disabled.
  • DEFLATE - Enable DEFLATE compression for a specific policy. For browsers that do not support DEFLATE, compression is disabled.

Synopsis

add cmp action [-addVaryHeader -varyHeaderValue ]

Arguments

name Name of the compression action. 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 action is added.

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 action” or ‘my cmp action’).

cmpType Type of compression performed by this action. Available settings function as follows:

  • COMPRESS - Apply GZIP or DEFLATE compression to the response, depending on the request header. Prefer GZIP.
  • GZIP - Apply GZIP compression.
  • DEFLATE - Apply DEFLATE compression.
  • NOCOMPRESS - Do not compress the response if the request matches a policy that uses this action.

Possible values: compress, gzip, deflate, nocompress

addVaryHeader 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.

Possible values: GLOBAL, DISABLED, ENABLED Default value: GLOBAL

varyHeaderValue The value of the HTTP Vary header for compressed responses.

Example

add cmp action nocmp NOCOMPRESS

show cmp action

Displays information about all the built-in and user-defined compression actions, or detailed information about the specified action.

Synopsis

show cmp action []

Arguments

name Name of the action for which to display detailed information.

Output

cmpType Type of compression performed by this action. Available settings function as follows:

  • COMPRESS - Apply GZIP or DEFLATE compression to the response, depending on the request header. Prefer GZIP.
  • GZIP - Apply GZIP compression.
  • DEFLATE - Apply DEFLATE compression.
  • NOCOMPRESS - Do not compress the response if the request matches a policy that uses this action.

deltaType The type of delta action if compression type is delta compression.

addVaryHeader 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.

varyHeaderValue The value of the HTTP Vary header for compressed responses.

stateflag flags builtin Flag to determine whether compression is default or not

isDefault A value of true is returned if it is a default policy

devno count

Example

Example 1

The following example shows output from the show cmp action command when no custom cmp actions have been defined:

show cmp action 3 Compression actions: 1) Name: GZIP Compression Type: gzip 2) Name: NOCOMPRESS Compression Type: nocompress 3) Name: DEFLATE Compression Type: deflate 4) Name: COMPRESS Compression Type: compress Done

Done Example 2 The following command creates a compression action: add cmp action nocmp NOCOMPRESS The following example shows output from the show cmp action command after the previous command has been issued:

show cmp action 3 Compression actions: 1) Name: GZIP Compression Type: gzip 2) Name: NOCOMPRESS Compression Type: nocompress 3) Name: DEFLATE Compression Type: deflate 4) Name: COMPRESS Compression Type: compress

    1 Compression action: 1)      Name: nocmp     Compression Type: nocompress  Done
cmp-action
June 28, 2023
Contributed by: 
C
June 28, 2023
Contributed by: 
C

In this article

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