- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ipa_dnsrecord – Manage FreeIPA DNS records

New in version 2.4.

- Synopsis
- Parameters
- Examples
- Return Values
- Status

## Synopsis

- Add, modify and delete an IPA DNS Record using IPA API.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
ipa_host string | Default: "ipa.example.com" | IP or hostname of IPA server. If the value is not specified in the task, the value of environment variable `IPA_HOST` will be used instead. If both the environment variable `IPA_HOST` and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server. The relevant entry needed in FreeIPA is the 'ipa-ca' entry. If neither the DNS entry, nor the environment `IPA_HOST`, nor the value are available in the task, then the default value will be used. Environment variable fallback mechanism is added in Ansible 2.5.
ipa_pass string / required |  | Password of administrative user. If the value is not specified in the task, the value of environment variable `IPA_PASS` will be used instead. Note that if the 'urllib_gssapi' library is available, it is possible to use GSSAPI to authenticate to FreeIPA. If the environment variable `KRB5CCNAME` is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server. If the environment variable `KRB5_CLIENT_KTNAME` is available, and `KRB5CCNAME` is not; the module will use this kerberos keytab to authenticate. If GSSAPI is not available, the usage of 'ipa_pass' is required. Environment variable fallback mechanism is added in Ansible 2.5.
ipa_port integer | Default: 443 | Port of FreeIPA / IPA server. If the value is not specified in the task, the value of environment variable `IPA_PORT` will be used instead. If both the environment variable `IPA_PORT` and the value are not specified in the task, then default value is set. Environment variable fallback mechanism is added in Ansible 2.5.
ipa_prot string | Choices: http https ← | Protocol used by IPA server. If the value is not specified in the task, the value of environment variable `IPA_PROT` will be used instead. If both the environment variable `IPA_PROT` and the value are not specified in the task, then default value is set. Environment variable fallback mechanism is added in Ansible 2.5.
ipa_timeout integer added in 2.7 | Default: 10 | Specifies idle timeout (in seconds) for the connection. For bulk operations, you may want to increase this in order to avoid timeout from IPA server. If the value is not specified in the task, the value of environment variable `IPA_TIMEOUT` will be used instead. If both the environment variable `IPA_TIMEOUT` and the value are not specified in the task, then default value is set.
ipa_user string | Default: "admin" | Administrative account used on IPA server. If the value is not specified in the task, the value of environment variable `IPA_USER` will be used instead. If both the environment variable `IPA_USER` and the value are not specified in the task, then default value is set. Environment variable fallback mechanism is added in Ansible 2.5.
record_name - / required |  | The DNS record name to manage. aliases: name
record_ttl - added in 2.7 |  | Set the TTL for the record. Applies only when adding a new or changing the value of record_value.
record_type - | Choices: A ← AAAA A6 CNAME DNAME PTR TXT SRV MX | The type of DNS record name. Currently, 'A', 'AAAA', 'A6', 'CNAME', 'DNAME', 'PTR', 'TXT', 'SRV' and 'MX' are supported. 'A6', 'CNAME', 'DNAME' and 'TXT' are added in version 2.5. 'SRV' and 'MX' are added in version 2.8.
record_value - / required |  | Manage DNS record name with this value. In the case of 'A' or 'AAAA' record types, this will be the IP address. In the case of 'A6' record type, this will be the A6 Record data. In the case of 'CNAME' record type, this will be the hostname. In the case of 'DNAME' record type, this will be the DNAME target. In the case of 'PTR' record type, this will be the hostname. In the case of 'TXT' record type, this will be a text. In the case of 'SRV' record type, this will be a service record. In the case of 'MX' record type, this will be a mail exchanger record.
state - | Choices: present ← absent | State to ensure
validate_certs boolean | Choices: no yes ← | This only applies if `ipa_prot` is https. If set to `no`, the SSL certificates will not be validated. This should only set to `no` used on personally controlled sites using self-signed certificates.
zone_name - / required |  | The DNS zone name to which DNS record needs to be managed.

## Examples

    # Ensure dns record is present
    - ipa_dnsrecord:
        ipa_host: spider.example.com
        ipa_pass: Passw0rd!
        state: present
        zone_name: example.com
        record_name: vm-001
        record_type: 'AAAA'
        record_value: '::1'

    # Ensure that dns record exists with a TTL
    - ipa_dnsrecord:
        name: host02
        zone_name: example.com
        record_type: 'AAAA'
        record_value: '::1'
        record_ttl: 300
        ipa_host: ipa.example.com
        ipa_pass: topsecret
        state: present

    # Ensure a PTR record is present
    - ipa_dnsrecord:
        ipa_host: spider.example.com
        ipa_pass: Passw0rd!
        state: present
        zone_name: 2.168.192.in-addr.arpa
        record_name: 5
        record_type: 'PTR'
        record_value: 'internal.ipa.example.com'

    # Ensure a TXT record is present
    - ipa_dnsrecord:
        ipa_host: spider.example.com
        ipa_pass: Passw0rd!
        state: present
        zone_name: example.com
        record_name: _kerberos
        record_type: 'TXT'
        record_value: 'EXAMPLE.COM'

    # Ensure an SRV record is present
    - ipa_dnsrecord:
        ipa_host: spider.example.com
        ipa_pass: Passw0rd!
        state: present
        zone_name: example.com
        record_name: _kerberos._udp.example.com
        record_type: 'SRV'
        record_value: '10 50 88 ipa.example.com'

    # Ensure an MX record is present
    - ipa_dnsrecord:
        ipa_host: spider.example.com
        ipa_pass: Passw0rd!
        state: present
        zone_name: example.com
        record_name: '@'
        record_type: 'MX'
        record_value: '1 mailserver.example.com'

    # Ensure that dns record is removed
    - ipa_dnsrecord:
        name: host01
        zone_name: example.com
        record_type: 'AAAA'
        record_value: '::1'
        ipa_host: ipa.example.com
        ipa_user: admin
        ipa_pass: topsecret
        state: absent

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
dnsrecord dictionary | always | DNS record as returned by IPA API.

## Status

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

### Authors

- Abhijeet Kasurde (@Akasurde)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.