ovirt_host_pm – Модуль для управления управлением питанием хостов в oVirt/RHV
Обзор
- Модуль для управления управлением питанием хостов в oVirt/RHV.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address - | Адрес интерфейса управления питанием. | ||
| 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 строка | Строка, содержащая API-URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной среды OVIRT_URL. Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например admin@internal. Значение по умолчанию задается переменной среды OVIRT_USERNAME. | ||
| encrypt_options логическое значение |
| Если true, параметры будут зашифрованы при отправке агенту. псевдонимы: encrypt | |
| fetch_nested логическое значение |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| name - / обязательно | Имя хоста для управления. псевдонимы: host | ||
| nested_attributes список | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применим только тогда, когда fetch_nested равно true. | ||
| options - | Словарь дополнительных параметров агента fence (включая слот управления питанием). Дополнительную информацию об опциях можно найти по адресу https://github.com/ClusterLabs/fence-agents/blob/master/doc/FenceAgentAPI.md. | ||
| order - добавлено в 2.5 | Целочисленное значение, по умолчанию добавляется в конец. | ||
| password - | Пароль пользователя, указанный в параметре username. | ||
| poll_interval целое число | По умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос на проверку состояния сущности. | |
| port - | Порт интерфейса управления питанием. | ||
| state - |
| Следует ли присутствовать/отсутствовать хосту. | |
| 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 логическое значение |
| 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:
# 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
# Add fence agent to host 'myhost' using 'slot' option
- ovirt_host_pm:
name: myhost
address: 1.2.3.4
options:
myoption1: x
myoption2: y
slot: myslot
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 |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом 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_host_pm_module.html
