codeaffen.phpipam.tag – Manage tags

Note

This plugin is part of the codeaffen.phpipam collection (version 1.5.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 Choices/Defaults Comments
app_id
string
Default:
"ansible"
API app name
bg_color
string / required
Background color of the given tag
Can be a valid color name or a hex code
compress_range
boolean
    Choices:
  • no ←
  • yes
Compress range or not
fg_color
string / required
Foreground color of the given tag
Can be a valid color name or a hex code
is_locked
boolean
    Choices:
  • no ←
  • yes
Lock tag or not
name
string / required
Name of the given tag

aliases: type
password
string / required
Password of the user to access phpIPAM server
server_url
string / required
URL of the phpIPAM server
show_tag
boolean
    Choices:
  • no ←
  • yes
Show tag or not
state
string
    Choices:
  • present ←
  • absent
State of the entity
update_tags
boolean
    Choices:
  • no ←
  • yes
Update tags or not
username
string / required
Username to access phpIPAM server
validate_certs
boolean
    Choices:
  • no
  • yes ←
Is the TLS certificate of the phpIPAM server verified or not.

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)