Skip to content

tm-formSSOAction

The following operations can be performed on "tm-formSSOAction":

add| show| set| unset| rm|

add tm formSSOAction

Creates a form-based single sign-on traffic profile (action.) Form-based single sign-on allows users to access web applications that require an HTML form-based logon without having to type their password again for each new application.

Synopsis

add tm formSSOAction -actionURL -userField -passwdField -ssoSuccessRule [-nameValuePair ] [-responsesize ] [-nvtype ( STATIC | DYNAMIC )] [-submitMethod ( GET | POST )]

Arguments

name Name for the new form-based single sign-on profile. 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 an SSO action 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 action" or 'my action').

actionURL 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 checks to see if single sign-on is successful.

nameValuePair Name-value pair attributes to send to the server in addition to sending the username and password. Value names are separated by an ampersand (&) (for example, name1=value1&name2=value2).

responsesize Number of bytes, in the response, to parse for extracting the forms. Default value: 8096 Minimum value: 0

nvtype Type of processing of the name-value pair. If you specify STATIC, the values configured by the administrator are used. For DYNAMIC, the response is parsed, and the form is extracted and then submitted.

Possible values: STATIC, DYNAMIC Default value: DYNAMIC

submitMethod HTTP method used by the single sign-on form to send the logon credentials to the logon server. Applies only to STATIC name-value type.

Possible values: GET, POST Default value: GET

show tm formSSOAction

Displays information about all configured form-based single sign-on actions, or displays detailed information about the specified action.

Synopsis

show tm formSSOAction []

Arguments

name Name of the SSO action for which to display detailed information.

Output

actionURL URL to which the completed form is submitted.

userField Username field.

passwdField Password field.

responsesize Number of bytes, in the response, to parse 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

set tm formSSOAction

Modifies the specified attributes of a form-based single sign-on traffic profile (action.)

Synopsis

set tm formSSOAction [-actionURL ] [-userField ] [-passwdField ] [-ssoSuccessRule ] [-responsesize ] [-nameValuePair ] [-nvtype ( STATIC | DYNAMIC )] [-submitMethod ( GET | POST )]

Arguments

name Name of the form-based single sign-on profile (action) to modify.

actionURL 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 checks to see if single sign-on is successful.

responsesize Number of bytes, in the response, to parse for extracting the forms. Default value: 8096 Minimum value: 0

nameValuePair Name-value pair attributes to send to the server in addition to sending the username and password. Value names are separated by an ampersand (&) (for example, name1=value1&name2=value2).

nvtype Type of processing of the name-value pair. If you specify STATIC, the values configured by the administrator are used. For DYNAMIC, the response is parsed, and the form is extracted and then submitted.

Possible values: STATIC, DYNAMIC Default value: DYNAMIC

submitMethod HTTP method used by the single sign-on form to send the logon credentials to the logon server. Applies only to STATIC name-value type.

Possible values: GET, POST Default value: GET

unset tm formSSOAction

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

Synopsis

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

rm tm formSSOAction

Deletes an existing form-based single sign-on traffic profile (action.)

Synopsis

rm tm formSSOAction

Arguments

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

Was this article helpful?