Update vmware_guest.py docs

[danielkucera]

SUMMARY

None of name or vlan is in fact required. For correct operation either one can be specified.

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

vmware_guest

ADDITIONAL INFORMATION

This cost us about 2 hours of debugging because we thought that vlan is required. When we specified both name and vlan, another network was picked than we specified in name because vlan takes precedence and there was another network available with the same vlan id.
This PR might be worth backporting to all version where this applies.

Relevant code section:

community.vmware/plugins/modules/vmware_guest.py

Lines 1811 to 1812 in e249a03

	self.module.fail_json(msg="Please specify at least a network name or"
	" a VLAN name under VM network list.")

[softwarefactory-project-zuul]

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/f3db2b42e3a647ec82002c3930bad244

✔️ ansible-tox-linters SUCCESS in 4m 40s
✔️ build-ansible-collection SUCCESS in 7m 25s
⚠️ ansible-test-cloud-integration-vcenter7_only-stable218 CANCELED
⚠️ ansible-test-cloud-integration-vcenter7_2esxi-stable218 CANCELED
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 CANCELED
❌ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 FAILURE in 11m 02s
✔️ ansible-galaxy-importer SUCCESS in 3m 56s

[danielkucera]

recheck

[softwarefactory-project-zuul]

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/af3e81d406ee4940bf8c85dd066bb516

✔️ ansible-tox-linters SUCCESS in 5m 02s
✔️ build-ansible-collection SUCCESS in 7m 19s
⚠️ ansible-test-cloud-integration-vcenter7_only-stable218 CANCELED
⚠️ ansible-test-cloud-integration-vcenter7_2esxi-stable218 CANCELED
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 CANCELED
❌ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 FAILURE in 11m 09s
✔️ ansible-galaxy-importer SUCCESS in 4m 49s

[danielkucera]

recheck

[softwarefactory-project-zuul]

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/16c9d02f46b1400fa3149a4cb5554a36

✔️ ansible-tox-linters SUCCESS in 4m 51s
✔️ build-ansible-collection SUCCESS in 7m 33s
⚠️ ansible-test-cloud-integration-vcenter7_only-stable218 CANCELED
❌ ansible-test-cloud-integration-vcenter7_2esxi-stable218 FAILURE in 15m 50s
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 CANCELED
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 4m 45s

[danielkucera]

recheck

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/eeabde3145484e5aa35df1a997fef4ad

✔️ ansible-tox-linters SUCCESS in 4m 29s
✔️ build-ansible-collection SUCCESS in 7m 29s
✔️ ansible-test-cloud-integration-vcenter7_only-stable218 SUCCESS in 17m 00s
✔️ ansible-test-cloud-integration-vcenter7_2esxi-stable218 SUCCESS in 13m 24s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 SUCCESS in 1h 00m 39s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 SUCCESS in 51m 40s
✔️ ansible-galaxy-importer SUCCESS in 4m 12s

[mariolenz]

I'm sorry, I didn't find much time to work on this collection during the last weeks. I hope I'm able to review this PR soon.

[mariolenz]

Thanks for this @danielkucera! But I think you're wrong in saying that those options are both simply optional. It looks like you need at least one of them:

community.vmware/plugins/modules/vmware_guest.py

Lines 1816 to 1818 in 9b138fe

	if 'name' not in network and 'vlan' not in network:
	self.module.fail_json(msg="Please specify at least a network name or"
	" a VLAN name under VM network list.")

I suggest to make this clear. Feel free to improve my wording if you don't like it :-)

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/0f1890aa413a47298ceed601ccc95ea2

✔️ ansible-tox-linters SUCCESS in 5m 01s
✔️ build-ansible-collection SUCCESS in 7m 41s
✔️ ansible-test-cloud-integration-vcenter7_only-stable218 SUCCESS in 25m 29s
✔️ ansible-test-cloud-integration-vcenter7_2esxi-stable218 SUCCESS in 26m 51s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 SUCCESS in 1h 13m 41s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 SUCCESS in 45m 13s
✔️ ansible-galaxy-importer SUCCESS in 6m 02s

[softwarefactory-project-zuul]

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/30d1506528b94272bdced05006523c84

✔️ ansible-tox-linters SUCCESS in 5m 22s
✔️ build-ansible-collection SUCCESS in 5m 58s
✔️ ansible-galaxy-importer SUCCESS in 5m 33s