slb template port¶
Port template
port Specification¶
Type Collection Object Key(s) name Collection Name port-list Collection URI /axapi/v3/slb/template/port Element Name port Element URI /axapi/v3/slb/template/port/{name} Element Attributes port_attributes Schema port schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/template/port | ||
Create List | POST | /axapi/v3/slb/template/port | ||
Get Object | GET | /axapi/v3/slb/template/port/{name} | ||
Get List | GET | /axapi/v3/slb/template/port | ||
Modify Object | POST | /axapi/v3/slb/template/port/{name} | ||
Replace Object | PUT | /axapi/v3/slb/template/port/{name} | ||
Replace List | PUT | /axapi/v3/slb/template/port | ||
Delete Object | DELETE | /axapi/v3/slb/template/port/{name} |
port-list¶
port-list is JSON List of port attributes
port-list : [
]
port attributes¶
add
Description Slow start connection limit add by a number every interval (Add by this number every interval)
Type: number
Range: 1-4095
Mutual Exclusion: add and times are mutually exclusive
bw-rate-limit
Description Configure bandwidth rate limit on real server port (Bandwidth rate limit in Kbps)
Type: number
Range: 1-16777216
bw-rate-limit-duration
Description Duration in seconds the observed rate needs to honor
Type: number
Range: 1-250
bw-rate-limit-no-logging
Description Do not log bandwidth rate limit related state transitions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
bw-rate-limit-resume
Description Resume server selection after bandwidth drops below this threshold (in Kbps) (Bandwidth rate limit resume threshold (in Kbps))
Type: number
Range: 1-16777216
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-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
dampening-flaps
Description service dampening flaps count (max-flaps allowed in flap period)
Type: number
Range: 1-255
decrement
Description Decrease after every round of DNS query (default is 0)
Type: number
Range: 0-7
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
dest-nat
Description Destination NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
down-grace-period
Description Port down grace period (Down grace period in seconds)
Type: number
Range: 1-86400
down-timer
Description The timer to bring the marked down server/port to up (default is 0, never bring up) (The timer to bring up server (in second, default is 0))
Type: number
Range: 0-255
Default: 0
dscp
Description Differentiated Services Code Point (DSCP to Real Server IP Mapping Value)
Type: number
Range: 1-63
dynamic-member-priority
Description Set dynamic member’s priority (Initial priority (default is 16))
Type: number
Range: 1-16
Default: 16
every
Description Slow start connection limit increment interval (default 10)
Type: number
Range: 1-60
Default: 10
extended-stats
Description Enable extended statistics on real server port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
flap-period
Description take service out of rotation if max-flaps exceeded within time in seconds
Type: number
Range: 1-255
health-check
Description Health Check Monitor (Health monitor name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: health-check and health-check-disable are mutually exclusive
Reference Object: /axapi/v3/health/monitor
health-check-disable
Description Disable configured health check configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-check are mutually exclusive
inband-health-check
Description Use inband traffic to detect port’s health status
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
initial-slow-start
Description Initial slow start connection limit (default 128)
Type: number
Range: 1-4095
Default: 128
name
Description Port template name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: default
no-ssl
Description No SSL
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
reassign
Description Maximum reassign times before declear the server/port down (default is 25) (The maximum reassign number)
Type: number
Range: 0-255
Default: 25
request-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
request-rate-limit
Description Request rate limit
Type: number
Range: 1-1048575
request-rate-no-logging
Description Do not log connection over limit event
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
resel-on-reset
Description When receiving reset from server, do the server/port reselection (default is 0, don’t do reselection)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
reset
Description Send client reset when connection rate over limit
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
restore-svc-time
Description put the service back to the rotation after time in seconds
Type: number
Range: 1-4095
resume
Description Resume accepting new connection after connection number drops below threshold (Connection resume threshold)
Type: number
Range: 1-1048575
retry
Description Maximum retry times before reassign this connection to another server/port (default is 2) (The maximum retry number)
Type: number
Range: 0-7
Default: 2
shared-partition-pool
Description Reference a NAT pool or pool-group from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-pool and source-nat are mutually exclusive
slow-start
Description Slowly ramp up the connection number after port is up
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
source-nat
Description Source NAT (IP NAT Pool or pool group name)
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: source-nat and shared-partition-pool are mutually exclusive
Reference Object: /axapi/v3/ip/nat/pool
stats-data-action
Description ‘stats-data-enable’: Enable statistical data collection for real server port; ‘stats-data-disable’: Disable statistical data collection for real server port;
Type: string
Supported Values: stats-data-enable, stats-data-disable
Default: stats-data-enable
sub-group
Description Divide service group members into different sub groups (Sub group ID (default is 0))
Type: number
Range: 0-15
Default: 0
template-port-pool-shared
Description Source NAT (IP NAT Pool or pool group name)
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/nat/pool
till
Description Slow start ends when slow start connection limit reaches a number (default 4096) (Slow start ends when connection limit reaches this number)
Type: number
Range: 1-65535
Default: 4096
times
Description Slow start connection limit multiply by a number every interval (default 2) (Multiply by this number every interval)
Type: number
Range: 2-10
Default: 2
Mutual Exclusion: times and add are mutually exclusive
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
weight
Description Weight (port weight)
Type: number
Range: 1-1000
Default: 1