community.general.manageiq_tags module – Management of resource tags in ManageIQ.
Note
This module is part of the community.general collection (version 4.8.3).
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
.
To use it in a playbook, specify: community.general.manageiq_tags
.
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:
|
|
absent - tags should not exist, present - tags should exist, list - list current tags. Choices:
|
|
tags - list of dictionaries, each includes ‘name’ and ‘category’ keys. required if state is present or absent. |
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