ltm profile websocket
ltm profile websocket(1) BIG-IP TMSH Manual ltm profile websocket(1)
NAME
websocket - Configures a WebSocket protocol profile.
MODULE
websocket profile
SYNTAX
Configure the websocket component within the ltm profile module using the syntax shown in the following
sections.
CREATE/MODIFY
create websocket [name]
modify websocket [name]
options:
masking [preserve | unmask | remask | selective]
compress-mode [preserved | typed]
compression [enabled | disabled]
window-bits [integer]
no-delay [enabled | disabled]
edit websocket [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
mv websocket [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-
folder [folder-name]] ]
options:
to-folder
reset-stats websocket
reset-stats websocket [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list websocket
list websocket [ [ [name] | [glob] | [regex] ] ... ]
show running-config websocket
show running-config websocket [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show websocket
show websocket [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
global
DELETE
delete websocket [name]
DESCRIPTION
Use this command to create, modify, display, or delete a WebSocket profile.
EXAMPLES
create websocket my_websocket_profile defaults-from websocket
OPTIONS
masking
Specifies the masking operation for WebSocket frames.
preserve
Maintains the mask of the packet received from the client.
unmask
Removes the mask from the packet and remasks it using the same mask when sending the traffic to the
server.
remask
Removes the mask received from the client and the system generates a new, random mask when sending
the traffic to the server.
selective
Preserves the mask of the packet received, and makes no changes unless an Application Security
Policy is associated with the virtual server.
compress-mode
Specifies the mode that controls what compression operations are performed. The default value is
preserved.
preserved
No compression or decompression operations are performed in this mode.
typed
The compression parameter controls whether compression is negotiated with the endpoint. Compressed
data received from the endpoint is decompressed thereby enabling security policies to take actions
on cleartext data. Data maybe recompressed before being masked and sent on the wire.
= over 5
compression
Specifies whether compression will be negotiated with the endpoint. The default value is enabled.
window-bits
Specifies the maximum sliding window for compression negotiated with the endpoint. The default value
is 10.
no-delay
Specifies whether data should be buffered for efficient compression, or compressed without delay.
The default value is enabled.
= back
defaults-from
Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings
and values from the parent profile specified. The default value is none.
description
User defined description.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
name Specifies a unique name for the component. This option is required for the commands create, delete, and
modify.
regex
Displays the items that match the regular expression. The regular expression must be preceded by an at
sign (@[regular expression]) to indicate that the identifier is a regular expression. See help regex for
a description of regular expression syntax.
SEE ALSO
create, delete, edit, glob, list, ltm profile fasthttp, ltm virtual, modify, regex, reset-stats, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2011, 2013-2016. All rights reserved.
BIG-IP 2019-03-29 ltm profile websocket(1)