Spec-Zone.ru › Ansible

cisco.meraki.networks_alerts_settings модуль — Модуль ресурса для настроек сетевых оповещений

Примечание

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

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

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

Для использования в playbook укажите: cisco.meraki.networks_alerts_settings.

Новое в cisco.meraki 2.16.0

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

Обзор

  • Управление обновлением операции ресурса настроек сетевых оповещений.
  • Обновление конфигурации оповещений для этой сети.

Примечание

Для этого модуля имеется соответствующий плагин действия.

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

alerts

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

Настройка конкретного оповещения для каждого типа. Можно обновлять только оповещения, относящиеся к сети.

alertDestinations

словарь

Хэш назначений для этого конкретного оповещения.

allAdmins

логическое

Если значение истинно, все администраторы сети получат электронные письма об этом оповещении.

Варианты:

  • false
  • true

emails

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

Список электронных адресов, которые получат информацию об оповещении.

httpServerIds

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

Список идентификаторов HTTP-серверов, которым будет отправлен веб-хук для этого оповещения.

snmp

логическое

Если значение истинно, для этого оповещения будет отправлен SNMP-трав, если для этой сети настроен сервер SNMP-трапов.

Варианты:

  • false
  • true

enabled

логическое

Логическое значение, определяющее, включено или выключено оповещение.

Варианты:

  • false
  • true

filters

словарь

Хэш с конкретными данными конфигурации для оповещения. Будут обновлены только фильтры, относящиеся к оповещению.

type

строка

Тип оповещения.

defaultDestinations

словарь

Назначение по умолчанию для всех оповещений в сети.

allAdmins

логическое

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

Варианты:

  • false
  • true

emails

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

Список электронных адресов, которые получат оповещение(я).

httpServerIds

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

Список идентификаторов HTTP-серверов, которым будет отправлен веб-хук.

snmp

логическое

Если значение истинно, будет отправлен SNMP-трав, если для этой сети настроен сервер SNMP-трапов.

Варианты:

  • false
  • true

meraki_action_batch_retry_wait_time

целое число

meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки ошибки конвейера действия

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

meraki_api_key

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

meraki_api_key (строка), API ключ, сгенерированный на панели управления; также может быть задан как переменная окружения MERAKI_DASHBOARD_API_KEY

meraki_base_url

строка

meraki_base_url (строка), предшествующая всем ресурсам конечной точки

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

строка

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная окружения BE_GEO_ID

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

meraki_caller

строка

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть задан как переменная окружения MERAKI_PYTHON_SDK_CALLER

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

meraki_certificate_path

строка

meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если за локальным прокси-сервером

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

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), Наследует собственный экземпляр регистратора

Варианты:

  • false ← (default)
  • 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 ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), выводить выходные данные журнала на консоль?

Варианты:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS

Значение по умолчанию: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)?

Варианты:

  • false ← (default)
  • 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 ← (default)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API

Значение по умолчанию: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключить все ведение журнала? тогда вы предоставлены сами себе!

Варианты:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Варианты:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429?

Варианты:

  • false
  • true ← (default)

muting

dictionary

Отключение оповещений при определенных условиях.

byPortSchedules

dictionary

Отключение оповещений о недоступности беспроводной связи на основе расписаний портов коммутатора.

enabled

boolean

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

Варианты:

  • false
  • true

networkId

string

Параметр пути networkId. Идентификатор сети.

Примечания

Примечание

  • Используемый метод SDK: networks.Networks.update_network_alerts_settings,
  • Используемые пути: put /networks/{networkId}/alerts/settings,
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный диспетчер подключения Cisco DNAC 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_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=
        snmp: false
      enabled: true
      filters:
        timeout: 60
      type: gatewayDown
    defaultDestinations:
      allAdmins: true
      emails:
      - miles@meraki.com
      httpServerIds:
      - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
      snmp: true
    networkId: string

Значения возврата

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: {}

Авторы

  • Francisco Munoz (@fmunoz)

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

  • Система отслеживания проблем
  • Репозиторий (источники)

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

Spec-Zone.ru

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