ovirt_affinity_label — Модуль для управления метками сходства в oVirt/RHV
Новая версия 2.3.
Обзор
- Этот модуль управляет метками сходства в oVirt/RHV. Он также может управлять назначением этих меток хостам и виртуальным машинам.
Псевдонимы: ovirt_affinity_labels
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- 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 | Имя кластера, в котором находятся виртуальные машины и хосты. | |
| fetch_nested (добавлено в 2.3) | Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков виртуальных машин, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| hosts | Список имен хостов, которым должна быть назначена эта метка сходства. | |
| name обязательно | Имя метки сходства для управления. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые необходимо получить из API. Этот параметр применяется только когда fetch_nested равен true. | |
| poll_interval | По умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос опроса состояния сущности. |
| state |
| Метка сходства должна быть present или absent. |
| timeout | По умолчанию: 180 | Количество секунд, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. |
| vms | Список имен виртуальных машин, которым должна быть назначена эта метка сходства. | |
| wait |
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(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 dict | При успехе, если метка сходства найдена. | Словарь всех атрибутов метки сходства. Атрибуты метки сходства можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/affinity_label. |
| id str | При успехе, если метка сходства найдена. | Идентификатор метки сходства, которая управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробности см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- 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.6/modules/ovirt_affinity_label_module.html
