VMware: new module vmware_guest_register_operation #54647

sky-joker · 2019-03-31T06:44:09Z

SUMMARY

This module can do the following.

Register VM to inventory
Unregister VM from inventory

This is useful when you want to unregister a VM from inventory and register it again.

ISSUE TYPE

New Module Pull Request

ansibot · 2019-03-31T06:48:09Z

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

ansibot · 2019-03-31T06:48:10Z

@sky-joker, 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 · 2019-03-31T06:56:37Z

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

lib/ansible/modules/cloud/vmware/vmware_guest_register_operation.py:0:0: E312 No RETURN provided

click here for bot help

ansibot · 2019-03-31T08:29:50Z

@GBrawl @MikeKlebolt @Tomorrow9 @Akasurde @alongchamps @bedecarroll @CastawayEGR @chrrrles @dav1x @garbled1 @GyorgyPeter @imjoseangel @jjahns @kamsz @karstenjakobsen @kryptsi @lrivallain @michaeldeaton @nafpliot-ibm @nerzhul @oboukili @rhoop @ritzk @rmin @stravassac @sumkincpp @vmwjoseph @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

ansibot · 2019-04-09T16:25:17Z

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

test/integration/targets/vmware_guest_register_operation/aliases:0:0: missing alias `shippable/posix/group[1-4]` or `unsupported`

click here for bot help

chsnell · 2019-08-07T17:49:09Z

lib/ansible/modules/cloud/vmware/vmware_guest_register_operation.py

+    - Destination datacenter for the register/unregister operation.
+    - This parameter is case sensitive.
+    default: ha-datacenter
+  cluster_name:


These are random comments from someone extremely wanting to see this module (so much that I've pulled it and am testing it out). Other vmware modules use cluster instead of cluster_name. Would be nice if it were consistent throughout all the modules.

Thank you for comment!
Modify cluster_name to cluster.

Modified cluster_name parameter name to cluster. :)

chsnell · 2019-08-07T17:57:50Z

lib/ansible/modules/cloud/vmware/vmware_guest_register_operation.py

+    - 'Examples:'
+    - '    [datastore1] vm/vm.vmx'
+    - '    [datastore1] vm/vm.vmtx'
+  resource_pool:


If you set both cluster_name and resource_pool, resource_pool seems to be ignored and the guest is created at the top level of the cluster. If I leave cluster_name off, and just set resource_pool, the guest creates in the right place.

This assumes that only one of the cluster or resource_pool is specified.
If the and conditions for the cluster and resource_pool are required, modify the code.

… to DOCUMENTATION

goneri

Nice patch! Thanks @sky-joker.

goneri · 2019-09-30T20:33:45Z

lib/ansible/modules/cloud/vmware/vmware_guest_register_operation.py

+description:
+  - This module can register or unregister VMs to the inventory.
+requirements:
+  - python >= 2.6


pyvmomi only support 2.7+, so you can safely bump to Python version to 2.7

goneri · 2019-09-30T20:35:10Z

lib/ansible/modules/cloud/vmware/vmware_guest_register_operation.py

+    description:
+    - Destination datacenter for the register/unregister operation.
+    - This parameter is case sensitive.
+    default: ha-datacenter


We don't use any default value for the datacenter, See: https://docs.ansible.com/ansible/devel/dev_guide/platforms/vmware_guidelines.html#datacenter-argument-with-esxi

test/integration/targets/vmware_guest_register_operation/tasks/main.yml

goneri · 2019-09-30T20:43:26Z

test/integration/targets/vmware_guest_register_operation/tasks/main.yml

+  register: resource_pools
+
+- name: get a resource pool
+  set_fact: resource_pool="{{ resource_pools['json'][2].split('/').7 }}"


And you can remove the two steps above.

goneri · 2019-09-30T20:48:31Z

test/integration/targets/vmware_guest_register_operation/tasks/main.yml

+  set_fact: resource_pool="{{ resource_pools['json'][2].split('/').7 }}"
+
+- name: get a vm name
+  set_fact: vm_name="DC0_H0_VM0"


Two options here:

You use setup_virtualmachines: true to let prepare_vmware_tests prepare the VM for you, and you can use "{{ virtual_machines[0].name }}" or "{{ virtual_machines_in_cluster[0].name }}"

OR, you remove setup_virtualmachines: true the you prepare the VM yourself (please just call it test_vm1 https://docs.ansible.com/ansible/devel/dev_guide/platforms/vmware_guidelines.html#vm-names-should-be-predictable)

goneri · 2019-09-30T20:51:59Z

lib/ansible/modules/cloud/vmware/vmware_guest_register_operation.py

+            else:
+                if self.esxi_hostname:
+                    host_obj = self.find_hostsystem_by_name(self.esxi_hostname)
+                    if not host_obj:


This is the 4th if level, it probably means you can re-factorize your code a bit, e.g: with a function, of smaller if/else block.

This being said, the code is short enough to be comprehensible, I don't mind merging it like it is today.

sky-joker · 2019-10-01T14:18:53Z

Thank you @goneri for pointing it out!
I will cope with the points pointed out.

…t case Fixe the following. * ansible#54647 (review) * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment)

…t case Fixe the following. * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment)

goneri · 2019-10-02T20:53:50Z

The tests pass just fine now, thanks @sky-joker for the quick fix.

sky-joker · 2019-10-03T13:57:27Z

Thank you @goneri for merging!

Akron27 · 2019-10-17T21:02:25Z

Can I just use this vmware_guest_register_operation.py as a module in by copying this script in

/usr/lib/python2.7/site-packages/ansible/modules

Akasurde · 2019-10-18T02:12:03Z

@dinu21 You can -

copy required module to /usr/lib/python2.7/site-packages/ansible/modules/cloud/vmware/
or
create a directory library in current working directory and copy-paste required module inside this directory

Please refer - https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html#adding-a-module-locally for more details.

Akron27 · 2019-10-18T03:18:41Z

@dinu21 You can -

copy required module to /usr/lib/python2.7/site-packages/ansible/modules/cloud/vmware/
or

create a directory library in current working directory and copy-paste required module inside this directory

Please refer - https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html#adding-a-module-locally for more details.

@Akasurde Thanks this worked

Added vmware module vmware_guest_register_operation

338d1a2

ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed community_review In order to be merged, this PR must follow the community review workflow. labels Mar 31, 2019

fix validate module error code E312

d52ad8f

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Mar 31, 2019

ansibot added community_review In order to be merged, this PR must follow the community review workflow. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Mar 31, 2019

sky-joker added 3 commits March 31, 2019 23:51

Fix Author account name

5735e30

Modify path option

adf0012

Add integration tests

4fc0751

ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed community_review In order to be merged, this PR must follow the community review workflow. labels Apr 9, 2019

sky-joker added 2 commits April 10, 2019 01:27

Rename aliases file

1280f38

fix vcenter/3.6/1 test error

69c31fb

ansibot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Apr 9, 2019

ansibot added the stale_review Updates were made after the last review and the last review is more than 7 days old. label May 29, 2019

ansibot removed the stale_review Updates were made after the last review and the last review is more than 7 days old. label Jun 30, 2019

ansibot added the stale_review Updates were made after the last review and the last review is more than 7 days old. label Jul 8, 2019

chsnell reviewed Aug 7, 2019

View reviewed changes

[update] Modify cluster_name parameter name to cluster and add type…

e07d58a

… to DOCUMENTATION

ansibot removed stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. stale_review Updates were made after the last review and the last review is more than 7 days old. labels Aug 17, 2019

[update] vmware_guest_register_operation test case

76ec9fa

ansibot added stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. stale_review Updates were made after the last review and the last review is more than 7 days old. labels Aug 25, 2019

change version_added 2.9 to 2.10

5ce0de3

ansibot removed stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. stale_review Updates were made after the last review and the last review is more than 7 days old. labels Sep 26, 2019

sky-joker mentioned this pull request Sep 28, 2019

Add support to delete vm from inventory. #62903

Merged

goneri suggested changes Sep 30, 2019

View reviewed changes

goneri reviewed Sep 30, 2019

View reviewed changes

Made multiple fixes to vmware_guest_register_operation module and tes…

6ed2e17

…t case Fixe the following. * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment) * ansible#54647 (comment)

sky-joker force-pushed the new_module_vmware_guest_register_operation branch from da124eb to 6ed2e17 Compare October 1, 2019 16:04

goneri approved these changes Oct 2, 2019

View reviewed changes

goneri merged commit ff933be into ansible:devel Oct 2, 2019

sky-joker deleted the new_module_vmware_guest_register_operation branch October 3, 2019 13:57

ansible locked and limited conversation to collaborators Oct 30, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VMware: new module vmware_guest_register_operation #54647

VMware: new module vmware_guest_register_operation #54647

sky-joker commented Mar 31, 2019

ansibot commented Mar 31, 2019

ansibot commented Mar 31, 2019

ansibot commented Mar 31, 2019

ansibot commented Mar 31, 2019

ansibot commented Apr 9, 2019

chsnell Aug 7, 2019

sky-joker Aug 9, 2019

sky-joker Aug 17, 2019

chsnell Aug 7, 2019

sky-joker Aug 9, 2019

goneri left a comment

goneri Sep 30, 2019

goneri Sep 30, 2019

goneri Sep 30, 2019

goneri Sep 30, 2019

goneri Sep 30, 2019 •

edited

sky-joker commented Oct 1, 2019

goneri commented Oct 2, 2019

sky-joker commented Oct 3, 2019

Akron27 commented Oct 17, 2019

Akasurde commented Oct 18, 2019

Akron27 commented Oct 18, 2019

VMware: new module vmware_guest_register_operation #54647

VMware: new module vmware_guest_register_operation #54647

Conversation

sky-joker commented Mar 31, 2019

SUMMARY

ISSUE TYPE

ansibot commented Mar 31, 2019

ansibot commented Mar 31, 2019

ansibot commented Mar 31, 2019

ansibot commented Mar 31, 2019

ansibot commented Apr 9, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goneri left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goneri Sep 30, 2019 • edited

Choose a reason for hiding this comment

sky-joker commented Oct 1, 2019

goneri commented Oct 2, 2019

sky-joker commented Oct 3, 2019

Akron27 commented Oct 17, 2019

Akasurde commented Oct 18, 2019

Akron27 commented Oct 18, 2019

goneri Sep 30, 2019 •

edited