community / community.vmware / 4.2.0 / module / vmware_guest_disk_info Gather info about disks of given virtual machine Authors: Abhijeet Kasurde (@Akasurde) <akasurde@redhat.com>community.vmware.vmware_guest_disk_info (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to gather information about disks belonging to given virtual machine.
All parameters and VMware object names are case sensitive.
- 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
moid: description: - 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 O(name) or O(uuid) is not supplied. type: str name: description: - Name of the virtual machine. - This is required parameter, if parameter O(uuid) or O(moid) is not supplied. type: str port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int uuid: description: - UUID of the instance to gather information if known, this is VMware's unique identifier. - This is required parameter, if parameter O(name) or O(moid) is not supplied. type: str folder: description: - 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:' - ' folder: /ha-datacenter/vm' - ' folder: ha-datacenter/vm' - ' folder: /datacenter1/vm' - ' folder: datacenter1/vm' - ' folder: /datacenter1/vm/folder1' - ' folder: datacenter1/vm/folder1' - ' folder: /folder1/datacenter1/vm' - ' folder: folder1/datacenter1/vm' - ' folder: /folder1/datacenter1/vm/folder2' type: str hostname: description: - 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 E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str datacenter: description: - The datacenter name to which virtual machine belongs to. required: true type: str proxy_host: description: - 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 E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - 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 E(VMWARE_PROXY_PORT) will be used instead. required: false type: int validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool use_instance_uuid: default: false description: - Whether to use the VMware instance UUID rather than the BIOS UUID. type: bool
guest_disk_info: description: metadata about the virtual machine's disks returned: always sample: '0': backing_datastore: datastore2 backing_disk_mode: persistent backing_diskmode: persistent backing_eagerlyscrub: false backing_filename: '[datastore2] VM_225/VM_225.vmdk' backing_thinprovisioned: false backing_type: FlatVer2 backing_uuid: 200C3A00-f82a-97af-02ff-62a595f0020a backing_writethrough: false capacity_in_bytes: 10485760 capacity_in_kb: 10240 controller_bus_number: 0 controller_key: 1000 controller_type: paravirtual key: 2000 label: Hard disk 1 summary: 10,240 KB unit_number: 0 '1': backing_datastore: datastore3 backing_devicename: vml.012345678901234567890123456789012345678901234567890123 backing_disk_mode: independent_persistent backing_diskmode: independent_persistent backing_filename: '[datastore3] VM_226/VM_226.vmdk' backing_lunuuid: 012345678901234567890123456789012345678901234567890123 backing_type: RawDiskMappingVer1 backing_uuid: null capacity_in_bytes: 15728640 capacity_in_kb: 15360 controller_bus_number: 0 controller_key: 1000 controller_type: paravirtual key: 2001 label: Hard disk 3 summary: 15,360 KB unit_number: 1 type: dict