community.vmware.vmware_guest_disk – Manage disks related to virtual machine in given vCenter infrastructure

Note

This plugin is part of the community.vmware collection (version 1.15.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 community.vmware.

To use it in a playbook, specify: community.vmware.vmware_guest_disk.

Synopsis

  • This module can be used to add, remove and update disks belonging to given virtual machine.
  • All parameters and VMware object names are case sensitive.
  • This module is destructive in nature, please read documentation carefully before proceeding.
  • Be careful while removing disk specified as this may lead to data loss.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
datacenter
string / required
The datacenter name to which virtual machine belongs to.
disk
list / elements=dictionary
Default:
[]
A list of disks to add or remove.
The virtual disk related information is provided using this list.
All values and parameters are case sensitive.
autoselect_datastore
boolean
    Choices:
  • no
  • yes
Select the less used datastore. Specify only if datastore is not specified.
compatibility_mode
string
    Choices:
  • physicalMode
  • virtualMode
Compatibility mode for raw devices. Required for disk type 'rdm'
controller_number
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
This parameter is used with controller_type for specifying controller bus number.
controller_type
string
    Choices:
  • buslogic
  • lsilogic
  • lsilogicsas
  • paravirtual
  • sata
  • nvme
This parameter is added for managing disks attaching other types of controllers, e.g., SATA or NVMe.
If either controller_type or scsi_type is not specified, then use paravirtual type.
datastore
string
Name of datastore or datastore cluster to be used for the disk.
destroy
boolean
    Choices:
  • no
  • yes
If state is absent, make sure the disk file is deleted from the datastore. Added in version 2.10.
disk_mode
string
    Choices:
  • persistent
  • independent_persistent
  • independent_nonpersistent
Type of disk mode. If not specified then use persistent mode for new disk.
If set to 'persistent' mode, changes are immediately and permanently written to the virtual disk.
If set to 'independent_persistent' mode, same as persistent, but not affected by snapshots.
If set to 'independent_nonpersistent' mode, changes to virtual disk are made to a redo log and discarded at power off, but not affected by snapshots.
filename
string
Existing disk image to be used. Filename must already exist on the datastore.
Specify filename string in [datastore_name] path/to/file.vmdk format. Added in version 2.10.
iolimit
dictionary
Section specifies the shares and limit for storage I/O resource.
limit
integer
Section specifies values for limit where the utilization of a virtual machine will not exceed, even if there are available resources.
shares
dictionary
Specifies different types of shares user can add for the given disk.
level
string
    Choices:
  • low
  • normal
  • high
  • custom
Specifies different level for the shares section.
level_value
integer
Custom value when level is set as custom.
rdm_path
string
added in 1.12.0 of community.vmware
Path of LUN for Raw Device Mapping required for disk type rdm.
Only valid is type is set to rdm.
scsi_controller
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
SCSI controller number. Only 4 SCSI controllers are allowed per VM.
Care should be taken while specifying 'scsi_controller' is 0 and 'unit_number' as 0 as this disk may contain OS.
scsi_type
string
    Choices:
  • buslogic
  • lsilogic
  • lsilogicsas
  • paravirtual
Type of SCSI controller. This value is required only for the first occurrence of SCSI Controller.
This value is ignored, if SCSI Controller is already present or state is absent.
shares
dictionary
Section for iolimit section tells about what are all different types of shares user can add for disk.
level
string
    Choices:
  • low
  • normal
  • high
  • custom
Tells about different level for the shares section.
level_value
integer
Custom value when level is set as custom.
sharing
boolean
    Choices:
  • no
  • yes
This parameter is not available for Raw Device Mapping(RDM).
The sharing mode of the virtual disk.
Setting sharing means that multiple virtual machines can write to the virtual disk.
Sharing can only be set if type is set to eagerzeroedthick.
size
string
Disk storage size.
If size specified then unit must be specified. There is no space allowed in between size number and unit.
Only first occurrence in disk element will be considered, even if there are multiple size* parameters available.
size_gb
integer
Disk storage size in gb.
size_kb
integer
Disk storage size in kb.
size_mb
integer
Disk storage size in mb.
size_tb
integer
Disk storage size in tb.
state
string
    Choices:
  • present
  • absent
State of disk.
If set to 'absent', disk will be removed permanently from virtual machine configuration and from VMware storage.
If set to 'present', disk will be added if not present at given Controller and Unit Number.
or disk exists with different size, disk size is increased, reducing disk size is not allowed.
type
string
    Choices:
  • thin
  • eagerzeroedthick
  • thick
  • rdm
The type of disk, if not specified then use thick type for new disk, no eagerzero.
The disk type rdm is added in version 1.13.0.
unit_number
integer / required
Disk Unit Number.
Valid value range from 0 to 15, except 7 for SCSI Controller.
Valid value range from 0 to 29 for SATA controller.
Valid value range from 0 to 14 for NVME controller.
folder
string
Destination folder, absolute or relative path to find an existing guest.
This is a 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
hostname
string
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 VMWARE_HOST will be used instead.
Environment variable support added in Ansible 2.6.
moid
string
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 or uuid is not supplied.
name
string
Name of the virtual machine.
This is a required parameter, if parameter uuid or moid is not supplied.
password
string
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable support added in Ansible 2.6.

aliases: pass, pwd
port
integer
Default:
443
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
Environment variable support added in Ansible 2.6.
proxy_host
string
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 VMWARE_PROXY_HOST will be used instead.
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
proxy_port
integer
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 VMWARE_PROXY_PORT will be used instead.
use_instance_uuid
boolean
    Choices:
  • no
  • yes
Whether to use the VMware instance UUID rather than the BIOS UUID.
username
string
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable support added in Ansible 2.6.

aliases: admin, user
uuid
string
UUID of the instance to gather facts if known, this is VMware's unique identifier.
This is a required parameter, if parameter name or moid is not supplied.
validate_certs
boolean
    Choices:
  • no
  • yes
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.
Environment variable support added in Ansible 2.6.
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

  • Tested on vSphere 6.0 and 6.5
  • All modules requires API write access and hence is not supported on a free ESXi license.

Examples

- name: Add disks to virtual machine using UUID
  community.vmware.vmware_guest_disk:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    disk:
      - size_mb: 10
        type: thin
        datastore: datacluster0
        state: present
        scsi_controller: 1
        unit_number: 1
        scsi_type: 'paravirtual'
        disk_mode: 'persistent'
      - size_gb: 10
        type: eagerzeroedthick
        state: present
        autoselect_datastore: True
        scsi_controller: 2
        scsi_type: 'buslogic'
        unit_number: 12
        disk_mode: 'independent_persistent'
      - size: 10Gb
        type: eagerzeroedthick
        state: present
        autoselect_datastore: True
        scsi_controller: 2
        scsi_type: 'buslogic'
        unit_number: 1
        disk_mode: 'independent_nonpersistent'
      - filename: "[datastore1] path/to/existing/disk.vmdk"
  delegate_to: localhost
  register: disk_facts

- name: Add disks with specified shares to the virtual machine
  community.vmware.vmware_guest_disk:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    disk:
      - size_gb: 1
        type: thin
        datastore: datacluster0
        state: present
        scsi_controller: 1
        unit_number: 1
        disk_mode: 'independent_persistent'
        shares:
          level: custom
          level_value: 1300
  delegate_to: localhost
  register: test_custom_shares

- name: Add physical raw device mapping to virtual machine using name
  community.vmware.vmware_guest_disk:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    validate_certs: no
    name: "Test_VM"
    disk:
      - type: rdm
        state: present
        scsi_controller: 1
        unit_number: 5
        rdm_path: /vmfs/devices/disks/naa.060000003b1234efb453
        compatibility_mode: 'physicalMode'

- name: Add virtual raw device mapping to virtual machine using name and virtual mode
  community.vmware.vmware_guest_disk:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    validate_certs: no
    name: "Test_VM"
    disk:
      - type: rdm
        state: present
        scsi_controller: 1
        unit_number: 5
        rdm_path: /vmfs/devices/disks/naa.060000003b1234efb453
        compatibility_mode: 'virtualMode'
        disk_mode: 'persistent'

- name: create new disk with custom IO limits and shares in IO Limits
  community.vmware.vmware_guest_disk:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    disk:
      - size_gb: 1
        type: thin
        datastore: datacluster0
        state: present
        scsi_controller: 1
        unit_number: 1
        disk_mode: 'independent_persistent'
        iolimit:
            limit: 1506
            shares:
              level: custom
              level_value: 1305
  delegate_to: localhost
  register: test_custom_IoLimit_shares

- name: Remove disks from virtual machine using name
  community.vmware.vmware_guest_disk:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: VM_225
    disk:
      - state: absent
        scsi_controller: 1
        unit_number: 1
  delegate_to: localhost
  register: disk_facts

- name: Remove disk from virtual machine using moid
  community.vmware.vmware_guest_disk:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    moid: vm-42
    disk:
      - state: absent
        scsi_controller: 1
        unit_number: 1
  delegate_to: localhost
  register: disk_facts

- name: Remove disk from virtual machine but keep the VMDK file on the datastore
  community.vmware.vmware_guest_disk:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: VM_225
    disk:
      - state: absent
        scsi_controller: 1
        unit_number: 2
        destroy: no
  delegate_to: localhost
  register: disk_facts

- name: Add disks to virtual machine using UUID to SATA and NVMe controller
  community.vmware.vmware_guest_disk:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    validate_certs: no
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    disk:
      - size_mb: 256
        type: thin
        datastore: datacluster0
        state: present
        controller_type: sata
        controller_number: 1
        unit_number: 1
        disk_mode: 'persistent'
      - size_gb: 1
        state: present
        autoselect_datastore: True
        controller_type: nvme
        controller_number: 2
        unit_number: 3
        disk_mode: 'independent_persistent'
  delegate_to: localhost
  register: disk_facts

Return Values

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

Key Returned Description
disk_status
dictionary
always
metadata about the virtual machine's disks after managing them

Sample:
{'0': {'backing_datastore': 'datastore2', 'backing_disk_mode': 'persistent', 'backing_eagerlyscrub': False, 'backing_filename': '[datastore2] VM_225/VM_225.vmdk', 'backing_thinprovisioned': False, 'backing_uuid': '421e4592-c069-924d-ce20-7e7533fab926', 'backing_writethrough': False, 'capacity_in_bytes': 10485760, 'capacity_in_kb': 10240, 'controller_key': 1000, 'key': 2000, 'label': 'Hard disk 1', 'summary': '10,240 KB', 'unit_number': 0}}


Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_guest_disk_module.html