APIRef_tm_ltm_profile_sctpΒΆ

mgmt/tm/ltm/profile/sctp

/tm/ltm/profile

Virtual server SCTP traffic profile configuration

REST Endpoints

Collection URI
/mgmt/tm/ltm/profile/sctp
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/ltm/profile/sctp/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write The application service to which the object belongs.
clientSideMultihoming string disabled optional read/write  
cookieExpiration integer 60 optional read/write Specifies how many seconds the cookie is valid. The default value is 60 seconds.
defaultsFrom string   optional read/write 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.
description string   optional read/write User defined description.
heartbeatInterval integer 30 optional read/write Specifies the number of seconds to wait before sending a heartbeat chunk. The default value is 30 seconds.
heartbeatMaxBurst integer 1 optional read/write Specifies the maximum number of heartbeat packets sent in a single burst.The default value is 1.
idleTimeout integer 300 optional read/write Specifies the number of seconds without traffic before a connection is eligible for deletion. The default value is 300 seconds.
inStreams integer 2 optional read/write Specifies the number of inbound streams. The default value is 2.
initMaxRetries integer 8 optional read/write Specifies the maximum number of retries to establish a connection. The default value is 4.
ipTos string 0 optional read/write Specifies the type of IP service set in packets sent to peer. The default value is 0.
linkQos string 0 optional read/write Specifies the link quality of service set in sent packets. The default value is 0.
maxBurst integer 4 optional read/write Specifies the maximum number of data packets sent in a single burst.The default value is 4.
maxCommunicationPaths integer 16 optional read/write  
maxPathRetransmitLimit integer 5 optional read/write  
outStreams integer 2 optional read/write Specifies the number of outbound streams. The default value is 2.
tmPartition string Common optional read/write Displays the administrative partition within which this profile resides.
proxyBufferHigh integer 16384 optional read/write Specifies the proxy buffer level after which the system closes the receive window. The default value is 16384.
proxyBufferLow integer 4096 optional read/write Specifies the proxy buffer level after which the system opens the receive window. The default value is 4096.
receiveChunks integer 256 optional read/write Specifies the size (in chunks) of the rx_chunk buffer. The default value is 256.
receiveOrdered string   optional read/write When enabled, the system delivers messages to the application layer in order. The default value is enabled.
receiveWindowSize integer   optional read/write Specifies the size (in bytes) of the receive window. Prorate this value to the Receive Chunks value. The default value is 65536.
resetOnTimeout string   optional read/write When enabled, the default, the system resets a connection when the connection times out.
secret string   optional read/write Specifies the internal secret string that the system uses for HTTP Message Authenticated Code (HMAC) cookies.
sendBufferSize integer   optional read/write Specifies the size in bytes of the buffer. The default value is 65536.
sendMaxRetries integer 10 optional read/write Specifies the maximum number of times the system tries again to send data. The default value is 8.
sendPartial string   optional read/write When enabled, the default, the system accepts partial application data.
serverSideMultihoming string disabled optional read/write  
tcpShutdown string   optional read/write When enabled, the default, the system emulates the closing of a TCP connection.
transmitChunks integer 256 optional read/write Specifies the size (in chunks) of the tx_chunk buffer. The default value is 256.

Lists

Name Type Default Value Required Access Description
alternateAddresses (ltm/virtual-address) array_structure   optional read/write  
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.