ltm profile sctp
ltm profile sctp(1) BIG-IP TMSH Manual ltm profile sctp(1)
NAME
sctp - Configures a Stream Control Transmission Protocol (SCTP)
profile.
MODULE
ltm profile
SYNTAX
Configure the sctp component within the ltm profile module using the
syntax shown in the following sections.
CREATE
create sctp [name]
modify sctp [name]
options:
app-service [[string] | none]
cookie-expiration [integer]
defaults-from [name]
description [string]
heartbeat-interval [integer]
heartbeat-max-burst [integer]
idle-timeout [integer]
in-streams [integer]
init-max-retries [integer]
ip-tos [integer]
link-qos [integer]
max-burst [integer]
out-streams [integer]
proxy-buffer-high [integer]
proxy-buffer-low [integer]
receive-chunks [integer]
receive-ordered [disabled | enabled]
receive-window-size [integer]
reset-on-timeout [disabled | enabled]
secret [default | [string] ]
send-buffer-size [integer]
send-max-retries [integer]
send-partial [disabled | enabled]
tcp-shutdown [disabled | enabled]
transmit-chunks [integer]
edit sctp [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
mv sctp [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-folder [folder-name]] ]
options:
to-folder
reset-stats sctp
reset-stats sctp [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list sctp
list sctp [ [ [name] | [glob] | [regex] ] ... ]
show running-config sctp
show running-config sctp
[ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show sctp
show sctp [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
global
DELETE
delete sctp [name]
DESCRIPTION
You can use the sctp component to manage a profile for SCTP traffic.
EXAMPLES
create sctp my_sctp_profile defaults-from sctp
Creates a custom SCTP profile named my_sctp_profile that inherits its
settings from the system default SCTP profile.
list sctp all-properties
Displays all properties for all SCTP profiles.
mv sctp /Common/my_sctp_profile to-folder /Common/my_folder
Moves a custom sctp profile named my_sctp_profile to a folder named
my_folder, where my_folder has already been created and exists within
/Common.
OPTIONS
app-service
Specifies the name of the application service to which the profile
belongs. The default value is none. Note: If the strict-updates
option is enabled on the application service that owns the object,
you cannot modify or delete the profile. Only the application
service can modify or delete the profile.
cookie-expiration
Specifies how many seconds the cookie is valid. The default value
is 60 seconds.
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 sctp.
description
User defined description.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
heartbeat-interval
Specifies the number of seconds to wait before sending a heartbeat
chunk. The default value is 30 seconds.
heartbeat-max-burst
Specifies the number of heartbeat packets to be sent in a single
burst. The default value is 1.
idle-timeout
Specifies the number of seconds without traffic before a
connection is eligible for deletion. The default value is 300
seconds.
in-streams
Specifies the number of inbound streams. The default value is 2.
init-max-retries
Specifies the maximum number of retries to establish a connection.
The default value is 4.
ip-tos
Specifies the Type of Service (ToS) that is set in packets sent to
the peer. The default value is 0.
link-qos
Specifies the Link Quality of Service (QoS) that is set in sent
packets. The default value is 0.
name Specifies a unique name for the component. This option is required
for the commands create, delete, and modify.
out-streams
Specifies the number of outbound streams. The default value is 2.
partition
Displays the administrative partition within which the component
resides.
proxy-buffer-high
Specifies the proxy buffer level after which the system closes the
receive window. The default value is 16384.
proxy-buffer-low
Specifies the proxy buffer level after which the system opens the
receive window. The default value is 4096.
receive-chunks
Specifies the size (in chunks) of the rx_chunk buffer. The default
value is 256.
receive-ordered
When enabled, the default, the system delivers messages to the
application layer in order.
receive-window-size
Specifies the size (in bytes) of the receive window. Prorate this
value to the receive-chunks value. The default value is 65535.
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.
reset-on-timeout
When enabled, the default, the system resets the connection when
the connection times out.
secret
Specifies the internal secret string used for HTTP Message
Authenticated Code (HMAC) cookies.
send-buffer-size
Specifies the size in bytes of the buffer. The default value is
65536.
max-burst
Specifies the maximum number of data packets to send in a single
burst. The default value is 4.
send-max-retries
Specifies the maximum number of time the system tries again to
send the data. The default value is 8.
send-partial
When enabled, the default, the system accepts partial application
data.
tcp-shutdown
When enabled, the system emulates the closing of a TCP connection.
The default value is enabled.
to-folder
sctp profiles can be moved to any folder under /Common, but
configuration dependencies may restrict moving the profile out of
/Common.
transmit-chunks
Specifies the size of the tx_chunk buffer. The default value is
256.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, mv, 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-2010, 2012-2013, 2015. All
rights reserved.
BIG-IP 2015-07-22 ltm profile sctp(1)