vmware.vmware_rest.vcenter_vm_hardware_cdrom_info module – Gather information about virtual CD-ROM drives on a virtual machine.

Note

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

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

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about one or more virtual CD-ROM drives attached to a VMware virtual machine.

  • Can return a list of all virtual CD-ROM drives on a VM, or detailed information about a specific CD-ROM drive identified by its MOID.

  • Use this module to discover CD-ROM configurations such as the backing type (ISO file, host device, or client device), the adapter (IDE or SATA) the drive is attached to, the connection state, and guest control settings.

Parameters

Parameter

Comments

cdrom

string

Identifier of the virtual CD-ROM drive to retrieve details for.

Must be an identifier (MOID) for a Cdrom resource, for example 16000.

If omitted, all virtual CD-ROM drives on the VM are returned.

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

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_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

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

Identifier of the virtual machine to query.

Must be an identifier (MOID) for a Vm resource.

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: List all virtual CD-ROM drives on a VM
  vmware.vmware_rest.vcenter_vm_hardware_cdrom_info:
    vm: vm-1001
  register: all_cdroms

- name: Get details about a specific virtual CD-ROM drive
  vmware.vmware_rest.vcenter_vm_hardware_cdrom_info:
    vm: vm-1001
    cdrom: "16000"
  register: cdrom_details

Return Values

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

Key

Description

id

string

MOID of the queried virtual CD-ROM drive.

Returned: When only one resource, with a MOID, was queried.

Sample: "16000"

info

list / elements=string

A list of virtual CD-ROM drives matching the query.

Returned: On success.

Sample: [{"cdrom": "16000"}]

value

any

Raw output from the API response.

This output is maintained for consistency with version 4.x and earlier of this collection. It is recommended to switch to the info return key for a more consistent and documented output.

Returned: On success.

Sample: {"allow_guest_control": true, "backing": {"iso_file": "[datastore1] ISOs/installer.iso", "type": "ISO_FILE"}, "label": "CD/DVD drive 1", "sata": {"bus": 0, "unit": 0}, "start_connected": true, "state": "CONNECTED", "type": "SATA"}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)