Try SpotterInformation module for networks _wireless _channelutilizationhistory
| "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 _wireless _channelutilizationhistory.
Return AP channel utilization over time for a device or network client.
- name: Get all networks _wireless _channelutilizationhistory
cisco.meraki.networks_wireless_channel_utilization_history_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
resolution: 0
autoResolution: True
clientId: string
deviceSerial: string
apTag: string
band: string
networkId: 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
band:
description:
- Band query parameter. Filter results by band (either '2.4', '5' or '6').
type: str
apTag:
description:
- 'ApTag query parameter. Filter results by AP tag to return AP channel utilization
metrics for devices labeled with the given tag; either clientId or deviceSerial
must be jointly specified.
'
type: str
headers:
description: Additional headers.
type: dict
clientId:
description:
- 'ClientId query parameter. Filter results by network client to return per-device,
per-band AP channel utilization metrics inner joined by the queried client''s connection
history.
'
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 7 days.
'
type: float
networkId:
description:
- NetworkId path parameter. Network ID.
type: str
resolution:
description:
- 'Resolution query parameter. The time resolution in seconds for returned data. The
valid resolutions are 600, 1200, 3600, 14400, 86400. The default is 86400.
'
type: int
deviceSerial:
description:
- 'DeviceSerial query parameter. Filter results by device to return AP channel utilization
metrics for the queried device; either band or clientId must be jointly specified.
'
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
autoResolution:
description:
- 'AutoResolution query parameter. Automatically select a data resolution based on
the given timespan; this overrides the value specified by the ''resolution'' parameter.
The default setting is false.
'
type: bool
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
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 \"endTs\": \"string\",\n \"startTs\": \"string\",\n \"\
utilization80211\": 0,\n \"utilizationNon80211\": 0,\n \"utilizationTotal\"\
: 0\n }\n]\n"
type: list