a10_gslb_policy

Synopsis

Policy for GSLB zone, service or geo-location

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			Specify policy name
health_check bool			Select Service-IP by health status
health_check_preference_enable bool			Check health preference
health_preference_top int			Only keep top n
amount_first bool			Select record based on the amount of available service-ip
weighted_ip_enable bool			Enable Select Service-IP by weighted preference
weighted_ip_total_hits bool			Weighted by total hits
weighted_site_enable bool			Enable Select Service-IP by weighted site preference
weighted_site_total_hits bool			Weighted by total hits
weighted_alias bool			Select alias name by weighted preference
active_servers_enable bool			Enable Select Service-IP with the highest number of active servers
active_servers_fail_break bool			Break when no active server
bw_cost_enable bool			Enable bw cost
bw_cost_fail_break bool			Break when exceed limit
geographic bool			Select Service-IP by geographic
num_session_enable bool			Enable Select Service-IP for device having maximum number of available sessions
num_session_tolerance int			The difference between the available sessions, default is 10 (Tolerance)
admin_preference bool			Select Service-IP for the device having maximum admin preference
alias_admin_preference bool			Select alias name having maximum admin preference
least_response bool			Least response selection
admin_ip_enable bool			Enable admin ip
admin_ip_top_only bool			Return highest priority server only
ordered_ip_top_only bool			Return highest priority server only
round_robin bool			Round robin selection, enabled by default
metric_force_check bool			Always check Service-IP for all enabled metrics
metric_fail_break bool			Break if no valid Service-IP
ip_list str			Specify IP List (IP List Name)
metric_order bool			Specify order of metric
metric_type str			Field metric_type
uuid str			uuid of the object
user_tag str			Customized tag
capacity dict			Field capacity
	capacity_enable bool		Enable capacity
	threshold int		Specify capacity threshold, default is 90
	capacity_fail_break bool		Break when exceed threshold
	uuid str		uuid of the object
connection_load dict			Field connection_load
	connection_load_enable bool		Enable connection-load
	connection_load_fail_break bool		Break when exceed limit
	connection_load_samples int		Specify samples for connection-load (Number of samples used to calculate the connection load, default is 5)
	connection_load_interval int		Interval between two samples, Unit= second (Interval value,default is 5)
	limit bool		Limit of maxinum connection load, default is unlimited
	connection_load_limit int		The value of the connection-load limit, default is unlimited
	uuid str		uuid of the object
dns dict			Field dns
	action bool		Apply DNS action for service
	active_only bool		Only keep active servers
	active_only_fail_safe bool		Continue if no candidate
	dns_addition_mx bool		Append MX Records in Addition Section
	dns_auto_map bool		Automatically build DNS Infrastructure
	backup_alias bool		Return alias name when fail
	backup_server bool		Return fallback server when fail
	external_ip bool		Return DNS response with external IP address
	external_soa bool		Return DNS response with external SOA Record
	cname_detect bool		Apply GSLB for DNS Server response when service is Canonical Name (CNAME)
	ip_replace bool		Replace DNS Server Response with GSLB Service-IPs
	geoloc_alias bool		Return alias name by geo-location
	geoloc_action bool		Apply DNS action by geo-location
	geoloc_policy bool		Apply different policy by geo-location
	selected_only bool		Only keep selected servers
	selected_only_value int		Answer Number
	cache bool		Cache DNS Server response
	aging_time int		Specify aging-time, default is TTL in DNS record, unit= second (Aging time, default 0 means using TTL in DNS record as aging time)
	delegation bool		Zone Delegation
	hint str		‘none’= None; ‘answer’= Append Hint Records in DNS Answer Section; ‘addition’= Append Hint Records in DNS Addition Section;
	logging str		‘none’= None; ‘query’= DNS Query; ‘response’= DNS Response; ‘both’= Both DNS Query and Response;
	template str		Logging template (Logging Template Name)
	ttl int		Specify the TTL value contained in DNS record (TTL value, unit= second, default is 10)
	use_server_ttl bool		Use DNS Server Response TTL value in GSLB Proxy mode
	server bool		Run GSLB as DNS server mode
	server_srv bool		Provide SRV Records
	server_mx bool		Provide MX Records
	server_naptr bool		Provide NAPTR Records
	server_addition_mx bool		Append MX Records in Addition Section
	server_ns bool		Provide NS Records
	server_auto_ns bool		Provide A-Records for NS-Records automatically
	server_ptr bool		Provide PTR Records
	server_auto_ptr bool		Provide PTR Records automatically
	server_txt bool		Provide TXT Records
	server_custom bool		Provide Custom Records
	server_any bool		Provide All Records
	server_any_with_metric bool		Provide All Records with GSLB Metrics applied to A/AAAA Records
	server_authoritative bool		As authoritative server
	server_sec bool		Provide DNSSEC support
	server_ns_list bool		Append All NS Records in Authoritative Section
	server_full_list bool		Append All A Records in Authoritative Section
	server_mode_only bool		Only run GSLB as DNS server mode
	zone_owner_mode bool		Only run GSLB as DNS server mode with zone ownership
	server_cname bool		Provide CNAME Records
	server_caa bool		Provide CAA Records
	ipv6 list		Field ipv6
	block_action bool		Specify Action
	action_type str		‘drop’= Drop query; ‘reject’= Send refuse response; ‘ignore’= Send empty response;
	proxy_block_port_range_list list		Field proxy_block_port_range_list
	block_value list		Field block_value
	block_type str		Field block_type
	sticky bool		Make DNS Record sticky for certain time
	sticky_mask str		Specify IP mask, default is /32
	sticky_ipv6_mask int		Specify IPv6 mask length, default is 128
	sticky_aging_time int		Specify aging-time, unit= min, default is 5 (Aging time)
	dynamic_preference bool		Make dynamically change the preference
	dynamic_weight bool		dynamically change the weight
	uuid str		uuid of the object
geo_location_list list			Field geo_location_list
	name str		Specify geo-location name, section range is (1-15)
	ip_multiple_fields list		Field ip_multiple_fields
	ipv6_multiple_fields list		Field ipv6_multiple_fields
	uuid str		uuid of the object
	user_tag str		Customized tag
geo_location_match dict			Field geo_location_match
	overlap bool		Enable overlap mode to do longest match
	geo_type_overlap str		‘global’= Global Geo-location; ‘policy’= Policy Geo-location;
	match_first str		‘global’= Global Geo-location; ‘policy’= Policy Geo-location;
	uuid str		uuid of the object
active_rdt dict			Field active_rdt
	enable bool		Enable the active rdt
	single_shot bool		Single Shot RDT
	timeout int		Specify timeout if round-delay-time samples are not ready (Specify timeout, unit=sec,default is 3)
	skip int		Skip query if round-delay-time samples are not ready (Specify maximum skip count,default is 3)
	keep_tracking bool		Keep tracking client even round-delay-time samples are ready
	ignore_id int		Ignore IP Address specified in IP List by ID
	samples int		Specify samples number for round-delay-time (Number of samples,default is 5)
	tolerance int		The difference percentage between the round-delay-time, default is 10 (Tolerance)
	difference int		The difference between the round-delay-time, default is 0
	limit int		Limit of allowed RDT, default is 16383 (Limit, unit= millisecond)
	fail_break bool		Break when no valid RDT
	controller bool		Active round-delay-time by controller
	proto_rdt_enable bool		Enable the round-delay-time to the controller
	uuid str		uuid of the object
auto_map dict			Field auto_map
	ttl int		Specify Auto Map TTL (TTL, default is 300)
	module_disable bool		Specify Disable Auto Map Module
	all bool		All modules
	module_type str		Field module_type
	uuid str		uuid of the object
edns dict			Field edns
	client_subnet_geographic bool		Use client subnet for geo-location
	uuid str		uuid of the object
oper dict			Field oper
	metric_list list		Field metric_list
	name str		Specify policy name

Examples

Return Values

modified_values (changed, dict, )

Values modified (or potential changes if using check_mode) as a result of task operation

axapi_calls (always, list, )

Sequential list of AXAPI calls made by the task

endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])

The AXAPI endpoint being accessed.

http_method (, str, [‘POST’, ‘GET’])

HTTP method being used by the primary task to interact with the AXAPI endpoint.

request_body (, complex, )

Params used to query the AXAPI

response_body (, complex, )

Response from the AXAPI

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]

• This module is maintained by community.

Authors

• A10 Networks