vmware_tag – Управление тегами VMware
Новое в версии 2.6.
Описание
- Этот модуль можно использовать для создания, удаления и обновления тегов 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 | |
| protocol строка |
| Протокол подключения. |
| state строка |
| Состояние тега. Если установлено значение present, а тег не существует, то тег создается.Если установлено значение present, а тег существует, то тег обновляется.Если установлено значение absent, а тег существует, то тег удаляется.Если установлено значение absent, а тег не существует, никаких действий не предпринимается. |
| tag_description строка | По умолчанию: "" | Описание тега. Требуется только если state установлено в значение present. Этот параметр игнорируется, когда state установлено в значение absent. Процесс обновления тега допускает только изменение описания. |
| tag_name строка / обязательно | Имя тега для управления. | |
| username строка | Имя пользователя сервера vCenter vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_USER. псевдонимы: admin, user | |
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL не валидны. Устанавливается в значение no, когда сертификаты не доверяются.Если значение не указано в задаче, используется значение переменной среды VMWARE_VALIDATE_CERTS. |
Примечания
Примечание
- Проверено на vSphere 6.5
Примеры
- name: Create a tag
vmware_tag:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
validate_certs: no
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
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
vmware_tag:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
tag_name: Sample_Tag_0002
state: absent
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| results словарь | при успехе | словарь метаданных тега Пример: {'msg': "Тег 'Sample_Tag_0002' создан.", 'tag_id': 'urn:vmomi:InventoryServiceTag:bff91819-f529-43c9-80ca-1c9dfda09441:GLOBAL'} |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/vmware_tag_module.html