vmware.vmware_rest.vcenter_vm_hardware_disk_info module – Gather information about the virtual disks of a virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_vm_hardware_disk_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about the virtual disks attached to a virtual machine.

  • When disk is provided, detailed information about that single virtual disk is returned, including its label, adapter type and address, backing, and capacity.

  • When disk is omitted, a list summarizing every virtual disk attached to the virtual machine is returned.

  • Use this module to inspect a virtual machine’s disk layout, capacity, or backing files.

Parameters

Parameter

Comments

disk

string

Identifier of a specific virtual disk to gather detailed information about.

When omitted, a summary of all virtual disks attached to the virtual machine is returned.

Must be an identifier (MOID) for a Disk resource.

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

Allows connection when SSL certificates are not valid.

Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

vm

string / required

Identifier of the virtual machine whose virtual disks should be gathered.

Must be an identifier (MOID) for a Vm resource.

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: Gather information about all virtual disks on a virtual machine
  vmware.vmware_rest.vcenter_vm_hardware_disk_info:
    vm: vm-1013
  register: all_disks

- name: Gather information about a single virtual disk
  vmware.vmware_rest.vcenter_vm_hardware_disk_info:
    vm: vm-1013
    disk: "2000"
  register: disk_details

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

id

string

Identifier of the virtual disk that was queried.

Returned: When a single disk, with an identifier, was queried

Sample: "2000"

info

list / elements=string

A list summarizing the virtual disks attached to the virtual machine.

Returned: When no specific disk was queried

Sample: [{"disk": "2000"}, {"disk": "2001"}]

value

dictionary

Detailed information about a single virtual disk.

Returned: When a single disk was queried

Sample: {"backing": {"type": "VMDK_FILE", "vmdk_file": "[datastore1] my_vm/my_vm.vmdk"}, "capacity": 17179869184, "label": "Hard disk 1", "scsi": {"bus": 0, "unit": 0}, "type": "SCSI"}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)