ltm rule command UDP unused port

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

UDP::unused_port
       Returns an unused UDP port for the specified IP tuple.

SYNOPSIS
       UDP::unused_port REMOTE_ADDR REMOTE_PORT LOCAL_ADDR
				(HINT_PORT	     |
				(HINT_PORT MIN_PORT) |
				(HINT_PORT MIN_PORT MAX_PORT))?

DESCRIPTION
       Returns an unused UDP port for the specified IP tuple.

       Syntax

       UDP::unused_port    [] [] []

	    * Returns an unused UDP port for the specified IP tuple, using the
	      value of  as a starting point if it is supplied. If no
	      appropriate unused local port could be found, 0 is returned.

RETURN VALUE
VALID DURING
       CLIENT_ACCEPTED, CLIENT_CLOSED, CLIENT_DATA, SERVER_CLOSED, SERVER_CONNECTED, SERVER_DATA, SIP_REQUEST,
       SIP_REQUEST_SEND, SIP_RESPONSE, STREAM_MATCHED

EXAMPLES
	when CLIENT_ACCEPTED {
	  set port [UDP::unused_port [IP::remote_addr] [UDP::remote_port] [IP::local_addr]]
	  UDP::respond "Next unused port: $port"
	}

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

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