slb server port

Configure a TCP or UDP port on a real server.

port Specification

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

Operations Allowed:

Operation Method URI Payload

Create Object

POST

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

port Attributes

Create List

POST

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

port Attributes

Get Object

GET

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

port Attributes

Get List

GET

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

port-list

Modify Object

POST

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

port Attributes

Replace Object

PUT

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

port Attributes

Replace List

PUT

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

port-list

Delete Object

DELETE

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

port Attributes

Get Stats port-diameter

GET

/axapi/v3/slb/server/{name}/port/{port-number}+{protocol}/stats?port-diameter=true

stats port-diameter

Get Stats

GET

/axapi/v3/slb/server/{name}/port/{port-number}+{protocol}/stats

stats data

Get Oper

GET

/axapi/v3/slb/server/{name}/port/{port-number}+{protocol}/oper

operational data

port-list

port-list is JSON List of port Attributes

port-list : [

port Attributes

action

Description: Enable or disable a port.

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 alternate-port

Type: List

auth-cfg

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

Type: Object

conn-limit

Description: Specifies the maximum number of concurrent connections allowed on the server for this port.

Type: number

Range: 1-8000000

Default: 8000000

conn-resume

Description: Specifies the maximum number of connections the service port can have before the ACOS device resumes use of the port. 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 real server port.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

follow-port-protocol

Description: Specifies another real port upon which to base this port’s health status. Both the real port and the port to use for the real port’s health status must be the same type, TCP or UDP.

Type: string

Supported Values: tcp, udp

health-check

Description: Enables health monitoring of the port.

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 monitoring of the port.

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: Disables logging for port connection limiting.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-number

Description: Protocol port number.

Type: number

Range: 0-65534

Required: Yes

protocol

Description: Protocol type.

Type: string

Supported Values: tcp, udp

Required: Yes

range

Description: Specifies the range of real ports you want to create within the real server configuration. This value can range from 0-254.
NOTE: The port number specified will be the base number for the range of real ports.

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: Disable or enable statistical data collection for the port.

Type: string

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

Default: stats-data-enable

template-port

Description: The port option binds a port template to the port. The parameter settings in the template are applied to the port.

Type: string

Format: string-rlx

Default: default

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

template-server-ssl

Description: This command binds a server-side SSL template to the port. The parameter settings in the template are applied to the port. This may be useful in cases where the real servers load balanced by a VIP have different SSL settings.

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: Specifies the load-balancing preference for this port, 1-100. A higher weight gives more favor to this server for this port relative to the other servers.

Type: number

Range: 1-100

Default: 1

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

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

auth-cfg

Specification
Type object

service-principal-name

Description: Service Principal Name (Kerberos principal name)

Type: string

Format: string-rlx

stats port-diameter

Counter Size Description
svrsel_fail 2 Number of server selection failed
curr 2 Current
acr_out 2 Number of ACRs out
dwr_in 2 Number of DWRs in
num 2 Number
no_route 2 Number of no routes
server_fail 2 Number of server failures
user_session 2 Number of user sessions
aca_out 2 Number of ACAs out
sta_in 2 Number of STAs in
total 2 Total
dwa_in 2 Number of DWAs in
dwa_out 2 Number of DWAs out
asa_in 2 Number of ASAs in
asr_out 2 Number of ASRs out
aca_in 2 Number of ACAs in
dwr_out 2 Number of DWRs out
other_out 2 Number of other messages out
cea_out 2 Number of CEAs out
asr_in 2 Number of ASRs in
cer_in 2 Number of CERs in
str_in 2 Number of STRs in
sta_out 2 Number of STAs out
snat_fail 2 Number of snat failures
client_fail 2 Number of client failures
cer_out 2 Number of CERs out
str_out 2 Number of STRs out
cea_in 2 Number of CEAs in
asa_out 2 Number of ASAs out
no_sess 2 Number of no sessions
other_in 2 Number of other messages in
acr_in 2 Number of ACRs in

stats data

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

operational data

Name Type Description
alloc_failed number alloc_failed
vrid enum Output contains one of the following values: - default
ha_group_id enum Output contains one of the following values: - default
ip ipv4-address ip
ports_consumed number ports_consumed
state enum Output contains one of the following values: - Up, Down, Disabled, Maintenance, Unknown, DIS-UP, DIS-DOWN, DIS-MAINTENANCE
ipv6 ipv6-address ipv6
ports_freed_total number ports_freed_total
ports_consumed_total number ports_consumed_total