community.general.manageiq_group module – Management of groups in ManageIQ
Note
This module is part of the community.general collection (version 9.5.1).
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_group
.
Synopsis
The manageiq_group module supports adding, updating and deleting groups in ManageIQ.
Requirements
The below requirements are needed on the host that executes this module.
manageiq-client
manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/
Parameters
Parameter |
Comments |
---|---|
A list of strings with a reference to the allowed host, cluster or folder |
|
In merge mode existing settings are merged with the supplied In replace mode current values are replaced with the supplied Choices:
|
|
The group description. |
|
The tag values per category |
|
In merge mode existing categories are kept or updated, new categories are added. In replace mode all categories will be replaced with the supplied Choices:
|
|
ManageIQ connection configuration information. |
|
The path to a CA bundle file or directory with certificates. |
|
ManageIQ password. |
|
ManageIQ token. |
|
ManageIQ environment URL. |
|
ManageIQ username. |
|
Whether SSL certificates should be verified for HTTPS requests. Choices:
|
|
The the group role id |
|
absent - group should not exist, present - group should be. Choices:
|
|
The tenant for the group identified by the tenant id. |
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 a group in ManageIQ with the role EvmRole-user and tenant 'my_tenant'
community.general.manageiq_group:
description: 'MyGroup-user'
role: 'EvmRole-user'
tenant: 'my_tenant'
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false # only do this when you trust the network!
- name: Create a group in ManageIQ with the role EvmRole-user and tenant with tenant_id 4
community.general.manageiq_group:
description: 'MyGroup-user'
role: 'EvmRole-user'
tenant_id: 4
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false # only do this when you trust the network!
- name:
- Create or update a group in ManageIQ with the role EvmRole-user and tenant my_tenant.
- Apply 3 prov_max_cpu and 2 department tags to the group.
- Limit access to a cluster for the group.
community.general.manageiq_group:
description: 'MyGroup-user'
role: 'EvmRole-user'
tenant: my_tenant
managed_filters:
prov_max_cpu:
- '1'
- '2'
- '4'
department:
- defense
- engineering
managed_filters_merge_mode: replace
belongsto_filters:
- "/belongsto/ExtManagementSystem|ProviderName/EmsFolder|Datacenters/EmsFolder|dc_name/EmsFolder|host/EmsCluster|Cluster name"
belongsto_filters_merge_mode: merge
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false # only do this when you trust the network!
- name: Delete a group in ManageIQ
community.general.manageiq_group:
state: 'absent'
description: 'MyGroup-user'
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
- name: Delete a group in ManageIQ using a token
community.general.manageiq_group:
state: 'absent'
description: 'MyGroup-user'
manageiq_connection:
url: 'http://127.0.0.1:3000'
token: 'sometoken'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The group. Returned: success |
|
A list of strings with a reference to the allowed host, cluster or folder Returned: success |
|
Group creation date Returned: success Sample: |
|
The group description Returned: success |
|
The group type, system or user Returned: success |
|
The group id Returned: success |
|
The tag values per category Returned: success |
|
The group role name Returned: success |
|
The group tenant name Returned: success |
|
Group update date Returned: success Sample: |