Модуль community.vmware.vmware_tag – управление тегами VMware

Примечание

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

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

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

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

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

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

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

Требования

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

vSphere Automation SDK

Параметры

Параметр	Комментарии
category_id string	Следует использовать уникальный идентификатор, созданный vCenter. Пользователь может получить этот уникальный идентификатор с помощью модуля facts. Обязателен, если не задан `category_name`.
category_name псевдонимы: category string добавлено в community.vmware 3.5.0	Название категории. Обязательно, если не задан `category_id`.
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет принимать все HTTPS-запросы и перенаправлять их. Укажите имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет принимать все HTTPS-запросы и перенаправлять их. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_PORT`.
proxy_protocol псевдонимы: protocol string	Протокол соединения с прокси-сервером. Этот параметр используется, если правильный протокол прокси-сервера не удается определить автоматически. Варианты: `"http"` `"https"` ← (по умолчанию)
state string	Состояние тега. Если задано значение `present` и тег не существует, тег создается. Если задано значение `present` и тег существует, тег обновляется. Если задано значение `absent` и тег существует, тег удаляется. Если задано значение `absent` и тег не существует, никаких действий не выполняется. Варианты: `"present"` ← (по умолчанию) `"absent"`
tag_description псевдонимы: description string	Описание тега. Этот параметр обязателен только при `state=present`. Этот параметр игнорируется, когда `state=absent`. При обновлении тега можно изменить только описание. По умолчанию: `""`
tag_name псевдонимы: tag, name string / обязательный	Имя тега, которым нужно управлять.
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение при недействительных SSL-сертификатах. Если сертификаты не являются доверенными, задайте значение `false`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- 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

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

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

Ключ	Описание
tag_status dictionary	словарь с метаданными тега Возвращается: при успешном выполнении Пример: `{"msg": "Tag 'Sample_Tag_0002' created.", "tag_id": "urn:vmomi:InventoryServiceTag:bff91819-f529-43c9-80ca-1c9dfda09441:GLOBAL"}`

Авторы

Abhijeet Kasurde (@Akasurde)

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

© 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_module.html