vmware_guest_custom_attribute_defs – Управление определениями пользовательских атрибутов для виртуальной машины из VMWare
Новое в версии 2.7.
Обзор
- Этот модуль можно использовать для добавления и удаления определений пользовательских атрибутов для заданной виртуальной машины из VMWare.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| attribute_key - | Имя определения пользовательского атрибута. Этот параметр обязателен, если state задан как present или absent. | |
| hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_HOST. Поддержка переменных окружения добавлена в версии 2.6. | |
| password строка | Пароль сервера vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_PASSWORD. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | По умолчанию: 443 | Номер порта сервера vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_PORT. Поддержка переменных окружения добавлена в версии 2.6. |
| state - / обязательно |
| Управление определением пользовательских атрибутов. Если установлено present, а определение отсутствует, то создаётся определение пользовательского атрибута.Если установлено present, а определение присутствует, то никаких действий не выполняется.Если установлено absent, а определение присутствует, то определение пользовательского атрибута удаляется.Если установлено absent, а определение отсутствует, то никаких действий не выполняется. |
| username строка | Имя пользователя сервера vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_USER. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: admin, user | |
| validate_certs логическое значение |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите значение false, когда сертификаты ненадёжные.Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_VALIDATE_CERTS. Поддержка переменных окружения добавлена в версии 2.6. Если установлено yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примечания
Примечание
- Проверено на vSphere 6.5
Примеры
- name: Add VMWare Attribute Definition
vmware_guest_custom_attribute_defs:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
state: present
attribute_key: custom_attr_def_1
delegate_to: localhost
register: defs
- name: Remove VMWare Attribute Definition
vmware_guest_custom_attribute_defs:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
state: absent
attribute_key: custom_attr_def_1
delegate_to: localhost
register: defs
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| custom_attribute_defs список | всегда | список всех текущих определений атрибутов Пример: ['sample_5', 'sample_4'] |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Джимми Коннер
- Абхиджит Касурде (@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.7/modules/vmware_guest_custom_attribute_defs_module.html