tm-trafficPolicy¶
The following operations can be performed on "tm-trafficPolicy":
add| rm| set| unset| show| stat|
add tm trafficPolicy¶
Adds a traffic policy to use for setting connection timeout, single sign-on, and initiating logout. The policy sets the characteristics of application traffic at run time.
Synopsis¶
add tm trafficPolicy <name> <rule> <action>
Arguments¶
name
Name for the 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
Name of the Citrix ADC named expression, or an expression, that the policy uses to determine whether to apply certain action on the current traffic.
action
Name of the action to apply to requests or connections that match this policy.
rm tm trafficPolicy¶
Removes an existing traffic policy.
Synopsis¶
rm tm trafficPolicy <name>
Arguments¶
name
Name of the traffic policy to remove.
set tm trafficPolicy¶
Modifies the specified parameters of an existing traffic policy.
Synopsis¶
set tm trafficPolicy <name> [-rule <expression>] [-action <string>]
Arguments¶
name
Name of the traffic policy to modify.
rule
Name of the Citrix ADC named expression, or an expression, that the policy uses to determine whether to apply certain action on the current traffic.
action
Name of the action to apply to requests or connections that match this policy.
unset tm trafficPolicy¶
Use this command to remove tm trafficPolicy settings.Refer to the set tm trafficPolicy command for meanings of the arguments.
Synopsis¶
unset tm trafficPolicy <name> [-rule] [-action]
show tm trafficPolicy¶
Displays information about all configured traffic management (TM) traffic policies, or displays detailed information about the specified TM traffic policy.
Synopsis¶
show tm trafficPolicy [<name>]
Arguments¶
name
Name of the traffic policy for which to display detailed information.
Output¶
rule
The rule used by the vpn traffic policy. Rules are combinations of Expressions. Expressions are simple conditions, such as a test for equality, applied to operands, such as a URL string or an IP address. Expression syntax is described in the Installation and Configuration Guide
action
The action to be performed when the rule is matched.
boundTo
The entity name to which policy is bound
activePolicy
priority
hits
Number of hits.
bindPolicyType
vserverType
stateflag
devno
count
stat tm trafficPolicy¶
Display Traffic Management traffic policy statistics.
Synopsis¶
stat tm trafficPolicy [<name>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]
Arguments¶
name
The name of the TM traffic policy for which statistics will be displayed. If not given statistics are shown for all policies.
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
Example¶
stat tm trafficpolicy.