vmware.vmware_rest.vcenter_vm_hardware_disk_info 模块 – 返回虚拟磁盘信息。

注意

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

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

要安装它,请使用:ansible-galaxy collection install vmware.vmware_rest。您需要其他要求才能使用此模块,有关详细信息,请参阅 需求

要在 playbook 中使用它,请指定:vmware.vmware_rest.vcenter_vm_hardware_disk_info

vmware.vmware_rest 0.1.0 中的新增功能

概要

  • 返回有关虚拟磁盘的信息。

需求

执行此模块的主机需要以下需求。

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

disk

字符串

虚拟磁盘标识符。

该参数必须是由 vmware.vmware_rest.vcenter_vm_hardware_disk 返回的资源的 ID。在 state=[‘get’] 中是必需的。

label

字符串

项目的名称

session_timeout

浮点数

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

整个操作(包括建立连接、发送请求和响应)的最大秒数。

默认值为 300 秒。

vcenter_hostname

字符串 / 必需

vSphere vCenter 的主机名或 IP 地址

如果任务中未指定该值,则将使用环境变量 VMWARE_HOST 的值。

vcenter_password

字符串 / 必需

vSphere vCenter 密码

如果任务中未指定该值,则将使用环境变量 VMWARE_PASSWORD 的值。

vcenter_rest_log_file

字符串

您可以使用此可选参数设置日志文件的位置。

此文件将用于记录 HTTP REST 交互。

该文件将存储在运行该模块的主机上。

如果任务中未指定该值,则将使用

环境变量 VMWARE_REST_LOG_FILE 的值。

vcenter_username

字符串 / 必需

vSphere vCenter 用户名

如果任务中未指定该值,则将使用环境变量 VMWARE_USER 的值。

vcenter_validate_certs

布尔值

允许在 SSL 证书无效时连接。当证书不受信任时,设置为 false

如果任务中未指定该值,则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

vm

字符串 / 必需

虚拟机标识符。

该参数必须是由 vmware.vmware_rest.vcenter_vm_info 返回的资源的 ID。此参数是必需的。

备注

注意

  • 在 vSphere 7.0.3 上测试

示例

- name: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
    - test_vm1

- name: Collect information about a specific VM
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ search_result.value[0].vm }}'
  register: test_vm1_info

- name: Retrieve the disk information from the VM
  vmware.vmware_rest.vcenter_vm_hardware_disk_info:
    vm: '{{ test_vm1_info.id }}'
  register: _result

- name: Retrieve disk information using the label
  vmware.vmware_rest.vcenter_vm_hardware_disk_info:
    vm: '{{ test_vm1_info.id }}'
    label: Hard disk 1
  register: _result

返回值

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

描述

id

字符串

资源的 moid

返回:成功时

示例:"2000"

value

字典

使用标签检索磁盘信息

返回:成功时

示例:{"backing": {"type": "VMDK_FILE", "vmdk_file": "[local] test_vm1/test_vm1.vmdk"}, "capacity": 17179869184, "label": "Hard disk 1", "scsi": {"bus": 0, "unit": 0}, "type": "SCSI"}

作者

  • Ansible 云团队 (@ansible-collections)