vmware.vmware.tags module – Manage one or more VMware tags.

Note

This module is part of the vmware.vmware collection (version 2.9.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware.

To use it in a playbook, specify: vmware.vmware.tags.

Synopsis

  • This module allows you to create, update, and delete VMware tags.

  • For better performance, use object IDs instead of names when possible.

Parameters

Parameter

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

aliases: pass, pwd

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.

port

integer

The port number of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

proxy_host

string

The 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 VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

The 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 VMWARE_PROXY_PORT will be used instead.

proxy_protocol

aliases: protocol

string

The proxy connection protocol to use.

This option is used if the correct proxy protocol cannot be automatically determined.

Choices:

  • "http"

  • "https" ← (default)

state

string

Whether ensure the tags are present or absent.

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=dictionary / required

A list of tags to manage.

category_id

string

The id of the category of the tag.

Either category_name or category_id is required when looking up a tag by name.

The category must already exist.

category_name

string

The name of the category of the tag.

Either category_name or category_id is required when looking up a tag by name.

The category must already exist.

description

string

The description of the tag.

id

string

The id of the tag to manage.

Only applicable if the tag already exists.

If both name and ID are provided, the ID will be used to search for the tag. If a tag cannot be found and state is present, an error will be raised.

If both name and ID are provided and a tag is found, the name will be updated if needed.

name

string

The name of the tag.

The name is required when creating a new tag.

If both name and ID are provided, the ID will be used to search for the tag. If a tag cannot be found and state is present, an error will be raised.

If both name and ID are provided and a tag is found, the name will be updated if needed.

username

aliases: admin, user

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.

validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false 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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • All modules require API write access and hence are not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

  • Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

See Also

See also

vmware.vmware.tag_categories

Manage one or more VMware tag categories.

Examples

- name: Create or update tags
  vmware.vmware.tags:
    state: present
    tags:
      - name: my-test-tag-1
        category_id: urn:vmomi:InventoryServiceCategory:00000000-0000-0000-0000-000000000000:GLOBAL
      - id: urn:vmomi:InventoryServiceTag:00000000-0000-0000-0000-21b1f07e73cf:GLOBAL
        category_id: urn:vmomi:InventoryServiceCategory:00000000-0000-0000-0000-000000000000:GLOBAL
        description: "This is a test tag"
      - name: my-test-tag-3
        category_name: my-test-category
        description: "This is another test tag"

- name: Delete tags
  vmware.vmware.tags:
    state: absent
    tags:
      - name: my-test-tag-1
        category_id: urn:vmomi:InventoryServiceCategory:00000000-0000-0000-0000-000000000000:GLOBAL
      - id: urn:vmomi:InventoryServiceTag:00000000-0000-0000-0000-21b1f07e73cf:GLOBAL
        category_id: urn:vmomi:InventoryServiceCategory:00000000-0000-0000-0000-000000000000:GLOBAL

Return Values

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

Key

Description

created_tags

list / elements=string

List of tag IDs that were created by this module.

The list is empty if no tags were created.

Returned: always

Sample: ["urn:vmomi:InventoryServiceTag:00000000-0000-0000-0000-21b1f07e73cf:GLOBAL"]

removed_tags

list / elements=string

List of tag IDs that were removed by this module.

The list is empty if no tags were removed.

Returned: always

Sample: ["urn:vmomi:InventoryServiceTag:00000000-0000-0000-0000-21b1f07e73cf:GLOBAL"]

updated_tags

list / elements=string

List of tag IDs that were updated by this module.

The list is empty if no tags were updated.

Returned: always

Sample: ["urn:vmomi:InventoryServiceTag:00000000-0000-0000-0000-21b1f07e73cf:GLOBAL"]

vsphere_tags

dictionary

Dictionary of tags that were managed by this module. This includes any tags that the user specified, even if nothing was changed.

The key is the tag ID, the value is a dictionary with tag information.

Returned: always

Sample: {"urn:vmomi:InventoryServiceTag:00000000-0000-0000-0000-21b1f07e73cf:GLOBAL": {"category_id": "urn:vmomi:InventoryServiceCategory:00000000-0000-0000-0000-000000000000:GLOBAL", "description": "Description of tag1", "id": "urn:vmomi:InventoryServiceTag:00000000-0000-0000-0000-21b1f07e73cf:GLOBAL", "name": "tag1"}}

Authors

  • Ansible Cloud Team (@ansible-collections)