#!/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_switch_ports_usage_history_by_device_by_interval_info
short_description: Information module for organizations _switch _ports _usage _history
  _by _device _by _interval
description:
  - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
  - Get all organizations _switch _ports _usage _history _by _device _by _interval.
  - List the historical usage and traffic data of switchports in an 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 Switch Ports Usage History By Device By Interval Info.
      - OrganizationId path parameter. Organization ID.
    type: str
  t0:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - T0 query parameter. The beginning of the timespan for the data. The maximum
        lookback period is 31 days from today.
    type: str
  t1:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - T1 query parameter. The end of the timespan for the data. T1 can be a maximum
        of 31 days after t0.
    type: str
  timespan:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval 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 1 day.
        If interval is provided, the timespan will be autocalculated.
    type: float
  interval:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - >
        Interval query parameter. The time interval in seconds for returned data.
        The valid intervals are 300, 1200, 14400, 86400. The default is 1200. Interval
        is calculated if time params are provided.
    type: int
  perPage:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - PerPage query parameter. The number of entries per page returned. Acceptable
        range is 3 - 50. Default is 10.
    type: int
  startingAfter:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval 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 Switch Ports Usage History By Device By Interval 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
  configurationUpdatedAfter:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - >
        ConfigurationUpdatedAfter query parameter. Optional parameter to filter items
        to switches where the configuration has been updated after the given timestamp.
    type: str
  mac:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - >
        Mac query parameter. Optional parameter to filter items to switches with MAC
        addresses that contain the search term or are an exact match.
    type: str
  macs:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - Macs query parameter. Optional parameter to filter items to switches that
        have one of the provided MAC addresses.
    elements: str
    type: list
  name:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - >
        Name query parameter. Optional parameter to filter items to switches with
        names that contain the search term or are an exact match.
    type: str
  networkIds:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - NetworkIds query parameter. Optional parameter to filter items to switches
        in one of the provided networks.
    elements: str
    type: list
  portProfileIds:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - >
        PortProfileIds query parameter. Optional parameter to filter items to switches
        that contain switchports belonging to one of the specified port profiles.
    elements: str
    type: list
  serial:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - >
        Serial query parameter. Optional parameter to filter items to switches with
        serial number that contains the search term or are an exact match.
    type: str
  serials:
    description:
      - Information module for Organizations Switch Ports Usage History By Device By Interval Info.
      - Serials query parameter. Optional parameter to filter items to switches that
        have one of the provided serials.
    elements: str
    type: list
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for switch getOrganizationSwitchPortsUsageHistoryByDeviceByInterval
    description: Complete reference of the getOrganizationSwitchPortsUsageHistoryByDeviceByInterval
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-organization-switch-ports-usage-history-by-device-by-interval
notes:
  - SDK Method used are
    switch.Switch.get_organization_switch_ports_usage_history_by_device_by_interval,
  - Paths used are
    get /organizations/{organizationId}/switch/ports/usage/history/byDevice/byInterval,
"""

EXAMPLES = r"""
- name: Get all organizations _switch _ports _usage _history _by _device _by _interval
  cisco.meraki.organizations_switch_ports_usage_history_by_device_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_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
    interval: 0
    perPage: 0
    startingAfter: string
    endingBefore: string
    configurationUpdatedAfter: string
    mac: string
    macs: []
    name: string
    networkIds: []
    portProfileIds: []
    serial: string
    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: dict
  sample: >
    {
      "items": [
        {
          "name": "string",
          "serial": "string",
          "mac": "string",
          "network": {
            "name": "string",
            "id": "string"
          },
          "model": "string",
          "ports": [
            {
              "portId": "string",
              "intervals": [
                {
                  "startTs": "string",
                  "endTs": "string",
                  "data": {
                    "usage": {
                      "total": 0,
                      "upstream": 0,
                      "downstream": 0
                    }
                  },
                  "bandwidth": {
                    "usage": {
                      "total": 0,
                      "upstream": 0,
                      "downstream": 0
                    }
                  },
                  "energy": {
                    "usage": {
                      "total": 0
                    }
                  }
                }
              ]
            }
          ]
        }
      ],
      "meta": {
        "counts": {
          "items": {
            "total": 0,
            "remaining": 0
          }
        }
      }
    }
"""
