vmware.vmware_rest.vcenter_vm_hardware_cdrom module – Adds a virtual CD-ROM device to the virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 4.4.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_cdrom.

New in vmware.vmware_rest 0.1.0

Synopsis

  • Adds a virtual CD-ROM device to the virtual machine.

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

allow_guest_control

boolean

Flag indicating whether the guest can connect and disconnect the device.

If unset, the value is unchanged.

Choices:

  • false

  • true

backing

dictionary

Physical resource backing for the virtual CD-ROM device.

If unset, defaults to automatic detection of a suitable host device. Required with state=[‘present’]

Valid attributes are:

  • 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

  • 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 type is ISO_FILE. ([‘present’])

  • 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’])

  • 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 vmware.vmware_rest.vcenter_vm_hardware_cdrom. Required with state=[‘absent’, ‘connect’, ‘disconnect’, ‘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

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’])

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.

start_connected

boolean

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

If unset, the value is unchanged.

Choices:

  • false

  • true

state

string

Choices:

  • "absent"

  • "connect"

  • "disconnect"

  • "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 Cdrom to a virtual machine.

Choices:

  • "IDE"

  • "SATA"

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: 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

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: "16002"

value

dictionary

Attach an ISO image to a guest VM

Returned: On success

Sample: {"allow_guest_control": 0, "backing": {"iso_file": "[ro_datastore] fedora.iso", "type": "ISO_FILE"}, "label": "CD/DVD drive 1", "sata": {"bus": 0, "unit": 2}, "start_connected": 1, "state": "NOT_CONNECTED", "type": "SATA"}

Authors

  • Ansible Cloud Team (@ansible-collections)