ovirt_event – Создание или удаление события в oVirt/RHV
Новое в версии 2.8.
Описание
- Этот модуль может использоваться для создания или удаления события в oVirt/RHV.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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. | ||
| cluster строка | Идентификатор кластера, связанного с этим событием. | ||
| custom_id целое число | Пользовательский идентификатор события. Этот идентификатор должен быть уникальным для каждого события. Требуется, когда указан параметр state. | ||
| data_center строка | Идентификатор центра данных, связанного с этим событием. | ||
| description строка | Сообщение для события. Требуется, когда указан параметр state. | ||
| fetch_nested логическое добавлен в 2.3 |
| Если истина, модуль извлечёт дополнительные данные из API. Он извлечёт идентификаторы дисков, снимков VM и т.д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | |
| host строка | Идентификатор хоста, связанного с этим событием. | ||
| id строка | Идентификатор события в таблице oVirt/RHV audit_log. Этот идентификатор не такой, как custom_id, и используется только когда параметр state отсутствует. Требуется, когда параметр state отсутствует. | ||
| nested_attributes список добавлен в 2.3 | Указывает список атрибутов, которые следует извлечь из API. Этот параметр применяется только когда fetch_nested равен истине. | ||
| origin строка | Источник события. Требуется, когда указан параметр state. | ||
| poll_interval целое число | Значение по умолчанию: 3 | Количество секунд, в течение которого модуль ждёт, прежде чем отправить другой запрос о статусе сущности. | |
| severity строка |
| Степень серьезности события. Требуется, когда указан параметр state. | |
| state строка |
| Требуется ли наличие события (present/absent). Параметр wait должен быть установлен в значение false, когда state равен absent. | |
| storage_domain строка | Идентификатор хранилищного домена, связанного с этим событием. | ||
| template строка | Идентификатор шаблона, связанного с этим событием. | ||
| timeout целое число | Значение по умолчанию: 180 | Время в секундах, в течение которого модуль ожидает, пока инстанция не перейдёт в нужное состояние. | |
| user строка | Идентификатор пользователя, связанного с этим событием. | ||
| vm строка | Идентификатор VM, связанной с этим событием. | ||
| wait логическое |
| yes если модуль должен ожидать, пока сущность не перейдёт в нужное состояние. | |
Примечания
Примечание
- Для использования этого модуля необходимо установить 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: Create an event
ovirt_event:
state: present
description: "The file system /home on host xyz is almost full!"
origin: "mymonitor"
custom_id: 123456789
severity: warning
- name: Create an event and link it to a specific object
ovirt_event:
state: present
description: "The file system /home is almost full!"
origin: "mymonitor"
custom_id: 123456789
severity: warning
vm: "c79db183-46ef-44d1-95f9-1a368c516c19"
- name: Remove an event
ovirt_event:
state: absent
id: 123456789
wait: false
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| event словарь | При успехе. | Словарь всех атрибутов события. Все атрибуты события можно найти по следующему адресу URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/event |
| id строка | При успехе. | Идентификатор созданного события. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.8/modules/ovirt_event_module.html
