Skip to content

vcenter_object_move: add module to move vCenter inventory object #2346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
sbaerlocher wants to merge 2 commits into
base: main
Choose a base branch
from
Open

vcenter_object_move: add module to move vCenter inventory object #2346

sbaerlocher wants to merge 2 commits into from
+384 −0

Conversation

@sbaerlocher
Copy link

@sbaerlocher sbaerlocher commented Mar 6, 2025 •
edited
Loading

SUMMARY

This commit introduces the new module vcenter_object_move which allows moving vCenter inventory objects (e.g., Virtual Machines, Hosts, Datastores, Networks) into a specified destination folder. The module ensures idempotence by checking if the object is already located in the target folder and supports Ansible check mode for dry-run operations. This feature simplifies inventory management in vCenter environments and aids in maintaining an organized structure.

ISSUE TYPE
  • New Module Pull Request
COMPONENT NAME

vcenter_object_move

ADDITIONAL INFORMATION

The module leverages pyVmomi to interact with the vCenter API and integrates with the existing utilities from the community.vmware collection. It performs the following steps:

  1. Validates input parameters (datacenter, object_name, object_type, destination_folder).
  2. Locates the vCenter datacenter and the specified inventory object.
  3. Traverses the folder structure to locate the destination folder.
  4. Moves the object if it is not already in the target folder; if it is, no action is taken.
  5. Supports check mode to simulate the move without applying changes.

Example command output:

{
    "changed": true,
    "msg": "Object 'MyVM' was successfully moved to folder 'NewFolder/SubFolder'."
}

@sbaerlocher sbaerlocher changed the title [WIP] vcenter_object_move: add module to move vCenter inventory objec… [WIP] vcenter_object_move: add module to move vCenter inventory object Mar 6, 2025
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 5m 14s
✔️ build-ansible-collection SUCCESS in 7m 44s
❌ ansible-test-cloud-integration-vcenter7_only-stable218 FAILURE in 14m 27s
⚠️ 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 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 3m 08s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from fa0413d to 684b5a3 Compare March 6, 2025 12:52
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 4m 46s
✔️ build-ansible-collection SUCCESS in 7m 36s
❌ ansible-test-cloud-integration-vcenter7_only-stable218 FAILURE in 8m 05s
⚠️ 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 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 4m 51s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from 684b5a3 to c6ed128 Compare March 6, 2025 13:28
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 4m 43s
✔️ build-ansible-collection SUCCESS in 7m 21s
❌ ansible-test-cloud-integration-vcenter7_only-stable218 FAILURE in 13m 06s
⚠️ 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 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 5m 19s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from c6ed128 to b286376 Compare March 6, 2025 14:04
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 5m 40s
✔️ build-ansible-collection SUCCESS in 7m 22s
❌ ansible-test-cloud-integration-vcenter7_only-stable218 FAILURE in 13m 22s
⚠️ 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 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 4m 52s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from b286376 to 9093b90 Compare March 6, 2025 14:40
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 5m 06s
✔️ 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 10m 53s
✔️ ansible-galaxy-importer SUCCESS in 5m 14s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from 9093b90 to ced45ff Compare March 6, 2025 15:26
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 5m 04s
✔️ build-ansible-collection SUCCESS in 7m 25s
❌ ansible-test-cloud-integration-vcenter7_only-stable218 FAILURE in 7m 40s
⚠️ 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 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 4m 00s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from ced45ff to d0aa895 Compare March 6, 2025 16:27
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 4m 50s
✔️ build-ansible-collection SUCCESS in 7m 33s
⚠️ 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 FAILURE in 8m 02s
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 4m 36s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from d0aa895 to e85aea0 Compare March 6, 2025 17:35
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 5m 14s
✔️ build-ansible-collection SUCCESS in 7m 21s
⚠️ 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 FAILURE in 11m 25s
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 4m 35s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from e85aea0 to bba9879 Compare March 6, 2025 18:21
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 4m 41s
✔️ build-ansible-collection SUCCESS in 7m 29s
⚠️ 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 FAILURE in 16m 03s
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 5m 12s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from bba9879 to 7bababd Compare March 6, 2025 18:53
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 4m 46s
✔️ build-ansible-collection SUCCESS in 7m 22s
⚠️ 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 FAILURE in 9m 20s
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 4m 37s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from 7bababd to 6ad7b63 Compare March 6, 2025 19:13
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Mar 6, 2025

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

✔️ ansible-tox-linters SUCCESS in 5m 29s
✔️ build-ansible-collection SUCCESS in 7m 22s
⚠️ 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 17m 25s
✔️ ansible-galaxy-importer SUCCESS in 4m 18s

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from 6ad7b63 to 753186a Compare November 15, 2025 21:58
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Nov 15, 2025

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

❌ ansible-tox-linters FAILURE in 5m 00s
⚠️ ansible-galaxy-importer CANCELED (non-voting)
⚠️ build-ansible-collection CANCELED

Warning:
Job ansible-tox-linters: unable to map line for file comments:
stderr: 'fatal: -L invalid line number: 0'

@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from 753186a to ce0962c Compare November 15, 2025 22:08
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Nov 15, 2025

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

✔️ ansible-tox-linters SUCCESS in 5m 04s
✔️ ansible-galaxy-importer SUCCESS in 4m 11s (non-voting)
✔️ build-ansible-collection SUCCESS in 6m 59s

@sbaerlocher sbaerlocher changed the title [WIP] vcenter_object_move: add module to move vCenter inventory object vcenter_object_move: add module to move vCenter inventory object Nov 15, 2025
@sbaerlocher
Fix deprecated imports and add changelog fragment
7f735bf 
- Replace deprecated ansible.module_utils._text import with
  ansible.module_utils.common.text.converters
- Use base_argument_spec from vmware.vmware collection
- Update documentation fragment to vmware.vmware.base_options
- Add changelog fragment for new vcenter_object_move module
@sbaerlocher sbaerlocher force-pushed the feature/add-vcenter-object-move branch from ce0962c to 7f735bf Compare November 16, 2025 22:13
@softwarefactory-project-zuul
Copy link

softwarefactory-project-zuul bot commented Nov 16, 2025

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

✔️ ansible-tox-linters SUCCESS in 5m 36s
✔️ ansible-galaxy-importer SUCCESS in 4m 10s (non-voting)
✔️ build-ansible-collection SUCCESS in 6m 42s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sbaerlocher