ltm rule command DATAGRAM ip

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



DATAGRAM::ip
       Returns ip header information.

SYNOPSIS
       DATAGRAM::ip (tos | ttl | flags)

       DATAGRAM::ip (option | option_count) (IPV4_OPTION)?

DESCRIPTION
       This iRules command returns ip header information.

       DATAGRAM::ip tos

	    * Returns IP header ToS as an integer value.

       DATAGRAM::ip ttl

	    * Returns IP header TTL as an integer value.

       DATAGRAM::ip flags

	    * Returns IP header flags as an integer value. The flags are from the
	      IP datagram after IP fragment reassembly. Any MF flags that were
	      present in indivdual fragments will not be returned. DF flag is
	      preserved if it was set.

       DATAGRAM::ip option

	    * This command returns a Tcl list of IP options from reassembled IP
	      datagram. Each option is a Tcl list with one or two values - option
	      code (integer), and option value (byte array) if option has the
	      value. Multiple options with the same code will be returned as
	      separate sublists. There are one or two byte IP options that do not
	      have any data - in this case only option code is present. If
	      datagram has no IP options an empty value is returned.

       DATAGRAM::ip option [option-code]

	    * This command returns a Tcl list of values for IP option with
	      specified option code from reassembled IP datagram. If option
	      occurs multiple times and has no data (1 or 2 byte option) then a
	      list of empty values is returned. If there is a single occurrence
	      of such option then empty value is returned. In this case
	      option_count must be used to detect presence of this option.

       DATAGRAM::ip option_count

	    * This command returns a number of IP options in the IP datagram.

       DATAGRAM::ip option_count [option-code]

	    * This command returns a number of IP options with specified option
	      code in the IP datagram.

RETURN VALUE
VALID DURING
       FLOW_INIT, CLIENT_DATA

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



BIG-IP				  2017-01-31			      iRule(1)