codeaffen.phpipam.domain module – Manage L2 routing domains¶
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.domain
.
New in version 0.3.0: of codeaffen.phpipam
Synopsis¶
create, update and delete L2 routing domains
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” |
|
A descriptive text for that entity |
|
Name of the given domain |
|
Password of the user to access phpIPAM server |
|
List of sections where the nameserver appears |
|
URL of the phpIPAM server |
|
State of the entity Choices:
|
|
Username to access phpIPAM server |
|
Is the TLS certificate of the phpIPAM server verified or not. Choices:
|
Examples¶
- name: "Create domain"
codeaffen.phpipam.domain:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
name: "my domain"
sections:
- Example Inc.
- DEVOPS department
state: present
- name: "Remove domain"
codeaffen.phpipam.domain:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
name: "my domain"
state: absent