ovirt_affinity_label – Модуль для управления метками родства в 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 - | Имя кластера, в котором находятся виртуальные машины и хосты. | ||
| fetch_nested логическое значение |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков виртуальных машин, снимков и т.д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| hosts - | Список имен хостов, которым должна быть назначена эта метка родства. | ||
| name - / обязательно | Имя метки родства, которую необходимо обработать. | ||
| nested_attributes список | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применим только если fetch_nested имеет значение true. | ||
| poll_interval целое число | Значение по умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос опроса о статусе сущности. | |
| state - |
| Должна ли метка родства присутствовать или отсутствовать. | |
| timeout целое число | Значение по умолчанию: 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. | |
| vms - | Список имен виртуальных машин, которым должна быть назначена эта метка родства. | ||
| 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(if not exists) and assign affinity label to vms vm1 and vm2 and host host1
- ovirt_affinity_label:
name: mylabel
cluster: mycluster
vms:
- vm1
- vm2
hosts:
- host1
# To detach all VMs from label
- ovirt_affinity_label:
name: mylabel
cluster: mycluster
vms: []
# Remove affinity label
- ovirt_affinity_label:
state: absent
name: mylabel
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| affinity_label словарь | При успехе, если метка родства найдена. | Словарь всех атрибутов метки родства. Атрибуты метки родства можно найти на вашем экземпляре oVirt/RHV по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/affinity_label. |
| id строка | При успехе, если метка родства найдена. | ID метки родства, которая обрабатывается Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_affinity_label_module.html
