ltm rule command WS response

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



WS::response
       This command returns the values of the various Websocket header fields
       seen in a server response. Based on the values of the various Websocket
       header fields seen in a server response and accessed using this
       command, if desired Websocket processing can be disabled.

SYNOPSIS
       WS::response ('protocol' | 'extension' | 'version' | 'key' | 'valid' )

DESCRIPTION
       WS::response protocol
	   Returns the value of Sec-WebSocket-Protocol header field in server
       response.

       WS::response extension
	   Returns the value of Sec-WebSocket-Extensions header field in
       server response.

       WS::response version
	   Returns the value of Sec-WebSocket-Version header field in server
       response.

       WS::response key
	   Returns the value of Sec-WebSocket-Accept header field in server
       response.

       WS::response valid
	   Returns whether the client request and server response resulted in
       a successful Websocket upgrade.

RETURN VALUE
       This command can be used to lookup the values of various Websocket
       header fields seen in a server response.

VALID DURING
       WS_RESPONSE

EXAMPLES
	when WS_RESPONSE {
	    if { [WS::response key] equals "s3pPLMBiTxaQ9kYGzzhZRbK+xOo="} {
		WS::enabled false
	    }
	}

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



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