tm-trafficAction¶
The following operations can be performed on "tm-trafficAction":
add tm trafficAction¶
Creates a traffic action to set traffic characteristics at run time. You can create a traffic action for an application that is installed in the internal network (for example, an action that defines the destination IP address and destination port, and sets the amount of time a user can stay logged on to the application, such as 15 minutes).
Synopsis¶
add tm trafficAction <name> [-appTimeout <mins>] [-SSO ( ON | OFF ) [-formSSOAction <string>]] [-persistentCookie ( ON | OFF )] [-InitiateLogout ( ON | OFF )] [-kcdAccount <string>] [-samlSSOProfile <string>] [-forcedTimeout <forcedTimeout> -forcedTimeoutVal <mins> ] [-userExpression <string>] [-passwdExpression <string>]
Arguments¶
name
Name for the traffic action. 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 a traffic 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').
appTimeout
Time interval, in minutes, of user inactivity after which the connection is closed. Minimum value: 1 Maximum value: 715827
SSO
Use single sign-on for the resource that the user is accessing now.
Possible values: ON, OFF
formSSOAction
Name of the configured form-based single sign-on profile.
persistentCookie
Use persistent cookies for the traffic session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends.
Possible values: ON, OFF
InitiateLogout
Initiate logout for the traffic management (TM) session if the policy evaluates to true. The session is then terminated after two minutes.
Possible values: ON, OFF
kcdAccount
Kerberos constrained delegation account name Default value: "None"
samlSSOProfile
Profile to be used for doing SAML SSO to remote relying party
forcedTimeout
Setting to start, stop or reset TM session force timer
Possible values: START, STOP, RESET
forcedTimeoutVal
Time interval, in minutes, for which force timer should be set.
userExpression
expression that will be evaluated to obtain username for SingleSignOn Maximum value: 256
passwdExpression
expression that will be evaluated to obtain password for SingleSignOn Maximum value: 256
rm tm trafficAction¶
Removes an existing traffic action.
Synopsis¶
rm tm trafficAction <name>
Arguments¶
name
Name of the traffic action to remove.
set tm trafficAction¶
Modifies the specified parameters of an existing traffic action.
Synopsis¶
set tm trafficAction <name> [-appTimeout <mins>] [-SSO ( ON | OFF )] [-formSSOAction <string>] [-persistentCookie ( ON | OFF )] [-InitiateLogout ( ON | OFF )] [-kcdAccount <string>] [-samlSSOProfile <string>] [-forcedTimeout <forcedTimeout>] [-forcedTimeoutVal <mins>] [-userExpression <string>] [-passwdExpression <string>]
Arguments¶
name
Name of the traffic action to modify.
appTimeout
Time interval, in minutes, of user inactivity after which the connection is closed. Minimum value: 1 Maximum value: 715827
SSO
Use single sign-on for the resource that the user is accessing now.
Possible values: ON, OFF
formSSOAction
Name of the configured form-based single sign-on profile.
persistentCookie
Use persistent cookies for the traffic session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends.
Possible values: ON, OFF
InitiateLogout
Initiate logout for the traffic management (TM) session if the policy evaluates to true. The session is then terminated after two minutes.
Possible values: ON, OFF
kcdAccount
Kerberos contrained delegation account name Default value: "None"
samlSSOProfile
Profile to be used for doing SAML SSO to remote relying party
forcedTimeout
Setting to start, stop or reset TM session force timer
Possible values: START, STOP, RESET
forcedTimeoutVal
Time interval, in minutes, for which force timer should be set.
userExpression
expression that will be evaluated to obtain username for SingleSignOn Maximum value: 256
passwdExpression
expression that will be evaluated to obtain password for SingleSignOn Maximum value: 256
unset tm trafficAction¶
Use this command to remove tm trafficAction settings.Refer to the set tm trafficAction command for meanings of the arguments.
Synopsis¶
unset tm trafficAction <name> [-persistentCookie] [-kcdAccount] [-forcedTimeout] [-userExpression] [-passwdExpression]
show tm trafficAction¶
Displays information about all configured traffic management (TM) traffic actions, or displays detailed information about the specified TM traffic action.
Synopsis¶
show tm trafficAction [<name>]
Arguments¶
name
Name of the traffic action for which to display detailed information.
Output¶
appTimeout
The application timeout
SSO
Whether or not Single Sign On is enabled.
formSSOAction
Name of the configured form-based single sign-on profile.
stateflag
persistentCookie
Use persistent cookies for the traffic session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends.
InitiateLogout
Whether Logout is initiated with this action
kcdAccount
Kerberos contrained delegation account name
samlSSOProfile
Profile to be used for doing SAML SSO to remote relying party
forcedTimeout
Setting to start, stop or reset TM session force timer
forcedTimeoutVal
Time interval, in minutes, for which force timer should be set.
userExpression
expression that will be evaluated to obtain username for SingleSignOn
passwdExpression
expression that will be evaluated to obtain password for SingleSignOn
devno
count