community.general.ovirt_event_facts – Этот модуль можно использовать для получения информации об одном или нескольких событиях oVirt/RHV
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: 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 логическое |
| Указывает, следует ли учитывать регистр при поиске, выполненном с использованием параметра поиска. Значение по умолчанию - true, что означает учет регистра. Если необходимо игнорировать регистр, установите его в false. |
| fetch_nested логическое |
| Если да, модуль получит дополнительные данные из API. Будут получены только идентификаторы вложенной сущности. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| from_ целое число | Указывает индекс события, после которого должны возвращаться события. Индексы событий строго возрастают, поэтому при использовании этого параметра будут возвращены только события с большими индексами. | |
| headers строка | Дополнительные HTTP-заголовки. | |
| max целое число | Устанавливает максимальное количество возвращаемых событий. Если не указано, возвращаются все события. | |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только, когда fetch_nested имеет значение true. | |
| query строка | Дополнительные параметры запроса URL. | |
| search строка | Критерий поиска, принятый API oVirt/RHV. Например, для поиска событий уровня тревоги используйте следующий шаблон: severity=alert | |
| wait логическое |
| Если True, подождите ответа. |
Примечания
Примечание
- Для использования этого модуля необходимо установить Python SDK oVirt. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_event_facts_module.html