community.vmware.vmware_category_info – Gather info about VMware tag categories
Note
This plugin is part of the community.vmware collection (version 1.7.0).
To install it use: ansible-galaxy collection install community.vmware.
To use it in a playbook, specify: community.vmware.vmware_category_info.
Synopsis
- This module can be used to gather information about VMware tag categories.
- Tag feature is introduced in vSphere 6 version, so this module is not supported in earlier versions of vSphere.
- All variables and VMware object names are case sensitive.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
- vSphere Automation SDK
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| hostname  string  | The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable  VMWARE_HOSTwill be used instead. | |
| password  string  | The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable  VMWARE_PASSWORDwill be used instead.aliases: pass, pwd | |
| port  integer  | Default: 443 | The port number of the vSphere vCenter. If the value is not specified in the task, the value of environment variable  VMWARE_PORTwill be used instead. | 
| protocol  string  | 
 | The connection to protocol. | 
| username  string  | The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable  VMWARE_USERwill be used instead.aliases: admin, user | |
| validate_certs  boolean  | 
 | Allows connection when SSL certificates are not valid. Set to  Falsewhen certificates are not trusted.If the value is not specified in the task, the value of environment variable  VMWARE_VALIDATE_CERTSwill be used instead. | 
Notes
Note
- Tested on vSphere 6.5
Examples
- name: Gather info about tag categories
  community.vmware.vmware_category_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
  delegate_to: localhost
  register: all_tag_category_info
- name: Gather category id from given tag category
  community.vmware.vmware_category_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
  delegate_to: localhost
  register: tag_category_results
- set_fact:
    category_id: "{{ item.category_id }}"
  loop: "{{ tag_category_results.tag_category_info|json_query(query) }}"
  vars:
    query: "[?category_name==`Category0001`]"
- debug: var=category_id
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| tag_category_info  list / elements=string  | always | metadata of tag categories Sample: [{'category_associable_types': [], 'category_cardinality': 'MULTIPLE', 'category_description': 'awesome description', 'category_id': 'urn:vmomi:InventoryServiceCategory:e785088d-6981-4b1c-9fb8-1100c3e1f742:GLOBAL', 'category_name': 'Category0001', 'category_used_by': []}, {'category_associable_types': ['VirtualMachine'], 'category_cardinality': 'SINGLE', 'category_description': 'another awesome description', 'category_id': 'urn:vmomi:InventoryServiceCategory:ae5b7c6c-e622-4671-9b96-76e93adb70f2:GLOBAL', 'category_name': 'template_tag', 'category_used_by': []}] | 
Authors
- Abhijeet Kasurde (@Akasurde)
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_category_info_module.html