community.vmware.vmware_tag_info – Manage VMware tag info¶
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_tag_info
.
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.tag_facts
will be deprecated in Ansible 2.14, since it does not return multiple tags with same name and different category id.Please use
tag_info
instead oftag_facts
.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
PyVmomi
vSphere Automation SDK
Parameters¶
Examples¶
- name: Get info about tag
community.vmware.vmware_tag_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
delegate_to: localhost
- name: Get category id from the given tag
community.vmware.vmware_tag_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
delegate_to: localhost
register: tag_details
- debug:
msg: "{{ tag_details.tag_facts['fedora_machines']['tag_category_id'] }}"
- name: Gather tag id from the given tag
community.vmware.vmware_tag_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
delegate_to: localhost
register: tag_results
- set_fact:
tag_id: "{{ item.tag_id }}"
loop: "{{ tag_results.tag_info|json_query(query) }}"
vars:
query: "[?tag_name==`tag0001`]"
- debug: var=tag_id
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Abhijeet Kasurde (@Akasurde)