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
DESCRIPTION
Gets the persistence key for the current message.
DIAMETER::persist reset
DESCRIPTION
Clear any persistence record stored under the current message\'s persistence key.
DIAMETER::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.
DIAMETER::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.
DIAMETER::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.
DIAMETER::persist ignore
DESCRIPTION
Route the message using the route table. The results of the routing will not be stored in the persistence table.
DIAMETER::persist delete-none
DESCRIPTION
Do not delete the persistence record automatically upon completion of the transaction. This is the default action.
DIAMETER::persist delete-on-success
DESCRIPTION
The persistence record will be deleted upon successful completion of the transaction. The transaction complete delete
action should be specified when processing an answer response message.
DIAMETER::persist delete-on-failure
DESCRIPTION
The persistence record will be deleted upon unsuccessful completion of the transaction. The transaction complete delete
action should be specified when processing an answer response message.
DIAMETER::persist delete-on-any
DESCRIPTION
The persistence record will be deleted upon completion of the transaction. The transaction complete delete action should be
specified when processing an answer response message.
DIAMETER::persist timeout (VALUE)
DESCRIPTION
Sets or gets the persistence key timeout value. Modifying the persistence key timeout outside of DIMETER_INGRESS or
MR_INGRESS event has no effect on the persistence key timeout.
DIAMETER::persist bidirectional (BOOLEAN)?
DESCRIPTION
Sets of gets the persistence keys bidirectional persistence flag.
DIAMETER::persist direction ('detect' | 'forward' | 'reverse')?
DESCRIPTION
Sets of gets the persistence direction. If set to detect, the persist logic will determine if the message should be routed
to the destination of the persist record or the source of the persist record. If set to forward, the message will be routed
to the destination of the persistence record. If set to reverse, the message will be routed to the source of the
persistence record.
DIAMETER::persist (NEW_PERSIST_KEY)?
DESCRIPTION
Sets the persistence key for the current message. Modifying the persistence key outside of DIAMETER_REQUEST or MR_INGRESS
event has no effect of the persistence record used or modified when routing.
DIAMETER::persist (NEW_PERSIST_KEY) (BI_DIRECTION)?
DESCRIPTION
Sets the persistence key for the current message. Modifying the persistence key outside of DIAMETER_INGRESS or MR_INGRESS
event has no effect of the persistence record used or modified when routing.
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 @BIGIP-14.1.0 --Added subcommand:
use --Added subcommand: bypass --Added subcommand: replace --Added subcommand: ignore --Added subcommand: timeout --Added
subcommand: bidirectional @BIGIP-16.0.0 --Added subcommand: direction --Added subcommand: delete-none --Added subcommand:
delete-on-success --Added subcommand: delete-on-failure @BIGIP-17.0.0 --Added subcommand: delete-on-any
BIG-IP 2022-04-12 iRule(1)