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 |
---|---|
API app name Default: “ansible” |
|
Address description |
|
Device address belongs to |
|
Exclude this address from status update scans Choices:
|
|
Address hostname |
|
Controls if PTR should not be created Choices:
|
|
IP address to hanle |
|
Defines if address is presented as gateway Choices:
|
|
Mac address |
|
Note |
|
Address owner |
|
Password of the user to access phpIPAM server |
|
Port |
|
DNS PTR record |
|
name of the section the given subnet belongs to |
|
URL of the phpIPAM server |
|
State of the entity Choices:
|
|
subnet address belongs to |
|
IP tag (online, offline, …) |
|
Username to access phpIPAM server |
|
Is the TLS certificate of the phpIPAM server verified or not. Choices:
|
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