Try SpotterInformation module for networks _events
| "added in version" 2.16.0 of cisco.meraki"
Authors: Francisco Munoz (@fmunoz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections:
- name: cisco.meraki
version: 2.18.0Get all networks _events.
List the events for the network.
- 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
headers:
description: Additional headers.
type: dict
perPage:
description:
- PerPage query parameter. The number of entries per page returned. Acceptable range
is 3 - 1000. Default is 10.
type: int
clientIp:
description:
- 'ClientIp query parameter. The IP of the client which the list of events will be
filtered with. Only supported for track-by-IP networks.
'
type: str
clientMac:
description:
- '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.
'
type: str
deviceMac:
description:
- DeviceMac query parameter. The MAC address of the Meraki device which the list of
events will be filtered with.
type: str
direction:
default: https://api.meraki.com/api/v1
description:
- direction (string), direction to paginate, either "next" (default) or "prev" page
type: str
networkId:
description:
- NetworkId path parameter. Network ID.
type: str
clientName:
description:
- 'ClientName query parameter. The name, or partial name, of the client which the
list of events will be filtered with.
'
type: str
deviceName:
description:
- DeviceName query parameter. The name of the Meraki device which the list of events
will be filtered with.
type: str
productType:
description:
- '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.
'
type: str
smDeviceMac:
description:
- 'SmDeviceMac query parameter. The MAC address of the Systems Manager device which
the list of events will be filtered with.
'
type: str
total_pages:
description:
- total_pages(int), use with perPage to get total results up to total_pages*perPage;
-1 for all pages
required: true
type: str
deviceSerial:
description:
- DeviceSerial query parameter. The serial of the Meraki device which the list of
events will be filtered with.
type: str
endingBefore:
description:
- '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.
'
type: str
smDeviceName:
description:
- 'SmDeviceName query parameter. The name of the Systems Manager device which the
list of events will be filtered with.
'
type: str
meraki_caller:
default: ''
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be
set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
startingAfter:
description:
- '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.
'
type: str
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment
variable MERAKI_DASHBOARD_API_KEY
required: true
type: str
meraki_base_url:
default: https://api.meraki.com/api/v1
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
meraki_log_path:
default: ''
description:
- log_path (string), path to output log; by default, working directory of script if
not specified
type: str
meraki_simulate:
default: false
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
meraki_be_geo_id:
default: ''
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can
also be set as an environment variable BE_GEO_ID
type: str
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
type: bool
excludedEventTypes:
description:
- 'ExcludedEventTypes query parameter. A list of event types. The returned events
will be filtered to exclude events with these types.
'
elements: str
type: list
includedEventTypes:
description:
- 'IncludedEventTypes query parameter. A list of event types. The returned events
will be filtered to only include events with these types.
'
elements: str
type: list
meraki_print_console:
default: true
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
meraki_requests_proxy:
default: ''
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
meraki_log_file_prefix:
default: meraki_api_
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
meraki_maximum_retries:
default: 2
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering
429s or other server-side errors
type: int
meraki_retry_4xx_error:
default: false
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides
429)?
type: bool
meraki_certificate_path:
default: ''
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind
local proxy
type: str
meraki_suppress_logging:
default: false
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
meraki_wait_on_rate_limit:
default: true
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
meraki_inherit_logging_config:
default: false
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
meraki_single_request_timeout:
default: 60
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API
call
type: int
meraki_nginx_429_retry_wait_time:
default: 60
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
meraki_retry_4xx_error_wait_time:
default: 60
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
meraki_use_iterator_for_get_pages:
default: false
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator
with each object instead of a complete list with all items
type: bool
meraki_action_batch_retry_wait_time:
default: 60
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry
wait time
type: int
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki
Python SDK
returned: always
sample: "{\n \"events\": [\n {\n \"category\": \"string\",\n \"clientDescription\"\
: \"string\",\n \"clientId\": \"string\",\n \"clientMac\": \"string\"\
,\n \"description\": \"string\",\n \"deviceName\": \"string\",\n \
\ \"deviceSerial\": \"string\",\n \"eventData\": {\n \"aid\": \"\
string\",\n \"channel\": \"string\",\n \"client_ip\": \"string\"\
,\n \"client_mac\": \"string\",\n \"radio\": \"string\",\n \
\ \"rssi\": \"string\",\n \"vap\": \"string\"\n },\n \"networkId\"\
: \"string\",\n \"occurredAt\": \"string\",\n \"ssidNumber\": 0,\n \
\ \"type\": \"string\"\n }\n ],\n \"message\": \"string\",\n \"pageEndAt\"\
: \"string\",\n \"pageStartAt\": \"string\"\n}\n"
type: dict