vmware_tag — Управление тегами VMware
Новое в версии 2.6.
Обзор
- Этот модуль можно использовать для создания, удаления и обновления тегов VMware.
- Функция тегов была представлена в vSphere версии 6, поэтому этот модуль не поддерживается в более ранних версиях vSphere.
- Все переменные и имена объектов VMware чувствительны к регистру.
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.6
- PyVmomi
- vSphere Automation SDK
- vCloud Suite SDK
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| category_id | Следует использовать уникальный идентификатор, сгенерированный vCenter. Пользователь может получить этот уникальный идентификатор из модуля фактов. | |
| hostname | Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST. | |
| password | Пароль сервера vSphere vCenter. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD.псевдонимы: pass, pwd | |
| protocol |
| Протокол подключения. |
| state |
| Состояние тега. Если установлено значение present, а тег не существует, то тег создается.Если установлено значение present, а тег существует, то тег обновляется.Если установлено значение absent, а тег существует, то тег удаляется.Если установлено значение absent, а тег не существует, никаких действий не выполняется. |
| tag_description | Значение по умолчанию: "" | Описание тега. Требуется только если state установлено в present. Этот параметр игнорируется, если state установлено в absent. Процесс обновления тега позволяет изменить только описание. |
| tag_name обязательно | Имя тега для управления. | |
| username | Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER.псевдонимы: user, admin | |
| validate_certs bool |
| Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в false, когда сертификаты не доверяются.Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS. |
Примечания
Примечание
- Тестировалось на vSphere 6.5
Примеры
- name: Create a tag
vmware_tag:
hostname: 10.65.223.91
username: administrator@vsphere.local
password: Esxi@123$
validate_certs: False
category_id: 'urn:vmomi:InventoryServiceCategory:e785088d-6981-4b1c-9fb8-1100c3e1f742:GLOBAL'
tag_name: Sample_Tag_0002
tag_description: Sample Description
state: present
- name: Update tag description
vmware_tag:
hostname: 10.65.223.91
username: administrator@vsphere.local
password: Esxi@123$
validate_certs: False
tag_name: Sample_Tag_0002
tag_description: Some fancy description
state: present
- name: Delete tag
vmware_tag:
hostname: 10.65.223.91
username: administrator@vsphere.local
password: Esxi@123$
validate_certs: False
tag_name: Sample_Tag_0002
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| results dict | при успехе | Словарь метаданных тега Пример: {'msg': "Тег 'Sample_Tag_0002' создан.", 'tag_id': 'urn:vmomi:InventoryServiceTag:bff91819-f529-43c9-80ca-1c9dfda09441:GLOBAL'} |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет обратно совместимым.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Abhijeet Kasurde (@Akasurde)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vmware_tag_module.html
