VMware: add new module vmware_guest_network

[Tomorrow9]

SUMMARY

Fixes #51066

ISSUE TYPE

• New Module Pull Request

COMPONENT NAME

vmware_guest_network

ADDITIONAL INFORMATION

This module is used to add, reconfigure, remove network adapters for virtual machine.

- name: Change network adapter settings of virtual machine
  vmware_guest_network:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    validate_certs: no
    name: test-vm
    gather_network_facts: false
    networks:
      - name: "VM Network"
        state: new
        mac: "00:50:56:11:22:33"
      - state: present
        device_type: e1000e
        mac: "00:50:56:44:55:66"
      - state: present
        label: "Network adapter 3"
        connected: false
      - state: absent
        label: "Network adapter 4"
  delegate_to: localhost

[ansibot]

cc @Akasurde @ckotte @dav1x @warthog9
click here for bot help

[ansibot]

@Tomorrow9, just so you are aware we have a dedicated Working Group for vmware.
You can find other people interested in this in #ansible-vmware on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

[ansibot]

The test ansible-test sanity --test pylint [explain] failed with 1 error:

lib/ansible/modules/cloud/vmware/vmware_guest_network.py:453:0: missing-final-newline Final newline missing

The test ansible-test sanity --test pep8 [explain] failed with 5 errors:

lib/ansible/modules/cloud/vmware/vmware_guest_network.py:78:100: W291 trailing whitespace
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:324:41: E131 continuation line unaligned for hanging indent
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:328:41: E127 continuation line over-indented for visual indent
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:329:41: E127 continuation line over-indented for visual indent
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:453:11: W292 no newline at end of file

click here for bot help

[ansibot]

@MikeKlebolt @Akasurde @bedecarroll @CastawayEGR @chrrrles @dav1x @garbled1 @GyorgyPeter @imjoseangel @jjahns @kamsz @karstenjakobsen @kryptsi @lrivallain @nafpliot-ibm @nerzhul @oboukili @rhoop @ritzk @rmin @stravassac @tchernomax @warthog9 @woshihaoren

As a maintainer of a module in the same namespace this new module has been submitted to, your vote counts for shipits. Please review this module and add shipit if you would like to see it merged.

click here for bot help

[Tomorrow9]

I also hit this issue #50656 in this module. On vSphere 6.5, it works well, on vSphere 6.7, there is error "VM network does not exist" and "Hot plug failed". I'll take a look at that. Thanks.

[ansibot]

cc @lparkes
click here for bot help

[Tomorrow9]

I also hit this issue #50656 in this module. On vSphere 6.5, it works well, on vSphere 6.7, there is error "VM network does not exist" and "Hot plug failed". I'll take a look at that. Thanks.

Sorry, my mistake, configured the wrong "datacenter" parameter. :(

[xenlo]

Edited… see next Review

[xenlo]

I just tested this new module. Here is my feedback on what I tested, what works, what doesn't.

Adding NICs on an existing VM

  networks:
    - name: "vlan{{ vlan.id }}"
      mac: "{{ 'aa:bb:cc:dd:%02d:%02d' | format((vlan.id |int), (host.id |int)) }}"
      state: new

It works!

That really eases what was theoretically possible to do with vmware_guest module but to hard in practice. So that's a huge improvement for me.

Removing NICs on an existing VM

  networks:
    - name: "vlan{{ vlan.id }}"
      mac: "{{ 'aa:bb:cc:dd:%02d:%02d' | format((vlan.id |int), (host.id |int)) }}"
      state: new

Well here I have 2 issues:

     - C(label) or C(device_type) is required to reconfigure or remove an existing network adapter.
     - 'If there are multiple network adapters with the same C(device_type), you should set C(label),
        or will use the first matched network adapter.'

• In our use case, we don't work with the label but with the mac. I assume that it would be possible to delete or edit a NIC identified by its mac address. Am I wrong?
• It sounds strange to me to be able to delete a NIC just based on its device_type. I can imagine use case where you have to change something on all NICs of a defined type, … but not on just the first one found.

[Tomorrow9]

@xenlo thanks for your reviewing and feedback.
So the first question is: use mac address as one parameter to delete or reconfigure the matched network adapter. Right, that's reasonable. I'm not using this scenario but you do, so I'll add this.
The second one is: for multiple network adapters, what I wanted to do is if we do not get network adapter label, just know their device type and want to configure one of them, we can use it. But specify the "device_type" to reconfigure/remove all of them with that type, this also make sense. I'll make some changes.
Also, if there are any more scenarios not covered in this module, please let me know. Thank you very much.

[ansibot]

The test ansible-test sanity --test validate-modules [explain] failed with 7 errors:

lib/ansible/modules/cloud/vmware/vmware_guest_network.py:0:0: E337 Argument 'cluster' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:0:0: E337 Argument 'datacenter' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:0:0: E337 Argument 'esxi_hostname' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:0:0: E337 Argument 'folder' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:0:0: E337 Argument 'name' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:0:0: E337 Argument 'networks' in argument_spec defines type as <class 'list'> but documentation doesn't define type
lib/ansible/modules/cloud/vmware/vmware_guest_network.py:0:0: E337 Argument 'uuid' in argument_spec defines type as 'str' but documentation doesn't define type

click here for bot help

[Akasurde]

@Tomorrow9 Could you please merge Tomorrow9#2 which addresses my review comments ? Thanks.

[ansibot]

@Tomorrow9 this PR contains the following merge commits:

• a2b1771

Please rebase your branch to remove these commits.

click here for bot help

[ansibot]

cc @Smithx10 @bcoca @bvitnik @dagwieers @danowar2k @fishman @jasperla @jpdasma @mator @pdellaert @scathatheworm @troy2914 @xen0l
click here for bot help

[ansibot]

The test ansible-test sanity --test pylint [explain] failed with 1 error:

lib/ansible/modules/cloud/vmware/vmware_guest_network.py:209:20: undefined-variable Undefined variable 'nic_devices'

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

lib/ansible/modules/cloud/vmware/vmware_guest_network.py:0:0: E325 Argument 'networks' in argument_spec defines type as <class 'list'> but documentation defines type as 'list'

click here for bot help