community.general.manageiq_tags – Management of resource tags in ManageIQ.
community.general.manageiq_tags – Management of resource tags in ManageIQ.
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
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 | Choices/Defaults | Comments | |
---|---|---|---|
manageiq_connection dictionary |
ManageIQ connection configuration information. | ||
ca_cert string |
The path to a CA bundle file or directory with certificates. defaults to None.
| ||
password string |
ManageIQ password. | ||
token string |
ManageIQ token. | ||
url string |
ManageIQ environment url. | ||
username string |
ManageIQ username. | ||
validate_certs boolean |
|
Whether SSL certificates should be verified for HTTPS requests. defaults to True.
| |
resource_name string / required |
the relevant resource name in manageiq | ||
resource_type string / required |
|
the relevant resource type in manageiq | |
state string |
|
absent - tags should not exist, present - tags should exist, list - list current tags. | |
tags list / elements=string |
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: 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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/manageiq_tags_module.html