#!/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"""
author: Francisco Munoz (@fmunoz)
description:
  - Get all networks _firmware _upgrades _staged _groups.
  - Get networks _firmware _upgrades _staged _groups by id.
  - Get a Staged Upgrade Group from a network.
  - List of Staged Upgrade Groups in a network.
extends_documentation_fragment:
  - cisco.meraki.module_info
module: networks_firmware_upgrades_staged_groups_info
notes:
  - SDK Method used are networks.Networks.get_network_firmware_upgrades_staged_group,
    networks.Networks.get_network_firmware_upgrades_staged_groups,
  - Paths used are get /networks/{networkId}/firmwareUpgrades/staged/groups, get /networks/{networkId}/firmwareUpgrades/staged/groups/{groupId},
options:
  groupId:
    description:
      - GroupId path parameter. Group ID.
    type: str
  headers:
    description: Additional headers.
    type: dict
  networkId:
    description:
      - NetworkId path parameter. Network ID.
    type: str
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - description: Complete reference of the getNetworkFirmwareUpgradesStagedGroup API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-network-firmware-upgrades-staged-group
    name: Cisco Meraki documentation for networks getNetworkFirmwareUpgradesStagedGroup
  - description: Complete reference of the getNetworkFirmwareUpgradesStagedGroups
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-network-firmware-upgrades-staged-groups
    name: Cisco Meraki documentation for networks getNetworkFirmwareUpgradesStagedGroups
short_description: Information module for networks _firmware _upgrades _staged _groups
version_added: 2.16.0
"""

EXAMPLES = r"""
- name: Get all networks _firmware _upgrades _staged _groups
  cisco.meraki.networks_firmware_upgrades_staged_groups_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 }}'
    networkId: string
  register: result
- name: Get networks _firmware _upgrades _staged _groups by id
  cisco.meraki.networks_firmware_upgrades_staged_groups_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 }}'
    networkId: string
    groupId: string
  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: >
    {
      "assignedDevices": {
        "devices": [
          {
            "name": "string",
            "serial": "string"
          }
        ],
        "switchStacks": [
          {
            "id": "string",
            "name": "string"
          }
        ]
      },
      "description": "string",
      "groupId": "string",
      "isDefault": true,
      "name": "string"
    }
"""
