Product Documentation

authentication samlPolicy

Sep 12, 2016

The following operations can be performed on "authentication samlPolicy":

add | rm | set | unset | show

add authentication samlPolicy

Adds a SAML authentication policy. The policy defines the criteria under which the NetScaler appliance attempts to authenticate the user with the specified SAML server.

Synopsys

add authentication samlPolicy <name> <rule> <reqAction>

Arguments

name

Name for the SAML 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 SAML policy is created.

The following requirement applies only to the NetScaler 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 NetScaler named rule, or a default syntax expression, that the policy uses to determine whether to attempt to authenticate the user with the SAML server.

reqAction

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

rm authentication samlPolicy

Removes the specified SAML policy.

Synopsys

rm authentication samlPolicy <name>

Arguments

name

Name of the policy to remove.

set authentication samlPolicy

Modifies the specified parameters of a SAML policy.

Synopsys

set authentication samlPolicy <name> [-rule <expression>] [-reqAction <string>]

Arguments

name

Name of the SAML policy to modify.

rule

Name of the NetScaler named rule, or a default syntax expression, that the policy uses to determine whether to attempt to authenticate the user with the SAML server.

reqAction

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

unset authentication samlPolicy

Use this command to remove authentication samlPolicy settings.Refer to the set authentication samlPolicy command for meanings of the arguments.

Synopsys

unset authentication samlPolicy <name> [-rule] [-reqAction]

show authentication samlPolicy

Displays the current settings for the specified SAML policy. If no policy name is provided, displays a list of all SAML policies currently configured on the NetScaler appliance.

Synopsys

show authentication samlPolicy [<name>]

Arguments

name

Name of the SAML policy.

Outputs

rule

The name of the new rule associated with the policy.

reqAction

The name of the SAML action associated with the policy.

boundTo

The entity name to which policy is bound

activePolicy

priority

bindPolicyType

policyType

devno

count

stateflag