slb template tcp

L4 TCP switch config: Configure TCP connection settings.

tcp Specification

Type Collection
Object Key(s) name
Collection Name tcp-list
Collection URI /axapi/v3/slb/template/tcp/
Element Name tcp
Element URI /axapi/v3/slb/template/tcp/{name}
Element Attributes tcp_attributes
Schema tcp schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/slb/template/tcp/

tcp Attributes

Create List

POST

/axapi/v3/slb/template/tcp/

tcp Attributes

Get Object

GET

/axapi/v3/slb/template/tcp/{name}

tcp Attributes

Get List

GET

/axapi/v3/slb/template/tcp/

tcp-list

Modify Object

POST

/axapi/v3/slb/template/tcp/{name}

tcp Attributes

Replace Object

PUT

/axapi/v3/slb/template/tcp/{name}

tcp Attributes

Replace List

PUT

/axapi/v3/slb/template/tcp/

tcp-list

Delete Object

DELETE

/axapi/v3/slb/template/tcp/{name}

tcp Attributes

tcp-list

tcp-list is JSON List of tcp Attributes

tcp-list : [

tcp Attributes

alive-if-active

Description: Quickly terminates half-open TCP sessions on the virtual port while allowing active sessions to continue without being terminated.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

force-delete-timeout

Description: Specifies the maximum number of seconds a session can remain active, and forces deletion of any session that is still active after the specified number of seconds.

Type: number

Range: 1-31

Mutual Exclusion: force-delete-timeout and force-delete-timeout-100ms are mutually exclusive

force-delete-timeout-100ms

Description: Specifies the maximum number of milliseconds a session can remain active, and forces deletion of any session that is still active after the specified number of milliseconds.

Type: number

Range: 1-31

Mutual Exclusion: force-delete-timeout-100ms and force-delete-timeout are mutually exclusive

half-close-idle-timeout

Description: Enables aging of half-closed TCP sessions. A half-closed TCP session is a session in which the server sends a FIN but the client does not reply with an ACK.

Type: number

Range: 60-120

half-open-idle-timeout

Description: Enables aging of half-open TCP sessions. A half-open TCP session is one in which the client receives a SYN-ACK, but does not reply with an ACK.

Type: number

Range: 1-60

idle-timeout

Description: Specifies the number of seconds a connection can remain idle before the ACOS device terminates it. If you specify 31 seconds or higher, ACOS rounds up to the next multiple of 60 seconds.

Type: number

Range: 1-2097151

Default: 120

initial-window-size

Description: Sets the initial TCP window size in SYN ACK packets to clients. The TCP window size in a SYN ACK or ACK packet specifies the amount of data that a client can send before it needs to receive an ACK.

The initial TCP window size applies only to the SYN ACKs sent to the client. After the SYN ACK, the ACOS device does not modify the TCP window size for any other packets in the session.

Type: number

Range: 1-65535

insert-client-ip

Description: Places the client IP address into a TCP option field of type 0x1c, with a length of 6 bytes.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lan-fast-ack

Description: Increases performance of bidirectional peer sessions by acknowledging receipt of data on behalf of clients and servers.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description: Template name.

Type: string

Format: string-rlx

Default: default

Required: Yes

qos

Description: Marks the DSCP (Layer 3) and 802.1p priority (Layer 2) values in client-server SLB traffic. Based on the value you specify, ACOS marks the traffic as follows:

  • Layer 3 marking – ACOS sets the The Diffserv Control Point (DSCP) value in the IP header to value you specify.
  • Layer 2 marking – ACOS sets the 802.1p value in the MAC header to the value you specify, divided by 9.

Type: number

Range: 1-63

reset-fwd

Description: This option is useful for small, fast transactions for which the completion time of sessions is guaranteed. When used in combination with the reset-fwd and reset-rev options, the force-delete-timeout option can help clean up user connections with RSTs instead of allowing the connections to hang.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

reset-rev

Description: send reset to client if error happens

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string