slb server¶
Server
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 schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/server | ||
Create List | POST | /axapi/v3/slb/server | ||
Get Object | GET | /axapi/v3/slb/server/{name} | ||
Get List | GET | /axapi/v3/slb/server | ||
Modify Object | POST | /axapi/v3/slb/server/{name} | ||
Replace Object | PUT | /axapi/v3/slb/server/{name} | ||
Replace List | PUT | /axapi/v3/slb/server | ||
Delete Object | DELETE | /axapi/v3/slb/server/{name} |
server-list¶
server-list is JSON List of server attributes
server-list : [
]
server attributes¶
action
Description ‘enable’: Enable this Real Server; ‘disable’: Disable this Real Server; ‘disable-with-health-check’: disable real server, but health check work;
Type: string
Supported Values: enable, disable, disable-with-health-check
Default: enable
alternate-server
Type: Listconn-limit
Description Connection Limit
Type: number
Range: 1-64000000
Default: 64000000
conn-resume
Description Connection Resume (Connection Resume (min active conn before resume taking new conn))
Type: number
Range: 1-1000000
ethernet
Description ethernet interface
Type: number
Format: interface
Reference Object: /axapi/v3/interface/ethernet
extended-stats
Description Enable extended statistics on real server
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
external-ip
Description External IP address for NAT of GSLB
Type: string
Format: ipv4-address
fqdn-name
Description Server hostname
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: fqdn-name server-ipv6-addr and host are mutually exclusive
health-check
Description Health Check Monitor (Health monitor name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: health-check shared-partition-health-check and health-check-disable are mutually exclusive
Reference Object: /axapi/v3/health/monitor
health-check-disable
Description Disable configured health check configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disablehealth-check, shared-partition-health-check and health-check-shared are mutually exclusive
health-check-shared
Description Health Check Monitor (Health monitor name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: health-check-shared and health-check-disable are mutually exclusive
Reference Object: /axapi/v3/health/monitor
host
Description IP Address
Type: string
Format: ipv4-address
Mutual Exclusion: host server-ipv6-addr and fqdn-name are mutually exclusive
ipv6
Description IPv6 address Mapping of GSLB
Type: string
Format: ipv6-address
name
Description Server Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
no-logging
Description Do not log connection over limit event
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port-list
Type: List
Reference Object: /axapi/v3/slb/server/{name}/port/{port-number}+{protocol}
resolve-as
Description ‘resolve-to-ipv4’: Use A Query only to resolve FQDN; ‘resolve-to-ipv6’: Use AAAA Query only to resolve FQDN; ‘resolve-to-ipv4-and-ipv6’: Use A as well as AAAA Query to resolve FQDN;
Type: string
Supported Values: resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6
Default: resolve-to-ipv4
sampling-enable
Type: Listserver-ipv6-addr
Description IPV6 address
Type: string
Format: ipv6-address
Mutual Exclusion: server-ipv6-addr host and fqdn-name are mutually exclusive
shared-partition-health-check
Description Reference a health-check from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-health-check health-check and health-check-disable are mutually exclusive
shared-partition-server-template
Description Reference a server template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-server-template and template-server are mutually exclusive
slow-start
Description Slowly ramp up the connection number after server is up (start from 128, then double every 10 sec till 4096)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
spoofing-cache
Description This server is a spoofing cache
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
stats-data-action
Description ‘stats-data-enable’: Enable statistical data collection for real server; ‘stats-data-disable’: Disable statistical data collection for real server;
Type: string
Supported Values: stats-data-enable, stats-data-disable
Default: stats-data-enable
template-link-cost
Description Link-Cost template (Link-Cost template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/link-cost
template-server
Description Server template (Server template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: default
Mutual Exclusion: template-server and shared-partition-server-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/server
template-server-shared
Description Server Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/server
trunk
use-aam-server
Description Using aam server. For health check, please configure it in aam server
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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 Weight for this Real Server (Connection Weight)
Type: number
Range: 1-1000
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
Type: Listauth-cfg
Description: auth-cfg is a JSON Block. Please see below for port-list_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
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’: 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
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
Maximum Length: 127 characters
Maximum Length: 1 characters
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
Maximum Length: 128 characters
Maximum Length: 1 characters
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
Maximum Length: 127 characters
Maximum Length: 1 characters
sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘total-conn’: Total established connections; ‘fwd-pkt’: Forward Packets Processed; ‘rev-pkt’: Reverse Packets Processed; ‘peak-conn’: Peak number of established connections; ‘total_req’: Total Requests processed; ‘total_req_succ’: Total Requests succeeded; ‘curr_ssl_conn’: Current SSL connections established; ‘total_ssl_conn’: Total SSL connections established; ‘total_fwd_bytes’: Bytes processed in forward direction; ‘total_rev_bytes’: Bytes processed in reverse direction; ‘total_fwd_pkts’: Packets processed in forward direction; ‘total_rev_pkts’: Packets processed in reverse direction; ‘ip_only_lb_fwd_bytes’: IP-Only-LB Bytes processed in forward direction; ‘ip_only_lb_rev_bytes’: IP-Only-LB Bytes processed in reverse direction; ‘ip_only_lb_fwd_pkts’: IP-Only-LB Packets processed in forward direction; ‘ip_only_lb_rev_pkts’: IP-Only-LB Packets processed in reverse direction;
Type: string
Supported Values: all, total-conn, fwd-pkt, rev-pkt, peak-conn, total_req, total_req_succ, curr_ssl_conn, total_ssl_conn, total_fwd_bytes, total_rev_bytes, total_fwd_pkts, total_rev_pkts, ip_only_lb_fwd_bytes, ip_only_lb_rev_bytes, ip_only_lb_fwd_pkts, ip_only_lb_rev_pkts
stats data¶
| Counter | Size | Description | |
|---|---|---|---|
| peak-conn | 8 | Peak number of established connections | |
| rev-pkt | 8 | Reverse Packets Processed | |
| total_rev_bytes | 8 | Bytes processed in reverse direction | |
| total_fwd_pkts | 8 | Packets processed in forward direction | |
| total_ssl_conn | 8 | Total SSL connections established | |
| ip_only_lb_fwd_pkts | 8 | IP-Only-LB Packets processed in forward direction | |
| ip_only_lb_fwd_bytes | 8 | IP-Only-LB Bytes processed in forward direction | |
| total_req_succ | 8 | Total Requests succeeded | |
| total_req | 8 | Total Requests processed | |
| total-conn | 8 | Total established connections | |
| total_rev_pkts | 8 | Packets processed in reverse direction | |
| curr_ssl_conn | 8 | Current SSL connections established | |
| curr-conn | 8 | Current established connections | |
| ip_only_lb_rev_bytes | 8 | IP-Only-LB Bytes processed in reverse direction | |
| fwd-pkt | 8 | Forward Packets Processed | |
| total_fwd_bytes | 8 | Bytes processed in forward direction | |
| ip_only_lb_rev_pkts | 8 | IP-Only-LB Packets processed in reverse direction |
operational data¶
| Counter | Size | Description | |
|---|---|---|---|
| conn_rate_unit | string | conn_rate_unit | |
| weight | number | weight | |
| dns_update_time | string | dns_update_time | |
| creation_type | string | creation_type | |
| server_ttl | number | server_ttl | |
| curr_observe_rate | number | curr_observe_rate | |
| curr_conn_rate | number | curr_conn_rate | |
| state | enum | Output contains one of the following values: - Up, Down, Disabled, Maintenance, Unknown, Functional Up, DIS-UP, DIS-DOWN, DIS-MAINTENANCE, DIS-EXCEED-RATE, DIS-UNKNOWN | |
| disable | number | disable | |
| drs-list | drs-list | ||
| slow_start_conn_limit | number | slow_start_conn_limit | |
| is_autocreate | number | is_autocreate | |
| srv_gateway_arp | mac-address | srv_gateway_arp |