ltm rule command BOTDEFENSE cs attribute

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



BOTDEFENSE::cs_attribute
       Queries for or sets attributes for the client-side challenge.

SYNOPSIS
       BOTDEFENSE::cs_attribute 'device_id' (BOOLEAN)?

DESCRIPTION
       Queries for or sets attributes for the client-side challenge. These
       attributes are only effective if a client-side action is taken on the
       current request.

       Syntax

       BOTDEFENSE::cs_attribute device_id [enable | disable]

       By setting to "enable" during BOTDEFENSE_REQUEST the user requests to
       collect device id during the request (initiate response only). If page
       is not qualified or the actual mitigation action for the current
       request is "block" or "drop" the command will be ignored.

       By setting to "enable" during BOTDEFENSE_ACTION the user requests to
       collect device id during the request (initiate response only). If Bot
       defense action is to send browser_challenge or captcha_challenge,
       device id will be collected as well, otherwise the command will be
       ignored.

       Device id will be collected regardless of its configuration in profile
       and even if there is already a valid cookie.

       By setting to "disable" the user requests not to collect device id
       (regardless of the configured Device ID collection mode).

       When not specifying a value, the command will return "enable" in case
       Bot Defense attempts to collect the device id during request (initiate
       response), otherwise "disabled".

RETURN VALUE
       * When called with an argument  the command overrides the decision of
       Bot Defense whether to collect device id.  * When called without an
       argument, the command returns whether Bot Defense attempts to collect
       the device id during the request (initiate response). In case the
       mitigation is to block or drop the request the Device ID collection
       will not happen but the value will still returns "enable".

VALID DURING
       BOTDEFENSE_REQUEST, BOTDEFENSE_ACTION

EXAMPLES
	# EXAMPLE: Make sure that the data for the device_id is always collected when taking a client-side action.
	when BOTDEFENSE_REQUEST {
	    BOTDEFENSE::cs_attribute device_id enable
	}

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



BIG-IP				  2019-05-10			      iRule(1)