Deprecate vmware_host_inventory

ansible-collections · Dec 25, 2024 · 04e7dfa · 04e7dfa
1 parent 290bc26
commit 04e7dfa
Show file tree

Hide file tree

Showing 14 changed files with 13 additions and 415 deletions.
diff --git a/.github/workflows/extra-docs-linting.yml b/.github/workflows/extra-docs-linting.yml
@@ -34,7 +34,7 @@ jobs:
       - name: Install dependent collections
         run: >
           ansible-galaxy collection install
-          'vmware.vmware>=1.7.1'
+          'vmware.vmware>=1.8.0'
 
       - name: Run collection docs linter
         run: antsibull-docs lint-collection-docs . --plugin-docs --skip-rstcheck
diff --git a/changelogs/fragments/2279-deprecate-vmware_host_inventory.yml b/changelogs/fragments/2279-deprecate-vmware_host_inventory.yml
@@ -0,0 +1,3 @@
+deprecated_features:
+  - vmware_host_inventory - the inventory plugin is deprecated and will be removed in community.vmware 7.0.0
+    (https://github.com/ansible-collections/community.vmware/pull/2279).
diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -180,6 +180,11 @@ action_groups:
   - vsphere_file
 
 plugin_routing:
+  inventory:
+    vmware_host_inventory:
+      deprecation:
+        removal_version: 7.0.0
+        warning_text: Use vmware.vmware.esxi_hosts instead.
   modules:
     vmware_cluster:
       deprecation:

diff --git a/plugins/inventory/vmware_host_inventory.py b/plugins/inventory/vmware_host_inventory.py
@@ -10,6 +10,10 @@
 
 DOCUMENTATION = r"""
     name: vmware_host_inventory
+    deprecated:
+      removed_in: 7.0.0
+      why: This module has been moved to the L(new vmware.vmware collection,https://forum.ansible.com/t/5880)
+      alternative: Use M(vmware.vmware.esxi_hosts) instead.
     short_description: VMware ESXi hostsystem inventory source
     author:
       - Abhijeet Kasurde (@Akasurde)

diff --git a/tests/integration/targets/inventory_vmware_host_inventory/aliases b/tests/integration/targets/inventory_vmware_host_inventory/aliases
diff --git a/tests/integration/targets/inventory_vmware_host_inventory/playbook/build_inventory.yml b/tests/integration/targets/inventory_vmware_host_inventory/playbook/build_inventory.yml
diff --git a/...tegration/targets/inventory_vmware_host_inventory/playbook/build_inventory_with_cache.yml b/...tegration/targets/inventory_vmware_host_inventory/playbook/build_inventory_with_cache.yml
diff --git a/...ration/targets/inventory_vmware_host_inventory/playbook/build_inventory_without_cache.yml b/...ration/targets/inventory_vmware_host_inventory/playbook/build_inventory_without_cache.yml
diff --git a/tests/integration/targets/inventory_vmware_host_inventory/playbook/install_dependencies.yml b/tests/integration/targets/inventory_vmware_host_inventory/playbook/install_dependencies.yml
diff --git a/tests/integration/targets/inventory_vmware_host_inventory/playbook/prepare_vmware.yml b/tests/integration/targets/inventory_vmware_host_inventory/playbook/prepare_vmware.yml
diff --git a/tests/integration/targets/inventory_vmware_host_inventory/playbook/test_inventory_cache.yml b/tests/integration/targets/inventory_vmware_host_inventory/playbook/test_inventory_cache.yml
diff --git a/tests/integration/targets/inventory_vmware_host_inventory/playbook/test_options.yml b/tests/integration/targets/inventory_vmware_host_inventory/playbook/test_options.yml