dellemc.openmanage.ome_alert_policies модуль — Управление политиками оповещений OME.

Примечание

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

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

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

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

Впервые в dellemc.openmanage 8.3.0

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

Обзор

Этот модуль позволяет создавать, изменять или удалять политики оповещений на OpenManage Enterprise или OpenManage Enterprise Modular.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
actions список / элементы=словарь	Действия, которые будут инициированы для политики оповещений. Этот параметр чувствителен к регистру. Этот параметр обязателен для создания политики и необязателен для обновления политики. Этот параметр применим только когда state равно `present`
action_name строка / обязательно	Имя действия. Получается из dellemc.openmanage.ome_alert_policies_action_info. Этот параметр обязателен для создания политики и необязателен для обновления политики. Этот параметр чувствителен к регистру.
parameters список / элементы=словарь	Предварительно определенные параметры, необходимые для action_name. По умолчанию: `[]`
name строка	Имя предварительно определенного параметра. Получается из dellemc.openmanage.ome_alert_policies_action_info.
value строка	Значение предварительно определенного параметра. Эти значения не будут валидироваться.
all_devices логический тип	Этот параметр указывает, распространяется ли политика оповещений на все обнаруженные и необнаруженные устройства. Этот параметр несовместим с параметрами device_service_tag, specific_undiscovered_devices, any_undiscovered_devices и device_group. Этот параметр применим только когда state равно `present` Варианты: `false` `true`
any_undiscovered_devices логический тип	Этот параметр указывает, распространяется ли политика оповещений на любые необнаруженные устройства. Этот параметр несовместим с параметрами device_service_tag, specific_undiscovered_devices, device_group и all_devices. Этот параметр применим только когда state равно `present` Варианты: `false` `true`
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, используемый для проверки.
category список / элементы=словарь	Категория полученных оповещений. Этот параметр несовместим с параметрами message_ids, message_file. Получается из dellemc.openmanage.ome_alert_policies_category_info. Этот параметр применим только когда state равно `present`
catalog_category список / элементы=словарь	Категория каталога.
category_name строка	Название категории.
sub_category_names список / элементы=строка	Список подкатегорий.
catalog_name строка / обязательно	Имя каталога.
date_and_time словарь	Указывает расписание, когда политика оповещений применима. date_and_time обязателен для создания политики и необязателен при обновлении политики. Этот параметр применим только когда state равно `present`
date_from строка / обязательно	Дата начала в формате ГГГГ-ММ-ДД. Этот параметр должен быть в кавычках.
date_to строка	Дата окончания в формате ГГГГ-ММ-ДД. Этот параметр должен быть в кавычках.
days список / элементы=строка	Необходимые дни недели, на которые должна быть запланирована работа политики оповещений. Варианты: `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"` `"sunday"`
time_from строка	Время начала интервала в формате ЧЧ:ММ Этот параметр должен быть в кавычках. Этот параметр обязателен, когда time_interval равно `true`

time_interval boolean	Включить интервал времени, на который должна быть запланирована политика оповещения. Варианты: `false` `true`
time_to string	Время окончания интервала в формате ЧЧ:ММ Этот параметр должен быть передан в кавычках. Это обязательно, когда time_interval равен `true`
description string	Описание политики оповещения. Это применимо только когда state равен `present`
device_group list / элементы=строка	Список имен групп устройств, к которым применима политика оповещения. Этот параметр несовместим с параметрами device_service_tag, specific_undiscovered_devices, any_undiscovered_devices и all_devices. Это применимо только когда state равен `present`
device_service_tag list / элементы=строка	Список тегов сервиса устройств, к которым применима политика оповещения. Этот параметр несовместим с параметрами device_group, specific_undiscovered_devices, any_undiscovered_devices и all_devices. Это применимо только когда state равен `present`
enable boolean	`true` позволяет включить политику оповещения. `false` позволяет отключить политику оповещения. Это применимо только когда state равен `present`. Варианты: `false` `true`
hostname string / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
message_file путь	Локальный путь к CSV-файлу с идентификаторами сообщений Это исключает параметры category, message_ids Это применимо только когда state равен `present` Получается из dellemc.openmanage.ome_alert_policies_message_id_info.
message_ids list / элементы=строка	Список идентификаторов сообщений Это исключает параметры category, message_file Это применимо только когда state равен `present` Получается из dellemc.openmanage.ome_alert_policies_message_id_info.
name list / элементы=строка / обязательно	Имя политики оповещения или список политик оповещения. Несколько имён политик применимы, когда state равен `absent` и state равен `present` только с параметром enable.
new_name строка	Новое имя для политики оповещения. Это применимо только когда state равен `present`, и политика оповещения существует.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная окружения `OME_PASSWORD`. Пример: export OME_PASSWORD=пароль
port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
severity list / элементы=строка	Уровень серьезности политики оповещения. Обязательно для создания политики и необязательно для обновления политики. Это применимо только когда state равен `present`. Варианты: `"all"` `"unknown"` `"info"` `"normal"` `"warning"` `"critical"`
specific_undiscovered_devices list / элементы=строка	Список неустановленных IP-адресов, имен хостов или диапазонов IP-адресов устройств, к которым применима политика оповещения. Этот параметр несовместим с параметрами device_service_tag, device_group, any_undiscovered_devices и all_devices. Это применимо только когда state равен `present` Примеры допустимого формата диапазона IP: 10.35.0.0 10.36.0.0-10.36.0.255 10.37.0.0/24 2607:f2b1:f083:135::5500/118 2607:f2b1:f083:135::a500-2607:f2b1:f083:135::a600 hostname.domain.com Примеры недопустимого формата диапазона IP: 10.35.0.* 10.36.0.0-255 10.35.0.0/255.255.255.0 Эти значения не будут проверены.
state строка	`present` позволяет создать политику оповещения или обновить, если имя политики уже существует. `absent` позволяет удалить политику оповещения. Варианты: `"present"` ← (по умолчанию) `"absent"`

END_OF_DOCUMENT_MARKER

timeout integer added in dellemc.openmanage 5.0.0	Тайм-аут уровня сокета в секундах. По умолчанию: `30`
username string	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная окружения `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs boolean added in dellemc.openmanage 5.0.0	Если `false`, сертификаты SSL не будут проверены. Настраивайте `false` только на контролируемых вами сайтах, где используются самозаверяющие сертификаты. До версии коллекции `5.0.0`, validate_certs был `false` по умолчанию. Варианты: `false` `true` ← (по умолчанию)
x_auth_token string added in 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: "Create an alert policy"
  dellemc.openamanage.ome_alert_policies:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: "Alert Policy One"
    device_service_tag:
      - ABCD123
      - SVC7845
    category:
      - catalog_name: Application
        catalog_category:
          - category_name: Audit
            sub_category_names:
              - Generic
              - Devices
      - catalog_name: iDRAC
        catalog_category:
          - category_name: Audit
            sub_category_names:
              - BIOS Management
              - iDRAC Service Module
    date_and_time:
      date_from: "2023-10-10"
      date_to: "2023-10-11"
      time_from: "11:00"
      time_to: "12:00"
    severity:
      - unknown
      - critical
    actions:
      - action_name: Trap
        parameters:
          - name: "192.1.2.3:162"
            value: true
          - name: "traphostname.domain.com:162"
            value: true
  tags: create_alert_policy

- name: "Update an alert Policy"
  dellemc.openamanage.ome_alert_policies:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    new_name: "Update Policy Name"
    device_group: "Group Name"
    message_ids:
      - AMP400
      - CTL201
      - BIOS101
    date_and_time:
      date_from: "2023-10-10"
      date_to: "2023-10-11"
      time_from: "11:00"
      time_to: "12:00"
      time_interval: true
    actions:
      - action_name: Trap
        parameters:
          - name: "192.1.2.3:162"
            value: true
  tags: update_alert_policy

- name: "Enable an alert policy"
  dellemc.openamanage.ome_alert_policies:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: "Policy Name"
    enable: true
  tags: enable_alert_policy

- name: "Disable multiple alert policies"
  dellemc.openamanage.ome_alert_policies:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name:
      - "Policy Name 1"
      - "Policy Name 2"
    enable: false
  tags: disable_alert_policy

- name: "Delete an alert policy"
  dellemc.openamanage.ome_alert_policies:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name:
      - "Policy Name"
    state: absent
  tags: delete_alert_policy

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

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

Ключ	Описание
error_info словарь	Подробности HTTP-ошибки. Возвращается: при HTTP-ошибке Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to create or modify the alert policy because an invalid value [To Email] is entered for the action Email.", "MessageArgs": ["[To Email]", "Email"], "MessageId": "CMON7011", "RelatedProperties": [], "Resolution": "Enter a valid value for the action identified in the message and retry the operation.", "Severity": "Warning"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
msg строка	Состояние операции с политиками оповещений. Возвращается: всегда Пример: `"Successfully created the alert policy."`
status словарь	Политика, которая была создана или изменена. Возвращается: когда состояние — present Пример: {"DefaultPolicy": false, "Description": "Details of the Policy", "Editable": true, "Enabled": true, "Id": 12345, "Name": "Policy", "PolicyData": {"Actions": [{"Id": 8, "Name": "Email", "ParameterDetails": [{"Id": 1, "Name": "subject", "Type": "string", "TypeParams": [{"Name": "maxLength", "Value": "255"}], "Value": "Device Name: $name, Device IP Address: $ip, Severity: $severity"}, {"Id": 1, "Name": "to", "Type": "string", "TypeParams": [{"Name": "maxLength", "Value": "255"}], "Value": "test@org.com"}, {"Id": 1, "Name": "from", "Type": "string", "TypeParams": [{"Name": "maxLength", "Value": "255"}], "Value": "abc@corp.com"}, {"Id": 1, "Name": "message", "Type": "string", "TypeParams": [{"Name": "maxLength", "Value": "255"}], "Value": "Event occurred for Device Name: $name, Device IP Address: $ip"}]}], "Catalogs": [{"CatalogName": "iDRAC", "Categories": [4], "SubCategories": [41]}, {"CatalogName": "Application", "Categories": [0], "SubCategories": [0]}], "DeviceTypes": [1000, 2000], "Devices": [10086, 10088], "Groups": [], "Owner": 10069, "Schedule": {"CronString": "* * * ? * * *", "EndTime": "2023-06-06 18:02:46.000", "StartTime": "2023-06-06 15:02:46.000"}, "Severities": [16, 1, 2, 4, 8], "State": true, "UndiscoveredTargets": []}, "Visible": true}

Авторы

Jagadeesh N V(@jagadeeshnv)

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

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