ltm rule command MR message

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



MR::message
       Returns or sets details in the message routing table.

SYNOPSIS
       MR::message route

   DESCRIPTION
       Returns the contents of the route stored in the message.

       MR::message route none

   DESCRIPTION
       Clear any route already set in the message.

       MR::message route ('peer-selection-mode' | 'selection-mode' | 'mode')
       ('sequential' | 'seq' | 'ratio') ('peer' PEER)+

   DESCRIPTION
       Instructs the route table to route the message to the provided peer or
       list of peers and a peer-selection-mode. This form of the MR::message
       route command takes the names of configured peers or dynamic peers
       created via the MR::peer command.

       MR::message route ('peer' PEER)+

   DESCRIPTION
       Instructs the route table to route the message to the provided peer or
       list of peers. This form of the MR::message route command takes the
       names of configured peers or dynamic peers created via the MR::peer
       command.

       MR::message route (((('virtual' VIRTUAL_SERVER_OBJ)
				    |
				    ('config' TRANSPORT_CONFIG))     (('pool'
       POOL_OBJ) | ('host' HOST))
				  ))+

   DESCRIPTION
       Instructs the route table to route the message to the provided host or
       pool using the specified virtual server or transport config for
       creating the outgoing connection.

       MR::message attempted

   DESCRIPTION
       Gets the hosts that this message has been routed towards.

       MR::message attempted none

   DESCRIPTION
       Clear any attempted hosts already set in the message.

       MR::message attempted ((('virtual' VIRTUAL_SERVER_OBJ)
				    |
				    ('config' TRANSPORT_CONFIG))     ('host'
       HOST)
				  )+

   DESCRIPTION
       Sets the attempted hosts list. If set before routing the message
       (during MR_INGRESS or MR_EGRESS) a host will be selected from the pool
       that has not already been attempted.

       MR::message drop (REASON)?

   DESCRIPTION
       Drops the current message

       MR::message retry_count

   DESCRIPTION
       Returns the number of attempts to route this message that have
       occurred.

       MR::message status

   DESCRIPTION
       Returns the status of the routing operation (valid only at MR_EGRESS or
       MR_FAILED). Possible values are:
	   "unprocessed"
	   "route found"
	   "no route found"
	   "dropped"
	   "queue_full"
	   "no connection"
	   "connection closing"
	   "internal error"
	   "persist key in use"
	   "standby dropped"

       MR::message originator

   DESCRIPTION
       Returns the transport type, transport name and IP and port of the
       originator of the message.

       MR::message lasthop

   DESCRIPTION
       Returns the message's lasthop (details of the connection that
       originated the message).

       MR::message nexthop none

   DESCRIPTION
       Clears the nexthop already set in the message.

       MR::message nexthop (HOP)?

   DESCRIPTION
       Returns the nextop nexthop (details of the connection the message is to
       be forwarded to). If the new_nexthop parameter is present, a nexthop
       may be set for the message.

DESCRIPTION
RETURN VALUE
VALID DURING
       MR_INGRESS MR_EGRESS MR_FAILED

EXAMPLES
	when MR_INGRESS {
	    if {[GENERICMESSAGE::message is_request] != 0} {
		MR::message route config tcp_tc host 10.10.10.34:1234
	    }
	}
	when MR_EGRESS {
	    if {[GENERICMESSAGE::message is_request] != 0} {
		set orig_lasthop [MR::message lasthop]
	    } else {
		MR::message nexthop "$orig_lasthop"
	    }
	}

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-11.5.0 --First introduced the command.  @BIGIP-11.6.0 --Add
       MR::message retry_count --Add MR::message nexthop --Add MR::message
       lasthop @BIGIP-13.0.0 --Add peer-selection-mode keyword to MR::message
       route command.  --Add MR::message attempted



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