freeipa.ansible_freeipa.ipadnsforwardzone (1.11.1) — module

Manage FreeIPA DNS Forwarder Zones

Authors: Chris Procter (@chr15p), Thomas Woerner (@t-woerner)

preview | supported by community

Install collection

Install with ansible-galaxy collection install freeipa.ansible_freeipa:==1.11.1


Add to requirements.yml

  collections:
    - name: freeipa.ansible_freeipa
      version: 1.11.1

Description

Add and delete an IPA DNS Forwarder Zones using IPA API

Usage examples

1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure dns zone is present
- freeipa.ansible_freeipa.ipadnsforwardzone:
    ipaadmin_password: SomeADMINpassword
    state: present
    name: example.com
    forwarders:
    - ip_address: 8.8.8.8
    - ip_address: 4.4.4.4
    forwardpolicy: first
    skip_overlap_check: true
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure dns zone is present, with forwarder on non-default port
- freeipa.ansible_freeipa.ipadnsforwardzone:
    ipaadmin_password: SomeADMINpassword
    state: present
    name: example.com
    forwarders:
    - ip_address: 8.8.8.8
      port: 8053
    forwardpolicy: first
    skip_overlap_check: true
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure that dns zone is removed
- freeipa.ansible_freeipa.ipadnsforwardzone:
    ipaadmin_password: SomeADMINpassword
    name: example.com
    state: absent

Inputs

    
name:
    aliases:
    - cn
    description:
    - The DNS zone name which needs to be managed.
    elements: str
    required: true
    type: list

state:
    choices:
    - present
    - absent
    - enabled
    - disabled
    default: present
    description: State to ensure
    required: false
    type: str

action:
    choices:
    - member
    - dnsforwardzone
    default: dnsforwardzone
    description: 'Work on dnsforwardzone or member level. It can be one of `member` or

      `dnsforwardzone`.

      '
    type: str

forwarders:
    aliases:
    - idnsforwarders
    description:
    - List of the DNS servers to forward to
    elements: dict
    suboptions:
      ip_address:
        description: Forwarder IP address (either IPv4 or IPv6).
        required: true
        type: str
      port:
        description: Forwarder port.
        required: false
        type: int
    type: list

permission:
    aliases:
    - managedby
    description:
    - Allow DNS Forward Zone to be managed.
    required: false
    type: bool

forwardpolicy:
    aliases:
    - idnsforwardpolicy
    - forward_policy
    choices:
    - only
    - first
    - none
    description: Per-zone conditional forwarding policy
    required: false
    type: str

ipaapi_context:
    choices:
    - server
    - client
    description: '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.

      '
    required: false
    type: str

ipaadmin_password:
    description: The admin password.
    required: false
    type: str

ipaapi_ldap_cache:
    default: true
    description: Use LDAP cache for IPA connection.
    type: bool

ipaadmin_principal:
    default: admin
    description: The admin principal.
    type: str

skip_overlap_check:
    description:
    - Force DNS zone creation even if it will overlap with an existing zone.
    required: false
    type: bool