community.vmware.vmware_guest cannot add a cd-rom with an iso file loaded if the vmware already exists

[AaronJaegerVA]

SUMMARY

community.vmware.vmware_guest cannot add a cd-rom with an iso file loaded if the vm already exists

ISSUE TYPE

• Bug Report

COMPONENT NAME

community.vmware.vmware_guest

ANSIBLE VERSION

ansible 2.9.18
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/vhaispjaegea0/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/site-packages/ansible
  executable location = /bin/ansible
  python version = 2.7.5 (default, Aug 13 2020, 02:51:10) [GCC 4.8.5 20150623 (Red Hat 4.8.5-39)]

COLLECTION VERSION

ansible-galaxy collection list community.vmware
usage: ansible-galaxy collection [-h] COLLECTION_ACTION ...
ansible-galaxy collection: error: argument COLLECTION_ACTION: invalid choice: u'list' (choose from 'init', 'build', 'publish', 'install')

CONFIGURATION

ANSIBLE_PIPELINING(/etc/ansible/ansible.cfg) = True
DEFAULT_TIMEOUT(/etc/ansible/ansible.cfg) = 20

OS / ENVIRONMENT

RHEL8 on ESXi 6.7 Update 3

STEPS TO REPRODUCE

1. Create a new guest without a cd-rom or with a cd-rom with type: client
2. Run the vmware_guest module again against the same guest, but this time, set the cd-rom to type: iso and set an iso_path

- name: Deploy a VM without a CD-ROM
  vmware_guest:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ vcenter_dc }}"
    cluster: "{{ vcenter_cluster }}"
    datastore: "{{ guest_datastore }}"
    folder: "{{ guest_folder }}"
    name: "{{ guest_name }}"
    guest_id: "{{ guest_id | default('rhel8_64Guest') }}" 
    annotation: "{{ guest_note }}"
    template: "{{ guest_template_name | default(omit) }}"
    hardware:
      boot_firmware: efi
      secure_boot: yes
      version: 15
      num_cpus: "{{ vm_num_cpus | default('4') }}"
      num_cpu_cores_per_socket: "{{ vm_num_cpu_cores_per_socket | default('2') }}"
      memory_mb: "{{ vm_memory_mb | default('16384') }}"
    networks:
      - connected: yes
        start_connected: yes
        device_type: vmxnet3
        name: "{{ vm_network_name | default('NewLab -177') }}"
    state: "{{ vm_state | default('poweredoff') }}"
  delegate_to: "{{ env_control_host }}"
  register: deploy_no_cdrom_result
  when: cdrom_type is not defined

- name: Deploy a VM with a CD-ROM
  vmware_guest:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ vcenter_dc }}"
    cluster: "{{ vcenter_cluster }}"
    datastore: "{{ guest_datastore }}"
    folder: "{{ guest_folder }}"
    name: "{{ guest_name }}"
    guest_id: "{{ guest_id | default('rhel8_64Guest') }}" 
    annotation: "{{ guest_note }}"
    template: "{{ guest_template_name | default(omit) }}"
    hardware:
      boot_firmware: efi
      secure_boot: yes
      version: 15
      num_cpus: "{{ vm_num_cpus | default('4') }}"
      num_cpu_cores_per_socket: "{{ vm_num_cpu_cores_per_socket | default('2') }}"
      memory_mb: "{{ vm_memory_mb | default('16384') }}"
    networks:
      - connected: yes
        start_connected: yes
        device_type: vmxnet3
        name: "{{ vm_network_name | default('NewLab -177') }}"
        mac: "{{ new_vm_mac_address | default(omit) }}"
    cdrom:
      - type: "{{ cdrom_type }}"
        iso_path: "{{ cdrom_iso_path }}"
        controller_type: "{{ cdrom_controller_type }}"
        controller_number: "{{ cdrom_controller_number }}"
        unit_number: "{{ cdrom_unit_number }}"
        state: "{{ cdrom_state }}"
    state: "{{ vm_state | default('poweredoff') }}"
  delegate_to: "{{ env_control_host }}"
  register: deploy_with_cdrom_result
  when: cdrom_type is defined

EXPECTED RESULTS

I expect the cd-rom to be added and the ISO file loaded.

ACTUAL RESULTS

The cd-rom is created as a Client device despite type: iso and iso_path: ...

{
    "instance": {
        "hw_name": "vhaispbckcvfrel1",
        "hw_power_status": "poweredOn",
        "snapshots": [],
        "guest_question": null,
        "hw_interfaces": [
            "eth0"
        ],
        "hw_guest_id": null,
        "current_snapshot": null,
        "hw_eth0": {
            "macaddress": "00:50:56:ac:57:0d",
            "addresstype": "assigned",
            "macaddress_dash": "00-50-56-ac-57-0d",
            "summary": "DVSwitch: 95 9f 2c 50 27 6a 7f e8-c5 ac 13 10 26 c4 4a 0a",
            "portgroup_portkey": "902",
            "ipaddresses": null,
            "portgroup_key": "dvportgroup-1946156",
            "label": "Network adapter 1"
        },
        "hw_folder": "/ESE/ETS/BAY-ETS/vm",
        "customvalues": {},
        "hw_files": [
            "[SAN3PAR07] vhaispbckcvfrel1_1/vhaispbckcvfrel1.vmx",
            "[SAN3PAR07] vhaispbckcvfrel1_1/vhaispbckcvfrel1.vmsd",
            "[SAN3PAR07] vhaispbckcvfrel1_1/vhaispbckcvfrel1.nvram"
        ],
        "ipv4": null,
        "ipv6": null,
        "hw_product_uuid": "422c162b-5082-01fe-cdec-e7e63cc4f362",
        "hw_is_template": false,
        "vnc": {},
        "module_hw": true,
        "hw_guest_ha_state": false,
        "guest_consolidation_needed": false,
        "hw_guest_full_name": null,
        "guest_tools_status": "guestToolsNotRunning",
        "guest_tools_version": "0",
        "annotation": "VM deployed by Ansible",
        "instance_uuid": "502ca878-ab14-7ea2-d707-e1d113308a74",
        "hw_version": "vmx-15",
        "hw_processor_count": 4,
        "hw_memtotal_mb": 16384,
        "hw_datastores": [
            "SAN3PAR07"
        ],
        "moid": "vm-8236336",
        "hw_esxi_host": "vhaispvshesxi31.vha.med.va.gov",
        "hw_cores_per_socket": 2,
        "hw_cluster": "VHAISPNEWLAB",
        "vimref": "vim.VirtualMachine:vm-8236336"
    },
    "_ansible_no_log": false,
    "_ansible_delegated_vars": {
        "ansible_port": null,
        "ansible_host": "vhaispopsans001.vha.med.va.gov",
        "ansible_user": "..."
    },
    "invocation": {
        "module_args": {
            "resource_pool": null,
            "force": false,
            "customization_spec": null,
            "hardware": {
                "memory_mb": "16384",
                "version": 15,
                "secure_boot": true,
                "boot_firmware": "efi",
                "num_cpus": "4",
                "num_cpu_cores_per_socket": "2"
            },
            "cluster": "VHAISPNEWLAB",
            "wait_for_customization": false,
            "customization": {},
            "datastore": "SAN3PAR07",
            "disk": [],
            "port": 443,
            "wait_for_ip_address": false,
            "uuid": null,
            "customvalues": [],
            "hostname": "vaorlappvc01.vha.med.va.gov",
            "is_template": false,
            "networks": [
                {
                    "start_connected": true,
                    "connected": true,
                    "name": "NewLab -177",
                    "device_type": "vmxnet3"
                }
            ],
            "state": "poweredon",
            "template": null,
            "linked_clone": false,
            "folder": "/ESE/ETS/BAY-ETS/vm/",
            "username": "...",
            "snapshot_src": null,
            "convert": null,
            "proxy_port": null,
            "name_match": "first",
            "cdrom": [
                {
                    "controller_type": "ide",
                    "controller_number": "0",
                    "state": "present",
                    "type": "iso",
                    "unit_number": "0",
                    "iso_path": "[SAN3PAR07] ISO/Kickstart/vhaispbckcvfrel1.vha.med.va.gov_20210908_0702.iso"
                }
            ],
            "use_instance_uuid": false,
            "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
            "annotation": "VM deployed by Ansible",
            "datacenter": "BAY-ETS",
            "state_change_timeout": 0,
            "name": "vhaispbckcvfrel1",
            "guest_id": "rhel8_64Guest",
            "proxy_host": null,
            "vapp_properties": [],
            "esxi_hostname": null,
            "validate_certs": true
        }
    },
    "changed": true
}

[ansibullbot]

Files identified in the description:
None

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[grogersxyz]

I'm also experiencing the same issues with ansible core 2.12.2 although in my case this presents by not creating a cdrom device at all. I was still able to manually add the iso cdrom from vSphere, which leads me to believe the issue is somewhere in the community.vmware collection

[grogersxyz]

Having a look at some of the other open issues it looks like #1012 and #849 could be related. If there are issues with iso CD-ROMs not being idempotent as expected by the guest module it might stop ansible from requesting changes?

[chris2016]

Did you find a fix for it? I have exactly the same issue with vsphere 6.7

[mariolenz]

Unfortunately, I'm out of office at the moment and don't have access to my usual test environment. I'll try to have another look at this issue when I'm back the week after next.

@grogersxyz Thanks for digging out those other issues! They look like they could be related and I'll have a look at them, too.

[grogersxyz]

@chris2016 in the end we changed our implementation so that we kept the install media mounted for the lifetime of the VM instead of mounting and unmounting through ansible. So not really a fix but just a workaround sorry

[Yannik]

@grogersxyz I thought I stumbled upon the same bug (cdrom drive not being created at all), but then I found out that the issue was that I had state: powered-on, which does not cause a reconfiguration. Setting it to state: present fixed this.