ltm rule command SIP persist

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



SIP::persist
       Returns or replaces the persistence key being used for the current
       message.

SYNOPSIS
       SIP::persist

   DESCRIPTION
       Gets the persistence key for the current message.

       SIP::persist reset

   DESCRIPTION
       Clear any persistence record stored under the current message's
       persistence key.

       SIP::persist use

   DESCRIPTION
       Use the current persistence record for routing the message if present.
       If not present, route the message using the route table. On completion
       of routing, add a new persistence record if one does not exist. If an
       existing persistence record exists, replace the message's selected
       route with the destination stored in the persistence entry.

       SIP::persist replace

   DESCRIPTION
       Route the message using the route table. On completion of routing, add
       a new persistence record if one does not exist. If an existing
       persistence record exists, replace the persistence record with the
       route selected.

       SIP::persist bypass

   DESCRIPTION
       Route the message using the route table. On completion of routing, add
       a new persistence record if one does not exist. If an existing
       persistence record exists, it will be left unchanged.

       SIP::persist ignore

   DESCRIPTION
       Route the message using the route table. The results of the routing
       will not be stored in the persistence table.

       SIP::persist (PERSIST_KEY)?

   DESCRIPTION
       Sets the persistence key for the current message. Modifying the
       persistence key outside of SIP_REQUEST or MR_INGRESS event has no
       effect of the persistence record used or modified when routing.

       SIP::persist (PERSIST_KEY) (VALUE)?

   DESCRIPTION
       Sets the persistence key and if the second argument is present, its
       value set the persistence key timeout value. Modifying the persistence
       key outside of SIP_REQUEST or MR_INGRESS event has no effect of the
       persistence record used or modified when routing.

DESCRIPTION
       The SIP::persist command returns the persistence key being used for the
       current message. If new-persist-key is provided, the existing
       persistence key is replaced. The value of the new-persist-key MUST be
       one of valid header value in the message. A header name should not be
       given as the new-persist-key value.  Only valid for MRF SIP (sipsession
       profile) in 11.6+

       Syntax

       SIP::persist [new-persist-key]

RETURN VALUE
VALID DURING
       SIP_REQUEST, SIP_RESPONSE, SIP_REQUEST_SEND, SIP_RESPONSE_SEND,
       MR_INGRESS, MR_EGRESS, MR_FAILED

EXAMPLES
	when SIP_REQUEST {
	    SIP::persist "[SIP::uri]-[SIP::from]-[SIP::to]"
	}

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



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