ltm rule command DIAMETER header

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

DIAMETER::header
       Gets or sets the DIAMETER header fields.

SYNOPSIS
       DIAMETER::header (
				   ( 'version'			       (UNSIGNED_CHAR)? ) |
				   ( ('rflag' | 'request-flag')        (BINARY)? ) |
				   ( ('pflag' | 'proxiable-flag')      (BINARY)? ) |
				   ( ('eflag' | 'error-flag')	       (BINARY)? ) |
				   ( ('tflag' | 'retransmitted-flag')  (BINARY)? ) |
				   ( 'flags'			       (UNSIGNED_CHAR)? ) |
				   ( 'appid'			       (UNSIGNED_INT)? ) |
				   ( 'hopid'			       (UNSIGNED_INT)? ) |
				   ( 'endid'			       (UNSIGNED_INT)? )
				)

DESCRIPTION
       This iRule command is used to get and set header fields in the current DIAMETER message.

       Syntax

       DIAMETER::header version [new-version]

	    * Get or set the version of this message.  This is an 8-octet
	      integer, from 0 to 255.

       DIAMETER::header rflag|request-flag [new-flag]

	    * Get or set the request indication flag of this
	      message.	Possible values are 1 (message is a request) and 0
	      (message is a response).

       DIAMETER::header pflag|proxiable-flag [newflag]

	    * Get or set the PROXIABLE flag of this message.  Possible values
	      are 1 (message may be relayed) and 0 (message must be locally
	      processed).  BIG-IP normally relays all messages regardless of
	      this flag\'s value.

       DIAMETER::header eflag|error-flag [newflag]

	    * get or set the ERROR flag of this message.  Possible values are
	      1 (message contains an error) and 0 (message is believed to be
	      well-formed).

       DIAMETER::header tflag|retransmitted-flag [newflag]

	    * get or set the POTENTIALLY RETRANSMITTED MESSAGE flag.
	      Possible values are 0 (first request) and 1 (message may have
	      been transmitted at least once already).

       DIAMETER::header flags [newflag]

	    * Get or set all flags.  This command updates or returns the
	      entire flags field, as a 1-octet integer.

       DIAMETER::header appid [newappid]

	    * Get or set the message\'s Application-ID.  This value is a
	      4-octet integer.

       DIAMETER::header hopid [newhopid]

	    * Get or set the message\'s hop-by-hop identifier.	This value is
	      a 4-octet integer.  This value can only be set in egress events
	      (DIAMETER_EGRESS, MR_EGRESS).

       DIAMETER::header endid [newendid]

	    * Get or set the message\'s end-to-end identifier.	This value is
	      a 4-octet integer.

RETURN VALUE
VALID DURING
       DIAMETER_INGRESS, DIAMETER_EGRESS, DIAMETER_RETRANSMISSION, MR_INGRESS, MR_EGRESS, MR_FAILED

EXAMPLES
	when DIAMETER_INGRESS {
	    if { [DIAMETER::header tflag] } {
		log local0. "Received a potentially retransmitted Diameter message"
	    }
	}

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

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