slb template virtual-port¶

Virtual port template

virtual-port Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name virtual-port-list

Collection URI /axapi/v3/slb/template/virtual-port

Element Name virtual-port

Element URI /axapi/v3/slb/template/virtual-port/{name}

Element Attributes virtual-port_attributes

Partition Visibility shared

Schema virtual-port schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/slb/template/virtual-port	virtual-port attributes
POST /axapi/v3/slb/template/virtual-port/ Payload: { "virtual-port": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/slb/template/virtual-port	virtual-port attributes
Get Object	GET	/axapi/v3/slb/template/virtual-port/{name}	virtual-port attributes
GET /axapi/v3/slb/template/virtual-port/a Reponse: { "virtual-port": { "name": "a", "aflow": 0, "allow-syn-otherflags": 0, "conn-limit": 64000000, "conn-limit-reset": 0, "conn-limit-no-logging": 0, "allow-vip-to-rport-mapping": 0, "drop-unknown-conn": 0, "reset-unknown-conn": 0, "reset-l7-on-failover": 0, "ignore-tcp-msl": 0, "snat-port-preserve": 0, "non-syn-initiation": 0, "uuid": "aab92a4c-5080-11ee-98ee-fbe362803b33", "user-tag": "a", "a10-url": "/axapi/v3/slb/template/virtual-port/a" } }
Get List	GET	/axapi/v3/slb/template/virtual-port	virtual-port-list
Modify Object	POST	/axapi/v3/slb/template/virtual-port/{name}	virtual-port attributes
Replace Object	PUT	/axapi/v3/slb/template/virtual-port/{name}	virtual-port attributes
PUT /axapi/v3/slb/template/virtual-port/a Payload: { "virtual-port": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/slb/template/virtual-port	virtual-port-list
Delete Object	DELETE	/axapi/v3/slb/template/virtual-port/{name}	virtual-port attributes
DELETE /axapi/v3/slb/template/virtual-port/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

virtual-port-list¶

virtual-port-list is JSON List of virtual-port attributes

virtual-port-list : [

{ virtual-port attributes },

{ virtual-port attributes },

…

]

virtual-port attributes¶

aflow

Description Use aFlow to eliminate the traffic surge

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allow-syn-otherflags

Description Allow initial SYN packet with other flags

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allow-vip-to-rport-mapping

Description Allow mapping of VIP to real port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

conn-limit

Description Connection limit

Type: number

Range: 1-64000000

Default: 64000000

conn-limit-no-logging

Description Do not log connection over limit event

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

conn-limit-reset

Description Send client reset when connection over limit

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

conn-rate-limit

Description Connection rate limit

Type: number

Range: 1-1048575

conn-rate-limit-no-logging

Description Do not log connection over limit event

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

conn-rate-limit-reset

Description Send client reset when connection rate over limit

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

drop-unknown-conn

Description Drop conection if receives TCP packet without SYN or RST flag and it does not belong to any existing connections

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dscp

Description Differentiated Services Code Point (DSCP to Real Server IP Mapping Value)

Type: number

Range: 1-63

ignore-tcp-msl

Description reclaim TCP resource immediately without MSL

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log-options

Description ‘no-logging’: Do not log over limit event; ‘no-repeat-logging’: log once for over limit event. Default is log once per minute;

Type: string

Supported Values: no-logging, no-repeat-logging

name

Description Virtual port template name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Default: default

non-syn-initiation

Description Allow initial TCP packet to be non-SYN

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pkt-rate-interval

Description ‘100ms’: Source IP and port rate limit per 100ms; ‘second’: Source IP and port rate limit per second (default);

Type: string

Supported Values: 100ms, second

Default: second

pkt-rate-limit-reset

Description send client-side reset (reset after packet limit)

Type: number

Range: 0-1048575

Default: 0

pkt-rate-type

Description ‘src-ip-port’: Source IP and port rate limit; ‘src-port’: Source port rate limit;

Type: string

Supported Values: src-ip-port, src-port

rate

Description Source IP and port rate limit (Packet rate limit)

Type: number

Range: 1-1048575

rate-interval

Description ‘100ms’: Use 100 ms as sampling interval; ‘second’: Use 1 second as sampling interval;

Type: string

Supported Values: 100ms, second

Default: second

reset-l7-on-failover

Description Send reset to L7 client and server connection upon a failover

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

reset-unknown-conn

Description Send reset back if receives TCP packet without SYN or RST flag and it does not belong to any existing connections

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

snat-msl

Description Source NAT MSL (Source NAT MSL value (seconds))

Type: number

Range: 1-1800

snat-port-preserve

Description Source NAT Port Preservation

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

when-rr-enable

Description Only do rate limit if CPU RR triggered

Type: boolean

Supported Values: true, false, 1, 0

Default: 0