community.general.proxmox_storage_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_storage_info。

community.general 2.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 字符串 / 必需	指定用于身份验证的用户。
storage 别名：name 字符串	仅返回特定存储的信息。
type 字符串	按特定存储类型过滤。
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` 中更改的内容）的详细信息。

备注 

注意

此模块可以返回特定于存储的选项，请查看 https://pve.proxmox.com/wiki/Storage 中的文档。

示例 

- name: List existing storages
  community.general.proxmox_storage_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_storages

- name: List NFS storages only
  community.general.proxmox_storage_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) }}"
    type: nfs
  register: proxmox_storages_nfs

- name: Retrieve information about the lvm2 storage
  community.general.proxmox_storage_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) }}"
    storage: lvm2
  register: proxmox_storage_lvm

返回值 

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

键	描述
proxmox_storages 列表 / 元素=字典	存储池列表。返回：成功时
内容列表 / 元素=字符串	此存储中可用的 Proxmox 内容类型返回：成功时
摘要字符串	存储的摘要返回：成功时
节点列表 / 元素=字符串	与该存储关联的节点列表返回：成功时，如果存储不是本地的
路径字符串	此存储的物理路径返回：成功时
prune-backups 列表 / 元素=字典	备份保留选项返回：成功时
共享布尔值	此存储是否共享返回：成功时
存储字符串	存储名称返回：成功时
type 字符串	存储类型返回：成功时

作者

Tristan Le Guern (@tleguern)