community.dns.hosttech_dns_zone_info module – Retrieve zone information in Hosttech DNS service
Note
This module is part of the community.dns collection (version 2.4.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.dns
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.dns.hosttech_dns_zone_info
.
New in community.dns 0.2.0
Synopsis
Retrieves zone information in Hosttech DNS service.
Requirements
The below requirements are needed on the host that executes this module.
lxml
Parameters
Parameter |
Comments |
---|---|
The password for the Hosttech API user. If provided, hosttech_username must also be provided. Mutually exclusive with hosttech_token. |
|
The password for the Hosttech API user. Mutually exclusive with hosttech_username and hosttech_password. Since community.dns 1.2.0, the alias api_token can be used. |
|
The username for the Hosttech API user. If provided, hosttech_password must also be provided. Mutually exclusive with hosttech_token. |
|
The ID of the DNS zone to query. Exactly one of zone_name and zone_id must be specified. |
|
The DNS zone to query. Exactly one of zone_name and zone_id must be specified. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Action group: community.dns.hosttech added in community.dns 2.4.0 |
Use |
|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Retrieve details for foo.com zone
community.dns.hosttech_dns_zone_info:
zone_name: foo.com
hosttech_username: foo
hosttech_password: bar
register: rec
- name: Retrieve details for zone 23
community.dns.hosttech_dns_zone_info:
zone_id: 23
hosttech_token: access_token
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The ID of the zone. Returned: success Sample: |
|
Extra information returned by the API. Returned: success Sample: |
|
Whether DNSSEC is enabled for the zone or not. Returned: When hosttech_token has been specified. |
|
The email address contacted when the DNSSEC key is changed. Is Returned: When hosttech_token has been specified. |
|
The DS records. See Section 5 of RFC 4034 and Section 2.1 of RFC 4034 for details. Is Returned: When hosttech_token has been specified. |
|
This value is the algorithm number of the DNSKEY RR referred to by the DS record. A list of values can be found in Appendix A.1 of RFC 4034. Returned: success Sample: |
|
A digest of the DNSKEY RR record this DS record refers to. Returned: success Sample: |
|
This value identifies the algorithm used to construct the digest. A list of values can be found in Appendix A.2 of RFC 4034. Returned: success Sample: |
|
The Key Tag field lists the key tag of the DNSKEY RR referred to by the DS record. Returned: success Sample: |
|
Must be 3 according to RFC 4034. Returned: success Sample: |
|
The public key material. Returned: success Sample: |
|
The zone’s DNS contact mail in the SOA record. Returned: success |
|
The zone’s TTL. Returned: success |
|
The name of the zone. Returned: success Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication