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-адрес сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной среды OVIRT_URL.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 |
| Пул ВМ должен быть present/absent. Обратите внимание, что когда 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.0.0
Примеры
# 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. |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- 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.5/modules/ovirt_vmpools_module.html
