name Name for the tunnel traffic policy. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot 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 policy” or ‘my policy)’.

rule Expression, against which traffic is evaluated. The following requirements apply only to the Citrix ADC CLI:

If the expression includes blank spaces, the entire expression must be enclosed in double quotation marks.
If the expression itself includes double quotation marks, you must 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.

action Name of the built-in compression action to associate with the policy.

comment Any comments to preserve information about this policy.

logAction Name of the messagelog action to use for requests that match this policy.

Example

Example 1: add tunnel trafficpolicy cmp_all_destport “REQ.TCP.DESTPORT == 0-65535” GZIP

After creating above tunnel policy, it can be activated by binding it globally: bind tunnel global cmp_all_destport

The policy is evaluated for all traffic flowing through the ssl-vpn tunnel, and compresses traffic for all TCP application ports.

Example 2: The following tunnel policy disables compression for all access from a specific subnet: add tunnel trafficpolicy local_sub_nocmp “SOURCEIP == 10.1.1.0 -netmask 255.255.255.0” NOCOMPRESS bind tunnel global local_sub_nocmp

stat tunnel trafficPolicy

Displays statistics for all advanced tunnel traffic policies, or for only the specified policy.

Synopsis

stat tunnel trafficPolicy [] \[-detail] \[-fullValues] \[-ntimes <positive\_integer>] \[-logFile <input\_filename>] \[-clearstats \( basic | full )]

Arguments

name Name of the advanced tunnel traffic policy.

detail Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.

fullValues Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated

ntimes The number of times, in intervals of seven seconds, the statistics should be displayed. Default value: 1 Minimum value: 0

logFile The name of the log file to be used as input.

clearstats Clear the statsistics / counters

Possible values: basic, full

Output

count devno stateflag

Counters

Policy hits (Hits) Number of hits on the policy

Policy undef hits (Undefhits) Number of undef hits on the policy

Example

stat tunnel trafficpolicy

set tunnel trafficPolicy

Modifies the specified parameters of an existing tunnel traffic policy.

Synopsis

set tunnel trafficPolicy [-rule ] [-action ] [-comment ] [-logAction ]

Arguments

name Name of the tunnel traffic policy to modify.

rule Expression, against which traffic is evaluated. The following requirements apply only to the Citrix ADC CLI:

If the expression includes blank spaces, the entire expression must be enclosed in double quotation marks.
If the expression itself includes double quotation marks, you must 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.

action Name of the built-in compression action to associate with the policy.

comment Any comments to preserve information about this policy.

logAction Name of the messagelog action to use for requests that match this policy.

Example

add tunnel trafficpolicy cmp_all_destport “REQ.TCP.DESTPORT == 0-65535” GZIP set tunnel trafficpolicy cmp_all_destport -action NOCOMPRESS

Above ‘set’ command changes action for policy cmp_all_destport from GZIP to NOCOMPRESS

show tunnel trafficPolicy

Displays information about all the configured tunnel traffic policies, or displays detailed information about the specified tunnel traffic policy.

Synopsis

show tunnel trafficPolicy [] show tunnel trafficPolicy stats - alias for 'stat tunnel trafficPolicy'

Arguments

name Name of the tunnel traffic policy for which to show detailed information.

Output

stateflag expressionType Type of policy (Classic/Advanced)

rule Expression, against which traffic is evaluated. The following requirements apply only to the Citrix ADC CLI:

If the expression includes blank spaces, the entire expression must be enclosed in double quotation marks.
If the expression itself includes double quotation marks, you must 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.

action Name of the built-in compression action to associate with the policy.

hits No of hits.

undefHits Number of policy UNDEF hits.

txbytes Number of bytes transmitted.

rxbytes Number of bytes received.

clientTTLB Total client TTLB value.

clientTransactions Number of client transactions.

serverTTLB Total server TTLB value.

serverTransactions Number of server transactions.

piHits Number of hits.

piTxBytes Number of bytes transmitted.

piRxBytes Number of bytes received.

piCltTTLB Total client TTLB value.

piCltTransactions Number of client transactions.

piSvrTTLB Total server TTLB value.

piSvrTransactions Number of server transactions.

comment Any comments to preserve information about this policy.

logAction Name of the messagelog action to use for requests that match this policy.

boundTo The entity name to which policy is bound

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

flags bindPolicyType isDefault A value of true is returned if it is a default tunnelpolicy.

policyType builtin Indicates that a variable is a built-in (SYSTEM INTERNAL) type.

devno count

Example

show tunnel trafficpolicy 2 Tunnel policies: 1) Name: local_sub_nocmp Rule: SOURCEIP == 10.1.1.0 -netmask 255.255.255.0 Action: NOCOMPRESS Hits: 3

2) Name: cmp_all Rule: REQ.TCP.DESTPORT == 0-65535 Action: GZIP Hits: 57125 Bytes In:…796160 Bytes Out:… 197730 Bandwidth saving…75.16% Ratio 4.03:1 Done

rm tunnel trafficPolicy

Removes a tunnel traffic policy.

Synopsis

rm tunnel trafficPolicy

Arguments

name Name of the tunnel traffic policy to remove.

Example

rm tunnel trafficpolicy tunnel_policy_name The “show tunnel trafficpolicy” command shows all tunnel policies that are currently defined.

rename tunnel trafficPolicy

Renames a tunnel traffic policy.

Synopsis

rename tunnel trafficPolicy @ @

Arguments

name Existing name of the policy.

newName New name for the tunnel traffic policy. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), e quals (=), 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 tunnel policy” or ‘my tunnel policy’).

Example

rename tunnel trafficPolicy oldname newname

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

tunnel-trafficPolicy

June 28, 2023

Contributed by:

June 28, 2023

Contributed by:

tunnel-trafficPolicy

unset tunnel trafficPolicy

Synopsis

add tunnel trafficPolicy

Synopsis

Arguments

Example

stat tunnel trafficPolicy

Synopsis

Arguments

Output

Counters

Example

set tunnel trafficPolicy

Synopsis

Arguments

Example

show tunnel trafficPolicy

Synopsis

Arguments

Output

Example

rm tunnel trafficPolicy

Synopsis

Arguments

Example

rename tunnel trafficPolicy

Synopsis

Arguments

Example

In this article