Spec-Zone.ru › Ansible

модуль 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.

Для подписки на формат отчёта метрик используется MetricReport.

Варианты:

  • "Event" ← (по умолчанию)
  • "MetricReport"

event_type

string

Указывает тип события, на которое оформляется подписка.

Для подписки на оповещения используется Alert.

Для подписки на отчёт метрик используется MetricReport.

Варианты:

  • "Alert" ← (по умолчанию)
  • "MetricReport"

password

string

Пароль целевого контроллера управления внеполосным доступом.

Если пароль не указан, используется переменная окружения IDRAC_PASSWORD.

Пример: export IDRAC_PASSWORD=password

state

string

present добавляет новую подписку на события.

absent удаляет подписку на события с указанным значением destination.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

integer

добавлено в dellemc.openmanage 5.0.0

Тайм-аут на уровне сокета в секундах.

По умолчанию: 30

username

string

Имя пользователя целевого контроллера управления внеполосным доступом.

Если имя пользователя не указано, используется переменная окружения IDRAC_USERNAME.

Пример: export IDRAC_USERNAME=username

validate_certs

boolean

добавлено в dellemc.openmanage 5.0.0

Если задано значение false, сертификаты SSL не проверяются.

Устанавливайте false только на контролируемых вами ресурсах, где используются самоподписанные сертификаты.

До версии коллекции 5.0.0 параметр validate_certs по умолчанию имеет значение false.

Варианты:

  • false
  • true ← (по умолчанию)

x_auth_token

string

добавлено в dellemc.openmanage 9.3.0

Токен аутентификации.

Если x_auth_token не указан, используется переменная окружения IDRAC_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

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the operation because the JSON data format entered is invalid.", "Resolution": "Do the following and the retry the operation: 1) Enter the correct JSON data format and retry the operation. 2) Make sure that no syntax error is present in JSON data format. 3) Make sure that a duplicate key is not present in JSON data format.", "Severity": "Critical"}, {"Message": "The request body submitted was malformed JSON and could not be parsed by the receiving service.", "Resolution": "Ensure that the request body is valid JSON and resubmit the request.", "Severity": "Critical"}], "code": "Base.1.2.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

msg

string

Общий статус задачи.

Возвращается: всегда

Пример: "Successfully added the subscription."

status

dictionary

Возвращает созданный объект подписки

Возвращается: при успешном добавлении подписки

Пример: {"@Message.ExtendedInfo": [{"Message": "The resource has been created successfully", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "Base.1.7.Created", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "None", "Severity": "OK"}, {"Message": "A new resource is successfully created.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.2.2.SYS414", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "No response action is required.", "Severity": "Informational"}], "Actions": {"#EventDestination.ResumeSubscription": {"target": "/redfish/v1/EventService/Subscriptions/5d432f36-81f4-11eb-9dc0-2cea7ff7ff9a/Actions/EventDestination.ResumeSubscription"}}, "Context": "RedfishEvent", "DeliveryRetryPolicy": "RetryForever", "Description": "Event Subscription Details", "Destination": "https://192.168.1.100:8188", "EventFormatType": "Event", "EventTypes": ["Alert"], "EventTypes@odata.count": 1, "HttpHeaders": [], "HttpHeaders@odata.count": 0, "Id": "5d432f36-81f4-11eb-9dc0-2cea7ff7ff9a", "MetricReportDefinitions": [], "MetricReportDefinitions@odata.count": 0, "Name": "EventSubscription 5d432f36-81f4-11eb-9dc0-2cea7ff7ff9a", "OriginResources": [], "OriginResources@odata.count": 0, "Protocol": "Redfish", "Status": {"Health": "OK", "HealthRollup": "OK", "State": "Enabled"}, "SubscriptionType": "RedfishEvent"}

Авторы

  • Trevor Squillario (@TrevorSquillario)
  • Sachin Apagundi (@sachin-apa)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API