ovirt_vmpools - Модуль для управления пулами ВМ в oVirt/RHV
Новая версия 2.3.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Модуль для управления пулами ВМ в oVirt/RHV.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| 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 |
| Должен ли пул ВМ присутствовать/отсутствовать. Обратите внимание, что когда state равен absent, все ВМ в пуле останавливаются и удаляются. |
| template | нет | Имя шаблона, которое будет использоваться для создания пула ВМ. | ||
| timeout | нет | 180 | Количество секунд, которое модуль должен ожидать, чтобы экземпляр перешёл в нужное состояние. | |
| type | нет |
| Тип пула ВМ. Либо manual, либо automatic. manual - Администратор отвечает за явное возвращение виртуальной машины в пул. После возвращения виртуальной машины администратором, виртуальная машина возвращается к исходному базовому образу.Automatic - При выключении виртуальной машины она автоматически возвращается к своему базовому образу и возвращается в пул виртуальных машин.Значение по умолчанию задаётся движком. | |
| vm_count | нет | Количество ВМ в пуле. Значение по умолчанию задаётся движком. | ||
| vm_per_user | нет | Максимальное количество ВМ, которое один пользователь может подключить из этого пула. Значение по умолчанию задаётся движком. | ||
| wait | нет |
True, если модуль должен ожидать, пока сущность перейдёт в нужное состояние. |
Примеры
# 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 | ID пула ВМ, который управляется | При успехе, если пул ВМ найден. | str | 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| vm_pool | Словарь всех атрибутов пула ВМ. Атрибуты пула ВМ можно найти на вашей инстанции oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm_pool. | При успехе, если пул ВМ найден. | dict |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы захотите, пожалуйста, ознакомьтесь с Информацией о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_vmpools_module.html