ovirt_host_pm - Модуль для управления питанием хостов в oVirt/RHV
Новый в версии 2.3.
Обзор
- Модуль для управления питанием хостов в oVirt/RHV.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| address | Адрес интерфейса управления питанием. | |
| 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-запросу. | |
| encrypt_options | Если (true), параметры будут зашифрованы при отправке агенту. псевдонимы: encrypt | |
| fetch_nested (добавлен в 2.3) | Если True, модуль будет извлекать дополнительные данные из API. Он будет извлекать идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | |
| name обязательно | Имя хоста, который нужно управлять. псевдонимы: host | |
| nested_attributes (добавлен в 2.3) | Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только при значении fetch_nested равном true. | |
| options | Словарь дополнительных параметров агента барьера. Дополнительную информацию о параметрах можно найти по адресу https://fedorahosted.org/cluster/wiki/FenceArguments. | |
| order (добавлен в 2.5) | Целочисленное значение, по умолчанию добавляется в конец. | |
| password | Пароль пользователя, указанный в параметре username. | |
| poll_interval | По умолчанию: 3 | Число секунд, в течение которых модуль ожидает, прежде чем отправлять другой запрос об опросе статуса сущности. |
| port | Порт интерфейса управления питанием. | |
| slot | Разъем управления питанием. | |
| state |
| Хост должен быть present/absent. |
| timeout | По умолчанию: 180 | Количество секунд, в течение которого модуль должен ожидать, пока экземпляр не перейдет в желаемое состояние. |
| type | Тип управления питанием. Предварительно определенные значения oVirt/RHV: drac5, ipmilan, rsa, bladecenter, alom, apc, apc_snmp, eps, wti, rsb, cisco_ucs, drac7, hpblade, ilo, ilo2, ilo3, ilo4, ilo_ssh, но пользователь может определить собственный тип. | |
| username | Имя пользователя для подключения к интерфейсу управления питанием. | |
| wait |
True, если модуль должен ожидать, пока сущность не перейдет в желаемое состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Add fence agent to host 'myhost'
- ovirt_host_pm:
name: myhost
address: 1.2.3.4
options:
myoption1: x
myoption2: y
username: admin
password: admin
port: 3333
type: ipmilan
# Remove ipmilan fence agent with address 1.2.3.4 on host 'myhost'
- ovirt_host_pm:
state: absent
name: myhost
address: 1.2.3.4
type: ipmilan
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| agent словарь | При успехе, если агент найден. | Словарь всех атрибутов агента. Атрибуты агента можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/agent. |
| id строка | При успехе, если агент найден. | Идентификатор агента, который управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/ovirt_host_pm_module.html
