community.general.proxmox_group_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_group_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 字符串 / 必需	指定用于身份验证的用户。
group 别名：groupid, name 字符串	将结果限制为特定组。
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 groups
  community.general.proxmox_group_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_groups

- name: Retrieve information about the admin group
  community.general.proxmox_group_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) }}"
    group: admin
  register: proxmox_group_admin

返回值 

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

键	描述
proxmox_groups 列表 / 元素=字典	组的列表。返回：始终，但可以为空
comment 字符串	组的简短描述。返回：成功时，可以不存在
groupid 字符串	组名称。返回：成功时
users 列表 / 元素=字符串	组中用户的列表。返回：成功时

作者

Tristan Le Guern (@tleguern)