slb server

Configure real servers for load balancing.

server Specification

Type Collection
Object Key(s) name
Collection Name server-list
Collection URI /axapi/v3/slb/server/
Element Name server
Element URI /axapi/v3/slb/server/{name}
Element Attributes server_attributes
Statistics Data URI /axapi/v3/slb/server/{name}/stats
Operational Data URI /axapi/v3/slb/server/{name}/oper
Schema server schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/slb/server/

server Attributes

Create List

POST

/axapi/v3/slb/server/

server Attributes

Get Object

GET

/axapi/v3/slb/server/{name}

server Attributes

Get List

GET

/axapi/v3/slb/server/

server-list

Modify Object

POST

/axapi/v3/slb/server/{name}

server Attributes

Replace Object

PUT

/axapi/v3/slb/server/{name}

server Attributes

Replace List

PUT

/axapi/v3/slb/server/

server-list

Delete Object

DELETE

/axapi/v3/slb/server/{name}

server Attributes

Get Stats

GET

/axapi/v3/slb/server/{name}/stats

stats data

Get Oper

GET

/axapi/v3/slb/server/{name}/oper

operational data

server-list

server-list is JSON List of server Attributes

server-list : [

server Attributes

action

Description: Enable or disable a real server.

Type: string

Supported Values: enable, disable, disable-with-health-check

Default: enable

alternate-server

Description: alternate-server is a JSON List . Please see below for alternate-server

Type: List

conn-limit

Description: Specify the maximum number of concurrent connections allowed on a real server. You also can set the connection limit on individual protocol ports.

Type: number

Range: 1-8000000

Default: 8000000

conn-resume

Description: Specify the maximum number of connections the server can have before the ACOS device resumes use of the server. Use does not resume until the number of connections reaches the configured maximum or less.

Type: number

Range: 1-1000000

extended-stats

Description: Enable collection of peak connection statistics for a server.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

external-ip

Description: Assigns an external Network Address Translation (NAT) IP address to the server. The external IP address allows a server that has an internal IP address to be reached from outside the internal network.

Type: string

Format: ipv4-address

fqdn-name

Description: Fully-qualified hostname, for dynamic real server creation.

Type: string

health-check

Description: Specifies the name of the health monitor you want to use. The health monitor must already be configured.

Type: string

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

Reference Object: /axapi/v3/health/monitor

health-check-disable

Description: Disable the target of a health check if the target fails the health check. This command applies to all servers, ports, or service groups that use the health monitor. When a server, port, or service group is disabled based on this command, the server, port, or service group’s state is changed to disable in the running-config. If you save the configuration while the server, port, or service group is disabled, the state change is written to the startup-config.

The server, port, or service group remains disabled until you explicitly enable it.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

host

Description: IP address of the server in IPv4 format. The address is required only if you are creating a new server.

Type: string

Format: ipv4-address

ipv6

Description: Assign an IPv6 address to the reals server for GSLB.

Type: string

Format: ipv6-address

name

Description: Server name. After you have created a real server, you can use this command to rename the real server.

Type: string

Format: string-rlx

Required: Yes

no-logging

Description: Disable logging for connection limiting.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-list

Description: port-list is a JSON List . Please see below for port-list

Type: List

Reference Object: /axapi/v3/slb/server/{name}/port/{port-number}+{protocol}

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

server-ipv6-addr

Description: IP address of the server in IPv6 format. The address is required only if you are creating a new server.

Type: string

Format: ipv6-address

slow-start

Description: Enable slow-start for a server. Slow start allows time for a server to ramp up after the server is enabled or comes online, by temporarily limiting the number of new connections on the server

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

spoofing-cache

Description: Enable support for a spoofing cache server. A spoofing cache server uses the client’s IP address instead of its own as the source address when obtaining content requested by the client. This command applies to the Transparent Cache Switching (TCS) feature.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stats-data-action

Description: Enable or disable collection of statistical data for the server. To collect statistical data for a load-balancing resource, statistical data collection also must be enabled globally.

Type: string

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

Default: stats-data-enable

template-server

Description: Bind a real server template to the server.
If a parameter is set individually on this server and also is set in a server template bound to this server, the individual setting on this server is used instead of the setting in the template.

Type: string

Format: string-rlx

Default: default

Reference Object: /axapi/v3/slb/template/server

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

weight

Description: Assign an administrative weight to the server, for weighted load balancing.
This parameter applies only to the weighted-least-connection and weighted-rr (weighted round robin) load-balancing methods

Type: number

Range: 1-100

Default: 1

port-list

Specification
Type list
Block object keys

action

Description: ‘enable’: enable; ‘disable’: disable; ‘disable-with-health-check’: disable port, but health check work;

Type: string

Supported Values: enable, disable, disable-with-health-check

Default: enable

alternate-port

Description: alternate-port is a JSON List . Please see below for l150_alternate-port

Type: List

auth-cfg

Description: auth-cfg is a JSON Block . Please see below for l150_auth-cfg

Type: Object

conn-limit

Description: Connection Limit

Type: number

Range: 1-8000000

Default: 8000000

conn-resume

Description: Connection Resume

Type: number

Range: 1-1000000

extended-stats

Description: Enable extended statistics on real server port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

follow-port-protocol

Description: ‘tcp’: TCP Port; ‘udp’: UDP Port;

Type: string

Supported Values: tcp, udp

health-check

Description: Health Check (Monitor Name)

Type: string

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

Reference Object: /axapi/v3/health/monitor

health-check-disable

Description: Disable health check

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

health-check-follow-port

Description: Specify which port to follow for health status (Port Number)

Type: number

Range: 1-65534

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

no-logging

Description: Do not log connection over limit event

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

no-ssl

Description: No SSL

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-number

Description: Port Number

Type: number

Range: 0-65534

protocol

Description: ‘tcp’: TCP Port; ‘udp’: UDP Port;

Type: string

Supported Values: tcp, udp

range

Description: Port range (Port range value - used for vip-to-rport-mapping)

Type: number

Range: 0-254

Default: 0

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

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

template-port

Description: Port template (Port template name)

Type: string

Format: string-rlx

Default: default

Reference Object: /axapi/v3/slb/template/port

template-server-ssl

Description: Server side SSL template (Server side SSL Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/server-ssl

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

weight

Description: Port Weight (Connection Weight)

Type: number

Range: 1-100

Default: 1

port-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘curr_req’: Current requests; ‘total_req’: Total Requests; ‘total_req_succ’: Total requests succ; ‘total_fwd_bytes’: Forward bytes; ‘total_fwd_pkts’: Forward packets; ‘total_rev_bytes’: Reverse bytes; ‘total_rev_pkts’: Reverse packets; ‘total_conn’: Total connections; ‘last_total_conn’: Last total connections; ‘peak_conn’: Peak connections; ‘es_resp_200’: Response status 200; ‘es_resp_300’: Response status 300; ‘es_resp_400’: Response status 400; ‘es_resp_500’: Response status 500; ‘es_resp_other’: Response status other; ‘es_req_count’: Total proxy request; ‘es_resp_count’: Total proxy response; ‘es_resp_invalid_http’: Total non-http response; ‘total_rev_pkts_inspected’: Total reverse packets inspected; ‘total_rev_pkts_inspected_good_status_code’: Total reverse packets with good status code inspected; ‘response_time’: Response time; ‘fastest_rsp_time’: Fastest response time; ‘slowest_rsp_time’: Slowest response time; ‘curr_ssl_conn’: Current SSL connections; ‘total_ssl_conn’: Total SSL connections;

Type: string

Supported Values: all, curr_req, total_req, total_req_succ, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, last_total_conn, peak_conn, es_resp_200, es_resp_300, es_resp_400, es_resp_500, es_resp_other, es_req_count, es_resp_count, es_resp_invalid_http, total_rev_pkts_inspected, total_rev_pkts_inspected_good_status_code, response_time, fastest_rsp_time, slowest_rsp_time, curr_ssl_conn, total_ssl_conn

port-list.alternate-port

Specification
Type list
Block object keys

alternate

Description: Alternate Server Number

Type: number

Range: 1-16

alternate-name

Description: Alternate Name

Type: string

Format: string-rlx

alternate-server-port

Description: Port (Alternate Server Port Value)

Type: number

Range: 1-65535

port-list.auth-cfg

Specification
Type object

service-principal-name

Description: Service Principal Name (Kerberos principal name)

Type: string

Format: string-rlx

alternate-server

Specification
Type list
Block object keys

alternate

Description: Alternate Server (Alternate Server Number)

Type: number

Range: 1-16

alternate-name

Description: Alternate Name

Type: string

Format: string-rlx

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘total-conn’: Total connections; ‘fwd-pkt’: Forward packets; ‘rev-pkt’: Reverse packets; ‘peak-conn’: Peak connections; ‘total_req’: Total Requests; ‘total_req_succ’: Total requests succ; ‘curr_ssl_conn’: Current SSL connections; ‘total_ssl_conn’: Total SSL connections;

Type: string

Supported Values: all, total-conn, fwd-pkt, rev-pkt, peak-conn, total_req, total_req_succ, curr_ssl_conn, total_ssl_conn

stats data

Counter Size Description
peak-conn 8 Peak connections
rev-pkt 8 Reverse packets
total_ssl_conn 8 Total SSL connections
total_req_succ 8 Total requests succ
total_req 8 Total Requests
total-conn 8 Total connections
curr_ssl_conn 8 Current SSL connections
curr-conn 8 Current connections
fwd-pkt 8 Forward packets

operational data

Name Type Description
state enum Output contains one of the following values: - Up, Down, Disabled, Maintenance, Unknown, Functional Up, DIS-UP, DIS-DOWN, DIS-MAINTENANCE, DIS-UNKNOWN