ltm rule command XLAT src nat valid range

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

XLAT::src_nat_valid_range
       Return a list of valid source-translation endpoint ranges.

SYNOPSIS
       XLAT::src_nat_valid_range

DESCRIPTION
       Returns a list of lists containing valid source-translation addresses and port-ranges (source-translation
       endpoints). This command must be called every time a new connection/listener needs to be created to retrieve
       the valid source translation information. This data must not be cached. Only the source-translation address
       used by the parent with a valid port-range is returned, not all of the endpoints in the source-translation
       object/pool. In PBA mode multiple source-translation addresses and port-ranges can be returned if the client
       has multiple active blocks.

RETURN VALUE
       A list of lists containing the valid source-translation endpoint ranges. For e.g. { {address-1 start-port
       end-port} {address-2 start-port end-port} ...}

VALID DURING
       SA_PICKED, CLIENT_DATA, SERVER_DATA, SERVER_CONNECTED

EXAMPLES
	when SA_PICKED {
	    set sa_list [XLAT::src_nat_valid_range]

	    foreach sa $sa_list {
		log local0. "address=[lindex $sa 0] port-start=[lindex $sa 1] port-end=[lindex $sa 2]"
	    }
	}

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

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