Модуль dellemc.openmanage.ome_alert_policies_message_id_info – Получение информации об идентификаторах сообщений правил оповещений.

Примечание

Этот модуль является частью коллекции dellemc.openmanage (версия 9.7.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: dellemc.openmanage.ome_alert_policies_message_id_info.

Новая функция в dellemc.openmanage 8.2.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль извлекает информацию об идентификаторах сообщений правил оповещений для OpenManage Enterprise и OpenManage Enterprise Modular.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл PEM (Privacy Enhanced Mail), содержащий сертификат CA для проверки.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная окружения `OME_PASSWORD`. Пример: export OME_PASSWORD=пароль
port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
timeout целое число добавлен в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная окружения `OME_USERNAME`. Пример: export OME_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 не указан, используется переменная окружения `OME_X_AUTH_TOKEN`. Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Выполняйте этот модуль с системы, имеющей прямой доступ к Dell OpenManage Enterprise или OpenManage Enterprise Modular.
Этот модуль поддерживает check_mode.
Этот модуль поддерживает адреса IPv4 и IPv6.

Примеры

---
- name: Get message ID details of all alert policies
  dellemc.openmanage.ome_alert_policies_message_id_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

Возвращаемые значения

Общие возвращаемые значения описаны в этом разделе, ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
error_info словарь	Подробности об ошибке HTTP. Возвращается: при HTTP ошибке Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
message_ids словарь	Подробности об идентификаторах сообщений. Возвращается: при успехе Пример: [{"Category": "System Health", "DetailedDescription": "The current sensor identified in the message has failed. This condition can cause system performance issues and degradation in the monitoring capability of the system.", "Message": "The ${0} sensor has failed, and the last recorded value by the sensor was ${1} A.", "MessageId": "AMP400", "Prefix": "AMP", "RecommendedAction": "Check the Embedded System Management (ESM) Log for any sensor related faults. If there is a failed sensor, replace the system board. For more information, contact your service provider.", "SequenceNo": 400, "Severity": "Critical", "SubCategory": "Amperage"}, {"Category": "System Health", "DetailedDescription": "The current sensor identified in the message has failed. This condition can cause system performance issues and degradation in the monitoring capability of the system.", "Message": "Unable to read the ${0} sensor value.", "MessageId": "AMP401", "Prefix": "AMP", "RecommendedAction": "Check the Embedded System Management (ESM) Log for any sensor related faults. If there is a failed sensor, replace the system board. For more information, contact your service provider.", "SequenceNo": 401, "Severity": "Warning", "SubCategory": "Amperage"}]
msg строка	Статус операции извлечения идентификаторов сообщений правил оповещений. Возвращается: всегда Пример: `"Successfully retrieved alert policies message ids information."`

Авторы

Shivam Sharma (@ShivamSh3)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_alert_policies_message_id_info_module.html