bot-policy¶
The following operations can be performed on "bot-policy":
add| rm| set| unset| show| rename| stat|
add bot policy¶
Creates a bot policy.
Synopsis¶
add bot policy <name> -rule <expression> -profileName <string> [-undefAction <string>] [-comment <string>] [-logAction <string>]
Arguments¶
name
Name for the bot policy. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Can be changed after the bot policy is added.
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 bot policy" or 'my bot policy').
rule
Expression that the policy uses to determine whether to apply bot profile on the specified request.
profileName
Name of the bot profile to apply if the request matches this bot policy.
undefAction
Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition.
comment
Any type of information about this bot policy.
logAction
Name of the messagelog action to use for requests that match this policy.
Example¶
i) add bot policy pol9 -rule "HTTP.REQ.HEADER(\"header\").CONTAINS(\"qh3\")" -profileName bot_prof
rm bot policy¶
Removes the specified bot policy.
Synopsis¶
rm bot policy <name>
Arguments¶
name
Name of the bot policy to remove.
Example¶
rm bot policy pol9
set bot policy¶
Modifies the rule or action portion of the specified bot policy.
Synopsis¶
set bot policy <name> [-rule <expression>] [-profileName <string>] [-undefAction <string>] [-comment <string>] [-logAction <string>]
Arguments¶
name
Name of the bot policy.
rule
Expression that the policy uses to determine whether to apply bot profile on the specified request.
profileName
Name of the bot profile to apply if the request matches this bot policy.
undefAction
Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition.
comment
Any type of information about this bot policy.
logAction
Name of the messagelog action to use for requests that match this policy.
Example¶
set bot policy pol9 -rule "HTTP.REQ.HEADER(\"header\").CONTAINS(\"qh2\")"
unset bot policy¶
Removes the settings of an existing bot policy. Attributes for which a default value is available revert to their default values..Refer to the set bot policy command for meanings of the arguments.
Synopsis¶
unset bot policy <name> [-undefAction] [-comment] [-logAction]
Example¶
unset bot policy botpol9 -undefAction
show bot policy¶
Displays the current settings for the specified bot policy. If no policy name is specified, displays a list of all bot policies currently configured on the Citrix ADC, with abbreviated settings.
Synopsis¶
show bot policy [<name>] show bot policy stats - alias for 'stat bot policy'
Arguments¶
name
Name of the bot policy for which to display settings.
Output¶
stateflag
rule
Expression that the policy uses to determine whether to apply bot profile on the specified request.
profileName
Name of the bot profile to apply if the request matches this bot policy.
undefAction
Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition.
hits
Number of hits.
undefHits
Number of policy UNDEF hits.
activePolicy
Indicates whether policy is bound or not.
boundTo
Location where policy is bound
priority
Specifies the priority of the policy.
gotoPriorityExpression
Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
labelType
Type of policy label invocation.
labelName
Name of the label to invoke if the current policy rule evaluates to TRUE.
comment
Any type of information about this bot policy.
logAction
Name of the messagelog action to use for requests that match this policy.
bindPolicyType
vserverType
builtin
Flag to determine if bot policy is built-in or not
feature
The feature to be checked while applying this config
type
devno
count
Example¶
show bot policy
rename bot policy¶
Renames the specified bot policy.
Synopsis¶
rename bot policy <name>@ <newName>@
Arguments¶
name
Existing name of the bot policy.
newName
New name for the bot policy. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.
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 bot policy" or 'my bot policy').
Example¶
rename bot policy oldname newname
stat bot policy¶
Displays statistics for all bot policies currently configured on the Citrix ADC, or detailed statistics for the specified policy.
Synopsis¶
stat bot policy [<name>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]
Arguments¶
name
Name of the bot policy for which to show detailed statistics.
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