ltm rule command MR return

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

MR::return
       Returns the current message to the originating connection.

SYNOPSIS
       MR::return

   DESCRIPTION
       Returns the current message to the originating connection with a route status of 'returned by irule'

       MR::return (no_route_found | queue_full | no_connection | connection_closing | internal_error |
       max_retries_exceeded )

   DESCRIPTION
       Returns the current message to the originating connection and sets the route status to the route status
       specified.

DESCRIPTION
       The MR::return command instructs the Message Routing Framework to return the current message to the
       originating connection. The message's route status will be updated to 'returned by irule' or the provided
       route status. When the connection is received on the originating connection, MR_FAILED event will be raised.

RETURN VALUE
VALID DURING
       MR_EGRESS

EXAMPLES
	when MR_EGRESS {
	    if {[DIAMETER::is_request]} {
		if {$pend_req > 100} {
		    MR::return queue_full
		} {
		    incr pend_req
		}
	    }
	}
	when MR_INGRESS {
	    if {[DIAMETER::is_response]} {
		incr pend_req -1
	    }
	}

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

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