community.general.manageiq_user 模块 – 管理 ManageIQ 中的用户

注意

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

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

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

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

概要 

manageiq_user 模块支持在 ManageIQ 中添加、更新和删除用户。

要求 

以下要求需要在执行此模块的主机上满足。

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

参数 

参数	注释
email 字符串	用户的电子邮件地址。
group 字符串	用户所属的组的名称。
manageiq_connection 字典	ManageIQ 连接配置信息。
ca_cert 别名: ca_bundle_path 字符串	CA 捆绑文件或包含证书的目录的路径。
password 字符串	ManageIQ 密码。如果设置了 `MIQ_PASSWORD` 环境变量，则使用该变量。否则，如果没有传递令牌，则需要此参数。
token 字符串	ManageIQ 令牌。如果设置了 `MIQ_TOKEN` 环境变量，则使用该变量。否则，如果没有传递用户名或密码，则需要此参数。
url 字符串	ManageIQ 环境 URL。如果设置了 `MIQ_URL` 环境变量，则使用该变量。否则，需要传递此参数。
username 字符串	ManageIQ 用户名。如果设置了 `MIQ_USERNAME` 环境变量，则使用该变量。否则，如果没有传递令牌，则需要此参数。
validate_certs 别名: verify_ssl 布尔值	是否应验证 HTTPS 请求的 SSL 证书。选项 `false` `true` ←（默认）
name 字符串	用户的全名。
password 字符串	用户的密码。
state 字符串	absent - 用户不应存在，present - 用户应存在。选项 `"absent"` `"present"` ←（默认）
update_password 字符串	`always` 将无条件更新密码。 `on_create` 将仅为新创建的用户设置密码。选项 `"always"` ←（默认） `"on_create"`
userid 字符串 / 必需	ManageIQ 中唯一的 userid，通常称为用户名。

属性 

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

示例 

- name: Create a new user in ManageIQ
  community.general.manageiq_user:
    userid: 'jdoe'
    name: 'Jane Doe'
    password: 'VerySecret'
    group: 'EvmGroup-user'
    email: '[email protected]'
    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 new user in ManageIQ using a token
  community.general.manageiq_user:
    userid: 'jdoe'
    name: 'Jane Doe'
    password: 'VerySecret'
    group: 'EvmGroup-user'
    email: '[email protected]'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      token: 'sometoken'
      validate_certs: false  # only do this when you trust the network!

- name: Delete a user in ManageIQ
  community.general.manageiq_user:
    state: 'absent'
    userid: 'jdoe'
    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 user in ManageIQ using a token
  community.general.manageiq_user:
    state: 'absent'
    userid: 'jdoe'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      token: 'sometoken'
      validate_certs: false  # only do this when you trust the network!

- name: Update email of user in ManageIQ
  community.general.manageiq_user:
    userid: 'jdoe'
    email: '[email protected]'
    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: Update email of user in ManageIQ using a token
  community.general.manageiq_user:
    userid: 'jdoe'
    email: '[email protected]'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      token: 'sometoken'
      validate_certs: false  # only do this when you trust the network!

作者

Daniel Korn (@dkorn)