Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_alert_policies_info — получение сведений об одной или нескольких политиках оповещений OME.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: dellemc.openmanage.ome_alert_policies_info.

Добавлено в dellemc.openmanage 8.2.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль получает сведения о политиках оповещений для OpenManage Enterprise и OpenManage Enterprise Modular.
  • Список сведений об определенной политике оповещений OME по ее имени.
  • Список всех политик оповещений OME и сведений о них, если имя политики не указано.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

путь

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

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

hostname

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

IP-адрес или имя хоста OpenManage Enterprise либо OpenManage Enterprise Modular.

password

строка

Пароль OpenManage Enterprise либо OpenManage Enterprise Modular.

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

Пример: export OME_PASSWORD=password

policy_name

строка

Имя политики.

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: Retrieve information about all OME alert policies.
  dellemc.openmanage.ome_alert_policies_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

- name: Retrieve information about a specific OME alert policy using the policy name.
  dellemc.openmanage.ome_alert_policies_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    policy_name: "Mobile Push Notification - Critical Alerts"

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

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

Ключ

Описание

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 all the OME alert policies information."

policies

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

Сведения обо всех политиках оповещений OME.

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

Пример: [{"DefaultPolicy": true, "Description": "This policy is applicable to critical alerts. Associated actions will be taken when a critical alert is received.", "Enabled": true, "Id": 10006, "Name": "Mobile Push Notification - Critical Alerts", "Owner": null, "PolicyData": {"Actions": [{"Id": 5, "Name": "Mobile", "ParameterDetails": [], "TemplateId": 112}], "AllTargets": false, "Catalogs": [], "DeviceTypes": [], "Devices": [], "Groups": [], "MessageIds": [], "Schedule": {"CronString": null, "EndTime": null, "Interval": false, "StartTime": null}, "Severities": [16], "UndiscoveredTargets": []}, "State": true, "Visible": true}]

Авторы

  • Abhishek Sinha(@ABHISHEK-SINHA10)

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

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

© 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/ome_alert_policies_info_module.html

Spec-Zone.ru

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