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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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	Файл PEM (Privacy Enhanced Mail), содержащий сертификат CA, который будет использоваться для проверки.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_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=имя_пользователя
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–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_info_module.html