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 |
---|---|
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:
This key is required with [‘present’].
This field is optional and it is only relevant when the value of type is VMDK_FILE. ([‘present’]) |
|
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’] |
|
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:
If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected. ([‘present’])
If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected. ([‘present’]) |
|
The name of the item |
|
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:
If unset, a name (derived from the name of the virtual machine) will be chosen by the server. ([‘present’])
If unset, defaults to a guest-specific capacity. ([‘present’])
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’])
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. |
|
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:
This key is required with [‘present’].
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’]) |
|
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:
This key is required with [‘present’].
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’]) |
|
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:
This key is required with [‘present’].
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’]) |
|
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. |
|
Choices:
|
|
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:
|
|
The hostname or IP address of the vSphere vCenter If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter password If the value is not specified in the task, the value of environment variable |
|
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 |
|
The vSphere vCenter username If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
|
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 |
---|---|
moid of the resource Returned: On success Sample: |
|
Create a new disk Returned: On success Sample: |