Try SpotterInformation module for organizations _apirequests _overview _responsecodes _byinterval
| "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 organizations _apirequests _overview _responsecodes _byinterval.
Tracks organizations' API requests by response code across a given time period.
- name: Get all organizations _apirequests _overview _responsecodes _byinterval
cisco.meraki.organizations_api_requests_overview_response_codes_by_interval_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}}"
t0: string
t1: string
timespan: 0
interval: 0
version: 0
operationIds: []
sourceIps: []
adminIds: []
userAgent: string
organizationId: string
register: result
t0:
description:
- T0 query parameter. The beginning of the timespan for the data. The maximum lookback
period is 31 days from today.
type: str
t1:
description:
- T1 query parameter. The end of the timespan for the data. T1 can be a maximum of
31 days after t0.
type: str
headers:
description: Additional headers.
type: dict
version:
description:
- Version query parameter. Filter by API version of the endpoint. Allowable values
are 0, 1.
type: int
adminIds:
description:
- AdminIds query parameter. Filter by admin ID of user that made the API request.
elements: str
type: list
interval:
description:
- 'Interval query parameter. The time interval in seconds for returned data. The valid
intervals are 120, 3600, 14400, 21600. The default is 21600. Interval is calculated
if time params are provided.
'
type: int
timespan:
description:
- 'Timespan query parameter. The timespan for which the information will be fetched.
If specifying timespan, do not specify parameters t0 and t1. The value must be in
seconds and be less than or equal to 31 days. The default is 31 days. If interval
is provided, the timespan will be autocalculated.
'
type: float
sourceIps:
description:
- SourceIps query parameter. Filter by source IP that made the API request.
elements: str
type: list
userAgent:
description:
- 'UserAgent query parameter. Filter by user agent string for API request. This will
filter by a complete or partial match.
'
type: str
operationIds:
description:
- OperationIds query parameter. Filter by operation ID of the endpoint.
elements: str
type: list
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
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
organizationId:
description:
- OrganizationId path parameter. Organization ID.
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
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
elements: dict
returned: always
sample: "[\n {\n \"counts\": [\n {\n \"code\": 0,\n \"count\"\
: 0\n }\n ],\n \"endTs\": \"string\",\n \"startTs\": \"string\"\n\
\ }\n]\n"
type: list