ovirt_vmpool – Модуль для управления пулами ВМ в oVirt/RHV
Новая версия с 2.3.
Краткое описание
- Модуль для управления пулами ВМ в oVirt/RHV.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth словарь / обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: | ||
| ca_file строка | Файл PEM, содержащий доверенные сертификаты CA. Сертификат, представленный сервером, будет проверен с помощью этих сертификатов CA. Если параметр ca_file не задан, используется системный хранилище сертификатов CA.Значение по умолчанию устанавливается переменной среды OVIRT_CAFILE. | ||
| headers словарь | Словарь HTTP-заголовков, которые необходимо добавить к каждому API-запросу. | ||
| hostname строка | Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию устанавливается переменной среды OVIRT_HOSTNAME. Требуется либо url, либо hostname. | ||
| insecure булево |
| Флаг булевого типа, указывающий, следует ли проверять сертификат TLS сервера и имя хоста. | |
| kerberos булево |
| Флаг булевого типа, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации. | |
| password строка / обязательно | Пароль пользователя. Значение по умолчанию устанавливается переменной среды OVIRT_PASSWORD. | ||
| token строка | Токен, который используется вместо входа с именем пользователя/паролем. Значение по умолчанию устанавливается переменной среды OVIRT_TOKEN. | ||
| url строка | Строка, содержащая URL-адрес API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной среды OVIRT_URL. Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например admin@internal. Значение по умолчанию устанавливается переменной среды OVIRT_USERNAME. | ||
| cluster - | Имя кластера, в котором должен быть создан пул ВМ. | ||
| comment - | Комментарий к пулу виртуальных машин. | ||
| description - | Описание пула ВМ. | ||
| fetch_nested булево добавлен в 2.3 |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т.д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| id - добавлен в 2.8 | Идентификатор пула ВМ для управления. | ||
| 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 булево |
| yes — если модуль должен ждать, пока сущность не перейдет в нужное состояние. | |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.3.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_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
# Change Pool Name
- ovirt_vmpool:
id: 00000000-0000-0000-0000-000000000000
name: "new_pool_name"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | При успехе, если пул ВМ найден. | Идентификатор управляемого пула ВМ. Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| vm_pool словарь | При успехе, если пул ВМ найден. | Словарь всех атрибутов пула ВМ. Атрибуты пула ВМ можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm_pool. |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/ovirt_vmpool_module.html
