VMware: new module : vmware_tag_facts (#39889)

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

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

@@ -19,7 +19,7 @@ module: vmware_tag
 short_description: Manage VMware tags
 description:
 - This module can be used to create / delete / update VMware tags.
-- Tag Feature is introduced in vSphere 6 version, so module not supported in eariler versions of vSphere.
+- Tag feature is introduced in vSphere 6 version, so this module is not supported in the earlier versions of vSphere.
 - All variables and VMware object names are case sensitive.
 version_added: '2.6'
 author:

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

@@ -0,0 +1,126 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2018, Ansible Project
+# Copyright: (c) 2018, Abhijeet Kasurde <akasurde@redhat.com>
+#
+#  GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+ANSIBLE_METADATA = {
+    'metadata_version': '1.1',
+    'status': ['preview'],
+    'supported_by': 'community'
+}
+
+DOCUMENTATION = r'''
+---
+module: vmware_tag_facts
+short_description: Manage VMware tag facts
+description:
+- This module can be used to collect facts about VMware tags.
+- Tag feature is introduced in vSphere 6 version, so this module is not supported in the earlier versions of vSphere.
+- All variables and VMware object names are case sensitive.
+version_added: '2.6'
+author:
+- Abhijeet Kasurde (@akasurde)
+notes:
+- Tested on vSphere 6.5
+requirements:
+- python >= 2.6
+- PyVmomi
+- vSphere Automation SDK
+- vCloud Suite SDK
+extends_documentation_fragment: vmware_rest_client.documentation
+'''
+
+EXAMPLES = r'''
+- name: Get facts about tag
+  vmware_tag_facts:
+    hostname: 10.65.223.91
+    username: administrator@vsphere.local
+    password: Esxi@123$
+    validate_certs: False
+
+- name: Get category id from the given tag
+  vmware_tag_facts:
+    hostname: 10.65.223.91
+    username: administrator@vsphere.local
+    password: Esxi@123$
+    validate_certs: False
+  register: tag_details
+
+- debug:
+    msg: "{{ tag_details.tag_facts['fedora_machines']['tag_category_id'] }}"
+
+'''
+
+RETURN = r'''
+results:
+  description: dictionary of tag metadata
+  returned: on success
+  type: dict
+  sample: {
+        "Sample_Tag_0002": {
+            "tag_category_id": "urn:vmomi:InventoryServiceCategory:6de17f28-7694-43ec-a783-d09c141819ae:GLOBAL",
+            "tag_description": "Sample Description",
+            "tag_id": "urn:vmomi:InventoryServiceTag:a141f212-0f82-4f05-8eb3-c49647c904c5:GLOBAL",
+            "tag_used_by": []
+        },
+        "fedora_machines": {
+            "tag_category_id": "urn:vmomi:InventoryServiceCategory:baa90bae-951b-4e87-af8c-be681a1ba30c:GLOBAL",
+            "tag_description": "",
+            "tag_id": "urn:vmomi:InventoryServiceTag:7d27d182-3ecd-4200-9d72-410cc6398a8a:GLOBAL",
+            "tag_used_by": []
+        },
+        "ubuntu_machines": {
+            "tag_category_id": "urn:vmomi:InventoryServiceCategory:89573410-29b4-4cac-87a4-127c084f3d50:GLOBAL",
+            "tag_description": "",
+            "tag_id": "urn:vmomi:InventoryServiceTag:7f3516d5-a750-4cb9-8610-6747eb39965d:GLOBAL",
+            "tag_used_by": []
+        }
+    }
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.vmware_rest_client import VmwareRestClient
+try:
+    from com.vmware.cis.tagging_client import Tag
+except ImportError:
+    pass
+
+
+class VmTagFactManager(VmwareRestClient):
+    def __init__(self, module):
+        """Constructor."""
+        super(VmTagFactManager, self).__init__(module)
+        self.tag_service = Tag(self.connect)
+        self.global_tags = dict()
+
+    def get_all_tags(self):
+        """Function to retrieve all tag information."""
+        for tag in self.tag_service.list():
+            tag_obj = self.tag_service.get(tag)
+            self.global_tags[tag_obj.name] = dict(
+                tag_description=tag_obj.description,
+                tag_used_by=tag_obj.used_by,
+                tag_category_id=tag_obj.category_id,
+                tag_id=tag_obj.id
+            )
+
+        self.module.exit_json(changed=False, tag_facts=self.global_tags)
+
+
+def main():
+    argument_spec = VmwareRestClient.vmware_client_argument_spec()
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    vmware_tag_facts = VmTagFactManager(module)
+    vmware_tag_facts.get_all_tags()
+
+
+if __name__ == '__main__':
+    main()