community.vmware.vmware_guest_disk_info module – Gather info about disks of given virtual machine
Note
This module is part of the community.vmware collection (version 3.11.1).
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 community.vmware.
To use it in a playbook, specify: community.vmware.vmware_guest_disk_info.
Synopsis
This module can be used to gather information about disks belonging to given virtual machine.
All parameters and VMware object names are case sensitive.
Parameters
Parameter |
Comments |
|---|---|
The datacenter name to which virtual machine belongs to. |
|
Destination folder, absolute or relative path to find an existing guest. This is required parameter, only if multiple VMs are found with same name. The folder should include the datacenter. ESX’s datacenter is ha-datacenter Examples:
|
|
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance. This is required if |
|
Name of the virtual machine. This is required parameter, if parameter |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. Default: |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
|
Whether to use the VMware instance UUID rather than the BIOS UUID. Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
UUID of the instance to gather information if known, this is VMware’s unique identifier. This is required parameter, if parameter |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Gather disk info from virtual machine using UUID
community.vmware.vmware_guest_disk_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: ha-datacenter
uuid: 421e4592-c069-924d-ce20-7e7533fab926
delegate_to: localhost
register: disk_info
- name: Gather disk info from virtual machine using name
community.vmware.vmware_guest_disk_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: ha-datacenter
name: VM_225
delegate_to: localhost
register: disk_info
- name: Gather disk info from virtual machine using moid
community.vmware.vmware_guest_disk_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: ha-datacenter
moid: vm-42
delegate_to: localhost
register: disk_info
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
metadata about the virtual machine’s disks Returned: always Sample: |