Product Documentation

tunnel trafficPolicy

Sep 12, 2016

The following operations can be performed on "tunnel trafficPolicy":

add | rm | set | unset | show

add tunnel trafficPolicy

Creates a tunnel traffic policy. A tunnel traffic policy defines the type of compression to be used for the tunneled traffic.

Synopsys

add tunnel trafficPolicy <name> <rule> <action>

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 NetScaler 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. Written in classic or default syntax.

Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: '"<string of 255 characters>" + "<string of 245 characters>"'

The following requirements apply only to the NetScaler 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.

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.

Synopsys

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.

Synopsys

set tunnel trafficPolicy <name> [-rule <expression>] [-action <string>]

Arguments

name

Name of the tunnel traffic policy to modify.

rule

Expression, against which traffic is evaluated. Written in classic or default syntax.

Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: '"<string of 255 characters>" + "<string of 245 characters>"'

The following requirements apply only to the NetScaler 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.

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.

Synopsys

unset tunnel trafficPolicy <name> [-rule] [-action]

show tunnel trafficPolicy

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

Synopsys

show tunnel trafficPolicy [<name>]

Arguments

name

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

Outputs

rule

Expression, against which traffic is evaluated. Written in classic or default syntax.

Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: '"<string of 255 characters>" + "<string of 245 characters>"'

The following requirements apply only to the NetScaler 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.

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.

boundTo

The entity name to which policy is bound

activePolicy

priority

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

stateflag

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