ltm rule command GENERICMESSAGE message

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



GENERICMESSAGE::message
       Returns or sets values for messages in the generic message profile.

SYNOPSIS
       GENERICMESSAGE::message (len | length)

       GENERICMESSAGE::message (src | source | dst | dest | destination)
       (SRC_DST)?

       GENERICMESSAGE::message is_request (BOOLEAN)?

       GENERICMESSAGE::message data (DATA)?

       GENERICMESSAGE::message text (TEXT)?

       GENERICMESSAGE::message no_response (BOOLEAN)?

       GENERICMESSAGE::message create (CREATE_ARG1 (CREATE_ARG2)?)?

       GENERICMESSAGE::message status

       GENERICMESSAGE::message (reqseqnum | request_sequence_number)
       (NONNEGATIVE_INTEGER)?

DESCRIPTION
       The GENERICMESSAGE::message command returns or sets values from the
       current message being processed by the generic message profile.

       Syntax

       GENERICMESSAGE::message src []

	  * Returns (or sets) the message's source address.

	  Note: read/write in GENERICMESSAGE_INGRESS,MR_INGRESS. Read-Only in
	  GENERICMESSAGE_EGRESS,MR_EGRESS,MR_FAILED

       GENERICMESSAGE::message dst []

	  * Returns (or sets) the message's destination address.

	  Note: read/write in GENERICMESSAGE_INGRESS,MR_INGRESS. Read-Only in
	  GENERICMESSAGE_EGRESS,MR_EGRESS,MR_FAILED

       GENERICMESSAGE::message is_request [true OR false]

	  * Returns true if the message is a request message, or can manually
	    identify the message with the true/false flag

	  Note: read/write only in GENERICMESSAGE_INGRESS

       GENERICMESSAGE::message length

	  * Returns the message size in bytes.

       GENERICMESSAGE::message text []

	  * Returns (or sets) the message's text.

       GENERICMESSAGE::message data []

	  * Returns (or sets) the message data (as an array of bytes)

       GENERICMESSAGE::message no_response [true OR false]

	    * Returns true if the message is asynchronous. An asynchronous message
	      does not expect a response message to correspond with the message.
	    * Setting this attribute to "true" disables storing response routing information
	      in the pending request store (see request_sequence_number).

       GENERICMESSAGE::message create [ []]

	  * Creates a new empty message that can be sent. Once created a
	    TEXTMSG_INGRESS event shall be raised where the script writer will
	    be able to populate the message. Upon completion of the script, the
	    message will be forwarded for routing.

       GENERICMESSAGE::message drop 

	  * Terminates processing of the current message.

       GENERICMESSAGE::message status

	  * Returns the route status. Please see MR::message status

       GENERICMESSAGE::message request_sequence_number []

	  * Returns the request_sequence_number used to save the last hop of a
	    request message. This will be valid during GENERICMESSAGE_EGRESS of
	    request messages. During GENERICMESSAGE_INGRESS of response
	    messages, it will contain the sequence number of the oldest
	    un-responded request.
	  * Sets the request_sequence_number used to save the last hop of a
	    request message. During GENERICMESSAGE_INGRESS, setting this field
	    will allow associting a response message with an un-responded
	    request message and the request message's lasthop will be used as
	    the next hop for the message.

RETURN VALUE
VALID DURING
       GENERICMESSAGE_INGRESS, GENERICMESSAGE_EGRESS, MR_INGRESS, MR_EGRESS,
       MR_FAILED

EXAMPLES
	when CLIENT_DATA {
	    GENERICMESSAGE::message create "[TCP::payload]"
	    TCP::payload 0 [TCP::payload length] ""
	    TCP::release
	    TCP::collect
	}
	when GENERICMESSAGE_INGRESS {
	    GENERICMESSAGE::message src us
	    GENERICMESSAGE::message dst them
	}

	when GENERICMESSAGE_EGRESS {
	    GENERICMESSAGE::message data "[GENERICMESSAGE::message data] status: [GENERICMESSAGE::message status]"
	}

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



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