модуль cisco.meraki.networks_sensor_alerts_profiles – модуль ресурса для networks _sensor _alerts _profiles

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
conditions list / elements=dictionary	Список условий, при выполнении которых профиль отправит оповещение.
direction string	Если указано ‘above’, оповещение будет отправлено, когда показание датчика превысит пороговое значение. Если указано ‘below’, оповещение будет отправлено, когда показание датчика окажется ниже порогового значения. Применимо только к пороговым значениям температуры, влажности, realPower, apparentPower, powerFactor, напряжения, тока и частоты.
duration integer	Время в секундах, в течение которого должно сохраняться состояние срабатывания, прежде чем будет отправлено оповещение. Доступны следующие значения: 0 секунд, 1 минута, 2 минуты, 3 минуты, 4 минуты, 5 минут, 10 минут, 15 минут, 30 минут, 1 час, 1 час 30 минут, 2 часа, 4 часа и 8 часов. Значение по умолчанию — 0.
metric string	Тип показателя датчика, изменения которого будут отслеживаться.
threshold dictionary	Пороговое значение показаний датчика, при достижении которого будет отправлено оповещение. Этот объект должен содержать один ключ свойства, соответствующий значению ‘metric’ условия.
apparentPower dictionary	Пороговое значение полной мощности. Необходимо указать ‘draw’.
draw float	Пороговое значение для оповещения в вольт-амперах. Должно быть в диапазоне от 0 до 3750.
co2 dictionary	Пороговое значение концентрации CO2. Необходимо указать ‘concentration’ или ‘quality’.
concentration integer	Пороговое значение для оповещения в частях CO2 на миллион.
quality string	Пороговое значение для оповещения в виде качественного уровня CO2.
current dictionary	Пороговое значение электрического тока. Необходимо указать ‘level’.
draw float	Пороговое значение для оповещения в амперах. Должно быть в диапазоне от 0 до 15.
door dictionary	Пороговое значение открытия двери. Необходимо указать ‘open’ и установить его в true.
open boolean	Пороговое значение для оповещения о событии открытия двери. Должно быть установлено в true. Варианты: `false` `true`
frequency dictionary	Пороговое значение электрической частоты. Необходимо указать ‘level’.
level float	Пороговое значение для оповещения в герцах. Должно быть в диапазоне от 0 до 60.
humidity dictionary	Пороговое значение влажности. Необходимо указать ‘relativePercentage’ или ‘quality’.
quality string	Пороговое значение для оповещения в виде качественного уровня влажности.
relativePercentage integer	Пороговое значение для оповещения в %RH.
indoorAirQuality dictionary	Пороговое значение индекса качества воздуха в помещении. Необходимо указать ‘score’ или ‘quality’.
quality string	Пороговое значение для оповещения в виде качественного уровня качества воздуха в помещении.
score integer	Пороговое значение для оповещения в виде индекса качества воздуха в помещении.
noise dictionary	Пороговое значение шума. Необходимо указать ‘ambient’.
ambient dictionary	Пороговое значение фонового шума. Необходимо указать ‘level’ или ‘quality’.
level integer	Пороговое значение для оповещения в скорректированных децибелах.
quality string	Пороговое значение для оповещения в виде качественного уровня фонового шума.
pm25 dictionary	Пороговое значение концентрации PM2.5. Необходимо указать ‘concentration’ или ‘quality’.
concentration integer	Пороговое значение для оповещения в частях PM2.5 на миллион.
quality string	Пороговое значение для оповещения в виде качественного уровня PM2.5.
powerFactor dictionary	Пороговое значение коэффициента мощности. Необходимо указать ‘percentage’.
percentage integer	Пороговое значение для оповещения, выраженное отношением активной мощности к полной мощности. Должно быть в диапазоне от 0 до 100.
realPower dictionary	Пороговое значение активной мощности. Необходимо указать ‘draw’.
draw float	Пороговое значение для оповещения в ваттах. Должно быть в диапазоне от 0 до 3750.
temperature dictionary	Пороговое значение температуры. Необходимо указать ‘celsius’, ‘fahrenheit’ или ‘quality’.
celsius float	Пороговое значение для оповещения в градусах Цельсия.
fahrenheit float	Пороговое значение для оповещения в градусах Фаренгейта.
quality string	Пороговое значение для оповещения в виде качественного уровня температуры.
tvoc dictionary	Пороговое значение концентрации TVOC. Необходимо указать ‘concentration’ или ‘quality’.
concentration integer	Пороговое значение для оповещения в микрограммах TVOC на кубический метр.
quality string	Пороговое значение для оповещения в виде качественного уровня TVOC.
upstreamPower dictionary	Пороговое значение для входящего электропитания. Необходимо указать ‘outageDetected’ и установить его в true.
outageDetected boolean	Пороговое значение для оповещения о событии сбоя входящего электропитания. Должно быть установлено в true. Варианты: `false` `true`
voltage dictionary	Пороговое значение напряжения. Необходимо указать ‘level’.
level float	Пороговое значение для оповещения в вольтах. Должно быть в диапазоне от 0 до 250.
water dictionary	Пороговое значение обнаружения воды. Необходимо указать ‘present’ и установить его в true.
present boolean	Пороговое значение для оповещения об обнаружении воды. Должно быть установлено в true. Варианты: `false` `true`
id string	Параметр пути Id.
includeSensorUrl boolean	Добавлять ссылку на датчик в панели управления в сообщения (по умолчанию true). Варианты: `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), базовый URL, добавляемый перед всеми ресурсами конечных точек По умолчанию: `"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` ← (по умолчанию)
message string	Пользовательское сообщение, которое будет отображаться в оповещениях по электронной почте и SMS.
name string	Имя профиля оповещений датчика.
networkId string	Параметр пути NetworkId. Идентификатор сети.
recipients dictionary	Список получателей оповещения.
emails list / elements=string	Список адресов электронной почты, на которые будет отправляться информация об оповещении.
httpServerIds list / elements=string	Список идентификаторов конечных точек webhook, на которые будет отправляться информация об оповещении.
smsNumbers list / elements=string	Список номеров телефонов для получения SMS с информацией об оповещении.
schedule dictionary	Расписание датчика, используемое в профиле оповещений.
id string	Идентификатор расписания датчика, используемого в профиле оповещений. Если не задан, профиль оповещений будет активен постоянно.
serials list / elements=string	Список серийных номеров устройств, назначенных этому профилю оповещений датчика.

Примечания

Примечание

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

См. также

Документация Cisco Meraki для sensor createNetworkSensorAlertsProfile: Полное описание API createNetworkSensorAlertsProfile.
Документация Cisco Meraki для sensor deleteNetworkSensorAlertsProfile: Полное описание API deleteNetworkSensorAlertsProfile.
Документация Cisco Meraki для sensor updateNetworkSensorAlertsProfile: Полное описание API updateNetworkSensorAlertsProfile.

Примеры

- name: Create
  cisco.meraki.networks_sensor_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_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
    conditions:
      - direction: above
        duration: 60
        metric: temperature
        threshold:
          apparentPower:
            draw: 17.2
          co2:
            concentration: 400
            quality: poor
          current:
            draw: 0.14
          door:
            open: true
          frequency:
            level: 58.8
          humidity:
            quality: inadequate
            relativePercentage: 65
          indoorAirQuality:
            quality: fair
            score: 80
          noise:
            ambient:
              level: 120
              quality: poor
          pm25:
            concentration: 90
            quality: fair
          powerFactor:
            percentage: 81
          realPower:
            draw: 14.1
          temperature:
            celsius: 20.5
            fahrenheit: 70.0
            quality: good
          tvoc:
            concentration: 400
            quality: poor
          upstreamPower:
            outageDetected: true
          voltage:
            level: 119.5
          water:
            present: true
    includeSensorUrl: true
    message: Check with Miles on what to do.
    name: My Sensor Alert Profile
    networkId: string
    recipients:
      emails:
        - miles@meraki.com
      httpServerIds:
        - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
      smsNumbers:
        - '+15555555555'
    schedule:
      id: '5'
    serials:
      - Q234-ABCD-0001
      - Q234-ABCD-0002
      - Q234-ABCD-0003
- name: Update by id
  cisco.meraki.networks_sensor_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_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
    conditions:
      - direction: above
        duration: 60
        metric: temperature
        threshold:
          apparentPower:
            draw: 17.2
          co2:
            concentration: 400
            quality: poor
          current:
            draw: 0.14
          door:
            open: true
          frequency:
            level: 58.8
          humidity:
            quality: inadequate
            relativePercentage: 65
          indoorAirQuality:
            quality: fair
            score: 80
          noise:
            ambient:
              level: 120
              quality: poor
          pm25:
            concentration: 90
            quality: fair
          powerFactor:
            percentage: 81
          realPower:
            draw: 14.1
          temperature:
            celsius: 20.5
            fahrenheit: 70.0
            quality: good
          tvoc:
            concentration: 400
            quality: poor
          upstreamPower:
            outageDetected: true
          voltage:
            level: 119.5
          water:
            present: true
    id: string
    includeSensorUrl: true
    message: Check with Miles on what to do.
    name: My Sensor Alert Profile
    networkId: string
    recipients:
      emails:
        - miles@meraki.com
      httpServerIds:
        - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
      smsNumbers:
        - '+15555555555'
    schedule:
      id: '5'
    serials:
      - Q234-ABCD-0001
      - Q234-ABCD-0002
      - Q234-ABCD-0003
- name: Delete by id
  cisco.meraki.networks_sensor_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_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: absent
    id: string
    networkId: string

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: {"conditions": [{"direction": "string", "duration": 0, "metric": "string", "threshold": {"apparentPower": {"draw": 0}, "co2": {"concentration": 0, "quality": "string"}, "current": {"draw": 0}, "door": {"open": true}, "frequency": {"level": 0}, "humidity": {"quality": "string", "relativePercentage": 0}, "indoorAirQuality": {"quality": "string", "score": 0}, "noise": {"ambient": {"level": 0, "quality": "string"}}, "pm25": {"concentration": 0, "quality": "string"}, "powerFactor": {"percentage": 0}, "realPower": {"draw": 0}, "temperature": {"celsius": 0, "fahrenheit": 0, "quality": "string"}, "tvoc": {"concentration": 0, "quality": "string"}, "upstreamPower": {"outageDetected": true}, "voltage": {"level": 0}, "water": {"present": true}}}], "includeSensorUrl": true, "message": "string", "name": "string", "profileId": "string", "recipients": {"emails": ["string"], "httpServerIds": ["string"], "smsNumbers": ["string"]}, "schedule": {"id": "string", "name": "string"}, "serials": ["string"]}

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"conditions": [{"direction": "string", "duration": 0, "metric": "string", "threshold": {"apparentPower": {"draw": 0}, "co2": {"concentration": 0, "quality": "string"}, "current": {"draw": 0}, "door": {"open": true}, "frequency": {"level": 0}, "humidity": {"quality": "string", "relativePercentage": 0}, "indoorAirQuality": {"quality": "string", "score": 0}, "noise": {"ambient": {"level": 0, "quality": "string"}}, "pm25": {"concentration": 0, "quality": "string"}, "powerFactor": {"percentage": 0}, "realPower": {"draw": 0}, "temperature": {"celsius": 0, "fahrenheit": 0, "quality": "string"}, "tvoc": {"concentration": 0, "quality": "string"}, "upstreamPower": {"outageDetected": true}, "voltage": {"level": 0}, "water": {"present": true}}}], "includeSensorUrl": true, "message": "string", "name": "string", "profileId": "string", "recipients": {"emails": ["string"], "httpServerIds": ["string"], "smsNumbers": ["string"]}, "schedule": {"id": "string", "name": "string"}, "serials": ["string"]}

Авторы

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_sensor_alerts_profiles_module.html