ovirt_vmpool – Модуль для управления пулами ВМ в oVirt/RHV
Описание
- Модуль для управления пулами ВМ в 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 логическое значение |
| Если Истина, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes. | |
| id - добавлено в 2.8 | ID виртуального пула для управления. | ||
| name - / обязательно | Имя пула виртуальных машин для управления. | ||
| nested_attributes список | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равно истина. | ||
| poll_interval целое число | По умолчанию: 3 | Количество секунд, в течение которых модуль ожидает, прежде чем отправлять другой запрос на проверку состояния сущности. | |
| prestarted - | Количество предварительно запущенных ВМ определяет количество ВМ в состоянии работы, которые ожидают подключения к пользователям. Значение по умолчанию устанавливается движком. | ||
| state - |
| Пул ВМ должен быть present/absent. Обратите внимание, что когда state равен absent, все ВМ в пуле ВМ останавливаются и удаляются. | |
| template - | Имя шаблона, который будет использоваться для создания пула ВМ. | ||
| timeout целое число | По умолчанию: 180 | Количество секунд, которое модуль должен ждать, пока экземпляр не перейдет в желаемое состояние. | |
| type - |
| Тип пула ВМ. Либо ручной, либо автоматический. manual - Администратор отвечает за явное возвращение виртуальной машины в пул. Виртуальная машина возвращается к исходной базовой образи после того, как администратор вернул ее в пул.Automatic - Когда виртуальная машина выключается, она автоматически возвращается к своему базовому образу и возвращается в пул виртуальных машин.Значение по умолчанию устанавливается движком. | |
| vm словарь добавлено в 2.9 | Для создания пула ВМ без изменения шаблона. Примечание: Вы можете использовать vm только для создания пула ВМ. | ||
| cloud_init - | Словарь со значениями для инициализации виртуальной машины Unix-подобного типа с помощью cloud init. host_name - Имя хоста, которое нужно установить для виртуальной машины при развертывании.timezone - Временная зона, которую нужно установить для виртуальной машины при развертывании.user_name - Имя пользователя, которое нужно использовать для установки пароля виртуальной машине при развертывании.root_password - Пароль, который нужно установить для пользователя, указанного параметром user_name.authorized_ssh_keys - Использовать эти SSH-ключи для входа в виртуальную машину.regenerate_ssh_keys - Если Истина, SSH-ключи будут перегенерированы на виртуальной машине.custom_script - Скрипт cloud-init, который будет выполнен на виртуальной машине при развертывании. Он добавляется в конец скрипта cloud-init, созданного любыми другими параметрами.dns_servers - DNS-серверы, которые нужно настроить на виртуальной машине.dns_search - Домены поиска DNS, которые нужно настроить на виртуальной машине.nic_boot_protocol - Установите протокол загрузки сетевого интерфейса виртуальной машины. Может быть одним из none, dhcp или static. nic_ip_address - Если протокол загрузки статический, установите этот IP-адрес для сетевого интерфейса виртуальной машины.nic_netmask - Если протокол загрузки статический, установите эту маску подсети для сетевого интерфейса виртуальной машины.nic_gateway - Если протокол загрузки статический, установите этот шлюз для сетевого интерфейса виртуальной машины.nic_name - Установите имя сетевого интерфейса виртуальной машины.nic_on_boot - Если Истина, сетевой интерфейс будет установлен для запуска при загрузке. | ||
| comment - | Комментарий к виртуальной машине. | ||
| memory - | Объем памяти виртуальной машины. Используется стандарт IEC 60027-2 (например, 1GiB, 1024MiB). Значение по умолчанию устанавливается движком. | ||
| memory_guaranteed - | Минимальный гарантированный объем памяти виртуальной машины. Используется стандарт IEC 60027-2 (например, 1GiB, 1024MiB).
Параметр memory_guaranteed не может быть меньше параметра memory. Значение по умолчанию устанавливается движком. | ||
| memory_max - | Верхняя граница памяти виртуальной машины, до которой может выполняться горячая подкачка памяти. Префикс использует стандарт IEC 60027-2 (например, 1GiB, 1024MiB). Значение по умолчанию устанавливается движком. | ||
| nics - | Список сетевых адаптеров (NIC), которые должны быть подключены к виртуальной машине. NIC описывается следующим словарем. name - Название сетевого адаптера.profile_name - Имя профиля, к которому должен быть подключен сетевой адаптер.interface - Тип сетевого интерфейса. Один из следующих: virtio, e1000, rtl8139, по умолчанию virtio.mac_address - Пользовательский MAC-адрес сетевого интерфейса, по умолчанию он берется из пула MAC-адресов.ПРИМЕЧАНИЕ - Этот параметр используется только тогда, когда state имеет значение running или present и может только создавать сетевые адаптеры.Для более глубокой настройки сетевых адаптеров ВМ используйте модуль ovirt_nics вместо этого. | ||
| smartcard_enabled boolean |
| Если true, использовать аутентификацию с помощью смарт-карты. | |
| sso boolean |
|
True включить Single Sign On с помощью Guest Agent, False - отключить. По умолчанию выбирается движком oVirt/RHV. | |
| timezone - | Устанавливает смещение часового пояса для системных часов гостевой ОС. Например Etc/GMT
| ||
| vm_count - | Количество ВМ в пуле. Значение по умолчанию устанавливается движком. | ||
| vm_per_user - | Максимальное количество ВМ, которые один пользователь может подключить к данному пулу. Значение по умолчанию устанавливается движком. | ||
| wait boolean |
| 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:
- name: Create VM pool from template
ovirt_vmpool:
cluster: mycluster
name: myvmpool
template: rhel7
vm_count: 2
prestarted: 2
vm_per_user: 1
- name: Remove vmpool, note that all VMs in pool will be stopped and removed
ovirt_vmpool:
state: absent
name: myvmpool
- name: Change Pool Name
ovirt_vmpool:
id: 00000000-0000-0000-0000-000000000000
name: "new_pool_name"
- name: Create vm pool and override the pool values
ovirt_vmpool:
cluster: mycluster
name: vmpool
template: blank
vm_count: 2
prestarted: 1
vm_per_user: 1
vm:
memory: 4GiB
memory_guaranteed: 4GiB
memory_max: 10GiB
comment: vncomment
cloud_init:
nic_boot_protocol: static
nic_ip_address: 10.34.60.86
nic_netmask: 255.255.252.0
nic_gateway: 10.34.63.254
nic_name: eth1
nic_on_boot: true
host_name: example.com
custom_script: |
write_files:
- content: |
Hello, world!
path: /tmp/greeting.txt
permissions: '0644'
user_name: root
root_password: super_password
nics:
- name: nicname
interface: virtio
profile_name: network
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id string | При успешном поиске пула ВМ. | Идентификатор пула ВМ, который управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| vm_pool dictionary | При успешном поиске пула ВМ. | Словарь всех атрибутов пула ВМ. Атрибуты пула ВМ можно найти на вашем экземпляре 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.9/modules/ovirt_vmpool_module.html
