community.general.manageiq_tags module – Management of resource tags in ManageIQ
Note
This module is part of the community.general collection (version 6.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 community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.manageiq_tags
.
Synopsis
The manageiq_tags module supports adding, updating and deleting tags in ManageIQ.
Requirements
The below requirements are needed on the host that executes this module.
manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/
Parameters
Parameter |
Comments |
---|---|
ManageIQ connection configuration information. |
|
The path to a CA bundle file or directory with certificates. defaults to None. |
|
ManageIQ password. |
|
ManageIQ token. |
|
ManageIQ environment url. |
|
ManageIQ username. |
|
Whether SSL certificates should be verified for HTTPS requests. defaults to True. Choices:
|
|
The ID of the resource at which tags will be controlled. Must be specified if resource_name is not set. Both options are mutually exclusive. |
|
The name of the resource at which tags will be controlled. Must be specified if resource_id is not set. Both options are mutually exclusive. |
|
The relevant resource type in manageiq. Choices:
|
|
Choices:
|
|
Required if state is |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create new tags for a provider in ManageIQ.
community.general.manageiq_tags:
resource_name: 'EngLab'
resource_type: 'provider'
tags:
- category: environment
name: prod
- category: owner
name: prod_ops
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false
- name: Create new tags for a provider in ManageIQ.
community.general.manageiq_tags:
resource_id: 23000000790497
resource_type: 'provider'
tags:
- category: environment
name: prod
- category: owner
name: prod_ops
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false
- name: Remove tags for a provider in ManageIQ.
community.general.manageiq_tags:
state: absent
resource_name: 'EngLab'
resource_type: 'provider'
tags:
- category: environment
name: prod
- category: owner
name: prod_ops
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false
- name: List current tags for a provider in ManageIQ.
community.general.manageiq_tags:
state: list
resource_name: 'EngLab'
resource_type: 'provider'
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false
Authors
Daniel Korn (@dkorn)
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication