ADC CLI Commands

authentication-webAuthAction

May 28, 2024

Contributed by:

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

rm authentication webAuthAction

Removes a web authentication action. You cannot remove an action that is used in any part of a policy.

Synopsis

rm authentication webAuthAction

Arguments

name Name of the web authentication action to remove.

Example

rm authentication webAuthAction a1

unset authentication webAuthAction

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

Synopsis

unset authentication webAuthAction [-serverIP] [-serverPort] [-fullReqExpr] [-defaultAuthenticationGroup] [-Attribute1] [-Attribute2] [-Attribute3] [-Attribute4] [-Attribute5] [-Attribute6] [-Attribute7] [-Attribute8] [-Attribute9] [-Attribute10] [-Attribute11] [-Attribute12] [-Attribute13] [-Attribute14] [-Attribute15] [-Attribute16]

add authentication webAuthAction

Adds an action to be used for web authentication.

Specify the entire HTTP request in a single expression.

Synopsis

add authentication webAuthAction -serverIP <ip\_addr|ipv6\_addr|\*> -serverPort <port|\*> \[-fullReqExpr ] -scheme \( http | https ) -successRule \[-defaultAuthenticationGroup ] \[-Attribute1 ] \[-Attribute2 ] \[-Attribute3 ] \[-Attribute4 ] \[-Attribute5 ] \[-Attribute6 ] \[-Attribute7 ] \[-Attribute8 ] \[-Attribute9 ] \[-Attribute10 ] \[-Attribute11 ] \[-Attribute12 ] \[-Attribute13 ] \[-Attribute14 ] \[-Attribute15 ] \[-Attribute16 ]

Arguments

name Name for the Web Authentication action. 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 profile 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 action” or ‘my authentication action’).

serverIP IP address of the web server to be used for authentication.

serverPort Port on which the web server accepts connections. Minimum value: 1

fullReqExpr Exact HTTP request, in the form of an expression, which the Citrix ADC sends to the authentication server. The Citrix ADC does not check the validity of this request. One must manually validate the request.

scheme Type of scheme for the web server.

Possible values: http, https

successRule Expression, that checks to see if authentication is successful.

defaultAuthenticationGroup This is the default group that is chosen when the authentication succeeds in addition to extracted groups.

Attribute1 Expression that would be evaluated to extract attribute1 from the webauth response

Attribute2 Expression that would be evaluated to extract attribute2 from the webauth response

Attribute3 Expression that would be evaluated to extract attribute3 from the webauth response

Attribute4 Expression that would be evaluated to extract attribute4 from the webauth response

Attribute5 Expression that would be evaluated to extract attribute5 from the webauth response

Attribute6 Expression that would be evaluated to extract attribute6 from the webauth response

Attribute7 Expression that would be evaluated to extract attribute7 from the webauth response

Attribute8 Expression that would be evaluated to extract attribute8 from the webauth response

Attribute9 Expression that would be evaluated to extract attribute9 from the webauth response

Attribute10 Expression that would be evaluated to extract attribute10 from the webauth response

Attribute11 Expression that would be evaluated to extract attribute11 from the webauth response

Attribute12 Expression that would be evaluated to extract attribute12 from the webauth response

Attribute13 Expression that would be evaluated to extract attribute13 from the webauth response

Attribute14 Expression that would be evaluated to extract attribute14 from the webauth response

Attribute15 Expression that would be evaluated to extract attribute15 from the webauth response

Attribute16 Expression that would be evaluated to extract attribute16 from the webauth response

Example

add authentication webAuthAction a1 -ServerIP 1.1.1.1 -ServerPort 80 -scheme HTTP -successRule true -fullReqExpr

set authentication webAuthAction

Modifies the attributes of an existing web authentication action.

Synopsis

set authentication webAuthAction \[-serverIP <ip\_addr|ipv6\_addr|\*>] \[-serverPort <port|\*>] \[-fullReqExpr ] \[-scheme \( http | https )] \[-successRule ] \[-defaultAuthenticationGroup ] \[-Attribute1 ] \[-Attribute2 ] \[-Attribute3 ] \[-Attribute4 ] \[-Attribute5 ] \[-Attribute6 ] \[-Attribute7 ] \[-Attribute8 ] \[-Attribute9 ] \[-Attribute10 ] \[-Attribute11 ] \[-Attribute12 ] \[-Attribute13 ] \[-Attribute14 ] \[-Attribute15 ] \[-Attribute16 ]

Arguments

name Name of the action to configure.