Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

cmp-global

August 18, 2023
Contributed by: 
C

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

bind unbind show

bind cmp global

Binds (activates) the compression policy globally. Note that the compression feature requires a compression license. When you enable the compression feature, all of the built-in compression policies are bound globally.

Synopsis

bind cmp global [-priority ] [-gotoPriorityExpression ] [-type ] [-invoke ( ) ]

Arguments

policyName Name of the policy to bind globally.

priority Positive integer specifying the priority of the policy. The lower the number, the higher the priority. By default, polices within a label are evaluated in the order of their priority numbers. In the configuration utility, you can click the Priority field and edit the priority level or drag the entry to a new position in the list. If you drag the entry to a new position, the priority level is updated automatically. Minimum value: 1 Maximum value: 2147483647

gotoPriorityExpression Expression or other value specifying the priority of the next policy, within the policy label, to evaluate if the current policy evaluates to TRUE. Specify one of the following values:

  • NEXT - Evaluate the policy with the next higher numbered priority.
  • END - Stop evaluation.
  • USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT.
  • An expression that evaluates to a number. If you specify an expression, it’s evaluation result determines the next policy to evaluate, as follows:
  • If the expression evaluates to a higher numbered priority, that policy is evaluated next.
  • If the expression evaluates to the priority of the current policy, the policy with the next higher priority number is evaluated next.
  • If the expression evaluates to a priority number that is numerically higher than the highest priority number, policy evaluation ends. An UNDEF event is triggered if:
  • The expression is invalid.
  • The expression evaluates to a priority number that is numerically lower than the current policy’s priority.
  • The expression evaluates to a priority number that is between the current policy’s priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.

type Global bind point, specifying where to bind the policy.

Possible values: REQ_OVERRIDE, REQ_DEFAULT, RES_OVERRIDE, RES_DEFAULT, HTTPQUIC_REQ_OVERRIDE, HTTPQUIC_REQ_DEFAULT, HTTPQUIC_RES_OVERRIDE, HTTPQUIC_RES_DEFAULT, NONE Default value: NONE

invoke Invoke policies bound to a virtual server or a policy label. After the invoked policies are evaluated, the flow returns to the policy with the next priority.

labelType Type of policy label invocation.

Possible values: reqvserver, resvserver, policylabel

labelName Name of the label to invoke if the current policy rule evaluates to TRUE.

Example

add cmp policy pdf_cmp -rule “HTTP.RES.HEADER("Content-Type").CONTAINS("application/pdf")” -resAction COMPRESS

After creating the above compression policy, you must activate it by binding it globally: bind cmp global pdf_cmp -priority 100

After binding pdf_cmp compression policy globally, the policy gets activated and the Citrix ADC system will perform compression for the pdf files

unbind cmp global

Deactivates a globally bound HTTP compression policy.

Synopsis

unbind cmp global [-type [-priority ]]

Arguments

policyName Name of the compression policy to unbind.

type Bind point, specifying from where to unbind the policy.

Possible values: REQ_OVERRIDE, REQ_DEFAULT, RES_OVERRIDE, RES_DEFAULT, HTTPQUIC_REQ_OVERRIDE, HTTPQUIC_REQ_DEFAULT, HTTPQUIC_RES_OVERRIDE, HTTPQUIC_RES_DEFAULT, NONE

priority Integer specifying the priority of the policy. The lower the number, the higher the priority. By default, polices within a label are evaluated in the order of their priority numbers. Note that in the configuration utility, you can click the Priority field and edit the priority level or drag the entry to a new position in the list. If you drag the entry to a new position, the priority level is updated automatically. Minimum value: 1 Maximum value: 2147483647

Example

unbind cmp global pdf_cmp

show cmp global

Displays the globally bound HTTP compression policies.

Synopsis

show cmp global [-type ]

Arguments

type Bind point to which the policy is bound.

Possible values: REQ_OVERRIDE, REQ_DEFAULT, RES_OVERRIDE, RES_DEFAULT, HTTPQUIC_REQ_OVERRIDE, HTTPQUIC_REQ_DEFAULT, HTTPQUIC_RES_OVERRIDE, HTTPQUIC_RES_DEFAULT, NONE

Output

stateflag policyName The name of the globally bound HTTP compression policy.

priority Positive integer specifying the priority of the policy. The lower the number, the higher the priority. By default, polices within a label are evaluated in the order of their priority numbers. In the configuration utility, you can click the Priority field and edit the priority level or drag the entry to a new position in the list. If you drag the entry to a new position, the priority level is updated automatically.

numpol The number of policies bound to the bindpoint.

gotoPriorityExpression Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE

invoke Invoke flag.

labelType Type of policy label invocation.

labelName Name of the label to invoke if the current policy rule evaluates to TRUE.

globalBindType devno count

Example

show cmp global Global bindpoint: RES_DEFAULT Number of bound policies: 5 Done

cmp-global
August 18, 2023
Contributed by: 
C
August 18, 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.