#!/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_devices_statuses_info
short_description: Information module for organizations _devices _statuses
description:
  - Information module for Organizations Devices Statuses Info.
  - Get all organizations _devices _statuses.
  - List the status of every Meraki device 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 Devices Statuses Info.
      - OrganizationId path parameter. Organization ID.
    type: str
  perPage:
    description:
      - Information module for Organizations Devices Statuses Info.
      - PerPage query parameter. The number of entries per page returned. Acceptable
        range is 3 - 1000. Default is 1000.
    type: int
  startingAfter:
    description:
      - Information module for Organizations Devices Statuses 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 Devices Statuses 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 Devices Statuses Info.
      - NetworkIds query parameter. Optional parameter to filter devices by network
        ids.
    elements: str
    type: list
  serials:
    description:
      - Information module for Organizations Devices Statuses Info.
      - Serials query parameter. Optional parameter to filter devices by serials.
    elements: str
    type: list
  statuses:
    description:
      - Information module for Organizations Devices Statuses Info.
      - >
        Statuses query parameter. Optional parameter to filter devices by statuses.
        Valid statuses are "online", "alerting", "offline", "dormant".
    elements: str
    type: list
  productTypes:
    description:
      - Information module for Organizations Devices Statuses Info.
      - >
        ProductTypes query parameter. An optional parameter to filter device statuses
        by product type. Valid types are wireless, appliance, switch, systemsManager,
        camera, cellularGateway, sensor, wirelessController, campusGateway, and secureConnect.
    elements: str
    type: list
  models:
    description:
      - Information module for Organizations Devices Statuses Info.
      - Models query parameter. Optional parameter to filter devices by models.
    elements: str
    type: list
  tags:
    description:
      - Information module for Organizations Devices Statuses Info.
      - >
        Tags query parameter. An optional parameter to filter devices by tags. The
        filtering is case-sensitive. If tags are included, 'tagsFilterType' should
        also be included (see below).
    elements: str
    type: list
  tagsFilterType:
    description:
      - Information module for Organizations Devices Statuses Info.
      - >
        TagsFilterType query parameter. An optional parameter of value 'withAnyTags'
        or 'withAllTags' to indicate whether to return devices which contain ANY or
        ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
    type: str
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for organizations getOrganizationDevicesStatuses
    description: Complete reference of the getOrganizationDevicesStatuses API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-statuses
notes:
  - SDK Method used are
    organizations.Organizations.get_organization_devices_statuses,
  - Paths used are
    get /organizations/{organizationId}/devices/statuses,
"""

EXAMPLES = r"""
- name: Get all organizations _devices _statuses
  cisco.meraki.organizations_devices_statuses_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 }}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkIds: []
    serials: []
    statuses: []
    productTypes: []
    models: []
    tags: []
    tagsFilterType: string
    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: >
    [
      {
        "name": "string",
        "serial": "string",
        "mac": "string",
        "publicIp": "string",
        "networkId": "string",
        "status": "string",
        "lastReportedAt": "string",
        "lanIp": "string",
        "gateway": "string",
        "ipType": "string",
        "primaryDns": "string",
        "secondaryDns": "string",
        "productType": "string",
        "components": {
          "powerSupplies": [
            {
              "slot": 0,
              "serial": "string",
              "model": "string",
              "status": "string",
              "poe": {
                "unit": "string",
                "maximum": 0
              }
            }
          ]
        },
        "model": "string",
        "tags": [
          "string"
        ]
      }
    ]
"""
