slb template tcp

L4 TCP switch config

tcp Specification

Parameter Value
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
Partition Visibility shared
Schema tcp schema

Operations Allowed:

OperationMethodURIPayload

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 keep connection alive if active traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

del-session-on-server-down

Description Delete session if the server/port goes down (either disabled/hm down)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description send reset to client when server is disabled

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: disable and down are mutually exclusive

down

Description send reset to client when server is down

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: down and disable are mutually exclusive

force-delete-timeout

Description The maximum time that a session can stay in the system before being delete (number (second))

Type: number

Range: 1-31

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

force-delete-timeout-100ms

Description The maximum time that a session can stay in the system before being delete (number in 100ms)

Type: number

Range: 1-31

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

half-close-idle-timeout

Description TCP Half Close Idle Timeout (sec), default off (half close idle timeout in second, default off)

Type: number

Range: 60-120

half-open-idle-timeout

Description TCP Half Open Idle Timeout (sec), default off (half open idle timeout in second, default off)

Type: number

Range: 1-60

idle-timeout

Description Idle Timeout value (Interval of 60 seconds), default 120 seconds (idle timeout in second, default 120)

Type: number

Range: 1-2097151

Default: 120

initial-window-size

Description Set the initial window size (number)

Type: number

Range: 1-65535

insert-client-ip

Description Insert client ip into TCP option

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lan-fast-ack

Description Enable fast TCP ack on LAN

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

logging

Description ‘init’: init only log; ‘term’: termination only log; ‘both’: both initial and termination log;

Type: string

Supported Values: init, term, both

name

Description Fast TCP Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Default: default

proxy-header

Description: proxy-header is a JSON Block. Please see below for proxy-header

Type: Object

qos

Description QOS level (number)

Type: number

Range: 1-63

re-select-if-server-down

Description re-select another server if service port is down

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

reset-follow-fin

Description send reset to client or server upon receiving first fin

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

reset-fwd

Description send reset to server if error happens

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

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

proxy-header

Specification Value
Type object

proxy-header-action

Description ‘insert’: Insert proxy header;

Type: string

Supported Values: insert

proxy-header-version

Description ‘v1’: version 1; ‘v2’: version 2;

Type: string

Supported Values: v1, v2