community.general.proxmox_storage_contents_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_contents_info。

community.general 8.2.0 中的新增功能

概要

  • 检索有关附加到节点的特定存储中存储的对象的信息。

要求

以下要求在执行此模块的主机上是必需的。

  • 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

字符串 / 必需

指定用于身份验证的用户。

content

字符串

筛选特定内容类型。

选项

  • "all" ← (默认)

  • "backup"

  • "rootdir"

  • "images"

  • "iso"

node

字符串 / 必需

附加存储的 Proxmox 节点。

storage

别名：name

字符串 / 必需

仅返回存储在该特定存储上的内容。

validate_certs

布尔值

如果为 false，则不会验证 SSL 证书。

这仅应在使用自签名证书的个人控制站点上使用。

选项

  • false ← (默认)

  • true

vmid

整数

筛选特定 VMID。

属性

属性

支持

描述

action_group

操作组： community.general.proxmox

community.general 9.0.0 中新增

在 module_defaults 中使用 group/community.general.proxmox 为此模块设置默认值。

check_mode

支持：完全支持

此操作不会修改状态。

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：N/A

此操作不会修改状态。

处于 diff 模式时，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

- name: List existing storages
  community.general.proxmox_storage_contents_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
    content: backup
    vmid: 130

返回值

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

键

描述

proxmox_storage_content

列表 / 元素=字典

附加到节点的存储的内容。

返回：成功

content

字符串

此存储上列出对象的 Proxmox 内容。

返回：成功

ctime

字符串

列出对象的创建时间。

返回：成功

format

字符串

列出对象的格式（可以是 raw、pbs-vm、iso……）。

返回：成功

size

整数

列出对象的大小。

返回：成功

subtype

字符串

列出对象的子类型（可以是 qemu 或 lxc）。

返回：当存储专用于备份时，通常在 PBS 存储上。

verification

字典

列出对象的备份验证状态。

返回：当存储专用于备份时，通常在 PBS 存储上。

示例：{"state": "ok", "upid": "UPID:backup-srv:00130F49:1A12D8375:00001CD7:657A2258:verificationjob:daily:v-d0cc18c5-8707:root@pam:"}

volid

字符串

列出对象的卷标识符。

返回：成功

作者

  • Julian Vanden Broeck (@l00ptr)