tm-sessionPolicy¶
The following operations can be performed on "tm-sessionPolicy":
add| rm| set| unset| show| stat|
add tm sessionPolicy¶
Creates a traffic management (TM) session policy, which is applied after the user logs on to the AAA virtual server, to customize user sessions.
Synopsis¶
add tm sessionPolicy <name> <rule> <action>
Arguments¶
name
Name for the session policy. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Cannot be changed after a session 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. Both classic and advance expressions are supported in default partition but only advance expressions in non-default partition.
The following requirements apply only to the Citrix ADC CLI: * If the expression includes one or more spaces, enclose the entire expression in double quotation marks. * If the expression itself includes double quotation marks, 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
Action to be applied to connections that match this policy.
rm tm sessionPolicy¶
Removes an existing traffic management (TM) session policy.
Synopsis¶
rm tm sessionPolicy <name>
Arguments¶
name
Name of the session policy to remove.
set tm sessionPolicy¶
Modifies the rule or action of an existing traffic management (TM) session policy.
Synopsis¶
set tm sessionPolicy <name> [-rule <expression>] [-action <string>]
Arguments¶
name
Name of the session policy to modify.
rule
Expression, against which traffic is evaluated. Both classic and advance expressions are supported in default partition but only advance expressions in non-default partition.
The following requirements apply only to the Citrix ADC CLI: * If the expression includes one or more spaces, enclose the entire expression in double quotation marks. * If the expression itself includes double quotation marks, 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
Action to be applied to connections that match this policy.
unset tm sessionPolicy¶
Use this command to remove tm sessionPolicy settings.Refer to the set tm sessionPolicy command for meanings of the arguments.
Synopsis¶
unset tm sessionPolicy <name> [-rule] [-action]
show tm sessionPolicy¶
Displays information about all the configured traffic management (TM) session policies, or displays detailed information about the specified TM session policy.
Synopsis¶
show tm sessionPolicy [<name>]
Arguments¶
name
Name of the session policy for which to display detailed information.
Output¶
stateflag
rule
Expression, against which traffic is evaluated. Both classic and advance expressions are supported in default partition but only advance expressions in non-default partition.
The following requirements apply only to the Citrix ADC CLI: * If the expression includes one or more spaces, enclose the entire expression in double quotation marks. * If the expression itself includes double quotation marks, 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
Action to be applied to connections that match this policy.
boundTo
The entity name to which policy is bound
activePolicy
priority
bindPolicyType
policyType
builtin
Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
feature
The feature to be checked while applying this config
expressionType
Type of policy (Classic/Advanced)
hits
Number of hits.
gotoPriorityExpression
Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
devno
count
stat tm sessionPolicy¶
Displays tm session statistics for all advanced tm session policies, or for only the specified policy.
Synopsis¶
stat tm sessionPolicy [<name>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]
Arguments¶
name
Name of the advanced tmsession policy for which to display statistics. If no name is specified, statistics for all advanced tmsession polices are shown.
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 tmsession policy