Merge pull request #2283 from mariolenz/20250115-deprecate-inventory-plugins

Deprecate inventory plugins

Author: mariolenz

.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.9.0'
 
       - name: Run collection docs linter
         run: antsibull-docs lint-collection-docs . --plugin-docs --skip-rstcheck

changelogs/fragments/2283-deprecate-inventory-plugins.yml

@@ -0,0 +1,5 @@
+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/2283).
+  - vmware_vm_inventory - the inventory plugin is deprecated and will be removed in community.vmware 7.0.0
+    (https://github.com/ansible-collections/community.vmware/pull/2283).

meta/runtime.yml

@@ -180,6 +180,15 @@ action_groups:
   - vsphere_file
 
 plugin_routing:
+  inventory:
+    vmware_host_inventory:
+      deprecation:
+        removal_version: 7.0.0
+        warning_text: Use vmware.vmware.esxi_hosts instead.
+    vmware_vm_inventory:
+      deprecation:
+        removal_version: 7.0.0
+        warning_text: Use vmware.vmware.vms instead.
   modules:
     vmware_cluster:
       deprecation:

plugins/connection/vmware_tools.py

@@ -86,9 +86,8 @@
         required: false
       vm_uuid:
         description:
+          - UUID of the virtual machine
           - Mutually exclusive with O(vm_path)
-          - VM UUID to the connection.
-          - UUID of the virtual machine from property config.uuid of P(community.vmware.vmware_vm_inventory#inventory) plugin
         vars:
           - name: ansible_vmware_guest_uuid
         required: false

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 P(vmware.vmware.esxi_hosts#inventory) instead.
     short_description: VMware ESXi hostsystem inventory source
     author:
       - Abhijeet Kasurde (@Akasurde)

plugins/inventory/vmware_vm_inventory.py

@@ -9,6 +9,10 @@
 
 DOCUMENTATION = r'''
     name: vmware_vm_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 P(vmware.vmware.vms#inventory) instead.
     short_description: VMware Guest inventory source
     author:
       - Abhijeet Kasurde (@Akasurde)