community.general.ovirt_event_facts – Этот модуль можно использовать для получения информации об одном или нескольких событиях oVirt/RHV
Примечание
Этот плагин является частью коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.ovirt_event_facts.
УСТАРЕВШИЙ
- Удалён в
-
версии 3.0.0
- Почему
-
При миграции на коллекцию мы решили использовать только модули _info.
- Альтернатива
-
Используйте ovirt.ovirt.ovirt_event_info вместо этого.
Описание
- Получение информации об одном или нескольких событиях oVirt/RHV.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 boolean |
| Указывает, следует ли выполнять поиск, использующий параметр поиска, учитывая регистр. Значение по умолчанию — true, что означает учёт регистра. Если нужно игнорировать регистр, установите значение в false. |
| fetch_nested boolean |
| Если да, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes. |
| from_ целое число | Указывает индекс события, после которого должны быть возвращены события. Индексы событий строго возрастают, поэтому при использовании этого параметра будут возвращены только события с большими индексами. | |
| headers строка | Дополнительные HTTP-заголовки. | |
| max целое число | Устанавливает максимальное количество событий для возврата. Если не указано, возвращаются все события. | |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только, когда fetch_nested равен true. | |
| query строка | Дополнительные параметры запроса URL. | |
| search строка | Термин поиска, который принимается API oVirt/RHV. Например, для поиска событий с уровнем серьезности «alert» используйте следующий шаблон: severity=alert | |
| wait boolean |
| Если True, ожидается ответ. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: ansible.builtin.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
- ansible.builtin.debug:
msg: "{{ result.ovirt_events }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_events список / элементы=строка | В случае успеха. | Список словарей, описывающих события. Атрибуты события отображаются в ключи словаря. Все атрибуты событий можно найти по следующему адресу URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/event |
Статус
- Этот модуль будет удалён в версии 3.0.0. [устаревший]
- Дополнительную информацию см. в разделе УСТАРЕВШИЙ.
Авторы
- 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.10/collections/community/general/ovirt_event_facts_module.html
