cisco.meraki.networks_events_info module – Information module for networks _events
Note
This module is part of the cisco.meraki collection (version 2.17.0).
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_events_info.
New in cisco.meraki 2.16.0
Synopsis
Get all networks _events.
List the events for the 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 |
|---|---|
ClientIp query parameter. The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. |
|
ClientMac query parameter. The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. |
|
ClientName query parameter. The name, or partial name, of the client which the list of events will be filtered with. |
|
DeviceMac query parameter. The MAC address of the Meraki device which the list of events will be filtered with. |
|
DeviceName query parameter. The name of the Meraki device which the list of events will be filtered with. |
|
DeviceSerial query parameter. The serial of the Meraki device which the list of events will be filtered with. |
|
direction (string), direction to paginate, either “next” (default) or “prev” page Default: |
|
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. |
|
ExcludedEventTypes query parameter. A list of event types. The returned events will be filtered to exclude events with these types. |
|
Additional headers. |
|
IncludedEventTypes query parameter. A list of event types. The returned events will be filtered to only include events with these types. |
|
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_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER 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:
|
|
NetworkId path parameter. Network ID. |
|
PerPage query parameter. The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. |
|
ProductType query parameter. The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway. |
|
SmDeviceMac query parameter. The MAC address of the Systems Manager device which the list of events will be filtered with. |
|
SmDeviceName query parameter. The name of the Systems Manager device which the list of events will be filtered with. |
|
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. |
|
total_pages(int), use with perPage to get total results up to total_pages*perPage; -1 for all pages |
Notes
Note
SDK Method used are networks.Networks.get_network_events,
Paths used are get /networks/{networkId}/events,
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 networks getNetworkEvents
Complete reference of the getNetworkEvents API.
Examples
- name: Get all networks _events
cisco.meraki.networks_events_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}}"
productType: string
includedEventTypes: []
excludedEventTypes: []
deviceMac: string
deviceSerial: string
deviceName: string
clientIp: string
clientMac: string
clientName: string
smDeviceMac: string
smDeviceName: string
perPage: 0
startingAfter: string
endingBefore: string
networkId: string
total_pages: -1
direction: next
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: |