virt module is not able to undefine a domain with defined nvram file

[cueball23]

SUMMARY

Virt module is not able to undefine a domain with defined nvram file.

ISSUE TYPE

• Bug Report

COMPONENT NAME

virt

ANSIBLE VERSION

ansible 2.6.2
python version = 2.7.12

CONFIGURATION

OS / ENVIRONMENT

STEPS TO REPRODUCE

- name: undefine vm with nvram
  virt:
    name: example-vm-nvram
    command: undefine

EXPECTED RESULTS

domain "example-vm-nvram" is undefined

ACTUAL RESULTS

An exception occurred during task execution. To see the full traceback, use -vvv. The error was: libvirt.libvirtError: Requested operation is not valid: cannot delete inactive domain with nvram
fatal: [localhost]: FAILED! => {"changed": false, "failed_when_result": true, "msg": "Requested operation is not valid: cannot delete inactive domain with nvram"}

The libvirt function undefine is not able to remove a domain with nvram, by using undefineFlags it is possible to control the deletion of the nvram file. See:
https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainUndefine
https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainUndefineFlags

With the following command the undefine action is possible.

virsh undefine example-vm-nvram --nvram

[ansibot]

Files identified in the description:

• lib/ansible/modules/cloud/misc/virt.py

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

[ansibot]

cc @skvidal
click here for bot help

[ansibot]

cc @joshainglis @karmab @machacekondra @mwperina
click here for bot help

[arrfab]

I confirm this bug as we encounter it in the CentOS QA environment : aarch64 VMs have nvram defined, and the ansible virt module doesn't have a way to pass options.
For the time being, we had to fall back to "shell" module :

- name: == KVM == undefining UEFI VMs with nvram
  shell: "virsh undefine --nvram {{ inventory_hostname }}"
  when: '"aarch64" in inventory_hostname'
  delegate_to: "{{ kvm_host }}"

[ansibot]

Thank you very much for your interest in Ansible. Ansible has migrated much of the content into separate repositories to allow for more rapid, independent development. We are closing this issue/PR because this content has been moved to one or more collection repositories.

• lib/ansible/modules/cloud/misc/virt.py -> https://galaxy.ansible.com/community/libvirt

For further information, please see:
https://github.com/ansible/ansibullbot/blob/master/docs/collection_migration.md