ovirt_host_pm - Модуль управления питанием хостов в oVirt/RHV
Новая версия 2.3.
- Описание
- Требования (к хосту, выполняющему модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Модуль управления питанием хостов в oVirt/RHV.
Требования (к хосту, выполняющему модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| 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 | нет | Словарь дополнительных параметров агента fence. Дополнительную информацию о параметрах можно найти по адресу https://fedorahosted.org/cluster/wiki/FenceArguments. | ||
| order | нет | Целочисленное значение, по умолчанию добавляется в конец. | ||
| password | нет | Пароль пользователя, указанного в параметре username. | ||
| poll_interval | нет | 3 | Количество секунд, которое модуль ожидает до отправки следующего запроса на проверку статуса сущности. | |
| port | нет | Порт интерфейса управления питанием. | ||
| slot | нет | Разъем управления питанием. | ||
| state | нет | present |
| Хост должен быть 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, если модуль должен ждать, пока сущность не перейдет в нужное состояние. |
Примеры
# 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. | При успехе, если агент найден. | dict | |
| id | ID агента, которым управляет модуль. | При успехе, если агент найден. | str | 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Для обеспечения установки с правильной версией можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если у вас возникнет желание, ознакомьтесь с Информацией о сообществе и участии в разработке, Тестированием Ansible и Разработкой модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_host_pm_module.html