Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_alert_policies_actions_info — Получение информации о действиях правил оповещения.

Примечание

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

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

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

Для использования в книге задач укажите: dellemc.openmanage.ome_alert_policies_actions_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=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=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.
  • Этот модуль поддерживает адреса IPv4 и IPv6.
  • Этот модуль поддерживает check_mode.

Примеры

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

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

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

Ключ

Описание

actions

список / элементы=строка

Возвращает информацию о действиях правил оповещения, собранную с устройства.

Возвращается: успех

Пример: [{"Description": "Email", "Disabled": false, "Name": "Email", "ParameterDetails": [{"Id": 1, "Name": "subject", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": "Device Name: $name,  Device IP Address: $ip,  Severity: $severity"}, {"Id": 2, "Name": "to", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": ""}, {"Id": 3, "Name": "from", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": "admin1@dell.com"}, {"Id": 4, "Name": "message", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": "Event occurred for Device Name: $name, Device IP Address: $ip, Service Tag: $identifier, UTC Time: $time, Severity: $severity, Message ID: $messageId, $message"}, {"Description": "Trap", "Disabled": false, "Id": 60, "Name": "Trap", "ParameterDetails": [{"Id": 1, "Name": "localhost:162", "TemplateParameterTypeDetails": [], "Type": "boolean", "Value": "true"}]}, {"Description": "Syslog", "Disabled": false, "Id": 90, "Name": "Syslog", "ParameterDetails": [{"Id": 1, "Name": "localhost.scomdev.com:555", "TemplateParameterTypeDetails": [], "Type": "boolean", "Value": "true"}, {"Id": 2, "Name": "localhost.scomdev.com:555", "TemplateParameterTypeDetails": [], "Type": "boolean", "Value": "true"}]}, {"Description": "Ignore", "Disabled": false, "Id": 100, "Name": "Ignore", "ParameterDetails": []}, {"Description": "SMS", "Disabled": false, "Id": 70, "Name": "SMS", "ParameterDetails": [{"Id": 1, "Name": "to", "TemplateParameterTypeDetails": [{"Name": "maxLength", "Value": "255"}], "Type": "string", "Value": ""}]}, {"Description": "Power Control Action Template", "Disabled": false, "Id": 110, "Name": "PowerControl", "ParameterDetails": [{"Id": 1, "Name": "powercontrolaction", "TemplateParameterTypeDetails": [{"Name": "option", "Value": "powercycle"}, {"Name": "option", "Value": "poweroff"}, {"Name": "option", "Value": "poweron"}, {"Name": "option", "Value": "gracefulshutdown"}], "Type": "singleSelect", "Value": "poweroff"}]}, {"Description": "RemoteCommand", "Disabled": true, "Id": 111, "Name": "RemoteCommand", "ParameterDetails": [{"Id": 1, "Name": "remotecommandaction", "TemplateParameterTypeDetails": [], "Type": "singleSelect", "Value": null}]}, {"Description": "Mobile", "Disabled": false, "Id": 112, "Name": "Mobile", "ParameterDetails": []}]}]

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."}}

msg

строка

Статус операции извлечения действий правил оповещения.

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

Пример: "Successfully retrieved alert policies actions information."

Авторы

  • Критика Бхатеджа (@Kritika-Bhateja-03)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (источники)

© 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_actions_info_module.html

Spec-Zone.ru

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