ltm rule command DIAMETER persist

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



DIAMETER::persist
       Returns the persistence key being used for the current message.

SYNOPSIS
       DIAMETER::persist (( (NEW_PERSIST_KEY)? (BI_DIRECTION)? ) |
				  ( reset ))

DESCRIPTION
       This iRule command returns the persistence key being used for the
       current message. If new persist key is provided, the existing
       persistence key will be replaced. The value of the new key MUST be the
       value of a valid AVP in the message. An AVP attribute name should not
       be given as the new key value.

       If bidirection is specified as false, disable(d), no, 0, or is
       unspecified, then persistence is not bidirectional. If bidirection is
       specified as true, enable(d), yes, or 1 this persistence entry is
       bidirectional.

       If the "reset" sub-command is used, the persistence record associated
       with the current message will be removed.

       When using this iRule command to set a persistence record, the
       associated diameter session profile must be configured with the
       attribute persist-type set to custom or else the iRule will fail.

       Syntax DIAMETER::persist [new-persist-key] [bidirection]
       DIAMETER::persist reset

RETURN VALUE
VALID DURING
       DIAMETER_INGRESS, MR_INGRESS

EXAMPLES
	when DIAMETER_INGRESS {
	    log local0. "Received a DIAMETER message, persistence key is [DIAMETER::persist]"
	}

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-12.0.0 --First introduced the command.  @BIGIP-13.0.0 --Added
       subcommand: reset



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