vcenter_vm_hardware_disk
Adds a thin provisioned virtual disk to the virtual machine
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.vcenter_vm_hardware_disk
Synopsis
Adds a thin provisioned virtual disk to the virtual machine
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| vcenter_hostname | string | yes | The hostname or IP address of the vSphere vCenter | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. | ||||
| vcenter_username | string | yes | The vSphere vCenter username | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. | ||||
| vcenter_password | string | yes | The vSphere vCenter password | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. | ||||
| vcenter_validate_certs | bool | true | Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) 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 C(VMWARE_REST_LOG_FILE) will be used instead. | ||||
| session_timeout | float | 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. | ||||
| backing | dict | Existing physical resource backing for the virtual disk. Exactly one of I(backing) or I(new_vmdk) must be specified. | ||
| If unset, the virtual disk will not be connected to an existing backing. Required with I(state=[‘present’]) | ||||
| Valid attributes are: |
- C(type) (str): This option defines the valid backing types for a virtual disk. ([‘present’])
This key is required with [‘present’].
- Accepted values:
- VMDK_FILE
- Accepted values:
- C(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 I(type) is VMDK_FILE. ([‘present’]) | | disk | string | | | Virtual disk identifier. The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_hardware_disk). Required with I(state=[‘absent’, ‘present’]) | | ide | dict | | | 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:
- C(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’])
- C(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 | dict | | | Specification for creating a new VMDK backing for the virtual disk. Exactly one of I(backing) or I(new_vmdk) must be specified. If unset, a new VMDK backing will not be created. Valid attributes are:
- C(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’])
- C(capacity) (int): Capacity of the virtual disk backing in bytes. If unset, defaults to a guest-specific capacity. ([‘present’])
- C(storage_policy) (dict): The I(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 M(vmware.vmware_rest.vcenter_storage_policies_info). | | nvme | dict | | | 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 I(state=[‘present’]) Valid attributes are:
- Accepted keys:
- C(bus) (int): Bus number of the adapter to which the device should be attached. ([‘present’]) This key is required with [‘present’].
- C(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 | dict | | | 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 I(state=[‘present’]) Valid attributes are:
- C(bus) (int): Bus number of the adapter to which the device should be attached. ([‘present’]) This key is required with [‘present’].
- C(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 | dict | | | 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 I(state=[‘present’]) Valid attributes are:
- C(bus) (int): Bus number of the adapter to which the device should be attached. ([‘present’]) This key is required with [‘present’].
- C(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’]) |
| state | string | |
present| Operation to perform; allowed values: absent, present. | | type | string | | | The I(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. | | vm | string | yes | | Virtual machine identifier. The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_info). This parameter is mandatory. |
Example
yaml
- 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