codeaffen.phpipam.nameserver module – Manage nameservers

Note

This module is part of the codeaffen.phpipam collection (version 1.7.0).

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 codeaffen.phpipam. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: codeaffen.phpipam.nameserver.

New in codeaffen.phpipam 0.3.0

Synopsis

  • create, update and delete nameservers

Requirements

The below requirements are needed on the host that executes this module.

  • inflection

  • ipaddress

  • phpypam>=1.0.0

Parameters

Parameter

Comments

addresses

list / elements=string

List of IP addresses the namerserver can be reached on

app_id

string

API app name

Default: "ansible"

description

string

A descriptive text for that entity

name

string / required

Name of the given nameserver

password

string / required

Password of the user to access phpIPAM server

sections

list / elements=string

List of sections where the nameserver appears

server_url

string / required

URL of the phpIPAM server

state

string

State of the entity

Choices:

  • "present" ← (default)

  • "absent"

username

string / required

Username to access phpIPAM server

validate_certs

boolean

Is the TLS certificate of the phpIPAM server verified or not.

Choices:

  • false

  • true ← (default)

Examples

- name: "Create nameserver"
  codeaffen.phpipam.nameserver:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    name: "cloudflare dns"
    addresses:
      - 1.1.1.1
      - 1.0.0.1
    permissions: 1;2
    state: present

- name: "Remove nameserver
  codeaffen.phpipam.nameserver:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    name: "cloudflare dns"
    state: absent

Authors

  • Christian Meißner (@cmeissner)