slb server port¶

Real Server Port

port Specification¶

Parameter Value

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

Partition Visibility shared

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

port-list¶

port-list is JSON List of port attributes

port-list : [

{ port attributes },

{ port attributes },

…

]

port attributes¶

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

Type: List

auth-cfg

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

Type: Object

conn-limit

Description Connection Limit

Type: number

Range: 1-64000000

Default: 64000000

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

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: health-check,shared-rport-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, shared-rport-health-check, rport-health-check-shared, 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

only

Description Force using HTTP/2 with Prior Knowledge all the time

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

packet-capture-template

Description Name of the packet capture template to be bind with this object

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/slb-port-tmpl

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 and vport-rport range mapping)

Type: number

Range: 0-254

Default: 0

rport-health-check-shared

Description Health Check (Monitor Name)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

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

Reference Object: /axapi/v3/health/monitor

sampling-enable

Type: List

shared-partition-port-template

Description Reference a port template from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-partition-port-template and template-port are mutually exclusive

shared-rport-health-check

Description Reference a health-check from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-rport-health-check, health-check, and health-check-disable are mutually exclusive

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

support-http2

Description Starting HTTP/2 with Prior Knowledge

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

template-port

Description Port template (Port template name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Default: default

Mutual Exclusion: template-port and shared-partition-port-template are mutually exclusive

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

template-port-shared

Description Port Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

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

template-server-ssl

Description Server side SSL template (Server side SSL Name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

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

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 Port Weight (Connection Weight)

Type: number

Range: 1-1000

Default: 1

sampling-enable¶

Specification Value

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’: Bytes processed in forward direction; ‘total_fwd_pkts’: Packets processed in forward direction; ‘total_rev_bytes’: Bytes processed in reverse direction; ‘total_rev_pkts’: Packets processed in reverse direction; ‘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 requests; ‘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; ‘resp-count’: Total Response Count; ‘resp-1xx’: Response status 1xx; ‘resp-2xx’: Response status 2xx; ‘resp-3xx’: Response status 3xx; ‘resp-4xx’: Response status 4xx; ‘resp-5xx’: Response status 5xx; ‘resp-other’: Response status Other; ‘resp-latency’: Time to First Response Byte; ‘curr_pconn’: Current persistent 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, resp-count, resp-1xx, resp-2xx, resp-3xx, resp-4xx, resp-5xx, resp-other, resp-latency, curr_pconn

alternate-port¶

Specification Value

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

Maximum Length: 127 characters

Maximum Length: 1 characters

alternate-server-port

Description Port (Alternate Server Port Value)

Type: number

Range: 1-65535

auth-cfg¶

Specification Value

Type object

service-principal-name

Description Service Principal Name (Kerberos principal name)

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters