Skip to content

Latest commit

 

History

History
123 lines (96 loc) · 3.79 KB

README-dnsforwardzone.md

File metadata and controls

123 lines (96 loc) · 3.79 KB
Raw

Dnsforwardzone module

Description

The dnsforwardzone module allows the addition and removal of dns forwarders from the IPA DNS config.

It is desgined to follow the IPA api as closely as possible while ensuring ease of use.

Features

  • DNS zone management

Supported FreeIPA Versions

FreeIPA versions 4.4.0 and up are supported by the ipadnsforwardzone module.

Requirements

Controller

  • Ansible version: 2.14+

Node

  • Supported FreeIPA version (see above)

Usage

Example inventory file

[ipaserver]
ipaserver.test.local

Example playbook to ensure presence of a forwardzone to ipa DNS:

---
- name: Playbook to handle add a forwarder
  hosts: ipaserver
  become: true

  tasks:
  - name: ensure presence of forwardzone with a single forwarder DNS server
    ipadnsforwardzone:
      ipaadmin_password: SomeADMINpassword
      state: present
      name: example.com
      forwarders:
        - ip_address: 8.8.8.8
      forwardpolicy: first
      skip_overlap_check: true

  - name: ensure the forward zone is disabled
    ipadnsforwardzone:
      ipaadmin_password: SomeADMINpassword
      name: example.com
      state: disabled

  - name: ensure presence of forwardzone with multiple forwarder DNS server
    ipadnsforwardzone:
      ipaadmin_password: SomeADMINpassword
      state: present
      name: example.com
      forwarders:
        - ip_address: 8.8.8.8
        - ip_address: 4.4.4.4

  - name: ensure presence of another forwarder to any existing ones for example.com
    ipadnsforwardzone:
      ipaadmin_password: SomeADMINpassword
      state: present
      name: example.com
      forwarders:
        - ip_address: 1.1.1.1
      action: member

  - name: ensure presence of forwardzone with single forwarder DNS server on non-stardard port
    ipadnsforwardzone:
      ipaadmin_password: SomeADMINpassword
      state: present
      name: example.com
      forwarders:
        - ip_address: 4.4.4.4
          port: 8053

  - name: ensure the forward zone is absent
    ipadnsforwardzone:
      ipaadmin_password: SomeADMINpassword
      name: example.com
      state: absent

Variables

Variable Description Required
ipaadmin_principal The admin principal is a string and defaults to admin no
ipaadmin_password The admin password is a string and is required if there is no admin ticket available on the node no
ipaapi_context The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are server and client. no
ipaapi_ldap_cache Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) no
name | cn Zone name (FQDN). yes if state == present
forwarders | idnsforwarders Per-zone forwarders. A custom port can be specified for each forwarder. Options no
  ip_address: The forwarder IP address. yes
  port: The forwarder IP port. no
forwardpolicy | idnsforwardpolicy | forward_policy Per-zone conditional forwarding policy. Possible values are only, first, none. Set to "none" to disable forwarding to global forwarder for this zone. In that case, conditional zone forwarders are disregarded. no
skip_overlap_check Force DNS zone creation even if it will overlap with an existing zone. Defaults to False. no
permission Allow DNS Forward Zone to be managed. (bool) no
action Work on group or member level. It can be on of member or dnsforwardzone and defaults to dnsforwardzone. no
state The state to ensure. It can be one of present, absent, enabled or disabled, default: present. yes

Authors

Chris Procter