#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

DOCUMENTATION = r"""
module: organizations_wireless_devices_system_cpu_load_history_info
short_description: Information module for organizations _wireless _devices _system
  _cpu _load _history
description:
  - Information module for Organizations Wireless Devices System Cpu Load History Info.
  - Get all organizations _wireless _devices _system _cpu _load _history.
  - Return the CPU Load history for a list of wireless devices in the organization.
version_added: '1.0.0'
extends_documentation_fragment:
  - cisco.meraki.module_info
  - cisco.meraki.module_info_pagination
author: Francisco Munoz (@fmunoz)
options:
  headers:
    description: Additional headers.
    type: dict
  organizationId:
    description:
      - Information module for Organizations Wireless Devices System Cpu Load History Info.
      - OrganizationId path parameter. Organization ID.
    type: str
  t0:
    description:
      - Information module for Organizations Wireless Devices System Cpu Load History Info.
      - T0 query parameter. The beginning of the timespan for the data. The maximum
        lookback period is 1 day from today.
    type: str
  t1:
    description:
      - Information module for Organizations Wireless Devices System Cpu Load History Info.
      - T1 query parameter. The end of the timespan for the data. T1 can be a maximum
        of 1 day after t0.
    type: str
  timespan:
    description:
      - Information module for Organizations Wireless Devices System Cpu Load History 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 1 day. The default is 1 day.
    type: float
  perPage:
    description:
      - Information module for Organizations Wireless Devices System Cpu Load History Info.
      - PerPage query parameter. The number of entries per page returned. Acceptable
        range is 3 - 20. Default is 10.
    type: int
  startingAfter:
    description:
      - Information module for Organizations Wireless Devices System Cpu Load History 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.
    type: str
  endingBefore:
    description:
      - Information module for Organizations Wireless Devices System Cpu Load History 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.
    type: str
  networkIds:
    description:
      - Information module for Organizations Wireless Devices System Cpu Load History Info.
      - NetworkIds query parameter. Optional parameter to filter the result set by
        the included set of network IDs.
    elements: str
    type: list
  serials:
    description:
      - Information module for Organizations Wireless Devices System Cpu Load History Info.
      - Serials query parameter. Optional parameter to filter device availabilities
        history by device serial numbers.
    elements: str
    type: list
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for wireless getOrganizationWirelessDevicesSystemCpuLoadHistory
    description: Complete reference of the getOrganizationWirelessDevicesSystemCpuLoadHistory
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-organization-wireless-devices-system-cpu-load-history
notes:
  - SDK Method used are
    wireless.Wireless.get_organization_wireless_devices_system_cpu_load_history,
  - Paths used are
    get /organizations/{organizationId}/wireless/devices/system/cpu/load/history,
"""

EXAMPLES = r"""
- name: Get all organizations _wireless _devices _system _cpu _load _history
  cisco.meraki.organizations_wireless_devices_system_cpu_load_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_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
    networkIds: []
    serials: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result
"""
RETURN = r"""
meraki_response:
  description: A dictionary or list with the response returned by the Cisco Meraki Python SDK
  returned: always
  type: list
  elements: dict
  sample: >
    [
      {
        "serial": "string",
        "model": "string",
        "name": "string",
        "mac": "string",
        "tags": [
          "string"
        ],
        "network": {
          "id": "string",
          "name": "string",
          "tags": [
            "string"
          ]
        },
        "cpuCount": 0,
        "series": [
          {
            "ts": "string",
            "cpuLoad5": 0
          }
        ]
      }
    ]
"""
