tag_module.rst

orphan:

codeaffen.phpipam.tag module -- Manage tags

Note

This module is part of the codeaffen.phpipam collection (version 1.7.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.

.. versionadded:: 1.4.0 of codeaffen.phpipam

• Synopsis
• Requirements
• Parameters
• Examples

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

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title app_id .. rst-class:: ansible-option-type-line string	API app name .. rst-class:: ansible-option-line Default: "ansible"
.. rst-class:: ansible-option-title bg_color .. rst-class:: ansible-option-type-line string / required	Background color of the given tag Can be a valid color name or a hex code
.. rst-class:: ansible-option-title compress_range .. rst-class:: ansible-option-type-line boolean	Compress range or not .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title fg_color .. rst-class:: ansible-option-type-line string / required	Foreground color of the given tag Can be a valid color name or a hex code
.. rst-class:: ansible-option-title is_locked .. rst-class:: ansible-option-type-line boolean	Lock tag or not .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title name .. rst-class:: ansible-option-type-line aliases: type .. rst-class:: ansible-option-type-line string / required	Name of the given tag
.. rst-class:: ansible-option-title password .. rst-class:: ansible-option-type-line string / required	Password of the user to access phpIPAM server
.. rst-class:: ansible-option-title server_url .. rst-class:: ansible-option-type-line string / required	URL of the phpIPAM server
.. rst-class:: ansible-option-title show_tag .. rst-class:: ansible-option-type-line boolean	Show tag or not .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	State of the entity .. rst-class:: ansible-option-line Choices: present ← (default) absent
.. rst-class:: ansible-option-title update_tags .. rst-class:: ansible-option-type-line boolean	Update tags or not .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title username .. rst-class:: ansible-option-type-line string / required	Username to access phpIPAM server
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line boolean	Is the TLS certificate of the phpIPAM server verified or not. .. rst-class:: ansible-option-line Choices: no yes ← (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)

Collection links

Issue Tracker Homepage Repository (Sources)