#!/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_firewall_multicast_forwarding
short_description: Resource module for networks _appliance _firewall _multicast _forwarding
description:
  - Manage operation update of the resource networks _appliance _firewall _multicast _forwarding.
  - Update static multicast forward rules for a network.
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
  rules:
    description: Static multicast forwarding rules. Pass an empty array to clear all rules.
    elements: dict
    suboptions:
      address:
        description: IP address.
        type: str
      description:
        description: Forwarding rule description.
        type: str
      vlanIds:
        description: List of VLAN IDs.
        elements: str
        type: list
    type: list
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for appliance updateNetworkApplianceFirewallMulticastForwarding
    description: Complete reference of the updateNetworkApplianceFirewallMulticastForwarding API.
    link: https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-firewall-multicast-forwarding
notes:
  - SDK Method used are
    appliance.Appliance.update_network_appliance_firewall_multicast_forwarding,
  - Paths used are
    put /networks/{networkId}/appliance/firewall/multicastForwarding,
"""

EXAMPLES = r"""
- name: Update all
  cisco.meraki.networks_appliance_firewall_multicast_forwarding:
    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
    rules:
      - address: 224.0.0.1
        description: test
        vlanIds:
          - '1'
"""
RETURN = r"""
meraki_response:
  description: A dictionary or list with the response returned by the Cisco Meraki Python SDK
  returned: always
  type: dict
  sample: >
    {
      "network": {
        "id": "string",
        "name": "string"
      },
      "rules": [
        {
          "address": "string",
          "description": "string",
          "vlanIds": [
            "string"
          ]
        }
      ]
    }
"""
