cisco.meraki.organizations_api_requests_info module -- Information module for organizations _apirequests
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_api_requests_info.
New in cisco.meraki 1.0.0
Synopsis
Information module for Organizations Apirequests Info.
Get all organizations _apirequests.
List the API requests made by 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 Apirequests Info. AdminId query parameter. Filter the results by the ID of the admin who made the API requests. |
|
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 Apirequests 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. |
|
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 Apirequests Info. Method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE'). |
|
Information module for Organizations Apirequests Info. OperationIds query parameter. Filter the results by one or more operation IDs for the API request. |
|
Information module for Organizations Apirequests Info. OrganizationId path parameter. Organization ID. |
|
Information module for Organizations Apirequests Info. Path query parameter. Filter the results by the path of the API requests. |
|
Information module for Organizations Apirequests Info. PerPage query parameter. The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. |
|
Information module for Organizations Apirequests Info. ResponseCode query parameter. Filter the results by the response code of the API requests. |
|
Information module for Organizations Apirequests Info. SourceIp query parameter. Filter the results by the IP address of the originating API request. |
|
Information module for Organizations Apirequests 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 Apirequests Info. T0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today. |
|
Information module for Organizations Apirequests Info. T1 query parameter. The end of the timespan for the data. T1 can be a maximum of 31 days after t0. |
|
Information module for Organizations Apirequests Info. 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. |
|
total_pages(int), use with perPage to get total results up to total_pages*perPage; -1 for all pages |
|
Information module for Organizations Apirequests Info. UserAgent query parameter. Filter the results by the user agent string of the API request. |
|
Information module for Organizations Apirequests Info. Version query parameter. Filter the results by the API version of the API request. |
Notes
Note
SDK Method used are organizations.Organizations.get_organization_api_requests,
Paths used are get /organizations/{organizationId}/apiRequests,
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 getOrganizationApiRequests
Complete reference of the getOrganizationApiRequests API.
Examples
- name: Get all organizations _apirequests
cisco.meraki.organizations_api_requests_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 }}"
t0: string
t1: string
timespan: 0
perPage: 0
startingAfter: string
endingBefore: string
adminId: string
path: string
method: string
responseCode: 0
sourceIp: string
userAgent: string
version: 0
operationIds: []
organizationId: 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 |