ltm rule command WS enabled

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



WS::enabled
       This command can be used to turn off WebSocket processing. If called
       without parameters, it returns the current state of Websockets, whether
       the processing is turned on or off for this particular connection.

SYNOPSIS
       WS::enabled ( 'false' )?

DESCRIPTION
       WS::enabled
	   This can be used to determine whether the Websocket processing is
       enabled or disabled for a particular connection.

       WS::enabled false
	   This can be used to disable the Websocket processing for a
       particular connection.

RETURN VALUE
       WS::enabled command returns TRUE if Websocket processing is enabled for
       a particular connection, FALSE otherwise.

VALID DURING
       WS_REQUEST WS_RESPONSE HTTP_REQUEST HTTP_RESPONSE

EXAMPLES
	when WS_REQUEST {
	    WS::enabled false
	    log local0. "Websocket state: [WS::enabled]"
	}
	when WS_RESPONSE {
	    WS::enabled false
	    log local0. "Websocket state: [WS::enabled]"
	}
	when HTTP_REQUEST {
	    WS::enabled false
	}

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



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