ltm rule command SCTP payload

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



SCTP::payload
       Returns or replaces SCTP data content.

SYNOPSIS
       SCTP::payload ( (PAYLOAD_LENGTH) |
			       (PAYLOAD_OFFSET PAYLOAD_LENGTH) |
			       (length) |
			       (sid (UNSIGNED_INT)? ) |
			       (ppi (UNSIGNED_INT)? ) |
			       (unordered (BOOLEAN)? ) |
			       (replace PAYLOAD_OFFSET PAYLOAD_LENGTH
       PAYLOAD_DATA) |
			       (insert	PAYLOAD_OFFSET PAYLOAD_DATA) |
			       (delete	PAYLOAD_OFFSET PAYLOAD_LENGTH )
			     )?

DESCRIPTION
       Returns the accumulated SCTP data content, or replaces collected
       payload with the specified data.

       SCTP::payload []
	   Returns the accumulated SCTP payload data content upto size bytes
       if provided.

       SCTP::payload  
	   Returns upto number_of_bytes bytes of the accumulated SCTP payload
       data content starting from the offset provided.

       SCTP::payload replace   
	   Replaces collected payload data with the given data, starting at
       offset.

       SCTP::payload length
	   Returns the amount of accumulated SCTP data content in bytes.

       SCTP::payload sid
	   Returns the stream id.

       SCTP::payload ppi
	   Returns the protocol payload identification.

       SCTP::unordered 
	   Returns or sets the value of the unordered delivery flag.
       SCTP::payload replace   
	   Replaces collected payload data with the given data, starting at
       offset.

       SCTP::payload insert  
	   Insert data at offset in payload.

       SCTP::payload delete  
	   Delete payload starting at offset for length, len.

RETURN VALUE
VALID DURING
EXAMPLES
	when CLIENT_ACCEPTED {
	  SCTP::collect 15
	}
	when CLIENT_DATA {
	  if { [SCTP::payload 15] contains "XYZ" } {
	     pool xyz_servers
	  } else {
	     pool web_servers
	 }
	 SCTP::release
	}

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



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