vcenter_vm_hardware_cdrom
Adds a virtual CD-ROM device to the virtual machine
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.vcenter_vm_hardware_cdrom
Synopsis
Adds a virtual CD-ROM device 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. | ||||
| allow_guest_control | bool | Flag indicating whether the guest can connect and disconnect the device. | ||
| If unset, the value is unchanged. | ||||
| backing | dict | Physical resource backing for the virtual CD-ROM device. | ||
| If unset, defaults to automatic detection of a suitable host device. Required with I(state=[‘present’]) | ||||
| Valid attributes are: |
- C(type) (str): This option defines the valid backing types for a virtual CD-ROM device. ([‘present’])
This key is required with [‘present’].
- Accepted values:
- CLIENT_DEVICE
- HOST_DEVICE
- ISO_FILE
- Accepted values:
- C(iso_file) (str): Path of the image file that should be used as the virtual CD-ROM device backing. This field is optional and it is only relevant when the value of I(type) is ISO_FILE. ([‘present’])
- C(host_device) (str): Name of the device that should be used as the virtual CD-ROM device backing. If unset, the virtual CD-ROM device will be configured to automatically detect a suitable host device. ([‘present’])
- C(device_access_type) (str): This option defines the valid device access types for a physical device packing of a virtual CD-ROM device. ([‘present’])
- Accepted values:
- EMULATION
- PASSTHRU
- PASSTHRU_EXCLUSIVE | | cdrom | string | | | Virtual CD-ROM device identifier. The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_hardware_cdrom). Required with I(state=[‘absent’, ‘connect’, ‘disconnect’, ‘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:
- Accepted values:
- 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 | | 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’]) |
| start_connected | bool | | | Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
If unset, the value is unchanged. |
| state | string | |
present| Operation to perform; allowed values: absent, connect, disconnect, 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 Cdrom 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: Attach an ISO image to a guest VM
vmware.vmware_rest.vcenter_vm_hardware_cdrom:
vm: '{{ test_vm1_info.id }}'
type: SATA
sata:
bus: 0
unit: 2
start_connected: true
backing:
iso_file: '[ro_datastore] fedora.iso'
type: ISO_FILE
register: _result