Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

bot-global

May 28, 2024
Contributed by: 
C

The following operations can be performed on “bot-global”:

bind unbind show

bind bot global

Activates the specified bot policy for all requests sent to the Citrix ADC.

Synopsis

bind bot global -policyName -priority <positive\_integer> \[-gotoPriorityExpression ] \[-type \( REQ\_OVERRIDE | REQ\_DEFAULT )] \[-invoke \(-labelType \( vserver | policylabel ) -labelName ) ]

Arguments

policyName Name of the bot policy to activate. If you want to create the policy as well as activate it, specify a 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’).

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 policy’s 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.

type Bind point to which to bind the policy. Available settings function as follows:

  • REQ_OVERRIDE - Request override. Binds the policy to the priority request queue.
  • REQ_DEFAULT - Binds the policy to the default request queue.

Possible values: REQ_OVERRIDE, REQ_DEFAULT

invoke If the current policy evaluates to TRUE, terminate evaluation of policies bound to the current policy label, and then forward the request to the specified virtual server.

labelType Type of invocation, Available settings function as follows:

  • vserver - Forward the request to the specified virtual server.
  • policylabel - Invoke the specified policy label.

Possible values: vserver, policylabel

labelName Name of the policy label to invoke. If the current policy evaluates to TRUE, the invoke parameter is set, and Label Type is policylabel.

Example

i)bind bot global -policyName pol9 -priority 9

unbind bot global

Unbind the specified bot policy from bot global.

Synopsis

unbind bot global -policyName \[-type \( REQ\_OVERRIDE | REQ\_DEFAULT )] \[-priority <positive\_integer>]

Arguments

policyName Name of the policy to unbind.

type The bindpoint from which the policy is to be unbound.

Possible values: REQ_OVERRIDE, REQ_DEFAULT

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

Example

unbind bot global -policyName pol9

show bot global

Displays the list of policies bound to the specified bot global bind point. If no bind point is specified, displays a list of all policies bound to bot global.

Synopsis

show bot global [-type ( REQ_OVERRIDE REQ_DEFAULT )]

Arguments

type Specifies the bind point whose policies you want to display. Available settings function as follows:

  • REQ_OVERRIDE - Request override. Binds the policy to the priority request queue.
  • REQ_DEFAULT - Binds the policy to the default request queue.

Possible values: REQ_OVERRIDE, REQ_DEFAULT

Output

stateflag 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 then forward the request to the specified virtual server.

labelType Type of invocation, Available settings function as follows:

  • vserver - Forward the request to the specified virtual server.
  • policylabel - Invoke the specified policy label.

labelName Name of the policy label to invoke. If the current policy evaluates to TRUE, the invoke parameter is set, and Label Type is policylabel.

flowType flowtype of the bound bot policy.

numpol number of polices bound to label.

flags globalBindType devno count

Example

show bot global

bot-global
May 28, 2024
Contributed by: 
C
May 28, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.