slb service-group¶
Service Group
service-group Specification¶
Type Collection Object Key(s) name Collection Name service-group-list Collection URI /axapi/v3/slb/service-group Element Name service-group Element URI /axapi/v3/slb/service-group/{name} Element Attributes service-group_attributes Statistics Data URI /axapi/v3/slb/service-group/{name}/stats Operational Data URI /axapi/v3/slb/service-group/{name}/oper Schema service-group schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/service-group | ||
Create List | POST | /axapi/v3/slb/service-group | ||
Get Object | GET | /axapi/v3/slb/service-group/{name} | ||
Get List | GET | /axapi/v3/slb/service-group | ||
Modify Object | POST | /axapi/v3/slb/service-group/{name} | ||
Replace Object | PUT | /axapi/v3/slb/service-group/{name} | ||
Replace List | PUT | /axapi/v3/slb/service-group | ||
Delete Object | DELETE | /axapi/v3/slb/service-group/{name} |
service-group-list¶
service-group-list is JSON List of service-group attributes
service-group-list : [
]
service-group attributes¶
backup-server-event-log
Description Send log info on back up server events
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
conn-rate
Description Dynamically enable stateless method by conn-rate (Rate to trigger stateless method(conn/sec))
Type: number
Range: 1-1000000
Mutual Exclusion: conn-rate and l4-session-usage are mutually exclusive
conn-rate-duration
Description Period that trigger condition consistently happens(seconds)
Type: number
Range: 1-600
conn-rate-grace-period
Description Define the grace period during transition (Define the grace period during transition(seconds))
Type: number
Range: 1-600
conn-rate-log
Description Send log if transition happens
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
conn-rate-revert-duration
Description Period that revert condition consistently happens(seconds)
Type: number
Range: 1-600
conn-revert-rate
Description Rate to revert to statelful method (conn/sec)
Type: number
Range: 1-1000000
extended-stats
Description Enable extended statistics on service group
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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-partition-svcgrp-health-check 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-partition-svcgrp-health-check and svcgrp-health-check-shared are mutually exclusive
l4-session-revert-duration
Description Period that revert condition consistently happens(seconds)
Type: number
Range: 1-600
l4-session-usage
Description Dynamically enable stateless method by session usage (Usage to trigger stateless method)
Type: number
Range: 1-100
Mutual Exclusion: l4-session-usage and conn-rate are mutually exclusive
l4-session-usage-duration
Description Period that trigger condition consistently happens(seconds)
Type: number
Range: 1-600
l4-session-usage-grace-period
Description Define the grace period during transition (Define the grace period during transition(seconds))
Type: number
Range: 1-600
l4-session-usage-log
Description Send log if transition happens
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
l4-session-usage-revert-rate
Description Usage to revert to statelful method
Type: number
Range: 1-100
lb-method
Description ‘dst-ip-hash’: Load-balancing based on only Dst IP and Port hash; ‘dst-ip-only-hash’: Load-balancing based on only Dst IP hash; ‘fastest-response’: Fastest response time on service port level; ‘least-request’: Least request on service port level; ‘src-ip-hash’: Load-balancing based on only Src IP and Port hash; ‘src-ip-only-hash’: Load-balancing based on only Src IP hash; ‘weighted-rr’: Weighted round robin on server level; ‘service-weighted-rr’: Weighted round robin on service port level; ‘round-robin’: Round robin on server level; ‘round-robin-strict’: Strict mode round robin on server level; ‘odd-even-hash’: odd/even hash based of client src-ip;
Type: string
Supported Values: dst-ip-hash, dst-ip-only-hash, fastest-response, least-request, src-ip-hash, src-ip-only-hash, weighted-rr, service-weighted-rr, round-robin, round-robin-strict, odd-even-hash
Default: round-robin
Mutual Exclusion: lb-methodlc-method, stateless-lb-method, llb-method and lclb-method are mutually exclusive
lc-method
Description ‘least-connection’: Least connection on server level; ‘service-least-connection’: Least connection on service port level; ‘weighted-least-connection’: Weighted least connection on server level; ‘service-weighted-least-connection’: Weighted least connection on service port level;
Type: string
Supported Values: least-connection, service-least-connection, weighted-least-connection, service-weighted-least-connection
Mutual Exclusion: lc-methodlb-method, stateless-lb-method, llb-method and lclb-method are mutually exclusive
lclb-method
Description ‘link-cost-load-balance’: Link cost load balance;
Type: string
Supported Values: link-cost-load-balance
Mutual Exclusion: lclb-methodlb-method, lc-method, stateless-lb-method and llb-method are mutually exclusive
link-probe-template
Description Link Probe template (Link Probe template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/link-probe
llb-method
Description ‘next-hop-link’: Server selection w/ link probe template on service port level;
Type: string
Supported Values: next-hop-link
Mutual Exclusion: llb-methodlb-method, lc-method, stateless-lb-method and lclb-method are mutually exclusive
member-list
Type: List
Reference Object: /axapi/v3/slb/service-group/{name}/member/{name}+{port}
min-active-member
Description Minimum Active Member Per Priority (Minimum Active Member before Action)
Type: number
Range: 1-1024
min-active-member-action
Description ‘dynamic-priority’: dynamic change member priority to met the min-active-member requirement; ‘skip-pri-set’: Skip Current Priority Set If Min not met;
Type: string
Supported Values: dynamic-priority, skip-pri-set
name
Description SLB Service Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
persist-scoring
Description ‘global’: Use Global Configuration; ‘enable’: Enable persist-scoring; ‘disable’: Disable persist-scoring;
Type: string
Supported Values: global, enable, disable
Default: global
priorities
Type: Listpriority-affinity
Description Priority affinity. Persist to the same priority if possible.
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
protocol
Description ‘tcp’: TCP LB service; ‘udp’: UDP LB service;
Type: string
Supported Values: tcp, udp
pseudo-round-robin
Description PRR, select the oldest node for sub-select
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
report-delay
Description Reporting frequency (in minutes)
Type: number
Range: 1-7200
reset
Description: reset is a JSON Block. Please see below for reset
Type: Object
Reference Object: /axapi/v3/slb/service-group/{name}/reset
reset-on-server-selection-fail
Description Send reset to client if server selection fails
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
reset-priority-affinity
Description Reset
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rpt-ext-server
Description Report top 10 fastest/slowest servers
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sample-rsp-time
Description sample server response time
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sampling-enable
Type: Listshared-partition-policy-template
Description Reference a policy template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-policy-template and template-policy are mutually exclusive
shared-partition-svcgrp-health-check
Description Reference a health-check from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-svcgrp-health-check health-check and health-check-disable are mutually exclusive
stateless-auto-switch
Description Enable auto stateless method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
stateless-lb-method
Description ‘stateless-dst-ip-hash’: Stateless load-balancing based on Dst IP and Dst port hash; ‘stateless-per-pkt-round-robin’: Stateless load-balancing using per-packet round-robin; ‘stateless-src-dst-ip-hash’: Stateless load-balancing based on IP and port hash for both Src and Dst; ‘stateless-src-dst-ip-only-hash’: Stateless load-balancing based on only IP hash for both Src and Dst; ‘stateless-src-ip-hash’: Stateless load-balancing based on Src IP and Src port hash; ‘stateless-src-ip-only-hash’: Stateless load-balancing based on only Src IP hash; ‘stateless-per-pkt-weighted-rr’: Stateless load-balancing using per-packet weighted round robin on server level; ‘stateless-per-pkt-service-weighted-rr’: Stateless load-balancing using per-packet weighted round robin on service port level;
Type: string
Supported Values: stateless-dst-ip-hash, stateless-per-pkt-round-robin, stateless-src-dst-ip-hash, stateless-src-dst-ip-only-hash, stateless-src-ip-hash, stateless-src-ip-only-hash, stateless-per-pkt-weighted-rr, stateless-per-pkt-service-weighted-rr
Mutual Exclusion: stateless-lb-methodlb-method, lc-method, llb-method and lclb-method are mutually exclusive
stateless-lb-method2
Description ‘stateless-dst-ip-hash’: Stateless load-balancing based on Dst IP and Dst port hash; ‘stateless-per-pkt-round-robin’: Stateless load-balancing using per-packet round-robin; ‘stateless-src-dst-ip-hash’: Stateless load-balancing based on IP and port hash for both Src and Dst; ‘stateless-src-dst-ip-only-hash’: Stateless load-balancing based on only IP hash for both Src and Dst; ‘stateless-src-ip-hash’: Stateless load-balancing based on Src IP and Src port hash; ‘stateless-src-ip-only-hash’: Stateless load-balancing based on only Src IP hash; ‘stateless-per-pkt-weighted-rr’: Stateless load-balancing using per-packet weighted round robin on server level; ‘stateless-per-pkt-service-weighted-rr’: Stateless load-balancing using per-packet weighted round robin on service port level;
Type: string
Supported Values: stateless-dst-ip-hash, stateless-per-pkt-round-robin, stateless-src-dst-ip-hash, stateless-src-dst-ip-only-hash, stateless-src-ip-hash, stateless-src-ip-only-hash, stateless-per-pkt-weighted-rr, stateless-per-pkt-service-weighted-rr
stats-data-action
Description ‘stats-data-enable’: Enable statistical data collection for service group; ‘stats-data-disable’: Disable statistical data collection for service group;
Type: string
Supported Values: stats-data-enable, stats-data-disable
Default: stats-data-enable
strict-select
Description strict selection
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
svcgrp-health-check-shared
Description Health Check (Monitor Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: svcgrp-health-check-shared and health-check-disable are mutually exclusive
Reference Object: /axapi/v3/health/monitor
template-policy
Description Policy template (Policy template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-policy and shared-partition-policy-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/policy
template-policy-shared
Description Policy template
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/policy
template-port
Description Port template (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
Description Server template (Server template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/server
top-fastest
Description Report top 10 fastest servers
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
top-slowest
Description Report top 10 slowest servers
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
traffic-replication-mirror
Description Mirror Bi-directional Packet
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: traffic-replication-mirrortraffic-replication-mirror-da-repl, traffic-replication-mirror-ip-repl, traffic-replication-mirror-sa-da-repl and traffic-replication-mirror-sa-repl are mutually exclusive
traffic-replication-mirror-da-repl
Description Replace Destination MAC
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: traffic-replication-mirror-da-repltraffic-replication-mirror, traffic-replication-mirror-ip-repl, traffic-replication-mirror-sa-da-repl and traffic-replication-mirror-sa-repl are mutually exclusive
traffic-replication-mirror-ip-repl
Description Replaces IP with server-IP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: traffic-replication-mirror-ip-repltraffic-replication-mirror, traffic-replication-mirror-da-repl, traffic-replication-mirror-sa-da-repl and traffic-replication-mirror-sa-repl are mutually exclusive
traffic-replication-mirror-sa-da-repl
Description Replace Source MAC and Destination MAC
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: traffic-replication-mirror-sa-da-repltraffic-replication-mirror, traffic-replication-mirror-da-repl, traffic-replication-mirror-ip-repl and traffic-replication-mirror-sa-repl are mutually exclusive
traffic-replication-mirror-sa-repl
Description Replace Source MAC
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: traffic-replication-mirror-sa-repltraffic-replication-mirror, traffic-replication-mirror-da-repl, traffic-replication-mirror-ip-repl and traffic-replication-mirror-sa-da-repl are mutually exclusive
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
member-list¶
Specification Type list Block object keys fqdn-name
Description Server hostname - Not applicable if real server is already defined
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
host
Description IP Address - Not applicable if real server is already defined
Type: string
Format: ipv4-address
member-priority
Description Priority of Port in the Group (Priority of Port in the Group, default is 1)
Type: number
Range: 1-16
Default: 1
member-state
Description ‘enable’: Enable member service port; ‘disable’: Disable member service port; ‘disable-with-health-check’: disable member service port, but health check work;
Type: string
Supported Values: enable, disable, disable-with-health-check
Default: enable
member-stats-data-disable
Description Disable statistical data collection
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
member-template
Description Real server port template (Real server port template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/port
name
Description Member name
Type: string
Format: comp-string
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/server
port
Description Port number
Type: number
Range: 0-65534
Default: 65534
Reference Object: /axapi/v3/slb/server/port
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 - Not applicable if real server is already defined
Type: string
Format: ipv6-address
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
member-list_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘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 established connections; ‘total_rev_pkts_inspected’: Total reverse packets inspected; ‘total_rev_pkts_inspected_status_code_2xx’: Total reverse packets inspected status code 2xx; ‘total_rev_pkts_inspected_status_code_non_5xx’: Total reverse packets inspected status code non 5xx; ‘curr_req’: Current requests; ‘total_req’: Total requests; ‘total_req_succ’: Total requests successful; ‘peak_conn’: Peak connections; ‘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; ‘curr_conn_overflow’: Current connection counter overflow count; ‘state_flaps’: State flaps count;
Type: string
Supported Values: all, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, total_rev_pkts_inspected, total_rev_pkts_inspected_status_code_2xx, total_rev_pkts_inspected_status_code_non_5xx, curr_req, total_req, total_req_succ, peak_conn, response_time, fastest_rsp_time, slowest_rsp_time, curr_ssl_conn, total_ssl_conn, curr_conn_overflow, state_flaps
reset¶
Specification Type object auto-switch
Description Reset auto stateless state
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
priorities¶
Specification Type list Block object keys priority
Description Priority option. Define different action for each priority node. (Priority in the Group)
Type: number
Range: 1-16
priority-action
Description ‘drop’: Drop request when all priority nodes fail; ‘drop-if-exceed-limit’: Drop request when connection over limit; ‘proceed’: Proceed to next priority when all priority nodes fail(default); ‘reset’: Send client reset when all priority nodes fail; ‘reset-if-exceed-limit’: Send client reset when connection over limit;
Type: string
Supported Values: drop, drop-if-exceed-limit, proceed, reset, reset-if-exceed-limit
Default: proceed
sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘server_selection_fail_drop’: Drops due to Service selection failure; ‘server_selection_fail_reset’: Resets sent out for Service selection failure; ‘service_peak_conn’: Peak connection count for the Service Group; ‘service_healthy_host’: Service Group healthy host count; ‘service_unhealthy_host’: Service Group unhealthy host count; ‘service_req_count’: Service Group request count; ‘service_resp_count’: Service Group response count; ‘service_resp_2xx’: Service Group response 2xx count; ‘service_resp_3xx’: Service Group response 3xx count; ‘service_resp_4xx’: Service Group response 4xx count; ‘service_resp_5xx’: Service Group response 5xx count; ‘service_curr_conn_overflow’: Current connection counter overflow count;
Type: string
Supported Values: all, server_selection_fail_drop, server_selection_fail_reset, service_peak_conn, service_healthy_host, service_unhealthy_host, service_req_count, service_resp_count, service_resp_2xx, service_resp_3xx, service_resp_4xx, service_resp_5xx, service_curr_conn_overflow
stats data¶
| Counter | Size | Description | |
|---|---|---|---|
| service_resp_2xx | 8 | Service Group response 2xx count | |
| service_unhealthy_host | 8 | Service Group unhealthy host count | |
| service_curr_conn_overflow | 8 | Current connection counter overflow count | |
| service_req_count | 8 | Service Group request count | |
| service_healthy_host | 8 | Service Group healthy host count | |
| service_resp_count | 8 | Service Group response count | |
| service_resp_3xx | 8 | Service Group response 3xx count | |
| server_selection_fail_drop | 8 | Drops due to Service selection failure | |
| service_resp_4xx | 8 | Service Group response 4xx count | |
| server_selection_fail_reset | 8 | Resets sent out for Service selection failure | |
| service_peak_conn | 8 | Peak connection count for the Service Group | |
| service_resp_5xx | 8 | Service Group response 5xx count |
operational data¶
| Counter | Size | Description | |
|---|---|---|---|
| pri_affinity_priority | number | pri_affinity_priority | |
| stateless_type | number | stateless_type | |
| servers_down | number | servers_down | |
| servers_total | number | servers_total | |
| servers_disable | number | servers_disable | |
| stateless_state | number | stateless_state | |
| filter | enum | Output contains one of the following values: - sgm-sort-config | |
| stateless_current_rate | number | stateless_current_rate | |
| state | enum | Output contains one of the following values: - All Up, Functional Up, Down, Disb, Unkn | |
| sgm-list | sgm-list | ||
| servers_up | number | servers_up | |
| stateless_current_usage | number | stateless_current_usage | |
| hm_dsr_enable_all_vip | number | hm_dsr_enable_all_vip |