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

Synopsis

show authentication Policy []

Arguments

name Name of the advance authentication policy.

Output

rule The name of the new rule associated with the policy.

action The name of the authentication action associated with the policy.

stateflag undefAction Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition. Only the above built-in actions can be used.

comment Any comments to preserve information about this policy.

logAction Name of messagelog action to use when a request matches this policy.

hits Number of hits.

boundTo The entity name to which policy is bound

activePolicy priority bindPolicyType policyType nextFactor On success invoke label.

gotoPriorityExpression Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.

description Description of the policy

vserverType policySubType type devno count

add authentication Policy

Adds an advanced authentication policy. The policy defines the criteria under which the Citrix ADC attempts to authenticate the user.

Synopsis

add authentication Policy -rule -action [-undefAction ] [-comment ] [-logAction ]

Arguments

name Name for the advance AUTHENTICATION 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. Cannot be changed after AUTHENTICATION 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 authentication policy” or ‘my authentication policy’).

rule Name of the Citrix ADC named rule, or an expression, that the policy uses to determine whether to attempt to authenticate the user with the AUTHENTICATION server.

action Name of the authentication action to be performed if the policy matches.

undefAction Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition. Only the above built-in actions can be used.

comment Any comments to preserve information about this policy.

logAction Name of messagelog action to use when a request matches this policy.

set authentication Policy

Modifies the specified parameters of a authentication policy.

Synopsis

set authentication Policy [-rule ] [-action ] [-undefAction ] [-comment ] [-logAction ]

Arguments

name Name of the advance authentication policy to modify.

rule Name of the Citrix ADC named rule, or an expression, that the policy uses to determine whether to attempt to authenticate the user with the AUTHENTICATION server.

action Name of the authentication action to be performed if the policy matches.

undefAction Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition. Only the above built-in actions can be used.

comment Any comments to preserve information about this policy.

logAction Name of messagelog action to use when a request matches this policy.

rename authentication Policy

Renames the specified authentication policy.

Synopsis

rename authentication Policy @ @

Arguments

name Existing name of the authentication policy.

newName New name for the authentication 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.

Example

rename authentication policy oldname newname

stat authentication Policy

Displays authentication statistics for all advanced authentication policies, or for only the specified policy.

Synopsis

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

Arguments

name Name of the advanced authentication policy for which to display statistics. If no name is specified, statistics for all advanced authentication polices are shown.

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

Example

stat authentication policy

stat authentication OAuthIdPPolicy

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

authentication-Policy

May 28, 2024

Contributed by:

May 28, 2024

Contributed by:

authentication-Policy

unset authentication Policy

Synopsis

rm authentication Policy

Synopsis

Arguments

show authentication Policy

Synopsis

Arguments

Output

add authentication Policy

Synopsis

Arguments

set authentication Policy

Synopsis

Arguments

rename authentication Policy

Synopsis

Arguments

Example

stat authentication Policy

Synopsis

Arguments

Output

Counters

Example

Related Commands

In this article