ltm rule command ACCESS perflow

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

ACCESS::perflow
       Returns perflow variable value

SYNOPSIS
       ACCESS::perflow get KEY

       ACCESS::perflow set ( 'perflow.custom' | 'perflow.scratchpad' | 'perflow.custom.flow' |
       'perflow.scratchpad.flow' | 'perflow.l7_protocol_lookup.result' ) VALUE

DESCRIPTION
       This command can be used to either set or return the value of a perflow variable that has been set inside the
       Access Per-Request Policy that is being run.

       ACCESS::perflow get  will return the value of any perflow variable that has already been set. A perflow
       variable with no value set will return an empty string. An invalid perflow variable name will give a
       connection reset.

       ACCESS::perflow set   will set the value of the custom perflow variable. Currently the only perflow
       variables that can be set are "perflow.custom", "perflow.scratchpad" and "perflow.l7_protocol_lookup.result".
       All other variables will return a connection reset.

RETURN VALUE
       ACCESS::perflow get will return the string of perflow variable; empty if value isn't set

VALID DURING
EXAMPLES
	when ACCESS_PER_REQUEST_AGENT_EVENT {
	    set id [ACCESS::perflow get perflow.irule_agent_id]

	    if { $id eq "irule_agent_one" } {
		log local0. "Made it to iRule agent in perrequest policy."
		ACCESS::perflow set perflow.custom "agent_one"
	    }
	}

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-12.1.0
		   --First introduced the command.
		   @BIGIP-13.0
		   --Added ACCESS::perflow set command

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