Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

lb-global

August 18, 2023
Contributed by: 
C

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

show unbind bind

show lb global

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

Synopsis

show lb global [-type ]

Arguments

type

Output

stateflag policyName Name of the LB policy.

priority Specifies the priority of the policy.

flowType flowtype of the bound LB policy.

numpol number of polices bound to label.

flags 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 or evaluate the specified policy label.

labelType Type of invocation, Available settings function as follows:

  • vserver - Invokes the unnamed policy label associated with the specified virtual server.
  • policylabel - Invoke the specified policy label.

labelName Name of the virtual server or user-defined policy label to invoke if the policy evaluates to TRUE.

globalBindType devno count

Example

show lb global

unbind lb global

Unbind the specified LB policy from LB global.

Synopsis

unbind lb global -policyName [-type ]

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, OTHERTCP_REQ_OVERRIDE, OTHERTCP_REQ_DEFAULT, SIPUDP_REQ_OVERRIDE, SIPUDP_REQ_DEFAULT, SIPTCP_REQ_OVERRIDE, SIPTCP_REQ_DEFAULT, MSSQL_REQ_OVERRIDE, MSSQL_REQ_DEFAULT, MYSQL_REQ_OVERRIDE, MYSQL_REQ_DEFAULT, ORACLE_REQ_OVERRIDE, ORACLE_REQ_DEFAULT, NAT_REQ_OVERRIDE, NAT_REQ_DEFAULT, DIAMETER_REQ_OVERRIDE, DIAMETER_REQ_DEFAULT, RADIUS_REQ_OVERRIDE, RADIUS_REQ_DEFAULT, DNS_REQ_OVERRIDE, DNS_REQ_DEFAULT, MQTT_REQ_OVERRIDE, MQTT_REQ_DEFAULT, QUIC_OVERRIDE, QUIC_DEFAULT, HTTPQUIC_REQ_OVERRIDE, HTTPQUIC_REQ_DEFAULT, GSLB_REQ_OVERRIDE, GSLB_REQ_DEFAULT

Example

unbind lb global pol9

bind lb global

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

Synopsis

bind lb global -policyName -priority [-type ] [-gotoPriorityExpression ] [-invoke ( ) ]

Arguments

policyName Name of the LB policy to activate. 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 lb policy” or ‘my lb 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

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

  • REQ_OVERRIDE - Request override. Binds the policy to the override queue.
  • REQ_DEFAULT - Binds the policy to the default queue.
  • OTHERTCP_REQ_OVERRIDE - Binds the policy to the non-HTTP TCP override queue.
  • OTHERTCP_REQ_DEFAULT - Binds the policy to the non-HTTP TCP default queue.
  • SIPUDP_REQ_OVERRIDE - Binds the policy to the SIP UDP override queue.
  • SIPUDP_REQ_DEFAULT - Binds the policy to the SIP UDP default queue.
  • RADIUS_REQ_OVERRIDE - Binds the policy to the RADIUS override queue.
  • RADIUS_REQ_DEFAULT - Binds the policy to the RADIUS default queue.
  • MSSQL_REQ_OVERRIDE - Binds the policy to the Microsoft SQL override queue.
  • MSSQL_REQ_DEFAULT - Binds the policy to the Microsoft SQL default queue.
  • MYSQL_REQ_OVERRIDE - Binds the policy to the MySQL override queue.
  • MYSQL_REQ_DEFAULT - Binds the policy to the MySQL default queue.
  • ORACLE_REQ_OVERRIDE - Binds the policy to the Oracle override queue.
  • ORACLE_REQ_DEFAULT - Binds the policy to the Oracle default queue.
  • NAT_REQ_OVERRIDE - Binds the policy to the NAT override queue.
  • NAT_REQ_DEFAULT - Binds the policy to the NAT default queue.
  • DIAMETER_REQ_OVERRIDE - Binds the policy to the Diameter override queue.
  • DIAMETER_REQ_DEFAULT - Binds the policy to the Diameter default queue.
  • MQTT_REQ_OVERRIDE - Binds the policy to the MQTT override queue.
  • MQTT_REQ_DEFAULT - Binds the policy to the MQTT default queue.
  • QUIC_OVERRIDE - Binds the policy to the QUIC override queue.
  • QUIC_DEFAULT - Binds the policy to the QUIC default queue.
  • HTTPQUIC_REQ_OVERRIDE - Binds the policy to the HTTP_QUIC override queue.
  • HTTPQUIC_REQ_DEFAULT - Binds the policy to the HTTP_QUIC default queue.
  • GSLB_REQ_OVERRIDE- Binds the policy to the GSLB override queue.
  • GSLB_REQ_DEFAULT - Binds the policy to the GSLB default queue.

Possible values: REQ_OVERRIDE, REQ_DEFAULT, OTHERTCP_REQ_OVERRIDE, OTHERTCP_REQ_DEFAULT, SIPUDP_REQ_OVERRIDE, SIPUDP_REQ_DEFAULT, SIPTCP_REQ_OVERRIDE, SIPTCP_REQ_DEFAULT, MSSQL_REQ_OVERRIDE, MSSQL_REQ_DEFAULT, MYSQL_REQ_OVERRIDE, MYSQL_REQ_DEFAULT, ORACLE_REQ_OVERRIDE, ORACLE_REQ_DEFAULT, NAT_REQ_OVERRIDE, NAT_REQ_DEFAULT, DIAMETER_REQ_OVERRIDE, DIAMETER_REQ_DEFAULT, RADIUS_REQ_OVERRIDE, RADIUS_REQ_DEFAULT, DNS_REQ_OVERRIDE, DNS_REQ_DEFAULT, MQTT_REQ_OVERRIDE, MQTT_REQ_DEFAULT, QUIC_OVERRIDE, QUIC_DEFAULT, HTTPQUIC_REQ_OVERRIDE, HTTPQUIC_REQ_DEFAULT, GSLB_REQ_OVERRIDE, GSLB_REQ_DEFAULT

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.

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 or evaluate the specified policy label.

labelType Type of invocation, Available settings function as follows:

  • vserver - Invokes the unnamed policy label associated with the specified virtual server.
  • policylabel - Invoke the specified policy label.

Possible values: reqvserver, policylabel

labelName Name of the virtual server or user-defined policy label to invoke if the policy evaluates to TRUE.

Example

bind LB global lbpol1 10

lb-global
August 18, 2023
Contributed by: 
C
August 18, 2023
Contributed by: 
C

In this article

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