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。您需要其他要求才能使用此模块，有关详细信息，请参阅需求。

要在剧本中使用它，请指定：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	支持： N/A 此操作不会修改状态。	在差异模式下，将返回有关已更改内容（或可能需要在 `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 列表 / 元素=字典	Proxmox VE 节点的列表。返回：始终返回，但可能为空
cpu 浮点数	当前 CPU 使用率，以该主机总可用 CPU 的分数表示。返回：成功时返回
disk 整数	此主机的当前本地磁盘使用情况。返回：成功时返回
id 字符串	节点的标识。返回：成功时返回
level 字符串	支持级别。如果不在付费支持合同下，则可能为空。返回：成功时返回
maxcpu 整数	此主机上可用的 CPU 总数。返回：成功时返回
maxdisk 整数	本地磁盘大小（字节）。返回：成功时返回
maxmem 整数	内存大小（字节）。返回：成功时返回
mem 整数	已使用内存（字节）。返回：成功时返回
node 字符串	此节点的短主机名。返回：成功时返回
ssl_fingerprint 字符串	节点证书的 SSL 指纹。返回：成功时返回
status 字符串	节点状态。返回：成功时返回
type 字符串	返回的对象类型。返回：成功时返回
uptime 整数	节点运行时间（秒）。返回：成功时返回

作者

John Berninger (@jwbernin)