F5 Networks · Schema

TcpProfile

A TCP profile that defines how the BIG-IP processes TCP traffic, including connection settings, timeouts, and optimization.

API GatewayApplication DeliveryAutomationEdge ComputingKubernetesLoad BalancingMulti-CloudNGINXSecurityWAF

Properties

Name	Type	Description
kind	string
name	string
fullPath	string
generation	integer
selfLink	string
abc	string	Whether Appropriate Byte Counting is enabled.
ackOnPush	string	Whether to send ACK on PUSH flag.
closeWaitTimeout	integer	Timeout in seconds for CLOSE-WAIT state.
congestionControl	string	TCP congestion control algorithm.
defaultsFrom	string	Parent profile.
deferredAccept	string	Whether to defer connection acceptance.
description	string
finWaitTimeout	integer	Timeout in seconds for FIN-WAIT state.
idleTimeout	integer	Idle timeout in seconds. Connections idle longer than this value are closed.
initCwnd	integer	Initial TCP congestion window size.
initRwnd	integer	Initial TCP receive window size.
keepAliveInterval	integer	Interval in seconds between TCP keep-alive probes.
maxRetrans	integer	Maximum number of TCP retransmission attempts.
maxSegmentSize	integer	Maximum segment size (MSS) in bytes.
nagle	string	Nagle algorithm setting.
receiveWindowSize	integer	TCP receive window size in bytes.
sendBufferSize	integer	TCP send buffer size in bytes.
synMaxRetrans	integer	Maximum SYN retransmission attempts.
timeWaitRecycle	string	Whether to recycle TIME-WAIT connections.
timeWaitTimeout	integer	Timeout in milliseconds for TIME-WAIT state.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TcpProfile",
  "title": "TcpProfile",
  "type": "object",
  "description": "A TCP profile that defines how the BIG-IP processes TCP traffic, including connection settings, timeouts, and optimization.",
  "properties": {
    "kind": {
      "type": "string",
      "example": "tm:ltm:profile:tcp:tcpstate",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "example": "tcp"
    },
    "fullPath": {
      "type": "string",
      "readOnly": true,
      "example": "example_value"
    },
    "generation": {
      "type": "integer",
      "readOnly": true,
      "example": 10
    },
    "selfLink": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "example": "https://www.example.com"
    },
    "abc": {
      "type": "string",
      "description": "Whether Appropriate Byte Counting is enabled.",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "ackOnPush": {
      "type": "string",
      "description": "Whether to send ACK on PUSH flag.",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "closeWaitTimeout": {
      "type": "integer",
      "description": "Timeout in seconds for CLOSE-WAIT state.",
      "example": 10
    },
    "congestionControl": {
      "type": "string",
      "description": "TCP congestion control algorithm.",
      "enum": [
        "high-speed",
        "cdg",
        "chd",
        "cubic",
        "illinois",
        "new-reno",
        "none",
        "reno",
        "scalable",
        "vegas",
        "westwood",
        "woodside"
      ],
      "example": "high-speed"
    },
    "defaultsFrom": {
      "type": "string",
      "description": "Parent profile.",
      "example": "/Common/tcp"
    },
    "deferredAccept": {
      "type": "string",
      "description": "Whether to defer connection acceptance.",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "description": {
      "type": "string",
      "example": "A sample description."
    },
    "finWaitTimeout": {
      "type": "integer",
      "description": "Timeout in seconds for FIN-WAIT state.",
      "example": 10
    },
    "idleTimeout": {
      "type": "integer",
      "description": "Idle timeout in seconds. Connections idle longer than this value are closed.",
      "example": 10
    },
    "initCwnd": {
      "type": "integer",
      "description": "Initial TCP congestion window size.",
      "example": 10
    },
    "initRwnd": {
      "type": "integer",
      "description": "Initial TCP receive window size.",
      "example": 10
    },
    "keepAliveInterval": {
      "type": "integer",
      "description": "Interval in seconds between TCP keep-alive probes.",
      "example": 10
    },
    "maxRetrans": {
      "type": "integer",
      "description": "Maximum number of TCP retransmission attempts.",
      "example": 10
    },
    "maxSegmentSize": {
      "type": "integer",
      "description": "Maximum segment size (MSS) in bytes.",
      "example": 10
    },
    "nagle": {
      "type": "string",
      "description": "Nagle algorithm setting.",
      "enum": [
        "auto",
        "enabled",
        "disabled"
      ],
      "example": "auto"
    },
    "receiveWindowSize": {
      "type": "integer",
      "description": "TCP receive window size in bytes.",
      "example": 10
    },
    "sendBufferSize": {
      "type": "integer",
      "description": "TCP send buffer size in bytes.",
      "example": 10
    },
    "synMaxRetrans": {
      "type": "integer",
      "description": "Maximum SYN retransmission attempts.",
      "example": 10
    },
    "timeWaitRecycle": {
      "type": "string",
      "description": "Whether to recycle TIME-WAIT connections.",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "timeWaitTimeout": {
      "type": "integer",
      "description": "Timeout in milliseconds for TIME-WAIT state.",
      "example": 10
    }
  }
}