community.general.proxmox_node_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_node_info。

community.general 8.2.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 字符串 / 必需	指定用于身份验证的用户。
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 nodes
  community.general.proxmox_node_info:
    api_host: proxmox1
    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_nodes

返回值 

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

键	描述
proxmox_nodes 列表 / elements=字典	Proxmox VE 节点的列表。返回：始终，但可以为空
cpu 浮点数	此主机总可用 CPU 的分数份额中当前的 CPU 使用率。返回：成功时
disk 整数	此主机当前的本地磁盘使用情况。返回：成功时
id 字符串	节点的身份。返回：成功时
level 字符串	支持级别。如果未签订付费支持合同，则可以为空白。返回：成功时
maxcpu 整数	此主机上可用 CPU 的总数。返回：成功时
maxdisk 整数	本地磁盘的大小（以字节为单位）。返回：成功时
maxmem 整数	内存大小（以字节为单位）。返回：成功时
mem 整数	已用内存（以字节为单位）。返回：成功时
node 字符串	此节点的简短主机名。返回：成功时
ssl_fingerprint 字符串	节点证书的 SSL 指纹。返回：成功时
status 字符串	节点状态。返回：成功时
type 字符串	返回的对象类型。返回：成功时
uptime 整数	节点正常运行时间（以秒为单位）。返回：成功时

作者

John Berninger (@jwbernin)