Модуль community.vmware.vmware_tag_manager — управление связью тегов VMware с объектами VMware

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware. Для использования этого модуля необходимы дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.vmware.vmware_tag_manager.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

С помощью этого модуля можно назначать теги VMware указанным объектам VMware и удалять их.
Функция тегов появилась в vSphere 6, поэтому этот модуль не поддерживается в более ранних версиях vSphere.

Требования

На хосте, выполняющем этот модуль, должны быть соблюдены следующие требования.

vSphere Automation SDK

Параметры

Параметр	Комментарии
hostname строка	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
moid строка	Идентификатор управляемого объекта для указанного объекта. Обязателен, если не задано `object_name`.
object_name строка	Имя объекта, с которым нужно работать. Для DistributedVirtualPortgroups формат должен быть таким: «имя_коммутатора:имя_группы_портов». Обязательно, если не задано `moid`.
object_type строка / обязательно	Тип объекта, с которым нужно работать. Варианты: `"VirtualMachine"` `"Datacenter"` `"ClusterComputeResource"` `"HostSystem"` `"DistributedVirtualSwitch"` `"DistributedVirtualPortgroup"` `"Datastore"` `"DatastoreCluster"` `"ResourcePool"` `"Folder"`
password псевдонимы: pass, pwd строка	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
port целое число	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host строка	Адрес прокси-сервера, который будет принимать и перенаправлять все HTTPS-запросы. Значение должно быть именем хоста или IP-адресом. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port целое число	Порт HTTP-прокси, который будет принимать и перенаправлять все HTTPS-запросы. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_PORT`.
proxy_protocol псевдоним: protocol строка	Используемый протокол подключения к прокси-серверу. Этот параметр используется, если подходящий протокол прокси-сервера невозможно определить автоматически. Варианты: `"http"` `"https"` ← (по умолчанию)
state строка	Если задано значение `add` или `present`, теги будут добавлены к существующему списку тегов указанного объекта. Если задано значение `remove` или `absent`, теги будут удалены из существующего списка тегов указанного объекта. Если задано значение `set`, теги указанного объекта будут заменены списком тегов, заданным пользователем. Варианты: `"present"` `"absent"` `"add"` ← (по умолчанию) `"remove"` `"set"`
tag_names список / элементы=any / обязательно	Список тегов, которыми нужно управлять. Пользователь также может указать имя категории, разделив значения двоеточием. Например: «имя_категории:имя_тега». Пользователь также может указать тег и категорию в виде словаря, если тег или категория содержит двоеточие. Дополнительные сведения см. в примере. Имя категории можно не указывать, если имена тегов уникальны.
username псевдонимы: admin, user строка	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
validate_certs логическое значение	Разрешает подключение, если SSL-сертификаты недействительны. Если сертификаты не являются доверенными, задайте значение `false`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Для всех модулей необходим доступ на запись через API, поэтому они не поддерживаются при использовании бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python «requests», которая по умолчанию не применяет системное хранилище сертификатов. Указать хранилище сертификатов можно с помощью переменной окружения REQUESTS_CA_BUNDLE. Обратите внимание: в некоторых случаях, если эта переменная задана, значение «false» параметра «validate_certs» может игнорироваться. Пример: «export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem»

Примеры

- name: Add tags to a virtual machine
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Tag_0002
      - Category_0001:Sample_Tag_0003
    object_name: Fedora_VM
    object_type: VirtualMachine
    state: add
  delegate_to: localhost

- name: Specify tag and category as dict
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - tag: tag_0001
        category: cat_0001
      - tag: tag_0002
        category: cat_0002
    object_name: Fedora_VM
    object_type: VirtualMachine
    state: add
  delegate_to: localhost

- name: Remove a tag from a virtual machine
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Tag_0002
    object_name: Fedora_VM
    object_type: VirtualMachine
    state: remove
  delegate_to: localhost

- name: Add tags to a distributed virtual switch
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Tag_0003
    object_name: Switch_0001
    object_type: DistributedVirtualSwitch
    state: add
  delegate_to: localhost

- name: Add tags to a distributed virtual portgroup
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Tag_0004
    object_name: Switch_0001:Portgroup_0001
    object_type: DistributedVirtualPortgroup
    state: add
  delegate_to: localhost


- name: Get information about folders
  community.vmware.vmware_folder_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: 'Asia-Datacenter1'
  delegate_to: localhost
  register: r
- name: Set Managed object ID for the given folder
  ansible.builtin.set_fact:
    folder_mo_id: "{{ (r.flat_folder_info | selectattr('path', 'equalto', '/Asia-Datacenter1/vm/tier1/tier2') | map(attribute='moid'))[0] }}"
- name: Add tags to a Folder using managed object id
  community.vmware.vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    tag_names:
      - Sample_Cat_0004:Sample_Tag_0004
    object_type: Folder
    moid: "{{ folder_mo_id }}"
    state: add
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
tag_status список / элементы=строка	метаданные о тегах, связанных с конфигурацией объекта Возвращается: при успешном выполнении Пример: `{"attached_tags": ["urn:vmomi:InventoryServiceCategory:76f69e84-f6b9-4e64-954c-fac545d2c0ba:GLOBAL:security"], "current_tags": ["urn:vmomi:InventoryServiceCategory:927f5ff8-62e6-4364-bc94-23e3bfd7dee7:GLOBAL:backup", "urn:vmomi:InventoryServiceCategory:76f69e84-f6b9-4e64-954c-fac545d2c0ba:GLOBAL:security"], "detached_tags": [], "previous_tags": ["urn:vmomi:InventoryServiceCategory:927f5ff8-62e6-4364-bc94-23e3bfd7dee7:GLOBAL:backup"]}`

Ключ

Описание

tag_status

список / элементы=строка

метаданные о тегах, связанных с конфигурацией объекта

Возвращается: при успешном выполнении

Пример: {"attached_tags": ["urn:vmomi:InventoryServiceCategory:76f69e84-f6b9-4e64-954c-fac545d2c0ba:GLOBAL:security"], "current_tags": ["urn:vmomi:InventoryServiceCategory:927f5ff8-62e6-4364-bc94-23e3bfd7dee7:GLOBAL:backup", "urn:vmomi:InventoryServiceCategory:76f69e84-f6b9-4e64-954c-fac545d2c0ba:GLOBAL:security"], "detached_tags": [], "previous_tags": ["urn:vmomi:InventoryServiceCategory:927f5ff8-62e6-4364-bc94-23e3bfd7dee7:GLOBAL:backup"]}

Авторы

Abhijeet Kasurde (@Akasurde)
Frederic Van Reet (@GBrawl)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_tag_manager_module.html