Product Documentation

authentication webAuthAction

Sep 12, 2016

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

add | rm | set | unset | show

add authentication webAuthAction

Adds an action to be used for web authentication. * Specify the entire HTTP request in a single expression.

Synopsys

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

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 NetScaler 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 a default syntax expression, which the NetScaler appliance sends to the authentication server.

The NetScaler appliance 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 <http request string>

rm authentication webAuthAction

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

Synopsys

rm authentication webAuthAction <name>

Arguments

name

Name of the web authentication action to remove.

Example

rm authentication webAuthAction a1

set authentication webAuthAction

Modifies the attributes of an existing web authentication action.

Synopsys

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

Arguments

name

Name of the action to configure.

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 a default syntax expression, which the NetScaler appliance sends to the authentication server.

The NetScaler appliance 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

set authentication webAuthAction a1 -ServerIP 1.1.1.1 -ServerPort 80

unset authentication webAuthAction

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

Synopsys

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

show authentication webAuthAction

Displays information about the configured web authentication action.

Synopsys

show authentication webAuthAction [<name>]

Arguments

name

Name of the web authentication action to display. If a name is not provided, information about all actions is shown.

Outputs

stateflag

serverIP

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

serverPort

Port on which the web server accepts connections.

fullReqExpr

Exact HTTP request, in the form of a default syntax expression, which the NetScaler appliance sends to the authentication server.

The NetScaler appliance does not check the validity of this request. One must manually validate the request.

scheme

Type of scheme for the web server.

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

devno

count

Example

show authentication webAuthAction a1