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

actions

list / elements=dictionary

Действия, запускаемые для политики оповещений.

Этот параметр чувствителен к регистру.

Параметр обязателен при создании политики и необязателен при ее обновлении.

Применяется только, если state имеет значение present

action_name

string / обязательный

Имя действия.

Получается из dellemc.openmanage.ome_alert_policies_action_info.

Параметр обязателен при создании политики и необязателен при ее обновлении.

Этот параметр чувствителен к регистру.

parameters

list / elements=dictionary

Предопределенные параметры, необходимые для настройки action_name.

По умолчанию: []

name

string

Имя предопределенного параметра.

Получается из dellemc.openmanage.ome_alert_policies_action_info.

value

string

Значение предопределенного параметра.

Эти значения не проверяются.

all_devices

boolean

Этот параметр указывает, применяется ли политика оповещений ко всем обнаруженным и необнаруженным устройствам.

Этот параметр нельзя использовать одновременно с device_service_tag, specific_undiscovered_devices, any_undiscovered_devices и device_group.

Применяется только, если state имеет значение present.

Варианты:

• false
• true

any_undiscovered_devices

boolean

Этот параметр указывает, применяется ли политика оповещений к любым необнаруженным устройствам.

Этот параметр нельзя использовать одновременно с device_service_tag, specific_undiscovered_devices, device_group и all_devices.

Применяется только, если state имеет значение present.

Варианты:

• false
• true

ca_path

path

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

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

category

list / elements=dictionary

Категория полученных оповещений.

Этот параметр нельзя использовать одновременно с message_ids и message_file.

Получается из dellemc.openmanage.ome_alert_policies_category_info.

Применяется только, если state имеет значение present.

catalog_category

list / elements=dictionary

Категория каталога.

category_name

string

Имя категории.

sub_category_names

list / elements=string

Список подкатегорий.

catalog_name

string / обязательный

Имя каталога.

date_and_time

dictionary

Задает расписание, в соответствии с которым применяется политика оповещений.

date_and_time обязателен при создании политики и необязателен при ее обновлении.

Применяется только, если state имеет значение present.

date_from

string / обязательный

Дата начала в формате YYYY-MM-DD.

Значение этого параметра необходимо заключить в кавычки.

date_to

string

Дата окончания в формате YYYY-MM-DD.

Значение этого параметра необходимо заключить в кавычки.

days

list / elements=string

Дни недели, в которые необходимо запланировать выполнение политики оповещений.

Варианты:

• "monday"
• "tuesday"
• "wednesday"
• "thursday"
• "friday"
• "saturday"
• "sunday"

time_from

string

Время начала интервала в формате HH:MM

Значение этого параметра необходимо заключить в кавычки.

Обязательно, если time_interval имеет значение true.

time_interval

boolean

Включить временной интервал, на который необходимо запланировать выполнение политики оповещений.

Варианты:

• false
• true

time_to

string

Время окончания интервала в формате HH:MM

Значение этого параметра необходимо заключить в кавычки.

Обязательно, если time_interval имеет значение true

description

string

Описание политики оповещений.

Применяется только, если state имеет значение present

device_group

list / elements=string

Список имен групп устройств, к которым применяется политика оповещений.

Этот параметр нельзя использовать одновременно с device_service_tag, specific_undiscovered_devices, any_undiscovered_devices и all_devices.

Применяется только, если state имеет значение present

device_service_tag

list / elements=string

Список сервисных тегов устройств, к которым применяется политика оповещений.

Этот параметр нельзя использовать одновременно с 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

path

Локальный путь к файлу в формате CSV с идентификаторами сообщений

Этот параметр нельзя использовать одновременно с category и message_ids

Применяется только, если state имеет значение present

Получается из dellemc.openmanage.ome_alert_policies_message_id_info.

message_ids

list / elements=string

Список идентификаторов сообщений

Этот параметр нельзя использовать одновременно с category и message_file

Применяется только, если state имеет значение present

Получается из dellemc.openmanage.ome_alert_policies_message_id_info.

name

list / elements=string / обязательный

Имя политики оповещений или список политик оповещений.

Можно указать несколько имен политик, если state имеет значение absent, а также если state имеет значение present и указан только параметр enable.

new_name

string

Новое имя политики оповещений.

Применяется, только если state имеет значение present и политика оповещений существует.

password

string

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

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

Например: export OME_PASSWORD=password

port

integer

HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular.

По умолчанию: 443

severity

list / elements=string

Уровень серьезности политики оповещений.

Параметр обязателен при создании политики и необязателен при ее обновлении.

Применяется только, если state имеет значение present.

Варианты:

• "all"
• "unknown"
• "info"
• "normal"
• "warning"
• "critical"

specific_undiscovered_devices

list / elements=string

Список 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

string

present позволяет создать политику оповещений или обновить ее, если политика с таким именем уже существует.

absent позволяет удалить политику оповещений.

Варианты:

• "present" ← (по умолчанию)
• "absent"

timeout

integer

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

Тайм-аут на уровне сокета в секундах.

По умолчанию: 30

username

string

Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular.

Если имя пользователя не указано, используется переменная среды OME_USERNAME.

Например: export OME_USERNAME=username

validate_certs

boolean

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

Если задано false, SSL-сертификаты не проверяются.

Настраивайте false только на сайтах под личным контролем, где используются самоподписанные сертификаты.

В версиях коллекции до 5.0.0 параметр validate_certs по умолчанию имеет значение false.

Варианты:

• false
• true ← (по умолчанию)

x_auth_token

string

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

Токен аутентификации.

Если x_auth_token не указан, используется переменная среды OME_X_AUTH_TOKEN.

Например: export OME_X_AUTH_TOKEN=x_auth_token

error_info

dictionary

Сведения об ошибке 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

string

Состояние операции с политиками оповещений.

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

Пример: "Successfully created the alert policy."

status

dictionary

Созданная или измененная политика.

Возвращается: если state имеет значение 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}