a10_slb_service_group¶

Synopsis
Parameters
Examples
Status

Synopsis ¶

Service Group

Parameters ¶

Parameters		Choices/Defaults	Comment
state str/required		[‘noop’, ‘present’, ‘absent’]	State of the object to be created.
ansible_host str/required			Host for AXAPI authentication
ansible_username str/required			Username for AXAPI authentication
ansible_password str/required			Password for AXAPI authentication
ansible_port int/required			Port for AXAPI authentication
a10_device_context_id int		[‘1-8’]	Device ID for aVCS configuration
a10_partition str			Destination/target partition for object/command
name str/required			SLB Service Name
protocol str			‘tcp’= TCP LB service; ‘udp’= UDP LB service;
template_port str			Port template (Port template name)
template_policy str			Policy template (Policy template name)
shared_partition_policy_template bool			Reference a policy template from shared partition
template_policy_shared str			Policy template
lb_method str			‘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;
lc_method str			‘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;
stateless_lb_method str			‘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;
pseudo_round_robin bool			PRR, select the oldest node for sub-select
stateless_auto_switch bool			Enable auto stateless method
stateless_lb_method2 str			‘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;
conn_rate int			Dynamically enable stateless method by conn-rate (Rate to trigger stateless method(conn/sec))
conn_rate_duration int			Period that trigger condition consistently happens(seconds)
conn_revert_rate int			Rate to revert to statelful method (conn/sec)
conn_rate_revert_duration int			Period that revert condition consistently happens(seconds)
conn_rate_grace_period int			Define the grace period during transition (Define the grace period during transition(seconds))
conn_rate_log bool			Send log if transition happens
l4_session_usage int			Dynamically enable stateless method by session usage (Usage to trigger stateless method)
l4_session_usage_duration int			Period that trigger condition consistently happens(seconds)
l4_session_usage_revert_rate int			Usage to revert to statelful method
l4_session_revert_duration int			Period that revert condition consistently happens(seconds)
l4_session_usage_grace_period int			Define the grace period during transition (Define the grace period during transition(seconds))
l4_session_usage_log bool			Send log if transition happens
min_active_member int			Minimum Active Member Per Priority (Minimum Active Member before Action)
min_active_member_action str			‘dynamic-priority’= dynamic change member priority to met the min-active-member requirement; ‘skip-pri-set’= Skip Current Priority Set If Min not met;
reset_on_server_selection_fail bool			Send reset to client if server selection fails
priority_affinity bool			Priority affinity. Persist to the same priority if possible.
reset_priority_affinity bool			Reset
backup_server_event_log bool			Send log info on back up server events
strict_select bool			strict selection
stats_data_action str			‘stats-data-enable’= Enable statistical data collection for service group; ‘stats-data-disable’= Disable statistical data collection for service group;
extended_stats bool			Enable extended statistics on service group
traffic_replication_mirror bool			Mirror Bi-directional Packet
traffic_replication_mirror_da_repl bool			Replace Destination MAC
traffic_replication_mirror_ip_repl bool			Replaces IP with server-IP
traffic_replication_mirror_sa_da_repl bool			Replace Source MAC and Destination MAC
traffic_replication_mirror_sa_repl bool			Replace Source MAC
health_check str			Health Check (Monitor Name)
shared_partition_svcgrp_health_check bool			Reference a health-check from shared partition
svcgrp_health_check_shared str			Health Check (Monitor Name)
health_check_disable bool			Disable health check
priorities list			Field priorities
	priority int		Priority option. Define different action for each priority node. (Priority in the Group)
	priority_action str		‘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;
sample_rsp_time bool			sample server response time
rpt_ext_server bool			Report top 10 fastest/slowest servers
report_delay int			Reporting frequency (in minutes)
top_slowest bool			Report top 10 slowest servers
top_fastest bool			Report top 10 fastest servers
persist_scoring str			‘global’= Use Global Configuration; ‘enable’= Enable persist-scoring; ‘disable’= Disable persist-scoring;
uuid str			uuid of the object
user_tag str			Customized tag
sampling_enable list			Field sampling_enable
	counters1 str		‘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;
reset dict			Field reset
	auto_switch bool		Reset auto stateless state
member_list list			Field member_list
	name str		Member name
	port int		Port number
	fqdn_name str		Server hostname - Not applicable if real server is already defined
	resolve_as str		‘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;
	host str		IP Address - Not applicable if real server is already defined
	server_ipv6_addr str		IPV6 Address - Not applicable if real server is already defined
	member_state str		‘enable’= Enable member service port; ‘disable’= Disable member service port; ‘disable-with-health-check’= disable member service port, but health check work;
	member_stats_data_disable bool		Disable statistical data collection
	member_template str		Real server port template (Real server port template name)
	member_priority int		Priority of Port in the Group (Priority of Port in the Group, default is 1)
	uuid str		uuid of the object
	user_tag str		Customized tag
	sampling_enable list		Field sampling_enable
oper dict			Field oper
	state str		Field state
	servers_up int		Field servers_up
	servers_down int		Field servers_down
	servers_disable int		Field servers_disable
	servers_total int		Field servers_total
	stateless_current_rate int		Field stateless_current_rate
	stateless_current_usage int		Field stateless_current_usage
	stateless_state int		Field stateless_state
	stateless_type int		Field stateless_type
	hm_dsr_enable_all_vip int		Field hm_dsr_enable_all_vip
	pri_affinity_priority int		Field pri_affinity_priority
	filter str		Field filter
	sgm_list list		Field sgm_list
	name str		SLB Service Name
	member_list list		Field member_list
stats dict			Field stats
	server_selection_fail_drop str		Drops due to Service selection failure
	server_selection_fail_reset str		Resets sent out for Service selection failure
	service_peak_conn str		Peak connection count for the Service Group
	service_healthy_host str		Service Group healthy host count
	service_unhealthy_host str		Service Group unhealthy host count
	service_req_count str		Service Group request count
	service_resp_count str		Service Group response count
	service_resp_2xx str		Service Group response 2xx count
	service_resp_3xx str		Service Group response 3xx count
	service_resp_4xx str		Service Group response 4xx count
	service_resp_5xx str		Service Group response 5xx count
	service_curr_conn_overflow str		Current connection counter overflow count
	name str		SLB Service Name
	member_list list		Field member_list

Examples ¶

- name: Create service group
  a10.acos_axapi.a10_slb_service_group:
    name: sg1_80
    protocol: tcp
    lb_method: weighted-rr

- name: Add multiple members to sg1_80
  a10.acos_axapi.a10_slb_service_group:
    name: sg1_80
    protocol: tcp
    lb_method: weighted-rr
    member_list:
      - name: mem1
        port: 80
        host: 1.1.1.2
      - name: mem2
        port: 80
        host: 1.1.1.3
      - name: mem3
        port: 80
        host: 1.1.1.4
      - name: mem4
        port: 80
        host: 1.1.1.5
      - name: mem5
        port: 80
        host: 1.1.1.6

- name: Change the service group lb method from weighted round robin to src ip
  a10.acos_axapi.a10_slb_service_group:
    name: sg1_80
    protocol: tcp
    lb_method: src-ip-hash

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.

Authors¶

A10 Networks 2021