address_module.rst

orphan:

codeaffen.phpipam.address module -- Manage addresses

Note

This module is part of the codeaffen.phpipam collection (version 1.7.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.

.. versionadded:: 0.2.0 of codeaffen.phpipam

• Synopsis
• Requirements
• Parameters
• Examples

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

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title app_id .. rst-class:: ansible-option-type-line string	API app name .. rst-class:: ansible-option-line Default: "ansible"
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string	Address description
.. rst-class:: ansible-option-title device .. rst-class:: ansible-option-type-line string	Device address belongs to
.. rst-class:: ansible-option-title exclude_ping .. rst-class:: ansible-option-type-line boolean	Exclude this address from status update scans .. rst-class:: ansible-option-line Choices: no yes
.. rst-class:: ansible-option-title hostname .. rst-class:: ansible-option-type-line string	Address hostname
.. rst-class:: ansible-option-title ignore_ptr .. rst-class:: ansible-option-type-line boolean	Controls if PTR should not be created .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title ipaddress .. rst-class:: ansible-option-type-line aliases: ip, address .. rst-class:: ansible-option-type-line string / required	IP address to hanle
.. rst-class:: ansible-option-title is_gateway .. rst-class:: ansible-option-type-line boolean	Defines if address is presented as gateway .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title mac_address .. rst-class:: ansible-option-type-line aliases: mac .. rst-class:: ansible-option-type-line string	Mac address
.. rst-class:: ansible-option-title note .. rst-class:: ansible-option-type-line string	Note
.. rst-class:: ansible-option-title owner .. rst-class:: ansible-option-type-line string	Address owner
.. rst-class:: ansible-option-title password .. rst-class:: ansible-option-type-line string / required	Password of the user to access phpIPAM server
.. rst-class:: ansible-option-title port .. rst-class:: ansible-option-type-line string	Port
.. rst-class:: ansible-option-title ptr .. rst-class:: ansible-option-type-line string	DNS PTR record
.. rst-class:: ansible-option-title section .. rst-class:: ansible-option-type-line string / required added in 1.3.1 of codeaffen.phpipam	name of the section the given subnet belongs to
.. rst-class:: ansible-option-title server_url .. rst-class:: ansible-option-type-line string / required	URL of the phpIPAM server
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	State of the entity .. rst-class:: ansible-option-line Choices: present ← (default) absent
.. rst-class:: ansible-option-title subnet .. rst-class:: ansible-option-type-line string / required	subnet address belongs to
.. rst-class:: ansible-option-title tag .. rst-class:: ansible-option-type-line string	IP tag (online, offline, ...)
.. rst-class:: ansible-option-title username .. rst-class:: ansible-option-type-line string / required	Username to access phpIPAM server
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line boolean	Is the TLS certificate of the phpIPAM server verified or not. .. rst-class:: ansible-option-line 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)

Collection links

Issue Tracker Homepage Repository (Sources)