vmware_tag_manager – Управление ассоциацией тегов VMware с объектами VMware
Новая версия 2.8.
Обзор
- Этот модуль может использоваться для добавления/удаления тегов VMware из заданных объектов VMware.
- Функция тегов была введена в vSphere версии 6, поэтому этот модуль не поддерживается в более ранних версиях vSphere.
- Все переменные и имена объектов VMware чувствительны к регистру.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- PyVmomi
- vSphere Automation SDK
- vCloud Suite SDK
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| hostname строка | Имя хоста или IP-адрес сервера vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST. | |
| object_name - / обязательно | Имя объекта для работы. Для DistributedVirtualPortgroups формат должен быть "имя_коммутатора:имя_группы_портов" | |
| object_type - / обязательно |
| Тип объекта для работы. |
| password строка | Пароль сервера vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD.псевдонимы: pass, pwd | |
| protocol строка |
| Протокол подключения. |
| state - |
| Если state установлено в add или present, будут добавлены теги в существующий список тегов заданного объекта.Если state установлено в remove или absent, будут удалены теги из существующего списка тегов заданного объекта.Если state установлено в set, будут заменены теги заданных объектов на пользовательский список тегов. |
| tag_names - / обязательно | Список тегов, которые необходимо обработать. Вы также можете указать имя категории, указав значение, разделенное двоеточием. Например, "имя_категории:имя_тега". Вы можете пропустить имя категории, если у вас есть уникальные имена тегов. | |
| username строка | Имя пользователя сервера vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER. псевдонимы: admin, user | |
| validate_certs логический тип |
| Разрешает подключение, когда сертификаты 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.8/modules/vmware_tag_manager_module.html