Модуль dellemc.openmanage.redfish_event_subscription – Управление подписками Redfish

baseuri

строка / обязательно

IP-адрес целевого внешнего контроллера. Например - <ipaddress>:<port>.

ca_path

путь

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

Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использоваться для проверки.

destination

строка / обязательно

URI HTTPS места назначения для отправки событий.

Требуется HTTPS.

event_format_type

строка

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

Event используется для подписки на тип формата события.

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

Варианты:

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

event_type

строка

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

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

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

Варианты:

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

password

строка

Пароль целевого внешнего контроллера.

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

Пример: export IDRAC_PASSWORD=password

state

строка

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

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

Варианты:

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

timeout

целое число

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

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

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

username

строка

Имя пользователя целевого внешнего контроллера.

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

Пример: export IDRAC_USERNAME=username

validate_certs

логическое

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

Если false, SSL-сертификаты проверяться не будут.

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

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

Варианты:

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

x_auth_token

строка

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

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

Если x_auth_token не указан, используется переменная среды IDRAC_X_AUTH_TOKEN.

Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

error_info

словарь

Подробности ошибки 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

строка

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

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

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

status

словарь

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

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

Пример: {"@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"}