slb template tcp-proxy¶
TCP Proxy
tcp-proxy Specification¶
Type Collection Object Key(s) name Collection Name tcp-proxy-list Collection URI /axapi/v3/slb/template/tcp-proxy Element Name tcp-proxy Element URI /axapi/v3/slb/template/tcp-proxy/{name} Element Attributes tcp-proxy_attributes Schema tcp-proxy schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/template/tcp-proxy | ||
Create List | POST | /axapi/v3/slb/template/tcp-proxy | ||
Get Object | GET | /axapi/v3/slb/template/tcp-proxy/{name} | ||
Get List | GET | /axapi/v3/slb/template/tcp-proxy | ||
Modify Object | POST | /axapi/v3/slb/template/tcp-proxy/{name} | ||
Replace Object | PUT | /axapi/v3/slb/template/tcp-proxy/{name} | ||
Replace List | PUT | /axapi/v3/slb/template/tcp-proxy | ||
Delete Object | DELETE | /axapi/v3/slb/template/tcp-proxy/{name} |
tcp-proxy-list¶
tcp-proxy-list is JSON List of tcp-proxy attributes
tcp-proxy-list : [
]
tcp-proxy attributes¶
ack-aggressiveness
Description ‘low’: Delayed ACK; ‘medium’: Delayed ACK, with ACK on each packet with PUSH flag; ‘high’: ACK on each packet;
Type: string
Supported Values: low, medium, high
Default: low
alive-if-active
Description keep connection alive if active traffic
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
backend-wscale
Description The TCP window scale used for the server side, default is off (number)
Type: number
Range: 1-14
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
disable-abc
Description Appropriate Byte Counting RFC 3465 Disabled, default is enabled (Appropriate Byte Counting (ABC) is enabled by default)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable-sack
Description disable Selective Ack Option
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable-tcp-timestamps
Description disable TCP Timestamps Option
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable-window-scale
Description disable TCP Window-Scale Option
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
dynamic-buffer-allocation
Description Optimally adjust the transmit and receive buffer sizes of TCP proxy while keeping their sum constant
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
early-retransmit
Description Configure the Early-Retransmit Algorithm (RFC 5827) (Early-Retransmit is disabled by default)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
fin-timeout
Description FIN timeout (sec), default is disabled (number)
Type: number
Range: 1-60
force-delete-timeout
Description The maximum time that a session can stay in the system before being deleted, default is off (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 deleted, default is off (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 is off (cmd is deprecated, use fin-timeout instead) (number)
Type: number
Range: 60-120
half-open-idle-timeout
Description TCP Half Open Idle Timeout (sec), default is off (number)
Type: number
Range: 1-60
idle-timeout
Description Idle Timeout (Interval of 60 seconds), default is 600 (idle timeout in second, default 600)
Type: number
Range: 1-2097151
Default: 600
init-cwnd
Description The initial congestion control window size (packets), default is 10 (init-cwnd in packets, default 10)
Type: number
Range: 1-15
Default: 10
initial-window-size
Description Set the initial window size, default is off (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
invalid-rate-limit
Description Invalid Packet Response Rate Limit (ms), default is 500 (number default 500 challenges)
Type: number
Range: 0-60000000
Default: 500
keepalive-interval
Description Interval between keepalive probes (sec), default is off (number (seconds))
Type: number
Range: 60-12000
keepalive-probes
Description Number of keepalive probes sent, default is off
Type: number
Range: 2-10
limited-slowstart
Description RFC 3742 Limited Slow-Start for TCP with Large Congestion Windows (number)
Type: number
Range: 0-2147483647
Default: 0
maxburst
Description The max packet count sent per transmission event (number)
Type: number
Range: 1-100
Default: 25
min-rto
Description The minmum retransmission timeout, default is 200ms (number)
Type: number
Range: 100-1000
Default: 200
mss
Description Responding MSS to use if client MSS is large, default is off (number)
Type: number
Range: 128-9000
Default: 1460
nagle
Description Enable Nagle Algorithm
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
naked-ack-on-handshake
Description Send naked ack before data during 3-way handshake
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description TCP Proxy 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
psh-flag-optimization
Description Enable Optimized PSH Flag Use
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
qos
Description QOS level (number)
Type: number
Range: 1-63
reassembly-limit
Description The reassembly queuing limit, default is 25 segments (number)
Type: number
Range: 1-500
Default: 25
reassembly-timeout
Description The reassembly timeout, default is 30sec (number)
Type: number
Range: 1-300
Default: 30
receive-buffer
Description TCP Receive Buffer (default 200k) (number default 200000 bytes)
Type: number
Range: 1-2147483647
Default: 200000
reno
Description Enable Reno Congestion Control Algorithm
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
retransmit-retries
Description Number of Retries for Retransmit, default is 5
Type: number
Range: 1-20
Default: 5
server-down-action
Description ‘FIN’: FIN Connection; ‘RST’: Reset Connection;
Type: string
Supported Values: FIN, RST
syn-retries
Description SYN Retry Numbers, default is 5
Type: number
Range: 1-20
Default: 5
timewait
Description Timewait Threshold (sec), default 5 (number)
Type: number
Range: 1-60
Default: 5
transmit-buffer
Description TCP Transmit Buffer (default 200k) (number default 200000 bytes)
Type: number
Range: 1-2147483647
Default: 200000
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 Type object proxy-header-action
Description ‘insert’: Insert proxy header;
Type: string
Supported Values: insert
version
Description ‘v1’: version 1; ‘v2’: version 2;
Type: string
Supported Values: v1, v2