ovirt_vmpool – Модуль для управления пулами ВМ в oVirt/RHV
Новый в версии 2.3.
Обзор
- Модуль для управления пулами ВМ в oVirt/RHV.
Псевдонимы: ovirt_vmpools
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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 - | Имя кластера, в котором должен быть создан пул ВМ. | |
| comment - | Комментарий к пулу виртуальных машин. | |
| description - | Описание пула ВМ. | |
| fetch_nested boolean добавлен в 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 boolean |
|
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_vmpool:
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_vmpool:
state: absent
name: myvmpool
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | При успехе, если пул ВМ найден. | Идентификатор управляемого пула ВМ Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| vm_pool словарь | При успехе, если пул ВМ найден. | Словарь со всеми атрибутами пула ВМ. Атрибуты пула ВМ можно найти на вашей инстанции oVirt/RHV по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm_pool. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/ovirt_vmpool_module.html
