ovirt_event_info – Этот модуль можно использовать для получения информации об одном или нескольких событиях oVirt/RHV
В версии 2.8.
Обзор
- Получение информации об одном или нескольких событиях oVirt/RHV.
- Этот модуль назывался
ovirt_event_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль ovirt_event_info больше не возвращаетansible_facts!
Псевдонимы: ovirt_event_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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-запросу. | |
| case_sensitive булево |
| Указывает, следует ли учитывать регистр при поиске, выполненном с использованием параметра поиска. Значение по умолчанию - true, что означает учет регистра. Если необходимо игнорировать регистр, установите значение в false. |
| fetch_nested булево |
| Если да, модуль получит дополнительные данные из API. Будут получены только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| from_ целое число | Указывает индекс события, после которого должны быть возвращены события. Индексы событий строго возрастают, поэтому при использовании этого параметра будут возвращены только события с большими индексами. | |
| headers строка | Дополнительные HTTP-заголовки. | |
| max целое число | Устанавливает максимальное количество возвращаемых событий. Если не указано, возвращаются все события. | |
| nested_attributes список | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применим только когда fetch_nested равен истинному. | |
| query строка | Дополнительные параметры запроса URL. | |
| search строка | Поисковый термин, принимаемый API oVirt/RHV. Например, чтобы найти события с серьезностью alert, используйте следующий шаблон: severity=alert | |
| wait булево |
| Если True, ожидать ответа. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.3.0
Примеры
# Examples don't contain the auth parameter for simplicity,
# look at the ovirt_auth module to see how to reuse authentication.
- name: Return all events
ovirt_event_info:
register: result
- name: Return the last 10 events
ovirt_event_info:
max: 10
register: result
- name: Return all events of type alert
ovirt_event_info:
search: "severity=alert"
register: result
- debug:
msg: "{{ result.ovirt_events }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_events список | При успехе. | Список словарей, описывающих события. Атрибуты события сопоставляются с ключами словаря. Все атрибуты событий можно найти по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/event |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Chris Keller (@nasx)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 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_event_info_module.html