Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

authentication-samlIdPPolicy

May 28, 2024
Contributed by: 
C

The following operations can be performed on “authentication-samlIdPPolicy”:

rm set add stat show unset rename

rm authentication samlIdPPolicy

Removes an existing SAML Identity Provider (IdP) policy.

Synopsis

rm authentication samlIdPPolicy

Arguments

name Name of the authentication policy to remove.

set authentication samlIdPPolicy

Modifies the specified parameters of an existing SAML IdentityProvider (IdP) policy.

Synopsis

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

Arguments

name Name of the SAML Identity Provider (IdP) authentication policy to modify.

rule Expression which is evaluated to choose a profile for authentication.

The following requirements apply only to the Citrix ADC CLI:

  • If the expression includes one or more spaces, enclose the entire expression in double quotation marks.
  • If the expression itself includes double quotation marks, escape the quotations by using the \ character.
  • Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.

action Name of the profile to apply to requests or connections that match this policy.

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.

add authentication samlIdPPolicy

Adds a SAML Identity Provider (IdP) policy to use for use in authentication.

Synopsis

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

Arguments

name Name for the SAML Identity Provider (IdP) authentication policy. This is used for configuring Citrix ADC as SAML Identity Provider. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the 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 policy” or ‘my policy’).

rule Expression which is evaluated to choose a profile for authentication.

The following requirements apply only to the Citrix ADC CLI:

  • If the expression includes one or more spaces, enclose the entire expression in double quotation marks.
  • If the expression itself includes double quotation marks, escape the quotations by using the \ character.
  • Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.

action Name of the profile to apply to requests or connections that match this policy.

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.

stat authentication samlIdPPolicy

Display SAML Identity Provider (IdP) policy statistics.

Synopsis

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

Arguments

name The name of the SAML Identity Provider (IdP) policy for which statistics will be displayed. If not given statistics are shown for all policies.

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

Example

stat authentication samlidppolicy.

show authentication samlIdPPolicy

Displays information about all configured SAML Identity Provider (IdP) authentication policies, or displays detailed information about the specified policy.

Synopsis

show authentication samlIdPPolicy []

Arguments

name Name of the SAML IdentityProvider (IdP) policy for which to display detailed information.

Output

rule The rule used by the SAML Identity Provider (IdP) authentication policy. Rules are combinations of Expressions. Expressions are simple conditions, such as a test for equality, applied to operands, such as a URL string or an IP address. Expression syntax is described in the Installation and Configuration Guide

action The action to be performed when the rule is matched.

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.

boundTo The entity name to which policy is bound

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

hits Number of hits.

bindPolicyType vserverType devno count

unset authentication samlIdPPolicy

Removes the settings of an existing SAML IdentityProvider (IdP) policy. Attributes for which a default value is available revert to their default values. See the set samlIdPPolicy command for a description of the parameters..Refer to the set authentication samlIdPPolicy command for meanings of the arguments.

Synopsis

unset authentication samlIdPPolicy [-undefAction] [-comment] [-logAction]

Example

unset samlIdpPolicy pol9 -undefAction

rename authentication samlIdPPolicy

Renames the specified SAML IdentityProvider (IdP) policy. You must restart the Citrix ADC to put new name in effect.

Synopsis

rename authentication samlIdPPolicy @ @

Arguments

name Existing name of the SAML IdentityProvider policy.

newName New name for the SAML IdentityProvider 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 samlidppolicy policy” or ‘my samlidppolicy policy’).

Example

rename samlidppolicy policy oldname newname

authentication-samlIdPPolicy
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.