Implement gathering of Interface and Mac from powered off domain #190

stratus-ss · 2025-01-23T19:41:12Z

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"
            }
        }
    }
}

…ins that are offline

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 · 2025-02-03T19:43:05Z

@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 · 2025-02-03T20:15:20Z

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 · 2025-02-08T23:23:43Z

@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 · 2025-02-08T23:24:26Z

@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.

tests/integration/targets/virt_interfaces/files/vm_template.xml.j2

stratus-ss · 2025-02-13T19:49:06Z

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 · 2025-02-15T23:16:50Z

Thanks @stratus-ss !

Andersson007 · 2025-02-17T08:16:37Z

@stratus-ss @csmart thanks for the contribution!

# By Chris Smart (7) and others # Via Chris Smart * upstream/main: (21 commits) Update galaxy to next expected release Release 1.4.0 commit (ansible-collections#196) AZP: add 2.19, remove 2.16 (ansible-collections#195) Implement ansible module for management of libvirt volumes (ansible-collections#180) implement the removal of volumes when a domain is undefined (ansible-collections#191) Implement gathering of Interface and Mac from powered off domain (ansible-collections#190) Implement --check support for the libvirt.virt module (ansible-collections#183) updated doc fragment to add the uuid adding changelog fragment as per request Adding the ability to get the domuuid of a specified domain fix AZP matrix: remove stable-2.15 testing Update galaxy to next expected release Release 1.3.1 commit libvirt_lxc: Add configuration for libvirt_lxc_noseclabel (ansible-collections#182) AZP: update test matrix CI: add support for 2.19 (ansible-collections#179) README: remove old communication section (ansible-collections#178) README: Add Communication section with Forum information (ansible-collections#176) ci: update test container to 6.0.0 ...

* Refactor of virt_volume.py to fix many issues # By Chris Smart (7) and others # Via Chris Smart * upstream/main: (21 commits) Update galaxy to next expected release Release 1.4.0 commit (ansible-collections#196) AZP: add 2.19, remove 2.16 (ansible-collections#195) Implement ansible module for management of libvirt volumes (ansible-collections#180) implement the removal of volumes when a domain is undefined (ansible-collections#191) Implement gathering of Interface and Mac from powered off domain (ansible-collections#190) Implement --check support for the libvirt.virt module (ansible-collections#183) updated doc fragment to add the uuid adding changelog fragment as per request Adding the ability to get the domuuid of a specified domain fix AZP matrix: remove stable-2.15 testing Update galaxy to next expected release Release 1.3.1 commit libvirt_lxc: Add configuration for libvirt_lxc_noseclabel (ansible-collections#182) AZP: update test matrix CI: add support for 2.19 (ansible-collections#179) README: remove old communication section (ansible-collections#178) README: Add Communication section with Forum information (ansible-collections#176) ci: update test container to 6.0.0 ...

stratus-ss added 4 commits January 23, 2025 13:33

added the ability to get interfaces names and mac addresses from doma…

ac80433

…ins that are offline

added doc fragments and changelogs

2524ae3

pep8 fixes

f00179b

pep8 fixes

dd4328b

stratus-ss marked this pull request as draft January 24, 2025 00:40

stratus-ss added 3 commits January 23, 2025 18:52

added the pci bus information to the dict

752ce7f

fixed variable name to reflect pci bus and not slot

4509042

pep8 fixes

22111b9

stratus-ss marked this pull request as ready for review January 24, 2025 01:25

Andersson007 reviewed Jan 29, 2025

View reviewed changes

adding integration tests for the network_interfaces

37034d3

csmart reviewed Feb 8, 2025

View reviewed changes

tests/integration/targets/virt_interfaces/files/vm_template.xml.j2 Show resolved Hide resolved

updated the get_interfaces() to handle macvtap and nat interfaces better

226848b

stratus-ss added 4 commits February 13, 2025 15:21

linting fix

02f4a66

more linting fixes

a7e0e68

more linting fixes

a3241cd

python 2.7 support

6b36bc9

Andersson007 approved these changes Feb 14, 2025

View reviewed changes

csmart merged commit 6587071 into ansible-collections:main Feb 15, 2025
23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Implement gathering of Interface and Mac from powered off domain #190

Implement gathering of Interface and Mac from powered off domain #190

Uh oh!

stratus-ss commented Jan 23, 2025 •

edited

Loading

Uh oh!

Andersson007 left a comment

Uh oh!

stratus-ss commented Feb 3, 2025

Uh oh!

stratus-ss commented Feb 3, 2025

Uh oh!

csmart commented Feb 8, 2025

Uh oh!

csmart commented Feb 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

stratus-ss commented Feb 13, 2025

Uh oh!

Uh oh!

csmart commented Feb 15, 2025

Uh oh!

Andersson007 commented Feb 17, 2025

Uh oh!

Uh oh!

Implement gathering of Interface and Mac from powered off domain #190

Implement gathering of Interface and Mac from powered off domain #190

Uh oh!

Conversation

stratus-ss commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Uh oh!

Andersson007 left a comment

Choose a reason for hiding this comment

Uh oh!

stratus-ss commented Feb 3, 2025

Uh oh!

stratus-ss commented Feb 3, 2025

Uh oh!

csmart commented Feb 8, 2025

Uh oh!

csmart commented Feb 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

stratus-ss commented Feb 13, 2025

Uh oh!

Uh oh!

csmart commented Feb 15, 2025

Uh oh!

Andersson007 commented Feb 17, 2025

Uh oh!

Uh oh!

stratus-ss commented Jan 23, 2025 •

edited

Loading

csmart commented Feb 8, 2025 •

edited

Loading