#!/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: networks_appliance_devices_redundancy_swap
short_description: Resource module for networks _appliance _devices _redundancy _swap
description:
  - Manage operation create of the resource networks _appliance _devices _redundancy
    _swap.
  - Swap MX primary and warm spare appliances.
version_added: '1.0.0'
extends_documentation_fragment:
  - cisco.meraki.module
author: Francisco Munoz (@fmunoz)
options:
  networkId:
    description: NetworkId path parameter. Network ID.
    type: str
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for appliance createNetworkApplianceDevicesRedundancySwap
    description: Complete reference of the createNetworkApplianceDevicesRedundancySwap
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!create-network-appliance-devices-redundancy-swap
notes:
  - SDK Method used are
    appliance.Appliance.create_network_appliance_devices_redundancy_swap,
  - Paths used are
    post /networks/{networkId}/appliance/devices/redundancy/swap,
"""

EXAMPLES = r"""
- name: Create
  cisco.meraki.networks_appliance_devices_redundancy_swap:
    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 }}"
    networkId: string
"""
RETURN = r"""
meraki_response:
  description: A dictionary or list with the response returned by the Cisco Meraki Python SDK
  returned: always
  type: dict
  sample: >
    {
      "networkId": "string",
      "name": "string",
      "enabled": true,
      "mode": "string",
      "designations": [
        {
          "serial": "string",
          "priority": 0
        }
      ],
      "uplink": {
        "mode": "string",
        "interfaces": [
          {
            "name": "string",
            "addresses": [
              {
                "address": "string",
                "subnet": "string"
              }
            ]
          }
        ],
        "sharing": {
          "enabled": true,
          "vlanId": {},
          "byInterface": [
            {
              "name": "string",
              "parent": "string"
            }
          ]
        },
        "loadBalancing": {
          "enabled": true,
          "vlanSelection": {
            "mode": "string",
            "byDevice": [
              {
                "serial": "string",
                "vlanIds": [
                  0
                ]
              }
            ]
          }
        }
      }
    }
"""
