#!/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_policies_global_firewall_rulesets
short_description: Resource module for organizations _policies _global _firewall _rulesets
description:
  - Manage operations create, update and delete of the resource organizations _policies
    _global _firewall _rulesets.
  - Create an Organization-Wide Policy Firewall Ruleset.
  - Delete an Organization-Wide Policy Firewall Ruleset.
  - Update an Organization-Wide Policy Firewall Ruleset.
version_added: '1.0.0'
extends_documentation_fragment:
  - cisco.meraki.module
author: Francisco Munoz (@fmunoz)
options:
  description:
    description: Description of the firewall ruleset.
    type: str
  name:
    description: Name of the firewall ruleset.
    type: str
  organizationId:
    description: OrganizationId path parameter. Organization ID.
    type: str
  rulesetId:
    description: RulesetId path parameter. Ruleset ID.
    type: str
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for organizations createOrganizationPoliciesGlobalFirewallRuleset
    description: Complete reference of the createOrganizationPoliciesGlobalFirewallRuleset
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!create-organization-policies-global-firewall-ruleset
  - name: Cisco Meraki documentation for organizations deleteOrganizationPoliciesGlobalFirewallRuleset
    description: Complete reference of the deleteOrganizationPoliciesGlobalFirewallRuleset
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!delete-organization-policies-global-firewall-ruleset
  - name: Cisco Meraki documentation for organizations updateOrganizationPoliciesGlobalFirewallRuleset
    description: Complete reference of the updateOrganizationPoliciesGlobalFirewallRuleset
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!update-organization-policies-global-firewall-ruleset
notes:
  - SDK Method used are
    organizations.Organizations.create_organization_policies_global_firewall_ruleset,
    organizations.Organizations.delete_organization_policies_global_firewall_ruleset,
    organizations.Organizations.update_organization_policies_global_firewall_ruleset,
  - Paths used are
    post /organizations/{organizationId}/policies/global/firewall/rulesets,
    delete /organizations/{organizationId}/policies/global/firewall/rulesets/{rulesetId},
    put /organizations/{organizationId}/policies/global/firewall/rulesets/{rulesetId},
"""

EXAMPLES = r"""
- name: Create
  cisco.meraki.organizations_policies_global_firewall_rulesets:
    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 }}"
    state: present
    description: Block all Social Media
    name: Block Social Media
    organizationId: string
- name: Update by id
  cisco.meraki.organizations_policies_global_firewall_rulesets:
    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 }}"
    state: present
    description: Block all Social Media
    name: Block Social Media
    organizationId: string
    rulesetId: string
- name: Delete by id
  cisco.meraki.organizations_policies_global_firewall_rulesets:
    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 }}"
    state: absent
    organizationId: string
    rulesetId: 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: >
    {
      "rulesetId": "string",
      "name": "string",
      "description": "string",
      "createdAt": "string",
      "lastUpdatedAt": "string"
    }
"""
