a10_gslb_zone_service

Synopsis

Service information for the GSLB zone

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

zone_name

str/required

Key to identify parent object

service_port

int/required

Port number of the service

service_name

str/required

Specify the service name for the zone, * for wildcard

action

str

‘drop’= Drop query; ‘forward’= Forward packet; ‘ignore’= Send empty response; ‘reject’= Send refuse response;

forward_type

str

‘both’= Forward both query and response; ‘query’= Forward query; ‘response’= Forward response;

disable

bool

Disable

health_check_gateway

str

‘enable’= Enable Gateway Status Check; ‘disable’= Disable Gateway Status Check;

health_check_port

list

Field health_check_port

health_check_port

int

Check Related Port Status (Port Number)

policy

str

Specify policy for this service (Specify policy name)

uuid

str

uuid of the object

user_tag

str

Customized tag

sampling_enable

list

Field sampling_enable

counters1

str

‘all’= all; ‘received-query’= Number of DNS queries received for the service; ‘sent-response’= Number of DNS replies sent to clients for the service; ‘proxy- mode-response’= Number of DNS replies sent to clients by the ACOS device as a DNS proxy for the service; ‘cache-mode-response’= Number of cached DNS replies sent to clients by the ACOS device for the service. (This statistic applies only if the DNS cache; ‘server-mode-response’= Number of DNS replies sent to clients by the ACOS device as a DNS server for the service. (This statistic applies only if the D; ‘sticky-mode-response’= Number of DNS replies sent to clients by the ACOS device to keep the clients on the same site. (This statistic applies only if; ‘backup-mode-response’= help Number of DNS replies sent to clients by the ACOS device in backup mode;

dns_a_record

dict

Field dns_a_record

dns_a_record_srv_list

list

Field dns_a_record_srv_list

dns_a_record_ipv4_list

list

Field dns_a_record_ipv4_list

dns_a_record_ipv6_list

list

Field dns_a_record_ipv6_list

dns_cname_record_list

list

Field dns_cname_record_list

alias_name

str

Specify the alias name

admin_preference

int

Specify Administrative Preference, default is 100

weight

int

Specify Weight, default is 1

as_backup

bool

As backup when fail

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

dns_mx_record_list

list

Field dns_mx_record_list

mx_name

str

Specify Domain Name

priority

int

Specify Priority

ttl

int

Specify TTL

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

dns_ns_record_list

list

Field dns_ns_record_list

ns_name

str

Specify Domain Name

ttl

int

Specify TTL

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

dns_ptr_record_list

list

Field dns_ptr_record_list

ptr_name

str

Specify Domain Name

ttl

int

Specify TTL

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

dns_srv_record_list

list

Field dns_srv_record_list

srv_name

str

Specify Domain Name

port

int

Specify Port (Port Number)

priority

int

Specify Priority

weight

int

Specify Weight, default is 10

ttl

int

Specify TTL

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

dns_naptr_record_list

list

Field dns_naptr_record_list

naptr_target

str

Specify the replacement or regular expression

service_proto

str

Specify Service and Protocol

flag

str

Specify the flag (e.g., a, s). Default is empty flag

order

int

Specify Order

preference

int

Specify Preference

regexp

bool

Return the regular expression

ttl

int

Specify TTL

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

dns_txt_record_list

list

Field dns_txt_record_list

record_name

str

Specify the Object Name for TXT Data

txt_data

str

Specify TXT Data

ttl

int

Specify TTL

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

dns_caa_record_list

list

Field dns_caa_record_list

critical_flag

int

Issuer Critical Flag

property_tag

str

Specify other property tags, only allowed lowercase alphanumeric

rdata

str

Specify the Issuer Domain Name or a URL

ttl

int

Specify TTL

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

dns_record_list

list

Field dns_record_list

ntype

int

Specify DNS Type

data

str

Specify DNS Data

uuid

str

uuid of the object

geo_location_list

list

Field geo_location_list

geo_name

str

Specify the geo-location

alias

list

Field alias

action

bool

Action for this geo-location

action_type

str

‘allow’= Allow query from this geo-location; ‘drop’= Drop query from this geo- location; ‘forward’= Forward packet for this geo-location; ‘ignore’= Send empty response to this geo-location; ‘reject’= Send refuse response to this geo- location;

forward_type

str

‘both’= Forward both query and response; ‘query’= Forward query from this geo- location; ‘response’= Forward response to this geo-location;

policy

str

Policy for this geo-location (Specify the policy name)

uuid

str

uuid of the object

user_tag

str

Customized tag

oper

dict

Field oper

state

str

Field state

cache_list

list

Field cache_list

session_list

list

Field session_list

matched

int

Field matched

total_sessions

int

Field total_sessions

dns_a_record_list

list

Field dns_a_record_list

service_port

int

Port number of the service

service_name

str

Specify the service name for the zone, * for wildcard

dns_mx_record_list

list

Field dns_mx_record_list

dns_ns_record_list

list

Field dns_ns_record_list

stats

dict

Field stats

received_query

str

Number of DNS queries received for the service

sent_response

str

Number of DNS replies sent to clients for the service

proxy_mode_response

str

Number of DNS replies sent to clients by the ACOS device as a DNS proxy for the service

cache_mode_response

str

Number of cached DNS replies sent to clients by the ACOS device for the service. (This statistic applies only if the DNS cache

server_mode_response

str

Number of DNS replies sent to clients by the ACOS device as a DNS server for the service. (This statistic applies only if the D

sticky_mode_response

str

Number of DNS replies sent to clients by the ACOS device to keep the clients on the same site. (This statistic applies only if

backup_mode_response

str

help Number of DNS replies sent to clients by the ACOS device in backup mode

service_port

int

Port number of the service

service_name

str

Specify the service name for the zone, * for wildcard

dns_cname_record_list

list

Field dns_cname_record_list

dns_mx_record_list

list

Field dns_mx_record_list

dns_ns_record_list

list

Field dns_ns_record_list

dns_ptr_record_list

list

Field dns_ptr_record_list

dns_srv_record_list

list

Field dns_srv_record_list

dns_naptr_record_list

list

Field dns_naptr_record_list

dns_txt_record_list

list

Field dns_txt_record_list

dns_caa_record_list

list

Field dns_caa_record_list

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