ltm rule command BOTDEFENSE device id

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

BOTDEFENSE::device_id
       Returns the Device ID of the client, as retrieved from the request.

SYNOPSIS
       BOTDEFENSE::device_id

DESCRIPTION
       Returns a number, representing the Device ID of the client, as retrieved from the request. If the Device ID is
       unknown, 0 is returned. By default, the Device ID is collected from the client, if it is enabled in the
       configuration. However, this can be overridden using the BOTDEFENSE::cs_attribute command.

       Syntax

       BOTDEFENSE::device_id

RETURN VALUE
       The number representing the device ID of the client that sent the request, or 0 if there is no such value

VALID DURING
       BOTDEFENSE_REQUEST, BOTDEFENSE_ACTION

EXAMPLES
	# EXAMPLE: Log the Device ID of the client, upon each request, if it is known.
	when BOTDEFENSE_REQUEST {
	    if {[BOTDEFENSE::device_id] != 0} {
		set log "botdefense device_id of client IP [IP::client_addr] is"
		append log " [BOTDEFENSE::device_id]"
		HSL::send $hsl $log
	    }
	}

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

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