community / community.vmware / 4.2.0 / module / vmware_tag Manage VMware tags Authors: Abhijeet Kasurde (@Akasurde)community.vmware.vmware_tag (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to create / delete / update 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.
- name: Create a tag community.vmware.vmware_tag: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' category_id: 'urn:vmomi:InventoryServiceCategory:e785088d-6981-4b1c-9fb8-1100c3e1f742:GLOBAL' tag_name: Sample_Tag_0002 tag_description: Sample Description state: present delegate_to: localhost
- name: Update tag description community.vmware.vmware_tag: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' tag_name: Sample_Tag_0002 tag_description: Some fancy description state: present delegate_to: localhost
- name: Delete tag community.vmware.vmware_tag: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' tag_name: Sample_Tag_0002 state: absent delegate_to: localhost
port: default: 443 description: - The port number of the vSphere vCenter. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int state: choices: - present - absent default: present description: - The state of tag. - If set to V(present) and tag does not exists, then tag is created. - If set to V(present) and tag exists, then tag is updated. - If set to V(absent) and tag exists, then tag is deleted. - If set to V(absent) and tag does not exists, no action is taken. required: false type: str hostname: description: - The hostname or IP address of the vSphere vCenter server. - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str protocol: choices: - http - https default: https description: - The connection to protocol. type: str tag_name: aliases: - tag - name description: - The name of tag to manage. required: true type: str username: aliases: - admin - user description: - The username of the vSphere vCenter server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str proxy_host: description: - Address of a proxy that will receive all HTTPS requests and relay them. - The format is a hostname or a IP. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - Port of the HTTP proxy that will receive all HTTPS requests and relay them. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT) will be used instead. required: false type: int category_id: description: - The unique ID generated by vCenter should be used to. - User can get this unique ID from facts module. - Required if O(category_name) is not set. required: false type: str category_name: aliases: - category description: - The name of category. - Required if O(category_id) is not set. required: false type: str version_added: 3.5.0 version_added_collection: community.vmware validate_certs: default: true description: - Allows connection when SSL certificates are not valid. - Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool tag_description: aliases: - description default: '' description: - The tag description. - This is required only if O(state=present). - This parameter is ignored, when O(state=absent). - Process of updating tag only allows description change. required: false type: str
tag_status: description: dictionary of tag metadata returned: on success sample: msg: Tag 'Sample_Tag_0002' created. tag_id: urn:vmomi:InventoryServiceTag:bff91819-f529-43c9-80ca-1c9dfda09441:GLOBAL type: dict