cisco / cisco.meraki / 2.18.0 / module / organizations_api_requests_info Information module for organizations _apirequests | "added in version" 2.16.0 of cisco.meraki" Authors: Francisco Munoz (@fmunoz) This plugin has a corresponding action plugin.cisco.meraki.organizations_api_requests_info (2.18.0) — module
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections: - name: cisco.meraki version: 2.18.0
Get all organizations _apirequests.
List the API requests made by an organization.
- 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_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
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 path: description: - Path query parameter. Filter the results by the path of the API requests. type: str method: description: - 'Method query parameter. Filter the results by the method of the API requests (must be ''GET'', ''PUT'', ''POST'' or ''DELETE''). ' type: str adminId: description: - AdminId query parameter. Filter the results by the ID of the admin who made the API requests. type: str 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 50. type: int version: description: - Version query parameter. Filter the results by the API version of the API request. type: int sourceIp: description: - SourceIp query parameter. Filter the results by the IP address of the originating API request. type: str 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. ' type: float direction: default: https://api.meraki.com/api/v1 description: - direction (string), direction to paginate, either "next" (default) or "prev" page type: str userAgent: description: - UserAgent query parameter. Filter the results by the user agent string of the API request. 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 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 operationIds: description: - OperationIds query parameter. Filter the results by one or more operation IDs for the API request. elements: str type: list responseCode: description: - ResponseCode query parameter. Filter the results by the response code of the API requests. type: int 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 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 \"adminId\": \"string\",\n \"host\": \"string\",\n \"\ method\": \"string\",\n \"operationId\": \"string\",\n \"path\": \"string\"\ ,\n \"queryString\": \"string\",\n \"responseCode\": 0,\n \"sourceIp\"\ : \"string\",\n \"ts\": \"string\",\n \"userAgent\": \"string\",\n \"\ version\": 0\n }\n]\n" type: list