Implement gathering of Interface and Mac from powered off domain

[stratus-ss]

SUMMARY

There are use cases where you need to get the mac address of a domain in order to provide it to PXE, Sushy-tools or other related tools. There should be a way to get this information without powering on the machine

Fixes #189

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

This is an addition to the plugin virt.py which allows the ansible module to process the xml generated by get_xml in order to return the interfaces and their associate mac addresses

This makes use of etree.fromstring to get the xml. A dictionary is returned with the primary key being network_interfaces with a nested dict containing the interface name as the key for an additional dict containing the mac address and the pci bus:

interface_dict = {"network_interfaces": {"bridge0": {"mac": "00:00:00:00", "pci_bus": "00x02"} } } 

ADDITIONAL INFORMATION

A simple playbook

---
- name: get network interfaces
  gather_facts: false
  hosts: localhost
  tasks:
  - name: register vm info
    community.libvirt.virt:
      command: get_interfaces
      name: "sno"
    register: vminfo

  - name: debug result
    debug: 
      msg: "{{ vminfo }}"

And the output:

PLAY [get UUID] ******************************************************************************************************

TASK [register vm info] **********************************************************************************************
ok: [localhost]

TASK [debug result] **************************************************************************************************
ok: [testhost] => {
    "msg": {
        "changed": false,
        "failed": false,
        "network_interfaces": {
            "interface_1": {
                "mac": "52:54:00:94:e4:a0",
                "pci_bus": "0x01",
                "source": "default",
                "type": "NAT"
            },
            "interface_2": {
                "mac": "52:54:00:94:e4:a1",
                "pci_bus": "0x02",
                "source": "default",
                "type": "NAT"
            }
        }
    }
}

[Andersson007]

@stratus-ss thanks for the contribution!

@csmart do i understand it correctly that we can't run integration tests in containers for this collection?

[stratus-ss]

@stratus-ss thanks for the contribution!

@csmart do i understand it correctly that we can't run integration tests in containers for this collection?

In my other PR, i uploaded a dockerfile that runs my integration tests. Does your question refer to running integration tests in your CI or whether its actually possible?

[stratus-ss]

I added integration tests as well as fedora and ubuntu Dockerfiles for reference as to how I stood up the containers.

Tests run like this
Ubuntu:

ansible-test integration virt_interfaces   --docker "quay.io/sovens/ansible/integration-testing/libvirt-ubuntu:24.04"   --docker-privileged   --python 3.12

Fedora:

 ansible-test integration virt_interfaces   --docker "quay.io/sovens/ansible/integration-testing/libvirt-fedora:40"   --docker-privileged   --python 3.13 

[csmart]

@stratus-ss thanks, this looks good! I'm wondering whether the module should return NIC information for all VMs, if name is left off? I can see a use case for getting all the networking information for a set of VMs, and then doing something with them all. Perhaps a list of dicts of something with the UUID and name?..

[csmart]

@csmart do i understand it correctly that we can't run integration tests in containers for this collection?

@Andersson007 we can in principle, but I don't know if we can in the Azure infra... I might have to dig into them some more.

[stratus-ss]

This has been updated to better handle multiple nics in the testing. We can simply extend the template and the test if we want to test for all interface types

[csmart]

Thanks @stratus-ss !

[Andersson007]

@stratus-ss @csmart thanks for the contribution!