.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.meraki.meraki_firewalled_services module -- Edit firewall policies for administrative network services ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.meraki collection <https://galaxy.ansible.com/cisco/meraki>`_ (version 2.21.0). To install it, use: :code:`ansible-galaxy collection install cisco.meraki`. To use it in a playbook, specify: :code:`cisco.meraki.meraki_firewalled_services`. .. version_added .. contents:: :local: :depth: 1 .. Deprecated DEPRECATED ---------- :Removed in: version 3.0.0 :Why: Updated modules released with increased functionality :Alternative: cisco.meraki.networks\_appliance\_firewall\_firewalled\_services Synopsis -------- .. Description - Allows for setting policy firewalled services for Meraki network devices. .. Aliases .. Requirements .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-access"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-access: .. rst-class:: ansible-option-title **access** .. raw:: html <a class="ansibleOptionLink" href="#parameter-access" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Network service to query or modify. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"blocked"` - :ansible-option-choices-entry:`"restricted"` - :ansible-option-choices-entry:`"unrestricted"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-allowed_ips"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-allowed_ips: .. rst-class:: ansible-option-title **allowed_ips** .. raw:: html <a class="ansibleOptionLink" href="#parameter-allowed_ips" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> List of IP addresses allowed to access a service. Only used when \ :literal:`access`\ is set to restricted. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-auth_key"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-auth_key: .. rst-class:: ansible-option-title **auth_key** .. raw:: html <a class="ansibleOptionLink" href="#parameter-auth_key" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Authentication key provided by the dashboard. Required if environmental variable MERAKI\_KEY is not set. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-host"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-host: .. rst-class:: ansible-option-title **host** .. raw:: html <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"api.meraki.com"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-internal_error_retry_time"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-internal_error_retry_time: .. rst-class:: ansible-option-title **internal_error_retry_time** .. raw:: html <a class="ansibleOptionLink" href="#parameter-internal_error_retry_time" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Number of seconds to retry if server returns an internal server error. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-net_id"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-net_id: .. rst-class:: ansible-option-title **net_id** .. raw:: html <a class="ansibleOptionLink" href="#parameter-net_id" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> ID number of a network. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-net_name"></div> <div class="ansibleOptionAnchor" id="parameter-network"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-net_name: .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-network: .. rst-class:: ansible-option-title **net_name** .. raw:: html <a class="ansibleOptionLink" href="#parameter-net_name" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: network` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Name of a network. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-org_id"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-org_id: .. rst-class:: ansible-option-title **org_id** .. raw:: html <a class="ansibleOptionLink" href="#parameter-org_id" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> ID of organization associated to a network. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-org_name"></div> <div class="ansibleOptionAnchor" id="parameter-organization"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-org_name: .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-organization: .. rst-class:: ansible-option-title **org_name** .. raw:: html <a class="ansibleOptionLink" href="#parameter-org_name" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: organization` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Name of organization associated to a network. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-output_format"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-output_format: .. rst-class:: ansible-option-title **output_format** .. raw:: html <a class="ansibleOptionLink" href="#parameter-output_format" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Instructs module whether response keys should be snake case (ex. \ :literal:`net\_id`\ ) or camel case (ex. \ :literal:`netId`\ ). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"snakecase"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"camelcase"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-output_level"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-output_level: .. rst-class:: ansible-option-title **output_level** .. raw:: html <a class="ansibleOptionLink" href="#parameter-output_level" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Set amount of debug output during module execution. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"debug"` - :ansible-option-choices-entry-default:`"normal"` :ansible-option-choices-default-mark:`← (default)` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-rate_limit_retry_time"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-rate_limit_retry_time: .. rst-class:: ansible-option-title **rate_limit_retry_time** .. raw:: html <a class="ansibleOptionLink" href="#parameter-rate_limit_retry_time" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Number of seconds to retry if rate limiter is triggered. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`165` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-service"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-service: .. rst-class:: ansible-option-title **service** .. raw:: html <a class="ansibleOptionLink" href="#parameter-service" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Network service to query or modify. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"ICMP"` - :ansible-option-choices-entry:`"SNMP"` - :ansible-option-choices-entry:`"web"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-state"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> States that a policy should be created or modified. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"query"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-timeout"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-timeout: .. rst-class:: ansible-option-title **timeout** .. raw:: html <a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Time to timeout for HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`30` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-use_https"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-use_https: .. rst-class:: ansible-option-title **use_https** .. raw:: html <a class="ansibleOptionLink" href="#parameter-use_https" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> If \ :literal:`no`\ , it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-use_proxy"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-use_proxy: .. rst-class:: ansible-option-title **use_proxy** .. raw:: html <a class="ansibleOptionLink" href="#parameter-use_proxy" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-validate_certs"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__parameter-validate_certs: .. rst-class:: ansible-option-title **validate_certs** .. raw:: html <a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Whether to validate HTTP certificates. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html </div> .. Attributes .. Notes Notes ----- .. note:: - More information about the Meraki API can be found at \ https://dashboard.meraki.com/api_docs\ . - Some of the options are likely only used for developers within Meraki. - As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the \ :literal:`ANSIBLE\_MERAKI\_FORMAT`\ environment variable to \ :literal:`camelcase`\ . - Ansible's Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks. - Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change. .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: Set icmp service to blocked meraki_firewalled_services: auth_key: '{{ auth_key }}' state: present org_name: '{{ test_org_name }}' net_name: IntTestNetworkAppliance service: ICMP access: blocked delegate_to: localhost - name: Set icmp service to restricted meraki_firewalled_services: auth_key: abc123 state: present org_name: YourOrg net_name: YourNet service: web access: restricted allowed_ips: - 192.0.1.1 - 192.0.1.2 delegate_to: localhost - name: Query appliance services meraki_firewalled_services: auth_key: abc123 state: query org_name: YourOrg net_name: YourNet delegate_to: localhost - name: Query services meraki_firewalled_services: auth_key: abc123 state: query org_name: YourOrg net_name: YourNet service: ICMP delegate_to: localhost .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-data"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__return-data: .. rst-class:: ansible-option-title **data** .. raw:: html <a class="ansibleOptionLink" href="#return-data" title="Permalink to this return value"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`complex` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> List of network services. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` info .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-data/access"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__return-data/access: .. rst-class:: ansible-option-title **access** .. raw:: html <a class="ansibleOptionLink" href="#return-data/access" title="Permalink to this return value"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Access assigned to a service type. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"unrestricted"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-data/allowed_ips"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__return-data/allowed_ips: .. rst-class:: ansible-option-title **allowed_ips** .. raw:: html <a class="ansibleOptionLink" href="#return-data/allowed_ips" title="Permalink to this return value"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> List of IP addresses to have access to service. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.1.0"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-data/service"></div> .. _ansible_collections.cisco.meraki.meraki_firewalled_services_module__return-data/service: .. rst-class:: ansible-option-title **service** .. raw:: html <a class="ansibleOptionLink" href="#return-data/service" title="Permalink to this return value"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Service to apply policy to. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"ICMP"` .. raw:: html </div> .. Status (Presently only deprecated) Status ------ .. Deprecated note - This module will be removed in version 3.0.0. *[deprecated]* - For more information see `DEPRECATED`_. .. Authors Authors ~~~~~~~ - Kevin Breit (@kbreit) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html <p class="ansible-links"> <a href="https://github.com/meraki/dashboard-api-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/meraki/dashboard-api-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> </p> .. Parsing errors