.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.meraki.networks_sensor_alerts_profiles module -- Resource module for networks \_sensor \_alerts \_profiles ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.meraki collection `_ (version 2.18.2). To install it, use: :code:`ansible-galaxy collection install cisco.meraki`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.meraki.networks_sensor_alerts_profiles`. .. version_added .. rst-class:: ansible-version-added New in cisco.meraki 2.16.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource networks \_sensor \_alerts \_profiles. - Creates a sensor alert profile for a network. - Deletes a sensor alert profile from a network. - Updates a sensor alert profile for a network. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - meraki \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions: .. rst-class:: ansible-option-title **conditions** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of conditions that will cause the profile to send an alert. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/direction: .. rst-class:: ansible-option-title **direction** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
If 'above', an alert will be sent when a sensor reads above the threshold. If 'below', an alert will be sent when a sensor reads below the threshold. Only applicable for temperature, humidity, realPower, apparentPower, powerFactor, voltage, current, and frequency thresholds. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/duration: .. rst-class:: ansible-option-title **duration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Length of time in seconds that the triggering state must persist before an alert is sent. Available options are 0 seconds, 1 minute, 2 minutes, 3 minutes, 4 minutes, 5 minutes, 10 minutes, 15 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, and 8 hours. Default is 0. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/metric: .. rst-class:: ansible-option-title **metric** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The type of sensor metric that will be monitored for changes. Available metrics are apparentPower, co2, current, door, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, temperature, tvoc, upstreamPower, voltage, and water. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold: .. rst-class:: ansible-option-title **threshold** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Threshold for sensor readings that will cause an alert to be sent. This object should contain a single property key matching the condition's 'metric' value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/apparentpower: .. rst-class:: ansible-option-title **apparentPower** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Apparent power threshold. 'draw' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/apparentpower/draw: .. rst-class:: ansible-option-title **draw** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Alerting threshold in volt-amps. Must be between 0 and 3750. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/current: .. rst-class:: ansible-option-title **current** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Electrical current threshold. 'level' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/current/draw: .. rst-class:: ansible-option-title **draw** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Alerting threshold in amps. Must be between 0 and 15. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/door: .. rst-class:: ansible-option-title **door** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Door open threshold. 'open' must be provided and set to true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/door/open: .. rst-class:: ansible-option-title **open** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Alerting threshold for a door open event. Must be set to true. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/frequency: .. rst-class:: ansible-option-title **frequency** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Electrical frequency threshold. 'level' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/frequency/level: .. rst-class:: ansible-option-title **level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Alerting threshold in hertz. Must be between 0 and 60. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/humidity: .. rst-class:: ansible-option-title **humidity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Humidity threshold. One of 'relativePercentage' or 'quality' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/humidity/quality: .. rst-class:: ansible-option-title **quality** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Alerting threshold as a qualitative humidity level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/humidity/relativepercentage: .. rst-class:: ansible-option-title **relativePercentage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Alerting threshold in %RH. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/indoorairquality: .. rst-class:: ansible-option-title **indoorAirQuality** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Indoor air quality score threshold. One of 'score' or 'quality' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/indoorairquality/quality: .. rst-class:: ansible-option-title **quality** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Alerting threshold as a qualitative indoor air quality level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/indoorairquality/score: .. rst-class:: ansible-option-title **score** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Alerting threshold as indoor air quality score. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/noise: .. rst-class:: ansible-option-title **noise** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Noise threshold. 'ambient' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/noise/ambient: .. rst-class:: ansible-option-title **ambient** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Ambient noise threshold. One of 'level' or 'quality' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/noise/ambient/level: .. rst-class:: ansible-option-title **level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Alerting threshold as adjusted decibels. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/noise/ambient/quality: .. rst-class:: ansible-option-title **quality** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Alerting threshold as a qualitative ambient noise level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/pm25: .. rst-class:: ansible-option-title **pm25** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
PM2.5 concentration threshold. One of 'concentration' or 'quality' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/pm25/concentration: .. rst-class:: ansible-option-title **concentration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Alerting threshold as PM2.5 parts per million. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/pm25/quality: .. rst-class:: ansible-option-title **quality** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Alerting threshold as a qualitative PM2.5 level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/powerfactor: .. rst-class:: ansible-option-title **powerFactor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Power factor threshold. 'percentage' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/powerfactor/percentage: .. rst-class:: ansible-option-title **percentage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Alerting threshold as the ratio of active power to apparent power. Must be between 0 and 100. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/realpower: .. rst-class:: ansible-option-title **realPower** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Real power threshold. 'draw' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/realpower/draw: .. rst-class:: ansible-option-title **draw** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Alerting threshold in watts. Must be between 0 and 3750. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/temperature: .. rst-class:: ansible-option-title **temperature** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Temperature threshold. One of 'celsius', 'fahrenheit', or 'quality' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/temperature/celsius: .. rst-class:: ansible-option-title **celsius** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Alerting threshold in degrees Celsius. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/temperature/fahrenheit: .. rst-class:: ansible-option-title **fahrenheit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Alerting threshold in degrees Fahrenheit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/temperature/quality: .. rst-class:: ansible-option-title **quality** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Alerting threshold as a qualitative temperature level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/tvoc: .. rst-class:: ansible-option-title **tvoc** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
TVOC concentration threshold. One of 'concentration' or 'quality' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/tvoc/concentration: .. rst-class:: ansible-option-title **concentration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Alerting threshold as TVOC micrograms per cubic meter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/tvoc/quality: .. rst-class:: ansible-option-title **quality** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Alerting threshold as a qualitative TVOC level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/upstreampower: .. rst-class:: ansible-option-title **upstreamPower** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Upstream power threshold. 'outageDetected' must be provided and set to true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/upstreampower/outagedetected: .. rst-class:: ansible-option-title **outageDetected** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Alerting threshold for an upstream power event. Must be set to true. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/voltage: .. rst-class:: ansible-option-title **voltage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Voltage threshold. 'level' must be provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/voltage/level: .. rst-class:: ansible-option-title **level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Alerting threshold in volts. Must be between 0 and 250. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/water: .. rst-class:: ansible-option-title **water** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Water detection threshold. 'present' must be provided and set to true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-conditions/threshold/water/present: .. rst-class:: ansible-option-title **present** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Alerting threshold for a water detection event. Must be set to true. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_action_batch_retry_wait_time: .. rst-class:: ansible-option-title **meraki_action_batch_retry_wait_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_action\_batch\_retry\_wait\_time (integer), action batch concurrency error retry wait time .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_api_key: .. rst-class:: ansible-option-title **meraki_api_key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
meraki\_api\_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI\_DASHBOARD\_API\_KEY .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_base_url: .. rst-class:: ansible-option-title **meraki_base_url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_base\_url (string), preceding all endpoint resources .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"https://api.meraki.com/api/v1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_be_geo_id: .. rst-class:: ansible-option-title **meraki_be_geo_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_be\_geo\_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE\_GEO\_ID .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_caller: .. rst-class:: ansible-option-title **meraki_caller** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI\_PYTHON\_SDK\_CALLER .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_certificate_path: .. rst-class:: ansible-option-title **meraki_certificate_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_certificate\_path (string), path for TLS/SSL certificate verification if behind local proxy .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_inherit_logging_config: .. rst-class:: ansible-option-title **meraki_inherit_logging_config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_inherit\_logging\_config (boolean), Inherits your own logger instance .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_log_file_prefix: .. rst-class:: ansible-option-title **meraki_log_file_prefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_log\_file\_prefix (string), log file name appended with date and timestamp .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"meraki\_api\_"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_log_path: .. rst-class:: ansible-option-title **meraki_log_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
log\_path (string), path to output log; by default, working directory of script if not specified .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_maximum_retries: .. rst-class:: ansible-option-title **meraki_maximum_retries** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_maximum\_retries (integer), retry up to this many times when encountering 429s or other server-side errors .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_nginx_429_retry_wait_time: .. rst-class:: ansible-option-title **meraki_nginx_429_retry_wait_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_nginx\_429\_retry\_wait\_time (integer), Nginx 429 retry wait time .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_output_log: .. rst-class:: ansible-option-title **meraki_output_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_output\_log (boolean), create an output log file? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_print_console: .. rst-class:: ansible-option-title **meraki_print_console** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_print\_console (boolean), print logging output to console? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_requests_proxy: .. rst-class:: ansible-option-title **meraki_requests_proxy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
meraki\_requests\_proxy (string), proxy server and port, if needed, for HTTPS .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`""` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_retry_4xx_error: .. rst-class:: ansible-option-title **meraki_retry_4xx_error** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_retry\_4xx\_error (boolean), retry if encountering other 4XX error (besides 429)? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_retry_4xx_error_wait_time: .. rst-class:: ansible-option-title **meraki_retry_4xx_error_wait_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_retry\_4xx\_error\_wait\_time (integer), other 4XX error retry wait time .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_simulate: .. rst-class:: ansible-option-title **meraki_simulate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_single_request_timeout: .. rst-class:: ansible-option-title **meraki_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
meraki\_single\_request\_timeout (integer), maximum number of seconds for each API call .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_suppress_logging: .. rst-class:: ansible-option-title **meraki_suppress_logging** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_suppress\_logging (boolean), disable all logging? you're on your own then! .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_use_iterator_for_get_pages: .. rst-class:: ansible-option-title **meraki_use_iterator_for_get_pages** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_use\_iterator\_for\_get\_pages (boolean), list\* methods will return an iterator with each object instead of a complete list with all items .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-meraki_wait_on_rate_limit: .. rst-class:: ansible-option-title **meraki_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
meraki\_wait\_on\_rate\_limit (boolean), retry if 429 rate limit error encountered? .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the sensor alert profile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-networkid: .. rst-class:: ansible-option-title **networkId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NetworkId path parameter. Network ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-recipients: .. rst-class:: ansible-option-title **recipients** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
List of recipients that will receive the alert. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-recipients/emails: .. rst-class:: ansible-option-title **emails** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
A list of emails that will receive information about the alert. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-recipients/httpserverids: .. rst-class:: ansible-option-title **httpServerIds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
A list of webhook endpoint IDs that will receive information about the alert. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-recipients/smsnumbers: .. rst-class:: ansible-option-title **smsNumbers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
A list of SMS numbers that will receive information about the alert. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-schedule: .. rst-class:: ansible-option-title **schedule** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The sensor schedule to use with the alert profile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-schedule/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of the sensor schedule to use with the alert profile. If not defined, the alert profile will be active at all times. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__parameter-serials: .. rst-class:: ansible-option-title **serials** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of device serials assigned to this sensor alert profile. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are sensor.Sensor.create\_network\_sensor\_alerts\_profile, sensor.Sensor.delete\_network\_sensor\_alerts\_profile, sensor.Sensor.update\_network\_sensor\_alerts\_profile, - Paths used are post /networks/{networkId}/sensor/alerts/profiles, delete /networks/{networkId}/sensor/alerts/profiles/{id}, put /networks/{networkId}/sensor/alerts/profiles/{id}, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco Meraki documentation for sensor createNetworkSensorAlertsProfile `_ Complete reference of the createNetworkSensorAlertsProfile API. `Cisco Meraki documentation for sensor deleteNetworkSensorAlertsProfile `_ Complete reference of the deleteNetworkSensorAlertsProfile API. `Cisco Meraki documentation for sensor updateNetworkSensorAlertsProfile `_ Complete reference of the updateNetworkSensorAlertsProfile API. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.meraki.networks_sensor_alerts_profiles_module__return-meraki_response: .. rst-class:: ansible-option-title **meraki_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Meraki Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"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"]}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Francisco Munoz (@fmunoz) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors