ltm rule command AUTH start

iRule(1)					  BIG-IP TMSH Manual					     iRule(1)

AUTH::start
       Initializes an authentication session.

SYNOPSIS
       AUTH::start TYPE SERVICE

DESCRIPTION
       Initializes an authentication session. This command returns the authentication session ID, which must be
       specified to other authentication commands. Multiple simultaneous authentication sessions (up to 10) can be
       opened for a single connection, but it is the userXs responsibility to keep track of their respective session
       IDs. This command returns an error if attempted for a standby system.

       AUTH::start  

	    * Returns the authentication session ID, which must be specified to
	      other authentication commands. The value pam is currently the only
	      supported value for . The value of  must be the
	      name of the PAM service from which to apply authorization settings.

RETURN VALUE
VALID DURING
EXAMPLES
	when CLIENT_ACCEPTED {
	  set auth_id [AUTH::start pam default_radius]
	}

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-9.0.0 --First introduced the command.

BIG-IP						      2020-06-23					     iRule(1)