slb template port

Configure a template of SLB settings for ports on real servers.

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 schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/slb/template/port/

port Attributes

Create List

POST

/axapi/v3/slb/template/port/

port Attributes

Get Object

GET

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

port Attributes

Get List

GET

/axapi/v3/slb/template/port/

port-list

Modify Object

POST

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

port Attributes

Replace Object

PUT

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

port Attributes

Replace List

PUT

/axapi/v3/slb/template/port/

port-list

Delete Object

DELETE

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

port Attributes

port-list

port-list is JSON List of port Attributes

port-list : [

port Attributes

add

Description: Specifies the amount by which to increase the maximum number of concurrent connections allowed within slow start.

Type: number

Range: 1-4095

Mutual Exclusion: add and times are mutually exclusive

conn-limit

Description: Specifies the maximum number of connections allowed on ports that use this template.

Type: number

Range: 1-8000000

Default: 8000000

conn-limit-no-logging

Description: Disables logging for the feature.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

conn-rate-limit

Description: Limits the rate of new connections the ACOS device is allowed to send to ports that use this template. When a real port reaches its rate limit, the ACOS device stops selecting the port to serve client requests.

Type: number

Range: 1-1048575

conn-rate-limit-no-logging

Description: Disables logging for the feature.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

decrement

Description: Specifies how much to decrement Time to live (TTL) if the IP address is not included in the DNS reply. When configuring the service group, add the port template to the member.

Type: number

Range: 0-7

Default: 0

dest-nat

Description: Enables destination Network Address Translation (NAT) on ports that use this template.
Destination NAT is enabled by default, but is automatically disabled in Direct Server Return (DSR) configurations. You can re-enable destination NAT on individual ports for deployment of mixed DSR configurations, which use backup servers across Layer 3 (in different subnets).

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

down-grace-period

Description: Specifies the number of seconds the ACOS device will continue to forward packets to a Down port. This option is useful for taking servers down for maintenance without immediately impacting existing sessions on the servers.

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: Sets the differentiated services code point (DSCP) value in the IP header of a client request before sending the request to ports that use this template.

Type: number

Range: 1-63

dynamic-member-priority

Description: Configures service-group priority settings for ports on dynamically created servers. Set the initial Time to live (TTL) for dynamically created service-group members.

Type: number

Range: 1-16

Default: 16

every

Description: Specifies the number of seconds between each increase of the number of concurrent connections allowed. For example, if the ramp-up interval is 10 seconds, the number of concurrent connections to allow is increased every 10 seconds.

Type: number

Range: 1-60

Default: 10

extended-stats

Description: Enables collection of SLB peak connection statistics for the port.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

health-check

Description: Specifies the name of a configured health monitor. Enables health monitoring of ports that use this template. If you omit this command or you enter it without the monitor-name option, the default TCP or UDP health monitor is used:

  • TCP – Every 30 seconds, the ACOS device sends a connection request (TCP SYN) to the specified TCP port on the server. The port passes the health check if the server replies to the ACOS device by sending a TCP SYN ACK.
  • UDP – Every 30 seconds, the ACOS device sends a packet with a valid UDP header and a garbage payload to the UDP port. The port passes the health check if the server either does not reply, or replies with any type of packet except an ICMP Error message.

Type: string

Mutual Exclusion: health-check and health-check-disable are mutually exclusive

Reference Object: /axapi/v3/health/monitor

health-check-disable

Description: Disables health monitoring of ports that use this template.

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: Supplements the standard Layer 4 health checks by using client-server traffic to check the health of service ports.
A10 Networks recommends that you continue to use standard Layer 4 health monitoring even if you enable in-band health monitoring. Without standard health monitoring, a server port marked down by an in-band health check remains down.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

initial-slow-start

Description: Specifies the maximum number of concurrent connections to allow on the service port after it first comes up.

Type: number

Range: 1-4095

Default: 128

name

Description: Template name.

Type: string

Format: string-rlx

Default: default

Required: Yes

no-ssl

Description: Disables SSL for server-side connections. This command is useful if a server-SSL template is bound to the virtual port that uses this real port, and you want to disable encryption on this real port.

Encryption is disabled by default, but it is enabled for server-side connections when the real port is used by a virtual port that is bound to a server-SSL template.

Using the double-negative form of the command (no no-ssl) enables SSL for server-side connections.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rate-interval

Description: Specifies whether the connection rate limit applies to one-second intervals or 100-ms intervals.

Type: string

Supported Values: 100ms, second

Default: second

reassign

Description: Specifies the real port with its own reassign counter. Each time the retry counter for any session is exceeded, the ACOS device increments the reassign counter for the server port. If the reassign counter exceeds the configured maximum number of reassignments allowed, the ACOS device marks the port down.

In this case, the port remains down until the next time the port successfully passes a standard health check. Once the port passes a standard health check, the ACOS device starts using the port again and resets the reassign counter to 0.

Type: number

Range: 0-255

Default: 25

request-rate-interval

Description: Interval for the rate up to the number of new connection requests allowed per one-tenth second (100-ms) or per one second.

Type: string

Supported Values: 100ms, second

Default: second

request-rate-limit

Description: Limits the rate of new requests that can be received by the virtual port.

Type: number

Range: 1-1048575

request-rate-no-logging

Description: Disables logging for this feature.

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: Sends a RST to a client that sends a new request during an interval in which the request rate has been exceeded. By default, requests that are received after the limit is exceeded are dropped with no RST.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

resume

Description: Specifies the threshold of, number of connections at or below which connections can resume provided the connection-limit was encountered first.

Type: number

Range: 1-1048575

retry

Description: Specifies each client-server session with its own retry counter. The ACOS device increments a session’s retry counter each time a SYN ACK is late. If the retry counter exceeds the configured maximum number of retries allowed, the ACOS device sends the next SYN for the session to a different server. The ACOS device also resets the retry counter to 0.

Type: number

Range: 0-7

Default: 2

slow-start

Description: Provides time for real ports that use the template to ramp-up after TCP/UDP service is enabled, by temporarily limiting the number of new connections on the ports.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

source-nat

Description: Specifies the IP NAT pool to use for assigning source IP addresses to client traffic sent to ports that use this template. When the ACOS device performs NAT for a port that is bound to the template, the device selects an IP address from the pool.

Type: string

stats-data-action

Description: Disables or enables statistical data collection for ports that use this template.

Type: string

Supported Values: stats-data-enable, stats-data-disable

Default: stats-data-enable

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: Specifies the scale factor number by which to multiply the starting connection limit. For example, if the scale factor is 2 and the starting connection limit is 128, the ACOS device increases the connection limit to 256 after the first ramp-up interval.

As an alternative to specifying a scale factor, you can instead specify how many more concurrent connections to allow.

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

uuid

Description: uuid of the object

Type: string

weight

Description: Specifies the load-balancing preference for ports that use this template. A higher weight gives more favor to the server and port relative to the other servers and ports.
This option applies only to the service-weighted-least-connection load-balancing method. This option does not apply to the weighted-least-connection or weighted-round-robin load-balancing methods.

Type: number

Range: 1-100

Default: 1