codeaffen.phpipam.tag module – Manage tags

Note

This module is part of the codeaffen.phpipam collection (version 1.7.0).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: codeaffen.phpipam.tag.

New in codeaffen.phpipam 1.4.0

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

app_id

string

API app name

Default: "ansible"

bg_color

string / required

Background color of the given tag

Can be a valid color name or a hex code

compress_range

boolean

Compress range or not

Choices:

  • false ← (default)

  • true

fg_color

string / required

Foreground color of the given tag

Can be a valid color name or a hex code

is_locked

boolean

Lock tag or not

Choices:

  • false ← (default)

  • true

name

aliases: type

string / required

Name of the given tag

password

string / required

Password of the user to access phpIPAM server

server_url

string / required

URL of the phpIPAM server

show_tag

boolean

Show tag or not

Choices:

  • false ← (default)

  • true

state

string

State of the entity

Choices:

  • "present" ← (default)

  • "absent"

update_tags

boolean

Update tags or not

Choices:

  • false ← (default)

  • true

username

string / required

Username to access phpIPAM server

validate_certs

boolean

Is the TLS certificate of the phpIPAM server verified or not.

Choices:

  • false

  • true ← (default)

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)