Модуль cisco.meraki.networks_sensor_alerts_profiles — Модуль ресурсов для профилей оповещений о сенсорах сетей

Примечание

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

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

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

Для использования в книге задач укажите: cisco.meraki.networks_sensor_alerts_profiles.

Новое в cisco.meraki 2.16.0

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

Обзор

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

Примечание

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

Требования

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

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 час, 2 часа, 4 часа и 8 часов. Значение по умолчанию — 0.
metric string	Тип метрики датчика, который будет контролироваться на предмет изменений. Доступные метрики: apparentPower, co2, current, door, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, temperature, tvoc, upstreamPower, voltage и water.
threshold dictionary	Пороговое значение для показаний датчиков, которые приведут к отправке оповещения. Этот объект должен содержать один ключ свойства, соответствующий значению «metric» условия.
apparentPower dictionary	Пороговое значение кажущейся мощности. Необходимо указать ‘draw’.
draw float	Пороговое значение оповещения в вольт-амперах. Должно быть в диапазоне от 0 до 3750.
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. Choices: `false` `true`
voltage dictionary	Пороговое значение напряжения. Необходимо указать ‘level’.
level float	Пороговое значение для оповещения в вольтах. Должно быть в диапазоне от 0 до 250.
water dictionary	Пороговое значение обнаружения воды. Необходимо указать ‘present’ и установить значение true.
present boolean	Пороговое значение для оповещения о событии обнаружения воды. Должно быть установлено в true. Choices: `false` `true`
id string	Параметр пути Id.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий Default: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; может быть также установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем конечным точкам ресурсов Default: `"https://api.meraki.com/api/v1"`

meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная среды BE_GEO_ID Default: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр logger Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени Default: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до такого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повтора для ошибки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), выводить сообщения журнала на консоль? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повтора для других ошибок 4XX Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API Default: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все ведение журнала? тогда вы сами за себя! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Choices: `false` ← (default) `true`

meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить, если обнаружена ошибка ограничения скорости 429? Варианты: `false` `true` ← (по умолчанию)
name string	Название профиля оповещений о сенсорах.
networkId string	Параметр пути networkId. Идентификатор сети.
recipients dictionary	Список получателей, которые будут получать оповещения.
emails list / elements=string	Список адресов электронной почты, которые получат информацию об оповещении.
httpServerIds list / elements=string	Список идентификаторов конечных точек веб-хуков, которые получат информацию об оповещении.
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 DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki по сенсору createNetworkSensorAlertsProfile: Полное описание API createNetworkSensorAlertsProfile.
Документация Cisco Meraki по сенсору deleteNetworkSensorAlertsProfile: Полное описание API deleteNetworkSensorAlertsProfile.
Документация Cisco Meraki по сенсору 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_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
        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
    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_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

- 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_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
        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
    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

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: {"conditions": [{"direction": "string", "duration": 0, "metric": "string", "threshold": {"apparentPower": {"draw": 0}, "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}}}], "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}, "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}}}], "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/networks_sensor_alerts_profiles_module.html