tunnel-trafficPolicy¶
The following operations can be performed on "tunnel-trafficPolicy":
add| rm| set| unset| stat| show| rename|
add tunnel trafficPolicy¶
Creates a tunnel traffic policy. A tunnel traffic policy defines the type of compression to be used for the tunneled traffic.
Synopsis¶
add tunnel trafficPolicy <name> <rule> <action> [-comment <string>] [-logAction <string>]
Arguments¶
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
rm tunnel trafficPolicy¶
Removes a tunnel traffic policy.
Synopsis¶
rm tunnel trafficPolicy <name>
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.
set tunnel trafficPolicy¶
Modifies the specified parameters of an existing tunnel traffic policy.
Synopsis¶
set tunnel trafficPolicy <name> [-rule <expression>] [-action <string>] [-comment <string>] [-logAction <string>]
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
unset tunnel trafficPolicy¶
Use this command to remove tunnel trafficPolicy settings.Refer to the set tunnel trafficPolicy command for meanings of the arguments.
Synopsis¶
unset tunnel trafficPolicy <name> [-comment] [-logAction]
stat tunnel trafficPolicy¶
Displays statistics for all advanced tunnel traffic policies, or for only the specified policy.
Synopsis¶
stat tunnel trafficPolicy [<name>] [-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
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 [<name>] 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.
feature
The feature to be checked while applying this config
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
rename tunnel trafficPolicy¶
Renames a tunnel traffic policy.
Synopsis¶
rename tunnel trafficPolicy <name>@ <newName>@
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