slb server port¶
Real Server Port
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 schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/server/{name}/port | ||
Create List | POST | /axapi/v3/slb/server/{name}/port | ||
Get Object | GET | /axapi/v3/slb/server/{name}/port/{port-number}+{protocol} | ||
Get List | GET | /axapi/v3/slb/server/{name}/port | ||
Modify Object | POST | /axapi/v3/slb/server/{name}/port/{port-number}+{protocol} | ||
Replace Object | PUT | /axapi/v3/slb/server/{name}/port/{port-number}+{protocol} | ||
Replace List | PUT | /axapi/v3/slb/server/{name}/port | ||
Delete Object | DELETE | /axapi/v3/slb/server/{name}/port/{port-number}+{protocol} |
port-list¶
port-list is JSON List of port attributes
port-list : [
]
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: Listauth-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-checkshared-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-disablehealth-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
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: Listshared-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 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 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 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
stats port-diameter¶
| Counter | Size | Description | |
|---|---|---|---|
| ccr_in | 2 | Number of CCRs in | |
| 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 | |
| cca_in | 2 | Number of CCAs 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 | |
| ccr_out | 2 | Number of CCRs out | |
| 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 | |
| cca_out | 2 | Number of CCAs out | |
| aca_in | 2 | Number of ACAs in | |
| dwr_out | 2 | Number of DWRs out | |
| dpa_out | 2 | Number of DPAs out | |
| other_out | 2 | Number of other messages out | |
| cea_out | 2 | Number of CEAs out | |
| dpr_in | 2 | Number of DPRs in | |
| 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 | |
| dpa_in | 2 | Number of DPAs in | |
| dpr_out | 2 | Number of DPRs out | |
| 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 | |
| resp-1xx | 8 | Response status 1xx | |
| curr_ssl_conn | 8 | Current SSL connections | |
| resp-2xx | 8 | Response status 2xx | |
| es_resp_count | 8 | Total proxy response | |
| total_fwd_bytes | 8 | Bytes processed in forward direction | |
| es_resp_other | 8 | Response status other | |
| fastest_rsp_time | 8 | Fastest response time | |
| total_fwd_pkts | 8 | Packets processed in forward direction | |
| resp-3xx | 8 | Response status 3xx | |
| resp-latency | 8 | Time to First Response Byte | |
| resp-count | 8 | Total Response Count | |
| es_req_count | 8 | Total proxy requests | |
| resp-other | 8 | Response status Other | |
| 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_pconn | 8 | Current persistent connections | |
| curr_conn | 8 | Current connections | |
| es_resp_200 | 8 | Response status 200 | |
| total_rev_bytes | 8 | Bytes processed in reverse direction | |
| response_time | 8 | Response time | |
| resp-4xx | 8 | Response status 4xx | |
| total_ssl_conn | 8 | Total SSL connections | |
| total_conn | 8 | Total connections | |
| total_rev_pkts | 8 | Packets processed in reverse direction | |
| total_req_succ | 8 | Total requests succ | |
| last_total_conn | 8 | Last total connections | |
| total_rev_pkts_inspected | 8 | Total reverse packets inspected | |
| resp-5xx | 8 | Response status 5xx | |
| slowest_rsp_time | 8 | Slowest response time |
operational data¶
| Counter | Size | Description | |
|---|---|---|---|
| down_grace_period_allowed | number | down_grace_period_allowed | |
| nat-pool-addr-list | nat-pool-addr-list | ||
| drs-ip-nat-list | drs-ip-nat-list | ||
| drs-auto-nat-list | drs-auto-nat-list | ||
| auto-nat-addr-list | auto-nat-addr-list | ||
| aflow_queue_size | number | aflow_queue_size | |
| current_time | number | current_time | |
| state | enum | Output contains one of the following values: - Up, Down, Disabled, Maintenance, Unknown, DIS-UP, DIS-DOWN, DIS-MAINTENANCE, DIS-EXCEED-RATE, DIS-DAMP | |
| slow_start_conn_limit | number | slow_start_conn_limit | |
| resv_conn | number | resv_conn | |
| pool_name | string-rlx | pool_name | |
| hm-index | number | hm-index | |
| down_time_grace_period | number | down_time_grace_period | |
| inband_hm_reassign_num | number | inband_hm_reassign_num | |
| curr_observe_rate | number | curr_observe_rate | |
| curr_conn_rate | number | curr_conn_rate | |
| disable | number | disable | |
| aflow_conn_limit | number | aflow_conn_limit | |
| diameter_enabled | number | diameter_enabled | |
| soft_down_time | number | soft_down_time | |
| hm-key | number | hm-key | |
| es_resp_time | number | es_resp_time | |
| conn_rate_unit | string | conn_rate_unit |