модуль dellemc.openmanage.redfish_event_subscription — управление подписками Redfish
Примечание
Этот модуль входит в коллекцию dellemc.openmanage (версия 10.0.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля требуются дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: dellemc.openmanage.redfish_event_subscription.
Новое в dellemc.openmanage 4.1.0
Краткое описание
- Этот модуль позволяет добавлять и удалять подписки на события Redfish.
Требования
Указанные ниже зависимости должны быть установлены на узле, где выполняется этот модуль.
- python >= 3.9.6
Параметры
Параметр | Комментарии |
|---|---|
baseuri string / обязательный | IP-адрес целевого контроллера управления внеполосным доступом. Например: <ipaddress>:<port>. |
ca_path path добавлено в dellemc.openmanage 5.0.0 | Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA для проверки. |
destination string / обязательный | URI назначения HTTPS, на который отправляются события. Требуется HTTPS. |
event_format_type string | Указывает формат событий, на которые оформляется подписка. Для подписки на формат Event используется Для подписки на формат отчёта метрик используется Варианты:
|
event_type string | Указывает тип события, на которое оформляется подписка. Для подписки на оповещения используется Для подписки на отчёт метрик используется Варианты:
|
password string | Пароль целевого контроллера управления внеполосным доступом. Если пароль не указан, используется переменная окружения Пример: export IDRAC_PASSWORD=password |
state string |
Варианты:
|
timeout integer добавлено в dellemc.openmanage 5.0.0 | Тайм-аут на уровне сокета в секундах. По умолчанию: |
username string | Имя пользователя целевого контроллера управления внеполосным доступом. Если имя пользователя не указано, используется переменная окружения Пример: export IDRAC_USERNAME=username |
validate_certs boolean добавлено в dellemc.openmanage 5.0.0 | Если задано значение Устанавливайте До версии коллекции Варианты:
|
x_auth_token string добавлено в dellemc.openmanage 9.3.0 | Токен аутентификации. Если x_auth_token не указан, используется переменная окружения Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token |
Примечания
Примечание
-
Для подписки на метрики параметру event_type необходимо задать значение
MetricReport, а параметру event_format_type —MetricReport. -
Для подписки на события параметру event_type необходимо задать значение
Alert, а параметру event_format_type —Event. - Изменение подписки не поддерживается.
- Для контекста всегда задаётся значение RedfishEvent.
- Этот модуль поддерживает
check_mode.
Примеры
---
- name: Add Redfish metric subscription
redfish_event_subscription:
baseuri: "192.168.0.1"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
destination: "https://192.168.1.100:8188"
event_type: MetricReport
event_format_type: MetricReport
state: present
- name: Add Redfish alert subscription
redfish_event_subscription:
baseuri: "192.168.0.1"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
destination: "https://server01.example.com:8188"
event_type: Alert
event_format_type: Event
state: present
- name: Delete Redfish subscription with a specified destination
redfish_event_subscription:
baseuri: "192.168.0.1"
username: "user_name"
password: "user_password"
ca_path: "/path/to/ca_cert.pem"
destination: "https://server01.example.com:8188"
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
error_info dictionary | Сведения об ошибке HTTP. Возвращается: при ошибке HTTP Пример: |
msg string | Общий статус задачи. Возвращается: всегда Пример: |
status dictionary | Возвращает созданный объект подписки Возвращается: при успешном добавлении подписки Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/openmanage/redfish_event_subscription_module.html