cisco.meraki.organizations_assurance_alerts_info module -- Information module for organizations _assurance _alerts
Note
This module is part of the cisco.meraki collection (version 2.22.0).
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_info.
New in cisco.meraki 1.0.0
Synopsis
Information module for Organizations Assurance Alerts Info.
Get all organizations _assurance _alerts.
Get organizations _assurance _alerts by id.
Return a singular Health Alert by its id.
Return all 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 |
|---|---|
Information module for Organizations Assurance Alerts Info. Active query parameter. Optional parameter to filter by active alerts defaults to true. Choices: |
|
Information module for Organizations Assurance Alerts Info. Category query parameter. Optional parameter to filter by category. |
|
Information module for Organizations Assurance Alerts Info. DeviceTags query parameter. Optional parameter to filter by device tags. |
|
Information module for Organizations Assurance Alerts Info. DeviceTypes query parameter. Optional parameter to filter by device types. |
|
direction (string), direction to paginate, either "next" (default) or "prev" page Default: :ansible-option-default:`"https://api.meraki.com/api/v1"` |
|
Information module for Organizations Assurance Alerts Info. Dismissed query parameter. Optional parameter to filter by dismissed alerts defaults to false. Choices: |
|
Information module for Organizations Assurance Alerts Info. EndingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
|
Additional headers. |
|
Information module for Organizations Assurance Alerts Info. Id path parameter. |
|
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: |
|
Information module for Organizations Assurance Alerts Info. NetworkId query parameter. Optional parameter to filter alerts by network ids. |
|
Information module for Organizations Assurance Alerts Info. OrganizationId path parameter. Organization ID. |
|
Information module for Organizations Assurance Alerts Info. PerPage query parameter. The number of entries per page returned. Acceptable range is 4 - 300. Default is 30. |
|
Information module for Organizations Assurance Alerts Info. Resolved query parameter. Optional parameter to filter by resolved alerts defaults to false. Choices: |
|
Information module for Organizations Assurance Alerts Info. Serials query parameter. Optional parameter to filter by primary device serial. |
|
Information module for Organizations Assurance Alerts Info. Severity query parameter. Optional parameter to filter by severity type. |
|
Information module for Organizations Assurance Alerts Info. SortBy query parameter. Optional parameter to set column to sort by. |
|
Information module for Organizations Assurance Alerts Info. SortOrder query parameter. Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'ascending'. |
|
Information module for Organizations Assurance Alerts Info. StartingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
|
Information module for Organizations Assurance Alerts Info. 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: |
|
total_pages(int), use with perPage to get total results up to total_pages*perPage; -1 for all pages |
|
Information module for Organizations Assurance Alerts Info. TsEnd query parameter. Optional parameter to filter by end timestamp. |
|
Information module for Organizations Assurance Alerts Info. TsStart query parameter. Optional parameter to filter by starting timestamp. |
|
Information module for Organizations Assurance Alerts Info. Types query parameter. Optional parameter to filter by alert type. |
Notes
Note
SDK Method used are organizations.Organizations.get_organization_assurance_alert, organizations.Organizations.get_organization_assurance_alerts,
Paths used are get /organizations/{organizationId}/assurance/alerts, get /organizations/{organizationId}/assurance/alerts/{id},
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 getOrganizationAssuranceAlert
Complete reference of the getOrganizationAssuranceAlert API.
- Cisco Meraki documentation for organizations getOrganizationAssuranceAlerts
Complete reference of the getOrganizationAssuranceAlerts API.
Examples
- name: Get all organizations _assurance _alerts
cisco.meraki.organizations_assurance_alerts_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_caller: "{{ meraki_caller }}"
meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
perPage: 0
startingAfter: string
endingBefore: string
sortOrder: string
networkId: string
severity: string
types: []
tsStart: string
tsEnd: string
category: string
sortBy: string
serials: []
deviceTypes: []
deviceTags: []
active: true
dismissed: true
resolved: true
suppressAlertsForOfflineNodes: true
organizationId: string
total_pages: -1
direction: next
register: result
- name: Get organizations _assurance _alerts by id
cisco.meraki.organizations_assurance_alerts_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_caller: "{{ meraki_caller }}"
meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
organizationId: string
id: 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 |