cisco.meraki.organizations_api_requests_overview_response_codes_by_interval_info module – Information module for organizations _apirequests _overview _responsecodes _byinterval

Note

This module is part of the cisco.meraki collection (version 2.18.2).

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.organizations_api_requests_overview_response_codes_by_interval_info.

New in cisco.meraki 2.16.0

Synopsis

  • Get all organizations _apirequests _overview _responsecodes _byinterval.

  • Tracks organizations’ API requests by response code across a given time period.

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

adminIds

list / elements=string

AdminIds query parameter. Filter by admin ID of user that made the API request.

headers

dictionary

Additional headers.

interval

integer

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.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time

Default: 60

meraki_api_key

string / required

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

meraki_base_url (string), preceding all endpoint resources

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

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

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

meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), Inherits your own logger instance

Choices:

  • false ← (default)

  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (string), log file name appended with date and timestamp

Default: "meraki_api_"

meraki_log_path

string

log_path (string), path to output log; by default, working directory of script if not specified

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time

Default: 60

meraki_output_log

boolean

meraki_output_log (boolean), create an output log file?

Choices:

  • false

  • true ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), print logging output to console?

Choices:

  • false

  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)?

Choices:

  • false ← (default)

  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time

Default: 60

meraki_simulate

boolean

meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?

Choices:

  • false ← (default)

  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), maximum number of seconds for each API call

Default: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), disable all logging? you’re on your own then!

Choices:

  • false ← (default)

  • true

meraki_use_iterator_for_get_pages

boolean

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:

  • false ← (default)

  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?

Choices:

  • false

  • true ← (default)

operationIds

list / elements=string

OperationIds query parameter. Filter by operation ID of the endpoint.

organizationId

string

OrganizationId path parameter. Organization ID.

sourceIps

list / elements=string

SourceIps query parameter. Filter by source IP that made the API request.

t0

string

T0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

t1

string

T1 query parameter. The end of the timespan for the data. T1 can be a maximum of 31 days after t0.

timespan

float

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.

userAgent

string

UserAgent query parameter. Filter by user agent string for API request. This will filter by a complete or partial match.

version

integer

Version query parameter. Filter by API version of the endpoint. Allowable values are 0, 1.

Notes

Note

  • SDK Method used are organizations.Organizations.get_organization_api_requests_overview_response_codes_by_interval,

  • Paths used are get /organizations/{organizationId}/apiRequests/overview/responseCodes/byInterval,

  • Supports check_mode

  • The 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 getOrganizationApiRequestsOverviewResponseCodesByInterval

Complete reference of the getOrganizationApiRequestsOverviewResponseCodesByInterval API.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meraki_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco Meraki Python SDK

Returned: always

Sample: "[\n  {\n    \"counts\": [\n      {\n        \"code\": 0,\n        \"count\": 0\n      }\n    ],\n    \"endTs\": \"string\",\n    \"startTs\": \"string\"\n  }\n]\n"

Authors

  • Francisco Munoz (@fmunoz)