ovirt_vmpools - Модуль для управления пулами ВМ в oVirt/RHV
Новый в версии 2.3.
Обзор
- Модуль для управления пулами ВМ в oVirt/RHV.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например, admin@internal. Значение по умолчанию задаётся переменной среды OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию задаётся переменной среды OVIRT_PASSWORD.url - Строка, содержащая URL API сервера, обычно в формате `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задаётся переменной среды OVIRT_URL. Требуется либо url, либо hostname. hostname - Строка, содержащая имя хоста сервера, обычно в формате `server.example.com`. Значение по умолчанию задаётся переменной среды OVIRT_HOSTNAME. Требуется либо url, либо hostname.token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задаётся переменной среды OVIRT_TOKEN.insecure - Логический флаг, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.ca_file - PEM-файл, содержащий доверенные сертификаты CA. Сертификат, представленный сервером, будет проверен с использованием этих сертификатов CA. Если параметр `ca_file` не задан, используется системное хранилище сертификатов CA. Значение по умолчанию задаётся переменной среды OVIRT_CAFILE.kerberos - Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые следует добавить к каждому вызову API. | |
| cluster | Имя кластера, в котором должен быть создан пул ВМ. | |
| description | Описание пула ВМ. | |
| fetch_nested (добавлен в 2.3) | Если True, модуль извлечет дополнительные данные из API. Он извлечёт идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | |
| name обязательно | Имя пула ВМ для управления. | |
| nested_attributes (добавлен в 2.3) | Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применим только, когда fetch_nested равен true. | |
| poll_interval | По умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправить запрос на проверку состояния сущности. |
| prestarted | Количество предварительно запущенных ВМ определяет количество ВМ в состоянии выполнения, которые ожидают подключения к пользователям. Значение по умолчанию задается движком. | |
| state |
| Должен ли пул ВМ быть присутствующим/отсутствующим. Обратите внимание, что при state = absent все ВМ в пуле останавливаются и удаляются. |
| template | Имя шаблона, который будет использован для создания пула ВМ. | |
| timeout | По умолчанию: 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. |
| type |
| Тип пула ВМ. Либо manual, либо automatic. manual - Администратор несет ответственность за явное возвращение виртуальной машины в пул. Виртуальная машина возвращается к исходному базовому образу после того, как администратор вернёт её в пул.Automatic - При выключении виртуальной машины она автоматически возвращается к своему базовому образу и возвращается в пул виртуальных машин.Значение по умолчанию задаётся движком. |
| vm_count | Количество ВМ в пуле. Значение по умолчанию задаётся движком. | |
| vm_per_user | Максимальное количество ВМ, которое может подключить к этому пулу один пользователь. Значение по умолчанию задаётся движком. | |
| wait |
True, если модуль должен ждать, пока сущность не перейдет в нужное состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create VM pool from template
- ovirt_vmpools:
cluster: mycluster
name: myvmpool
template: rhel7
vm_count: 2
prestarted: 2
vm_per_user: 1
# Remove vmpool, note that all VMs in pool will be stopped and removed:
- ovirt_vmpools:
state: absent
name: myvmpool
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id str | При успехе, если пул ВМ найден. | Идентификатор пула ВМ, который управляется. Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| vm_pool dict | При успехе, если пул ВМ найден. | Словарь всех атрибутов пула ВМ. Атрибуты пула ВМ можно найти на вашем экземпляре oVirt/RHV по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm_pool. |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Более подробная информация содержится в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Ondra Machacek (@machacekondra)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/ovirt_vmpools_module.html
