Модуль cisco.meraki.organizations_alerts_profiles — Модуль ресурсов для организаций _alerts _profiles

Примечание

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

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

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

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

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

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

Обзор

Управление операциями создания, обновления и удаления ресурсов организаций _alerts _profiles.
Создание конфигурации оповещений для всей организации.
Удаление конфигурации оповещений для всей организации.
Обновление конфигурации оповещений для всей организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
alertCondition словарь	Условие, определяющее, срабатывает ли предупреждение.
bit_rate_bps целое число	Пороговое значение метрики, которое должно быть превышено для срабатывания предупреждения. Используется только для предупреждений об использовании WAN.
duration целое число	Общее время в секундах, в течение которого должно быть превышено пороговое значение перед срабатыванием предупреждения.
interface строка	Подключённый канал, за которым наблюдается предупреждение. Интерфейс должен быть одним из следующих: wan1, wan2, wan3, cellular.
jitter_ms целое число	Пороговое значение метрики, которое должно быть превышено для срабатывания предупреждения. Используется только для предупреждений о джиттере VoIP.
latency_ms целое число	Пороговое значение метрики, которое должно быть превышено для срабатывания предупреждения. Используется только для предупреждений о задержке WAN.
loss_ratio число с плавающей точкой	Пороговое значение метрики, которое должно быть превышено для срабатывания предупреждения. Используется только для предупреждений о потере пакетов.
mos число с плавающей точкой	Пороговое значение метрики, которое должно быть ниже для срабатывания предупреждения. Используется только для предупреждений о VoIP MOS.
window целое число	Период анализа в секундах для определения предупреждения.
alertConfigId строка	Параметр пути alertConfigId. Идентификатор конфигурации предупреждения.
description строка	Описание предупреждения, введенное пользователем.
enabled логическое значение	Включена ли конфигурация предупреждения. Варианты: `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 логическое значение	meraki_inherit_logging_config (логическое значение), наследует собственный экземпляр логгера Варианты: `false` ← (значение по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла журнала, дополненное датой и временной меткой Значение по умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для вывода журнала; по умолчанию, рабочая директория скрипта, если не указано Значение по умолчанию: `""`

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` ← (по умолчанию)
networkTags list / elements=string	Сети с этими тегами будут отслеживаться для получения оповещения.
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
recipients dictionary	Список получателей, которые получат оповещение.
emails list / elements=string	Список адресов электронной почты, которые получат информацию об оповещении.
httpServerIds list / elements=string	Список URL веб-хуков (в кодировке base64), которые получат информацию об оповещении.
type string	Тип оповещения.

Примечания

Примечание

Используемые методы SDK: organizations.Organizations.create_organization_alerts_profile, organizations.Organizations.delete_organization_alerts_profile, organizations.Organizations.update_organization_alerts_profile,
Используемые пути: post /organizations/{organizationId}/alerts/profiles, delete /organizations/{organizationId}/alerts/profiles/{alertConfigId}, put /organizations/{organizationId}/alerts/profiles/{alertConfigId},
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki для создания профиля оповещений организации createOrganizationAlertsProfile: Полное описание API createOrganizationAlertsProfile.
Документация Cisco Meraki для удаления профиля оповещений организации deleteOrganizationAlertsProfile: Полное описание API deleteOrganizationAlertsProfile.
Документация Cisco Meraki для обновления профиля оповещений организации updateOrganizationAlertsProfile: Полное описание API updateOrganizationAlertsProfile.

Примеры

- name: Create
  cisco.meraki.organizations_alerts_profiles:
    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
    alertCondition:
      bit_rate_bps: 10000
      duration: 60
      interface: wan1
      jitter_ms: 100
      latency_ms: 100
      loss_ratio: 0.1
      mos: 3.5
      window: 600
    description: WAN 1 high utilization
    networkTags:
    - tag1
    - tag2
    organizationId: string
    recipients:
      emails:
      - admin@example.org
      httpServerIds:
      - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA==
    type: wanUtilization

- name: Delete by id
  cisco.meraki.organizations_alerts_profiles:
    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: absent
    alertConfigId: string
    organizationId: string

- name: Update by id
  cisco.meraki.organizations_alerts_profiles:
    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
    alertCondition:
      bit_rate_bps: 10000
      duration: 60
      interface: wan1
      jitter_ms: 100
      latency_ms: 100
      loss_ratio: 0.1
      mos: 3.5
      window: 600
    alertConfigId: string
    description: WAN 1 high utilization
    enabled: true
    networkTags:
    - tag1
    - tag2
    organizationId: string
    recipients:
      emails:
      - admin@example.org
      httpServerIds:
      - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA==
    type: wanUtilization

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

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

Ключ	Описание
meraki_response словарь	Словарь или список со значением, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"alertCondition": {"bit_rate_bps": 0, "duration": 0, "interface": "string", "window": 0}, "description": "string", "enabled": true, "id": "string", "networkTags": ["string"], "recipients": {"emails": ["string"], "httpServerIds": ["string"]}, "type": "string"}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"alertCondition": {"bit_rate_bps": 0, "duration": 0, "interface": "string", "window": 0}, "description": "string", "enabled": true, "id": "string", "networkTags": ["string"], "recipients": {"emails": ["string"], "httpServerIds": ["string"]}, "type": "string"}

Авторы

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/organizations_alerts_profiles_module.html