Skip to content

bot-policylabel

The following operations can be performed on "bot-policylabel":

add| show| bind| stat| unbind| rm| rename|

add bot policylabel

Creates a user-defined bot policy label, to which you can bind policies. A policy label is a tool for evaluating a set of policies in a specified order. By using a policy label, you can configure the responder feature to choose the next policy, invoke a different policy label, or terminate policy evaluation completely by looking at whether the previous policy evaluated to TRUE or FALSE.

Synopsis

add bot policylabel [-comment ]

Arguments

labelName Name for the bot policy label. 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. Cannot be changed after the responder policy label 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 responder policy label" or my responder policy label').

comment Any comments to preserve information about this bot policy label.

Example

add bot policylabel bot_lab

show bot policylabel

Displays the current settings for the specified bot policy label. If no policy label is specified, displays a list of all bot policy labels currently configured on the Citrix ADC, with abbreviated settings.

Synopsis

show bot policylabel []

Arguments

labelName Name of the bot policy label.

Output

stateflag numpol number of polices bound to label.

hits Number of times policy label was invoked.

policyName Name of the bot policy.

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.

invoke If the current policy evaluates to TRUE, terminate evaluation of policies bound to the current policy label and evaluate the specified policy label.

labelType Type of policy label to invoke. Available settings function as follows: * vserver - Invoke an unnamed policy label associated with a virtual server. * policylabel - Invoke a user-defined policy label.

labelName * If labelType is policylabel, name of the policy label to invoke. * If labelType is vserver, name of the virtual server.

flags policylabeltype Type of transformations allowed by the policies bound to the label.

comment Any comments to preserve information about this bot policy label.

devno count

Example

i)show bot policylabel bot_lab ii)show bot policylabel

bind bot policylabel

Binds the specified bot policy to the specified policy label.

Synopsis

bind bot policylabel -policyName -priority [-gotoPriorityExpression ] [-invoke (-labelType ( vserver | policylabel ) -labelName ) ]

Arguments

labelName Name of the bot policy label to which to bind the policy.

policyName Name of the policy to bind to the bot policy label.

priority Positive integer specifying the priority of the policy. A lower number specifies a higher priority. Must be unique within the label. Policies are evaluated in the order of their priority numbers, and the first policy that matches the request is applied. Minimum value: 1 Maximum value: 2147483647

gotoPriorityExpression Expression or other value specifying the next policy to evaluate if the current policy evaluates to TRUE. Specify one of the following values: * NEXT - Evaluate the policy with the next higher priority number. * END - End policy evaluation. * USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT. * An expression that evaluates to a number. If you specify an expression, the number to which it evaluates determines the next policy to evaluate, as follows: * If the expression evaluates to a higher numbered priority, the policy with that priority is evaluated next. * If the expression evaluates to the priority of the current policy, the policy with the next higher numbered priority is evaluated next. * If the expression evaluates to a number that is larger than the largest numbered priority, policy evaluation ends.

An UNDEF event is triggered if: * The expression is invalid. * The expression evaluates to a priority number that is smaller than the current policys priority number. * The expression evaluates to a priority number that is between the current policy's priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.

invoke If the current policy evaluates to TRUE, terminate evaluation of policies bound to the current policy label and evaluate the specified policy label.

labelType Type of policy label to invoke. Available settings function as follows: * vserver - Invoke an unnamed policy label associated with a virtual server. * policylabel - Invoke a user-defined policy label.

Possible values: vserver, policylabel

labelName * If labelType is policylabel, name of the policy label to invoke. * If labelType is vserver, name of the virtual server.

Example

i)bind bot policylabel resp_lab pol_resp 1 2 ii)bind bot policylabel resp_lab pol_resp 1 2 -invoke vserver CURRENT

stat bot policylabel

Displays statistics for the specified bot policy label. If no policy label name is provided, displays abbreviated statistics for all bot policy labels currently configured on the Citrix ADC.

Synopsis

stat bot policylabel [] [-detail] [-fullValues] [-ntimes ] [-logFile ] [-clearstats ( basic | full )]

Arguments

labelName Name of the bot policy label.

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 Label Hits (Hits) Number of times policy label was invoked.

unbind bot policylabel

Unbinds the specified bot policy from the specified policy label.

Synopsis

unbind bot policylabel -policyName [-priority ]

Arguments

labelName Name for the bot policy label. 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. Cannot be changed after the responder policy label 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 responder policy label" or my responder policy label').

policyName The name of the policy to be unbound.

priority Priority of the NOPOLICY to be unbound. Minimum value: 1 Maximum value: 2147483647

Example

unbind bot policylabel bot_lab pol_bot

rm bot policylabel

Removes a bot policy label.

Synopsis

rm bot policylabel

Arguments

labelName Name of the bot policy label to remove.

Example

rm bot policylabel bot_lab

rename bot policylabel

Renames the specified bot policy label.

Synopsis

rename bot policylabel @ @

Arguments

labelName Current name of the bot policy label.

newName New name for the bot policy label. 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.

Example

rename bot policylabel oldname newname

Was this article helpful?