модуль cisco.meraki.networks_alerts_settings — модуль ресурса для networks _alerts _settings

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_alerts_settings.

Добавлено в cisco.meraki 1.0.0

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

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

Управление операцией обновления ресурса networks _alerts _settings.
Обновление конфигурации оповещений для этой сети.

Примечание

Этому модулю соответствует плагин действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
alerts list / elements=dictionary	Конфигурация оповещений для каждого типа. Можно обновлять только оповещения, относящиеся к сети.
alertDestinations dictionary	Список адресатов для данного оповещения.
allAdmins boolean	Если значение равно true, все администраторы сети будут получать электронные письма об этом оповещении. Варианты: `false` `true`
emails list / elements=string	Список адресов электронной почты для получения сведений об оповещении.
httpServerIds list / elements=string	Список идентификаторов HTTP-серверов, на которые будет отправлен веб-хук для этого оповещения.
smsNumbers list / elements=string	Список телефонных номеров для получения SMS-сообщений об оповещении. Доступно только для оповещений о состоянии датчиков.
snmp boolean	Если значение равно true, для этого оповещения будет отправлена SNMP-ловушка, если для этой сети настроен сервер SNMP-ловушек. Варианты: `false` `true`
enabled boolean	Логическое значение, указывающее, включено или выключено оповещение. Варианты: `false` `true`
filters dictionary	Набор данных конфигурации для оповещения. Обновляются только фильтры, относящиеся к этому оповещению.
conditions list / elements=dictionary	Условия.
direction string	Направление.
duration integer	Длительность.
threshold float	Пороговое значение.
type string	Тип условия.
unit string	Единица измерения.
failureType string	Тип сбоя.
lookbackWindow integer	Окно просмотра назад (в секундах).
minDuration integer	Минимальная длительность.
name string	Имя.
period integer	Период.
priority string	Приоритет.
regex string	Регулярное выражение.
selector string	Селектор.
serials list / elements=string	Серийные номера.
ssidNum integer	Номер SSID.
tag string	Тег.
threshold integer	Пороговое значение.
timeout integer	Тайм-аут.
type string	Тип оповещения.
defaultDestinations dictionary	Общие для сети адресаты всех оповещений.
allAdmins boolean	Если значение равно true, все администраторы сети будут получать электронные письма. Варианты: `false` `true`
emails list / elements=string	Список адресов электронной почты для получения оповещений.
httpServerIds list / elements=string	Список идентификаторов HTTP-серверов, на которые будет отправлен веб-хук.
snmp boolean	Если значение равно true, будет отправлена SNMP-ловушка, если для этой сети настроен сервер SNMP-ловушек. Варианты: `false` `true`
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный на панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), базовый адрес для всех ресурсов конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату для проверки TLS/SSL при работе через локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследовать собственный экземпляр логгера Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавленными датой и отметкой времени По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для записи журнала; если он не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), максимальное число повторных попыток при получении ответов 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повтором при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять запрос при получении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания перед повтором при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить ведение журнала? Тогда вы действуете на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторять запрос при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
muting dictionary	Отключать оповещения при определённых условиях.
byPortSchedules dictionary	Отключать оповещения о недоступности беспроводного устройства на основе расписаний портов коммутатора.
enabled boolean	Если значение равно true, оповещения о недоступности беспроводного устройства будут отключаться, когда причиной является расписание порта. Варианты: `false` `true`
networkId string	Параметр пути NetworkId. Идентификатор сети.

Примечания

Примечание

Используемый метод SDK: networks.Networks.update_network_alerts_settings,
Используемый путь: put /networks/{networkId}/alerts/settings,
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует подключаемые модули Ansible для соединения, а вместо этого использует встроенный менеджер соединений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установки соединения

См. также

Документация Cisco Meraki по networks updateNetworkAlertsSettings: Полный справочник по API updateNetworkAlertsSettings.

Примеры

- name: Update all
  cisco.meraki.networks_alerts_settings:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    alerts:
      - alertDestinations:
          allAdmins: false
          emails:
            - miles@meraki.com
          httpServerIds:
            - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
          smsNumbers:
            - '+15555555555'
          snmp: false
        enabled: true
        filters:
          conditions:
            - direction: +
              duration: 0
              threshold: 72.5
              type: temperature
              unit: celsius
          failureType: 802.1X auth fail
          lookbackWindow: 360
          minDuration: 60
          name: Filter
          period: 1800
          priority: ''
          regex: '[a-z]'
          selector: '{"smartSensitivity":"medium","smartEnabled":false,"eventReminderPeriodSecs":10800}'
          serials:
            - Q234-ABCD-0001
            - Q234-ABCD-0002
            - Q234-ABCD-0003
          ssidNum: 1
          tag: tag1
          threshold: 30
          timeout: 60
        type: gatewayDown
    defaultDestinations:
      allAdmins: true
      emails:
        - miles@meraki.com
      httpServerIds:
        - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
      snmp: true
    muting:
      byPortSchedules:
        enabled: true
    networkId: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: {"alerts": [{"alertDestinations": {"allAdmins": true, "emails": ["string"], "httpServerIds": ["string"], "smsNumbers": ["string"], "snmp": true}, "enabled": true, "filters": {"conditions": [{"direction": "string", "duration": 0, "threshold": 0, "type": "string", "unit": "string"}], "failureType": "string", "lookbackWindow": 0, "minDuration": 0, "name": "string", "period": 0, "priority": "string", "regex": "string", "selector": "string", "serials": ["string"], "ssidNum": 0, "tag": "string", "threshold": 0, "timeout": 0}, "type": "string"}], "defaultDestinations": {"allAdmins": true, "emails": ["string"], "httpServerIds": ["string"], "snmp": true}, "muting": {"byPortSchedules": {"enabled": true}}}

Ключ

Описание

meraki_response

словарь

Словарь или список с ответом, возвращённым Cisco Meraki Python SDK

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

Пример: {"alerts": [{"alertDestinations": {"allAdmins": true, "emails": ["string"], "httpServerIds": ["string"], "smsNumbers": ["string"], "snmp": true}, "enabled": true, "filters": {"conditions": [{"direction": "string", "duration": 0, "threshold": 0, "type": "string", "unit": "string"}], "failureType": "string", "lookbackWindow": 0, "minDuration": 0, "name": "string", "period": 0, "priority": "string", "regex": "string", "selector": "string", "serials": ["string"], "ssidNum": 0, "tag": "string", "threshold": 0, "timeout": 0}, "type": "string"}], "defaultDestinations": {"allAdmins": true, "emails": ["string"], "httpServerIds": ["string"], "snmp": true}, "muting": {"byPortSchedules": {"enabled": true}}}

Авторы

Francisco Munoz (@fmunoz)

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

© 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/cisco/meraki/networks_alerts_settings_module.html