community.vmware.vmware_datastore_info 模块 – 收集给定 vCenter 中可用数据存储的信息

注意

此模块是 community.vmware 集合 (版本 5.2.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定： community.vmware.vmware_datastore_info。

概要

• 此模块可用于收集有关 VMware 基础架构中数据存储的信息。

参数

参数	注释
cluster 字符串	要搜索数据存储的群集。 如果设置，将返回属于此群集的数据存储的信息。 如果未提供 datacenter，则此参数是必需的。
datacenter 别名：datacenter_name 字符串	要搜索数据存储的数据中心。 如果未提供 cluster，则此参数是必需的。
gather_nfs_mount_info 布尔值	收集 NFS 数据存储的挂载信息。 默认情况下禁用，因为如果您有很多数据存储，这会减慢执行速度。 仅当 schema=summary 时有效。 选项 false ← (默认) true
gather_vmfs_mount_info 布尔值	收集 VMFS 数据存储的挂载信息。 默认情况下禁用，因为如果您有很多数据存储，这会减慢执行速度。 仅当 schema=summary 时有效。 选项 false ← (默认) true
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定值，则将改用环境变量 VMWARE_HOST 的值。
name 字符串	要匹配的数据存储的名称。 如果设置，则返回特定数据存储的信息。
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定值，则将改用环境变量 VMWARE_PASSWORD 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果任务中未指定值，则将改用环境变量 VMWARE_PORT 的值。 默认值： 443
properties 列表 / 元素=字符串	指定要检索的属性。 如果未指定，则检索所有属性（深度检索）。 结果以与 vsphere API 相同的结构返回。 示例 properties: [ “name”, “info.vmfs.ssd”, “capability.vsanSparseSupported”, “overallStatus” ] 仅当 schema=vsphere 时有效。
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP。 如果任务中未指定值，则将改用环境变量 VMWARE_PROXY_HOST 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定值，则将改用环境变量 VMWARE_PROXY_PORT 的值。
schema 字符串	指定所需的输出模式。 “summary”输出模式是模块的旧版输出 “vsphere”输出模式是 vSphere API 类定义 选项 "summary" ← (默认) "vsphere"
show_tag 布尔值	如果设置为 true，则显示与数据存储相关的标签。 选项 false ← (默认) true
username 别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定值，则将改用环境变量 VMWARE_USER 的值。
validate_certs 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，设置为 false。 如果任务中未指定值，则将改用环境变量 VMWARE_VALIDATE_CERTS 的值。 选项 false true ← (默认)

备注

注意

• 所有模块都需要 API 写入权限，因此在免费 ESXi 许可证上不支持。

• 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Gather info from standalone ESXi server having datacenter as 'ha-datacenter'
  community.vmware.vmware_datastore_info:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    datacenter_name: "ha-datacenter"
  delegate_to: localhost
  register: info

- name: Gather info from datacenter about specific datastore
  community.vmware.vmware_datastore_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: '{{ datacenter_name }}'
    name: datastore1
  delegate_to: localhost
  register: info

- name: Gather some info from a datastore using the vSphere API output schema
  community.vmware.vmware_datastore_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: '{{ datacenter_name }}'
    schema: vsphere
    properties:
      - name
      - info.vmfs.ssd
      - capability.vsanSparseSupported
      - overallStatus
  delegate_to: localhost
  register: info

返回值

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

键

描述

数据存储 列表 / 元素=字符串

关于可用数据存储的元数据 返回值：始终返回 示例： [{"accessible": false, "capacity": 42681237504, "datastore_cluster": "datacluster0", "freeSpace": 39638269952, "maintenanceMode": "normal", "multipleHostAccess": false, "name": "datastore2", "provisioned": 12289211488, "type": "VMFS", "uncommitted": 9246243936, "url": "ds:///vmfs/volumes/5a69b18a-c03cd88c-36ae-5254001249ce/", "vmfs_blockSize": 1024, "vmfs_uuid": "5a69b18a-c03cd88c-36ae-5254001249ce", "vmfs_version": "6.81"}, {"accessible": true, "capacity": 5497558138880, "datastore_cluster": "datacluster0", "freeSpace": 4279000641536, "maintenanceMode": "normal", "multipleHostAccess": true, "name": "datastore3", "nfs_path": "/vol/datastore3", "nfs_server": "nfs_server1", "provisioned": 1708109410304, "type": "NFS", "uncommitted": 489551912960, "url": "ds:///vmfs/volumes/420b3e73-67070776/"}]

作者

• Tim Rightnour (@garbled1)

资源链接

• 问题追踪器
• 主页
• 代码仓库