cisco.meraki.networks_alerts_settings module – Resource module for networks _alerts _settings
Note
This module is part of the cisco.meraki collection (version 2.21.8).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.meraki.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.meraki.networks_alerts_settings.
New in cisco.meraki 1.0.0
Synopsis
Manage operation update of the resource networks _alerts _settings.
Update the alert configuration for this network.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
meraki >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Alert-specific configuration for each type. Only alerts that pertain to the network can be updated. |
|
A hash of destinations for this specific alert. |
|
If true, then all network admins will receive emails for this alert. Choices:
|
|
A list of emails that will receive information about the alert. |
|
A list of HTTP server IDs to send a Webhook to for this alert. |
|
A list of phone numbers that will receive text messages about the alert. Only available for sensors status alerts. |
|
If true, then an SNMP trap will be sent for this alert if there is an SNMP trap server configured for this network. Choices:
|
|
A boolean depicting if the alert is turned on or off. Choices:
|
|
A hash of specific configuration data for the alert. Only filters specific to the alert will be updated. |
|
Conditions. |
|
Direction. |
|
Duration. |
|
Threshold. |
|
Type of condition. |
|
Unit. |
|
Failure Type. |
|
Loopback Window (in sec). |
|
Min Duration. |
|
Name. |
|
Period. |
|
Priority. |
|
Regex. |
|
Selector. |
|
Serials. |
|
SSID Number. |
|
Tag. |
|
Threshold. |
|
Timeout. |
|
The type of alert. |
|
The network-wide destinations for all alerts on the network. |
|
If true, then all network admins will receive emails. Choices:
|
|
A list of emails that will receive the alert(s). |
|
A list of HTTP server IDs to send a Webhook to. |
|
If true, then an SNMP trap will be sent if there is an SNMP trap server configured for this network. Choices:
|
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: |
|
meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string), preceding all endpoint resources Default: |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: |
|
meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices:
|
|
meraki_log_file_prefix (string), log file name appended with date and timestamp Default: |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: |
|
meraki_output_log (boolean), create an output log file? Choices:
|
|
meraki_print_console (boolean), print logging output to console? Choices:
|
|
meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: |
|
meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices:
|
|
meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: |
|
meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices:
|
|
meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: |
|
meraki_suppress_logging (boolean), disable all logging? you’re on your own then! Choices:
|
|
meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items Choices:
|
|
meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices:
|
|
Mute alerts under certain conditions. |
|
Mute wireless unreachable alerts based on switch port schedules. |
|
If true, then wireless unreachable alerts will be muted when caused by a port schedule. Choices:
|
|
NetworkId path parameter. Network ID. |
Notes
Note
SDK Method used are networks.Networks.update_network_alerts_settings,
Paths used are put /networks/{networkId}/alerts/settings,
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager
from Cisco Dashboard API Python(SDK)
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco Meraki documentation for networks updateNetworkAlertsSettings
Complete reference of the updateNetworkAlertsSettings API.
Examples
- name: Update all
cisco.meraki.networks_alerts_settings:
meraki_api_key: "{{ meraki_api_key }}"
meraki_base_url: "{{ meraki_base_url }}"
meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
meraki_certificate_path: "{{ meraki_certificate_path }}"
meraki_requests_proxy: "{{ meraki_requests_proxy }}"
meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
meraki_maximum_retries: "{{ meraki_maximum_retries }}"
meraki_output_log: "{{ meraki_output_log }}"
meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
meraki_log_path: "{{ meraki_log_path }}"
meraki_print_console: "{{ meraki_print_console }}"
meraki_suppress_logging: "{{ meraki_suppress_logging }}"
meraki_simulate: "{{ meraki_simulate }}"
meraki_be_geo_id: "{{ meraki_be_geo_id }}"
meraki_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
alerts:
- alertDestinations:
allAdmins: false
emails:
- [email protected]
httpServerIds:
- aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
smsNumbers:
- '+15555555555'
snmp: false
enabled: true
filters:
conditions:
- direction: +
duration: 0
threshold: 72.5
type: temperature
unit: celsius
failureType: 802.1X auth fail
lookbackWindow: 360
minDuration: 60
name: Filter
period: 1800
priority: ''
regex: '[a-z]'
selector: '{"smartSensitivity":"medium","smartEnabled":false,"eventReminderPeriodSecs":10800}'
serials:
- Q234-ABCD-0001
- Q234-ABCD-0002
- Q234-ABCD-0003
ssidNum: 1
tag: tag1
threshold: 30
timeout: 60
type: gatewayDown
defaultDestinations:
allAdmins: true
emails:
- [email protected]
httpServerIds:
- aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
snmp: true
muting:
byPortSchedules:
enabled: true
networkId: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Meraki Python SDK Returned: always Sample: |