vmware_tag_manager – Управление ассоциацией тегов VMware с объектами VMware

Новая версия 2.8.

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

Обзор

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

Требования

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

python >= 2.6
PyVmomi
vSphere Automation SDK

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
hostname строка		Имя хоста или IP-адрес сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`.
object_name строка / обязательно		Имя объекта для работы. Для DistributedVirtualPortgroups формат должен быть "имя_коммутатора:имя_портгруппы".
object_type строка / обязательно	Варианты: VirtualMachine Datacenter ClusterComputeResource HostSystem DistributedVirtualSwitch DistributedVirtualPortgroup	Тип объекта для работы.
password строка		Пароль сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`. псевдонимы: pass, pwd
protocol строка	Варианты: http https ←	Протокол подключения.
state строка	Варианты: present absent add ← remove set	Если `state` установлено в `add` или `present`, будут добавлены теги в существующий список тегов заданного объекта. Если `state` установлено в `remove` или `absent`, будут удалены теги из существующего списка тегов заданного объекта. Если `state` установлено в `set`, будут заменены теги заданных объектов на список тегов, определённых пользователем.
tag_names список / обязательно		Список тегов для управления. Можно также указать имя категории, указав значение через двоеточие. Например, "имя_категории:имя_тега". Можно пропустить имя категории, если у вас есть уникальные имена тегов.
username строка		Имя пользователя сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_USER`. псевдонимы: admin, user
validate_certs логическое	Варианты: no yes ←	Разрешает подключение, когда сертификаты SSL не являются валидными. Установите `no`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_VALIDATE_CERTS`.

Примечания

Примечание

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

Примеры

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

- name: Remove a tag from a virtual machine
  vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    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
  vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    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
  vmware_tag_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    tag_names:
      - Sample_Tag_0004
    object_name: Switch_0001:Portgroup_0001
    object_type: DistributedVirtualPortgroup
    state: add
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
tag_status список	при успехе	метаданные о тегах, связанных с настройкой объекта Пример: {'current_tags': ['backup', 'security'], 'desired_tags': ['security'], 'previous_tags': ['backup', 'security']}

Состояние

Данный модуль не гарантирует обратную совместимость. [превью]
Данный модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vmware_tag_manager_module.html