codeaffen.phpipam.address module – Manage addresses

Note

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

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 codeaffen.phpipam.

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

New in version 0.2.0: of codeaffen.phpipam

Synopsis

  • create, update and delete addresses

Requirements

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

  • inflection

  • ipaddress

  • phpypam>=1.0.0

Parameters

Parameter

Comments

app_id

string

API app name

Default: “ansible”

description

string

Address description

device

string

Device address belongs to

exclude_ping

boolean

Exclude this address from status update scans

Choices:

  • no

  • yes

hostname

string

Address hostname

ignore_ptr

boolean

Controls if PTR should not be created

Choices:

  • no ← (default)

  • yes

ipaddress

aliases: ip, address

string / required

IP address to hanle

is_gateway

boolean

Defines if address is presented as gateway

Choices:

  • no ← (default)

  • yes

mac_address

aliases: mac

string

Mac address

note

string

Note

owner

string

Address owner

password

string / required

Password of the user to access phpIPAM server

port

string

Port

ptr

string

DNS PTR record

section

string / required

added in 1.3.1 of codeaffen.phpipam

name of the section the given subnet belongs to

server_url

string / required

URL of the phpIPAM server

state

string

State of the entity

Choices:

  • present ← (default)

  • absent

subnet

string / required

subnet address belongs to

tag

string

IP tag (online, offline, …)

username

string / required

Username to access phpIPAM server

validate_certs

boolean

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

Choices:

  • no

  • yes ← (default)

Examples

- name: "Reserve an IP address"
  codeaffen.phpipam.address:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    address: "192.0.2.1"
    section: "Customers"
    description: "Default router of sunet"
    subnet: "192.0.2.0/24"
    is_gateway: yes
    state: present

- name: "Remove address reservation"
  codeaffen.phpipam.address:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    address: "192.0.2.1"
    subnet: "192.0.2.0/24"
    section: "Customers"
    state: absent

Authors

  • Christian Meißner (@cmeissner)