ltm rule command WS request

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



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

SYNOPSIS
       WS::request ('protocol' | 'extension' | 'version' | 'key' )

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

       WS::request extension
	   Returns the value of Sec-WebSocket-Extensions header field in
       client request.

       WS::request version
	   Returns the value of Sec-WebSocket-Version header field in client
       request.

       WS::request key
	   Returns the value of Sec-WebSocket-Key header field in client
       request.

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

VALID DURING
       WS_REQUEST

EXAMPLES
	when WS_REQUEST {
	    if { [WS::request protocol] equals "chat" } {
		WS::enabled false
	    }
	}

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



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