Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

authorization-policylabel

May 28, 2024
Contributed by: 
C

The following operations can be performed on “authorization-policylabel”:

unbind rm rename bind add show stat

unbind authorization policylabel

Unbinds the specified policy from the specified authorization policy label.

Synopsis

unbind authorization policylabel [-priority ]

Arguments

labelName Name for the new authorization policy label. 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. Cannot be changed after the authorization 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 authorization policy label” or ‘authorization policy label’).

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

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

Example

unbind authorization policylabel trans_http_url pol_1

rm authorization policylabel

Removes an authorization policy label.

Synopsis

rm authorization policylabel

Arguments

labelName Name of the authorization policy label to remove.

Example

rm authorization policylabel trans_http_url

rename authorization policylabel

Rename a auth policy label.

Synopsis

rename authorization policylabel @ @

Arguments

labelName The name of the auth policy label

newName The new name of the auth policy label

Example

rename auth policy label oldname newname

bind authorization policylabel

Binds an authorization policy to a label.

Synopsis

bind authorization policylabel [] [-invoke ( ) ]

Arguments

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

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

priority Positive integer specifying the priority of the policy. The lower the number, the higher the priority. Policies within a label are evaluated in the order of their priority numbers. Minimum value: 1 Maximum value: 2147483647

gotoPriorityExpression Expression or other value specifying the next policy to be evaluated 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 either forward the request or response to the specified virtual server or evaluate the specified policy label.

labelType Type of invocation. Available settings function as follows:

  • reqvserver - Send the request to the specified request virtual server.
  • resvserver - Send the response to the specified response virtual server.
  • policylabel - Invoke the specified policy label.

Possible values: reqvserver, resvserver, 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 set to Policy Label.

Example

i)bind authorization policylabel trans_http_url pol_1 1 2 -invoke reqvserver CURRENT ii)bind authorization policylabel trans_http_url pol_2 2

add authorization policylabel

Creates a user-defined authorization policy label.

Synopsis

add authorization policylabel

Arguments

labelName Name for the new authorization policy label. 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. Cannot be changed after the authorization 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 authorization policy label” or ‘authorization policy label’).

Example

add authorization policylabel trans_http_url

show authorization policylabel

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

Synopsis

show authorization policylabel []

Arguments

labelName Name of the authorization policy label.

Output

stateflag numpol Number of polices bound to label.

hits Number of times policy label was invoked.

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

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 invocation. Available settings function as follows:

  • reqvserver - Send the request to the specified request virtual server.
  • resvserver - Send the response to the specified response 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 set to Policy Label.

flowType Flowtype of the bound authorization policy.

description Description of the policylabel

flags devno count

Example

i)show authorization policylabel trans_http_url ii)show authorization policylabel

stat authorization policylabel

Displays statistics for the specified authorization policy label. If no authorization policy label is specified, displays a list of all authorization policy labels.

Synopsis

stat authorization policylabel [] \[-detail] \[-fullValues] \[-ntimes <positive\_integer>] \[-logFile <input\_filename>] \[-clearstats \( basic | full )]

Arguments

labelName Name of the authorization 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.

authorization-policylabel
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.