community.general.manageiq_group 模块 – ManageIQ 中组的管理

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：community.general.manageiq_group。

概要 

manageiq_group 模块支持在 ManageIQ 中添加、更新和删除组。

要求 

执行此模块的主机需要以下要求。

manageiq-client
manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/

参数 

参数	注释
belongsto_filters 列表 / elements=string	包含对允许的主机、集群或文件夹的引用的字符串列表
belongsto_filters_merge_mode 字符串	在合并模式下，现有设置与提供的 `belongsto_filters` 合并。在替换模式下，当前值将替换为提供的 `belongsto_filters`。选择 `"合并"` `"替换"` ← (默认)
description 字符串 / 必需	组描述。
managed_filters 字典	每个类别的标签值
managed_filters_merge_mode 字符串	在合并模式下，保留或更新现有类别，并添加新类别。在替换模式下，所有类别都将替换为提供的 `managed_filters`。选择 `"合并"` `"替换"` ← (默认)
manageiq_connection 字典	ManageIQ 连接配置信息。
ca_cert 别名：ca_bundle_path 字符串	CA 包文件或包含证书的目录的路径。
密码字符串	ManageIQ 密码。如果设置了 `MIQ_PASSWORD` 环境变量。否则，如果未传入令牌，则为必需。
令牌字符串	ManageIQ 令牌。如果设置了 `MIQ_TOKEN` 环境变量。否则，如果未传入用户名或密码，则为必需。
url 字符串	ManageIQ 环境 URL。如果设置了 `MIQ_URL` 环境变量。否则，必须传入它。
用户名字符串	ManageIQ 用户名。如果设置了 `MIQ_USERNAME` 环境变量。否则，如果未传入令牌，则为必需。
validate_certs 别名：verify_ssl 布尔值	是否应验证 HTTPS 请求的 SSL 证书。选择 `false` `true` ← (默认)
角色字符串	组角色名称当提供时，`role_id` 优先于 `role`。
role_id 整数	组角色 ID
状态字符串	absent - 组不应存在，present - 组应存在。选择 `"absent"` `"present"` ← (默认)
租户字符串	由租户名称标识的组的租户。当提供时，`tenant_id` 优先于 `tenant`。租户名称区分大小写。
tenant_id 整数	由租户 ID 标识的组的租户。

属性 

属性	支持	描述
check_mode	支持: 无	可以在 `check_mode` 中运行，并返回更改状态预测，而无需修改目标。
diff_mode	支持: 无	当处于 diff 模式时，将返回有关已更改（或可能需要在 `check_mode` 中更改）的详细信息。

示例 

- 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'

返回值 

常见的返回值已记录在此处，以下是此模块特有的字段

键	描述
group 复杂	组。返回: 成功
belongsto_filters 列表 / elements=string	包含对允许的主机、集群或文件夹的引用的字符串列表返回: 成功
created_on 字符串	组创建日期返回: 成功示例: `"2018-08-12T08:37:55+00:00"`
description 字符串	组描述返回: 成功
group_type 字符串	组类型，系统或用户返回: 成功
id 整数	组 ID 返回: 成功
managed_filters 字典	每个类别的标签值返回: 成功
角色字符串	组角色名称返回: 成功
租户字符串	组租户名称返回: 成功
updated_on 整数	组更新日期返回: 成功示例: `"2018-08-12T08:37:55+00:00"`

作者

Evert Mulder (@evertmulder)