ltm rule command SSL collect

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

SSL::collect
       Collect plaintext data after SSL offloading.

SYNOPSIS
       SSL::collect (LENGTH)?

DESCRIPTION
       Starts the collection of plaintext data either indefinitely or for the specified amount of data. On successful
       collection, the corresponding data event is triggered. For clientside collection, the CLIENTSSL_DATA event is
       triggered. For serverside collection, the SERVERSSL_DATA event is triggered.

RETURN VALUE
       SSL::collect []
	   Starts the collection of plaintext data either indefinitely or for the specified amount of data.
	   When is specified, the data event will not be triggered until that length has been collected.

VALID DURING
EXAMPLES
	when CLIENTSSL_HANDSHAKE {
	    log local0. "[IP::client_addr]:[TCP::client_port]: SSL handshake completed, collecting SSL payload"
	    SSL::collect
	}
	when CLIENTSSL_DATA {
	    log local0. "[IP::client_addr]:[TCP::client_port]: Collected bytes [SSL::payload length], releasing payload"
	    log local0. "\[SSL::payload\]: [SSL::payload]"
	    SSL::release
	}

	when SERVERSSL_HANDSHAKE {
	    SSL::collect
	}
	when SERVERSSL_DATA {
	    set payload [SSL::payload]
	}

HINTS
SEE ALSO
       DTLS Echo iRule  - DTLS Echo

CHANGE LOG
       @BIGIP-10.0.0 --First introduced the command.

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