ltm rule command FLOW priority

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

FLOW::priority
       Set/Get flow's internal packet priority.

SYNOPSIS
       FLOW::priority FLOW_PRIORITY

       FLOW::priority (clientside | serverside) (FLOW_PRIORITY)?

       FLOW::priority (ANY_CHARS) (FLOW_PRIORITY)?

DESCRIPTION
       This command is used to get/set the flow's internal packet priority.  Valid priority is any integer value from
       0 to 7.	Syntax: FLOW::priority [TCL handle|clientside|serverside] [priority]

       Following are the variations of this command:

       FLOW::priority

	Returns the internal packet priority of current flow.

       Flow::priority 

	Sets the priority of the current flow's internal packet priority.
	Exception is thrown if priority is outside the allowed range [0-7].

       FLOW::priority clientside

	Returns the priority of the clientside flow's internal packet priority.

       FLOW::priority serverside

	Returns the priority of serverside flow's internal packet priority.

       FLOW::priority clientside 

	Sets the priority of the clientside flow's internal packet priority.
	Exception is thrown if priority is outside the allowed range [0-7].

       FLOW::priority serverside 

	Sets the priority of the serverside flow's internal packet priority.
	Exception is thrown if priority is outside the allowed range [0-7].

       FLOW::priority 

	Returns the priority of the  internal packet priority.

       FLOW::priority  

	Sets the priority of  internal packet priority.
	Exception is thrown if priority is outside the allowed range [0-7].

RETURN VALUE
       Get operation returns an integer between 0-7. Set operation returns nothing.  Exception is thrown if the
       operation cannot be completed.

VALID DURING
       FLOW_INIT, CLIENT_ACCEPTED, SERVER_CONNECTED

EXAMPLES
	when CLIENT_ACCEPTED {
	  FLOW::priority clientside 2

	  # Alternate way to use the command using the TCL flow handle.
	  # Get priority on the current flow.
	  set clientflow [FLOW::this]
	  set priority [FLOW::priority $clientflow]
	  #OR
	  set priority [FLOW::priority [FLOW::this]]

	  # Set priority on the current flow.
	  FLOW::priority $clientflow 2
	  #OR
	  FLOW::priority [FLOW::this] 2
	}
	when SERVER_CONNECTED {
	  FLOW::priority serverside 4

	  # Alternate way to use the command using the TCL flow handle.
	  # Set priority on both client side and server side flow.
	  FLOW::priority $clientflow 2
	  FLOW::priority [FLOW::this] 2
	}

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-11.5.0 --First introduced the command.  @BIGIP14.1.0 --Updated to support flow TCL handle.

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