cisco / cisco.meraki / 2.9.0 / module / meraki_alert Manage alerts in the Meraki cloud | "added in version" 2.1.0 of cisco.meraki" Authors: Kevin Breit (@kbreit) preview | supported by communitycisco.meraki.meraki_alert (2.9.0) — module
Install with ansible-galaxy collection install cisco.meraki:==2.9.0
collections: - name: cisco.meraki version: 2.9.0
Allows for creation, management, and visibility into alert settings within Meraki.
- name: Update settings meraki_alert: auth_key: abc123 org_name: YourOrg net_name: YourNet state: present default_destinations: emails: - 'youremail@yourcorp' - 'youremail2@yourcorp' all_admins: yes snmp: no alerts: - type: "gatewayDown" enabled: yes filters: timeout: 60 alert_destinations: emails: - 'youremail@yourcorp' - 'youremail2@yourcorp' all_admins: yes snmp: no - type: "usageAlert" enabled: yes filters: period: 1200 threshold: 104857600 alert_destinations: emails: - 'youremail@yourcorp' - 'youremail2@yourcorp' all_admins: yes snmp: no
- name: Query all settings meraki_alert: auth_key: abc123 org_name: YourOrg net_name: YourNet state: query delegate_to: localhost
host: default: api.meraki.com description: - Hostname for Meraki dashboard. - Can be used to access regional Meraki environments, such as China. type: str state: choices: - present - query default: present description: - Create or modify an alert. type: str alerts: description: - Alert-specific configuration for each type. elements: dict suboptions: alert_destinations: description: - A hash of destinations for this specific alert. suboptions: all_admins: description: - If true, all network admins will receive emails. type: bool emails: description: - A list of emails that will recieve the alert(s). elements: str type: list http_server_ids: description: - A list of HTTP server IDs to send a Webhook to. elements: str type: list snmp: description: - If true, then an SNMP trap will be sent if there is an SNMP trap server configured for this network. type: bool type: dict alert_type: description: - The type of alert. type: str enabled: description: - A boolean depicting if the alert is turned on or off. type: bool filters: description: - A hash of specific configuration data for the alert. Only filters specific to the alert will be updated. - No validation checks occur against C(filters). type: raw type: list net_id: description: - ID number of a network. type: str org_id: description: - ID of organization. type: str timeout: default: 30 description: - Time to timeout for HTTP requests. type: int auth_key: description: - Authentication key provided by the dashboard. Required if environmental variable C(MERAKI_KEY) is not set. required: true type: str net_name: aliases: - name - network description: - Name of a network. type: str org_name: aliases: - organization description: - Name of organization. type: str use_https: default: true description: - If C(no), it will use HTTP. Otherwise it will use HTTPS. - Only useful for internal Meraki developers. type: bool use_proxy: default: false description: - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. type: bool output_level: choices: - debug - normal default: normal description: - Set amount of debug output during module execution. type: str output_format: choices: - snakecase - camelcase default: snakecase description: - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel case (ex. C(netId)). type: str validate_certs: default: true description: - Whether to validate HTTP certificates. type: bool default_destinations: description: - Properties for destinations when alert specific destinations aren't specified. suboptions: all_admins: description: - If true, all network admins will receive emails. type: bool emails: description: - A list of emails that will recieve the alert(s). elements: str type: list http_server_ids: description: - A list of HTTP server IDs to send a Webhook to. elements: str type: list snmp: description: - If true, then an SNMP trap will be sent if there is an SNMP trap server configured for this network. type: bool type: dict rate_limit_retry_time: default: 165 description: - Number of seconds to retry if rate limiter is triggered. type: int internal_error_retry_time: default: 60 description: - Number of seconds to retry if server returns an internal server error. type: int
data: contains: alerts: contains: alert_destinations: contains: all_admins: description: If true, all network admins will receive emails. returned: success type: bool emails: description: A list of emails that will recieve the alert(s). returned: success type: list http_server_ids: description: A list of HTTP server IDs to send a Webhook to. returned: success type: list snmp: description: If true, then an SNMP trap will be sent if there is an SNMP trap server configured for this network. returned: success type: bool description: A hash of destinations for this specific alert. type: complex enabled: description: A boolean depicting if the alert is turned on or off. returned: success type: bool filters: description: - A hash of specific configuration data for the alert. Only filters specific to the alert will be updated. - No validation checks occur against C(filters). returned: success type: complex type: description: The type of alert. returned: success type: str description: Alert-specific configuration for each type. type: complex default_destinations: contains: all_admins: description: If true, all network admins will receive emails. returned: success sample: true type: bool emails: description: A list of emails that will recieve the alert(s). returned: success type: list http_server_ids: description: A list of HTTP server IDs to send a Webhook to. returned: success type: list snmp: description: If true, then an SNMP trap will be sent if there is an SNMP trap server configured for this network. returned: success sample: true type: bool description: Properties for destinations when alert specific destinations aren't specified. returned: success type: complex description: Information about the created or manipulated object. returned: info type: complex