W3cubDocs

/Ansible 2.9

vmware_tag_info – Manage VMware tag info

New in version 2.6.

Synopsis

  • This module can be used to collect information 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.
  • This module was called vmware_tag_facts before Ansible 2.9. The usage did not change.

Aliases: vmware_tag_facts

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_HOST will 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_PASSWORD will be used instead.

aliases: pass, pwd
protocol
string
    Choices:
  • http
  • https
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_USER will be used instead.

aliases: admin, user
validate_certs
boolean
    Choices:
  • no
  • yes
Allows connection when SSL certificates are not valid.
Set to no when certificates are not trusted.
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Notes

Note

  • Tested on vSphere 6.5

Examples

- name: Get info about tag
  vmware_tag_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
  delegate_to: localhost

- name: Get category id from the given tag
  vmware_tag_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
  delegate_to: localhost
  register: tag_details
- debug:
    msg: "{{ tag_details.tag_facts['fedora_machines']['tag_category_id'] }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
results
dictionary
on success
dictionary of tag metadata

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': []}}


Status

Authors

  • Abhijeet Kasurde (@Akasurde)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vmware_tag_info_module.html