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

支持： 不适用

此操作不会修改状态。

当处于 diff 模式时，将返回有关已更改（或可能需要在 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

整数

自 Unix 纪元以来的过期时间（以秒为单位）。零表示永不过期。

已返回：成功时

firstname

字符串

用户的名字。

已返回：成功时

groups

list / elements=string

用户所属的组列表。

已返回：成功时

keys

字符串

用户的双因素身份验证密钥。

已返回：成功时

lastname

字符串

用户的姓氏。

已返回：成功时

tokens

列表 / 元素=字典

与用户关联的 API 令牌列表。

已返回：成功时

comment

字符串

令牌的简短描述。

已返回：成功时

expire

整数

自 Unix 纪元以来的过期时间（以秒为单位）。零表示永不过期。

已返回：成功时

privsep

布尔值

描述 API 令牌是否受到 ACL 的进一步限制，还是具有完全的特权。

已返回：成功时

tokenid

字符串

令牌名称。

已返回：成功时

user

字符串

用户的登录名，也是用户 ID 的左侧部分。

已返回：成功时

userid

字符串

Proxmox 用户 ID，表示为 user@realm。

已返回：成功时

作者

  • Tristan Le Guern (@tleguern)