codeaffen.phpipam.tag module – Manage tags¶
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.tag
.
New in version 1.4.0: of codeaffen.phpipam
Synopsis¶
create, update and delete tags
Requirements¶
The below requirements are needed on the host that executes this module.
colour
inflection
ipaddress
phpypam>=1.0.0
Parameters¶
Parameter |
Comments |
---|---|
API app name Default: “ansible” |
|
Background color of the given tag Can be a valid color name or a hex code |
|
Compress range or not Choices:
|
|
Foreground color of the given tag Can be a valid color name or a hex code |
|
Lock tag or not Choices:
|
|
Name of the given tag |
|
Password of the user to access phpIPAM server |
|
URL of the phpIPAM server |
|
Show tag or not Choices:
|
|
State of the entity Choices:
|
|
Update tags or not Choices:
|
|
Username to access phpIPAM server |
|
Is the TLS certificate of the phpIPAM server verified or not. Choices:
|
Examples¶
- name: "Create tag"
codeaffen.phpipam.tag:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
name: "my tag"
bg_color: #ffffff
fg_color: #000000
state: present
- name: "Remove tag"
codeaffen.phpipam.tag:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
name: "my tag"
state: absent
Authors¶
Christian Meißner (@cmeissner)