ltm rule command ASM captcha

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

ASM::captcha
       Responds to the client with a CAPTCHA challenge.

SYNOPSIS
       ASM::captcha

DESCRIPTION
       Responds to the client with a CAPTCHA challenge.  Note although ASM will send the CAPTCHA challenge screen
       back to the user, the enforcement is not always done automatically.  To enforce the correct CAPTCHA response,
       the ASM::captcha_status command should be used.

		Syntax

       ASM::captcha

RETURN VALUE
       Returns a string signifying if the challenge was sent successfully: "ok" - CAPTCHA challenge was sent
       successfully "nok asm blocked request" -  CAPTCHA challenge was not sent, because a blocking page action was
       performed "nok asm uncaptcha command was raised" -  CAPTCHA challenge was not sent, because uncaptcha command
       was called "nok request unqualified for captcha" - CAPTCHA challenge was not sent, because request is not
       qualified for CAPTCHA action

VALID DURING
       ASM_REQUEST_DONE, ASM_REQUEST_VIOLATION

EXAMPLES
	# This example counts the number of violations, and if it exceeds 3,
	# it issues a CAPTCHA action.
	when ASM_REQUEST_DONE {
	    if {[ASM::violation count] > 3 and [ASM::severity] eq "Error"} {
		ASM::captcha
	    }
	}

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

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