community.vmware.vmware_tag – Управление тегами VMware

Примечание

Этот плагин входит в состав коллекции community.vmware (версия 1.7.0).

Для его установки используйте: ansible-galaxy collection install community.vmware.

Для использования в плейбуке укажите: community.vmware.vmware_tag.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

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

python >= 2.6
PyVmomi
vSphere Automation SDK

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
category_id строка		Уникальный идентификатор, сгенерированный vCenter, должен быть использован. Пользователь может получить этот уникальный идентификатор из модуля фактов.
hostname строка		Имя хоста или IP-адрес сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_HOST`.
password строка		Пароль сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PASSWORD`. псевдонимы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_PORT`.
protocol строка	Варианты: http https ←	Протокол подключения.
state строка	Варианты: present ← absent	Состояние тега. Если установлено значение `present`, а тега не существует, то тег создается. Если установлено значение `present`, а тег существует, то тег обновляется. Если установлено значение `absent`, а тег существует, то тег удаляется. Если установлено значение `absent`, а тега не существует, никаких действий не выполняется.
tag_description строка	Значение по умолчанию: ""	Описание тега. Это требуется только если `state` установлено в `present`. Этот параметр игнорируется, когда `state` установлено в `absent`. Процесс обновления тега позволяет изменить только описание.
tag_name строка / обязательно		Имя тега для управления.
username строка		Имя пользователя сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной среды `VMWARE_USER`. псевдонимы: admin, user
validate_certs логическое	Варианты: no yes ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите в значение `False`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной среды `VMWARE_VALIDATE_CERTS`.

Примечания

Примечание

Тестировалось на vSphere 6.5

Примеры

- 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 словарь	при успехе	Словарь метаданных тега Пример: {'msg': "Тег 'Sample_Tag_0002' создан.", 'tag_id': 'urn:vmomi:InventoryServiceTag:bff91819-f529-43c9-80ca-1c9dfda09441:GLOBAL'}

Авторы

Abhijeet Kasurde (@Akasurde)

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