community.general.proxmox_user_info 模块 – 获取一个或多个 Proxmox VE 用户的信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参见需求。

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

community.general 1.3.0 中的新增功能

概要 

检索一个或多个 Proxmox VE 用户的信息

需求 

以下是执行此模块的主机所需的条件。

proxmoxer
requests

参数 

参数	注释
api_host 字符串 / 必填	指定 Proxmox VE 集群的目标主机。
api_password 字符串	指定用于身份验证的密码。您可以使用 `PROXMOX_PASSWORD` 环境变量。
api_port 整数 community.general 9.1.0 中新增	指定 Proxmox VE 集群的目标端口。如果未指定，则使用 `PROXMOX_PORT` 环境变量。
api_token_id 字符串 community.general 1.3.0 中新增	指定令牌 ID。需要 `proxmoxer>=1.1.0` 才能工作。
api_token_secret 字符串 community.general 1.3.0 中新增	指定令牌密钥。需要 `proxmoxer>=1.1.0` 才能工作。
api_user 字符串 / 必填	指定用于身份验证的用户。
domain 别名：realm 字符串	将结果限制到特定的身份验证领域。
user 别名：name 字符串	将结果限制到特定的用户。
userid 字符串	将结果限制到特定的用户 ID，它是用户和域部分的串联。
validate_certs 布尔值	如果为 `false`，则不会验证 SSL 证书。这仅应在使用自签名证书的个人控制站点上使用。选项 `false` ← (默认) `true`

属性 

属性	支持	描述
action_group	动作组： community.general.proxmox community.general 9.0.0 中新增	在 `module_defaults` 中使用 `group/community.general.proxmox` 为此模块设置默认值。
check_mode	支持：完全支持此操作不会修改状态。	可以在 `check_mode` 下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持： N/A 此操作不会修改状态。	在差异模式下，将返回有关已更改内容（或可能需要在 `check_mode` 下更改）的详细信息。

示例 

- name: List existing users
  community.general.proxmox_user_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
  register: proxmox_users

- name: List existing users in the pve authentication realm
  community.general.proxmox_user_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    domain: pve
  register: proxmox_users_pve

- name: Retrieve information about admin@pve
  community.general.proxmox_user_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    userid: admin@pve
  register: proxmox_user_admin

- name: Alternative way to retrieve information about admin@pve
  community.general.proxmox_user_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    user: admin
    domain: pve
  register: proxmox_user_admin

返回值 

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

键	描述
proxmox_users 列表 / 元素=字典	用户列表。返回：始终返回，但可能为空
comment 字符串	用户的简短描述。返回：成功时返回
domain 字符串	用户的身份验证领域，也是用户 ID 的右侧部分。返回：成功时返回
email 字符串	用户的电子邮件地址。返回：成功时返回
enabled 布尔值	用户的帐户状态。返回：成功时返回
expire 整数	自纪元以来的到期日期（以秒为单位）。零表示没有到期日期。返回：成功时返回
firstname 字符串	用户的名字。返回：成功时返回
groups 列表 / 元素=字符串	用户所属的组列表。返回：成功时返回
keys 字符串	用户的双因素身份验证密钥。返回：成功时返回
lastname 字符串	用户的姓氏。返回：成功时返回
令牌列表 / 元素=字典	与用户关联的 API 令牌列表。返回：成功时返回
comment 字符串	令牌的简短描述。返回：成功时返回
expire 整数	自纪元以来的到期日期（以秒为单位）。零表示没有到期日期。返回：成功时返回
权限分离布尔值	描述 API 令牌是否通过 ACL 进行进一步限制或具有完全权限。返回：成功时返回
令牌 ID 字符串	令牌名称。返回：成功时返回
用户字符串	用户的登录名，也是用户 ID 的左侧部分。返回：成功时返回
userid 字符串	Proxmox 用户 ID，表示为 user@realm。返回：成功时返回

作者

Tristan Le Guern (@tleguern)