ADC CLI Commands

vpn-formSSOAction

The following operations can be performed on “vpn-formSSOAction”:

add unset show rm set

add vpn formSSOAction

Creates a form-based single sign-on profile. Form based single sign-on allows users to log on one time to all protected applications in your network. Users can access web applications that require an HTML form-based logon without having to type their password again.

Synopsis

add vpn formSSOAction -actionURL -userField -passwdField -ssoSuccessRule \[-nameValuePair ] \[-responsesize <positive\_integer>] \[-nvtype \( STATIC | DYNAMIC )] \[-submitMethod \( GET | POST )]

Arguments

name Name for the form based single sign-on profile.

actionURL Root-relative URL to which the completed form is submitted.

userField Name of the form field in which the user types in the user ID.

passwdField Name of the form field in which the user types in the password.

ssoSuccessRule Expression that defines the criteria for SSO success. Expression such as checking for cookie in the response is a common example.

nameValuePair Other name-value pair attributes to send to the server, in addition to sending the user name and password. Value names are separated by an ampersand (&), such as in name1=value1&name2=value2.

responsesize Maximum number of bytes to allow in the response size. Specifies the number of bytes in the response to be parsed for extracting the forms. Default value: 8096 Minimum value: 0

nvtype How to process the name-value pair. Available settings function as follows:

  • STATIC - The administrator-configured values are used.
  • DYNAMIC - The response is parsed, the form is extracted, and then submitted.

Possible values: STATIC, DYNAMIC Default value: DYNAMIC

submitMethod HTTP method (GET or POST) used by the single sign-on form to send the logon credentials to the logon server.

Possible values: GET, POST Default value: GET

unset vpn formSSOAction

Use this command to remove vpn formSSOAction settings.Refer to the set vpn formSSOAction command for meanings of the arguments.

Synopsis

unset vpn formSSOAction [-responsesize] [-nameValuePair] [-nvtype] [-submitMethod]

show vpn formSSOAction

Displays the attributes of a form-based single sign-on profile.

Synopsis

show vpn formSSOAction []

Arguments

name Name of the form-based single sign-on profile.

Output

actionURL Root-relative URL to which the completed form is submitted.

userField Username field.

passwdField Password field.

responsesize Maximum number of bytes to allow in the response size. Specifies the number of bytes in the response to be parsed for extracting the forms.

nameValuePair Form attributes and their values to be submitted.

nvtype Bypass Form extraction

ssoSuccessRule Rule to be evaluated to check whether sso succeeded or not.

submitMethod Form Submit method.

devno count stateflag

rm vpn formSSOAction

Removes a configured form-based single sign-on profile.

Synopsis

rm vpn formSSOAction

Arguments

name Name of the form-based single sign-on profile to remove.

set vpn formSSOAction

Modifies the parameters of an existing form-based single sign-on profile (or action).

Synopsis

set vpn formSSOAction \[-actionURL ] \[-userField ] \[-passwdField ] \[-ssoSuccessRule ] \[-responsesize <positive\_integer>] \[-nameValuePair ] \[-nvtype \( STATIC | DYNAMIC )] \[-submitMethod \( GET | POST )]

Arguments

name Name for the form based single sign-on profile.

actionURL Root-relative URL to which the completed form is submitted.

userField Name of the form field in which the user types in the user ID.

passwdField Name of the form field in which the user types in the password.

ssoSuccessRule Expression that defines the criteria for SSO success. Expression such as checking for cookie in the response is a common example.

responsesize Maximum number of bytes to allow in the response size. Specifies the number of bytes in the response to be parsed for extracting the forms. Default value: 8096 Minimum value: 0

nameValuePair Other name-value pair attributes to send to the server, in addition to sending the user name and password. Value names are separated by an ampersand (&), such as in name1=value1&name2=value2.

nvtype How to process the name-value pair. Available settings function as follows:

  • STATIC - The administrator-configured values are used.
  • DYNAMIC - The response is parsed, the form is extracted, and then submitted.

Possible values: STATIC, DYNAMIC Default value: DYNAMIC

submitMethod HTTP method (GET or POST) used by the single sign-on form to send the logon credentials to the logon server.

Possible values: GET, POST Default value: GET

vpn-formSSOAction