cisco.meraki.organizations_assurance_alerts_overview_info module -- Information module for organizations _assurance _alerts _overview
Note
This module is part of the cisco.meraki collection (version 2.20.5).
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.organizations_assurance_alerts_overview_info.
New in cisco.meraki 2.20.0
Synopsis
Get all organizations _assurance _alerts _overview.
Return overview of active health alerts for an organization.
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 |
|---|---|
Active query parameter. Optional parameter to filter by active alerts defaults to true. Choices: |
|
Category query parameter. Optional parameter to filter by category. |
|
DeviceTags query parameter. Optional parameter to filter by device tags. |
|
DeviceTypes query parameter. Optional parameter to filter by device types. |
|
Dismissed query parameter. Optional parameter to filter by dismissed alerts defaults to false. Choices: |
|
Additional headers. |
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: :ansible-option-default:`60` |
|
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: :ansible-option-default:`"https://api.meraki.com/api/v1"` |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: :ansible-option-default:`""` |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: :ansible-option-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 |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: :ansible-option-default:`""` |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: :ansible-option-default:`2` |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: :ansible-option-default:`60` |
|
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: :ansible-option-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: :ansible-option-default:`60` |
|
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: :ansible-option-default:`60` |
|
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: |
|
NetworkId query parameter. Optional parameter to filter alerts overview by network ids. |
|
OrganizationId path parameter. Organization ID. |
|
Resolved query parameter. Optional parameter to filter by resolved alerts defaults to false. Choices: |
|
Serials query parameter. Optional parameter to filter by primary device serial. |
|
Severity query parameter. Optional parameter to filter alerts overview by severity type. |
|
SuppressAlertsForOfflineNodes query parameter. When set to true the api will only return connectivity alerts for a given device if that device is in an offline state. This only applies to devices. This is ignored when resolved is true. Example If a Switch has a VLan Mismatch and is Unreachable. Only the Unreachable alert will be returned. Defaults to false. Choices: |
|
TsEnd query parameter. Optional parameter to filter by end timestamp. |
|
TsStart query parameter. Optional parameter to filter by starting timestamp. |
|
Types query parameter. Optional parameter to filter by alert type. |
Notes
Note
SDK Method used are organizations.Organizations.get_organization_assurance_alerts_overview,
Paths used are get /organizations/{organizationId}/assurance/alerts/overview,
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco meraki SDK
The parameters starting with meraki_ are used by the Cisco meraki Python SDK to establish the connection
See Also
See also
- Cisco Meraki documentation for organizations getOrganizationAssuranceAlertsOverview
Complete reference of the getOrganizationAssuranceAlertsOverview API.
Examples
- name: Get all organizations _assurance _alerts _overview
cisco.meraki.organizations_assurance_alerts_overview_info:
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 }}'
networkId: string
severity: string
types: []
tsStart: string
tsEnd: string
category: string
serials: []
deviceTypes: []
deviceTags: []
active: true
dismissed: true
resolved: true
suppressAlertsForOfflineNodes: true
organizationId: string
register: result
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: :ansible-rv-sample-value:`{"bySeverity": [{"count": 0, "type": "string"}], "total": 0}` |