vmware.vmware_rest.vcenter_vm_hardware_disk module – Adds a virtual disk to the virtual machine

Note

This module is part of the vmware.vmware_rest collection (version 4.2.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in vmware.vmware_rest 0.1.0

Synopsis

  • Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

Requirements

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

  • vSphere 7.0.3 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

backing

dictionary

Existing physical resource backing for the virtual disk. Exactly one of backing or new_vmdk must be specified.

If unset, the virtual disk will not be connected to an existing backing. Required with state=[‘present’]

Valid attributes are:

  • type (str): This option defines the valid backing types for a virtual disk. ([‘present’])

This key is required with [‘present’].

  • Accepted values:

  • VMDK_FILE

  • vmdk_file (str): Path of the VMDK file backing the virtual disk.

This field is optional and it is only relevant when the value of type is VMDK_FILE. ([‘present’])

disk

string

Virtual disk identifier.

The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_disk. Required with state=[‘absent’, ‘present’]

ide

dictionary

Address for attaching the device to a virtual IDE adapter.

If unset, the server will choose an available address; if none is available, the request will fail.

Valid attributes are:

  • primary (bool): Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.

If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected. ([‘present’])

  • master (bool): Flag specifying whether the device should be the master or slave device on the IDE adapter.

If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected. ([‘present’])

label

string

The name of the item

new_vmdk

dictionary

Specification for creating a new VMDK backing for the virtual disk. Exactly one of backing or new_vmdk must be specified.

If unset, a new VMDK backing will not be created.

Valid attributes are:

  • name (str): Base name of the VMDK file. The name should not include the ‘.vmdk’ file extension.

If unset, a name (derived from the name of the virtual machine) will be chosen by the server. ([‘present’])

  • capacity (int): Capacity of the virtual disk backing in bytes.

If unset, defaults to a guest-specific capacity. ([‘present’])

  • storage_policy (dict): The storage_policy_spec structure contains information about the storage policy that is to be associated the with VMDK file.

If unset the default storage policy of the target datastore (if applicable) is applied. Currently a default storage policy is only supported by object based datastores : VVol & vSAN. For non- object datastores, if unset then no storage policy would be associated with the VMDK file. ([‘present’])

  • Accepted keys:

  • policy (string): Identifier of the storage policy which should be associated with the VMDK file.

When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_storage_policies_info.

nvme

dictionary

Address for attaching the device to a virtual NVMe adapter.

If unset, the server will choose an available address; if none is available, the request will fail. Required with state=[‘present’]

Valid attributes are:

  • bus (int): Bus number of the adapter to which the device should be attached. ([‘present’])

This key is required with [‘present’].

  • unit (int): Unit number of the device.

If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected. ([‘present’])

sata

dictionary

Address for attaching the device to a virtual SATA adapter.

If unset, the server will choose an available address; if none is available, the request will fail. Required with state=[‘present’]

Valid attributes are:

  • bus (int): Bus number of the adapter to which the device should be attached. ([‘present’])

This key is required with [‘present’].

  • unit (int): Unit number of the device.

If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected. ([‘present’])

scsi

dictionary

Address for attaching the device to a virtual SCSI adapter.

If unset, the server will choose an available address; if none is available, the request will fail. Required with state=[‘present’]

Valid attributes are:

  • bus (int): Bus number of the adapter to which the device should be attached. ([‘present’])

This key is required with [‘present’].

  • unit (int): Unit number of the device.

If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected. ([‘present’])

session_timeout

float

added in vmware.vmware_rest 2.1.0

Timeout settings for client session.

The maximal number of seconds for the whole operation including connection establishment, request sending and response.

The default value is 300s.

state

string

Choices:

  • "absent"

  • "present" ← (default)

type

string

The host_bus_adapter_type enumerated type defines the valid types of host bus adapters that may be used for attaching a virtual storage device to a virtual machine.

Choices:

  • "IDE"

  • "NVME"

  • "SATA"

  • "SCSI"

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_rest_log_file

string

You can use this optional parameter to set the location of a log file.

This file will be used to record the HTTP REST interaction.

The file will be stored on the host that runs the module.

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

Virtual machine identifier.

The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.

Notes

Note

  • Tested on vSphere 7.0.3

Examples

- 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: Create a new disk
  vmware.vmware_rest.vcenter_vm_hardware_disk:
    vm: '{{ test_vm1_info.id }}'
    type: SATA
    new_vmdk:
      capacity: 320000
  register: my_new_disk

- name: Delete the disk
  vmware.vmware_rest.vcenter_vm_hardware_disk:
    vm: '{{ test_vm1_info.id }}'
    disk: '{{ my_new_disk.id }}'
    state: absent
  register: _result

Return Values

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

Key

Description

id

string

moid of the resource

Returned: On success

Sample: "16000"

value

dictionary

Create a new disk

Returned: On success

Sample: {"backing": {"type": "VMDK_FILE", "vmdk_file": "[local] test_vm1/test_vm1_1.vmdk"}, "capacity": 320000, "label": "Hard disk 2", "sata": {"bus": 0, "unit": 0}, "type": "SATA"}

Authors

  • Ansible Cloud Team (@ansible-collections)