.. 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_mx_nat_module:

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

cisco.meraki.meraki_mx_nat module -- Manage NAT rules in Meraki cloud
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This module is part of the `cisco.meraki collection <https://galaxy.ansible.com/cisco/meraki>`_ (version 2.20.9).

    To install it, use: :code:`ansible-galaxy collection install cisco.meraki`.

    To use it in a playbook, specify: :code:`cisco.meraki.meraki_mx_nat`.

.. 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\_one\_to\_many\_nat\_rules

Synopsis
--------

.. Description

- Allows for creation, management, and visibility of NAT rules (1:1, 1:many, port forwarding) within Meraki.


.. 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-auth_key"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_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 \ :literal:`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_mx_nat_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_mx_nat_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_mx_nat_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-name"></div>
        <div class="ansibleOptionAnchor" id="parameter-network"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-name:
      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-net_name:
      .. _ansible_collections.cisco.meraki.meraki_mx_nat_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: name, 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-one_to_many"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many:

      .. rst-class:: ansible-option-title

      **one_to_many**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      List of 1:many NAT rules.


      .. raw:: html

        </div>
    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_many/port_rules"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many/port_rules:

      .. rst-class:: ansible-option-title

      **port_rules**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many/port_rules" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of associated port rules.


      .. raw:: html

        </div>
    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_many/port_rules/allowed_ips"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many/port_rules/allowed_ips:

      .. rst-class:: ansible-option-title

      **allowed_ips**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many/port_rules/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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Remote IP addresses or ranges that are permitted to access the internal resource via this port forwarding rule, or 'any'.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_many/port_rules/local_ip"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many/port_rules/local_ip:

      .. rst-class:: ansible-option-title

      **local_ip**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many/port_rules/local_ip" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Local IP address to which traffic will be forwarded.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_many/port_rules/local_port"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many/port_rules/local_port:

      .. rst-class:: ansible-option-title

      **local_port**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many/port_rules/local_port" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Destination port of the forwarded traffic that will be sent from the MX to the specified host on the LAN.

      If you simply wish to forward the traffic without translating the port, this should be the same as the Public port.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_many/port_rules/name"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many/port_rules/name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many/port_rules/name" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      A description of the rule.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_many/port_rules/protocol"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many/port_rules/protocol:

      .. rst-class:: ansible-option-title

      **protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many/port_rules/protocol" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Protocol to apply NAT rule to.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"tcp"`
      - :ansible-option-choices-entry:`"udp"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_many/port_rules/public_port"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many/port_rules/public_port:

      .. rst-class:: ansible-option-title

      **public_port**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many/port_rules/public_port" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Destination port of the traffic that is arriving on the WAN.


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_many/public_ip"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many/public_ip:

      .. rst-class:: ansible-option-title

      **public_ip**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many/public_ip" 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-indent-desc"></div><div class="ansible-option-cell">

      The IP address that will be used to access the internal resource from the WAN.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_many/uplink"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_many/uplink:

      .. rst-class:: ansible-option-title

      **uplink**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_many/uplink" 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-indent-desc"></div><div class="ansible-option-cell">

      The physical WAN interface on which the traffic will arrive.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"both"`
      - :ansible-option-choices-entry:`"internet1"`
      - :ansible-option-choices-entry:`"internet2"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_one"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_one:

      .. rst-class:: ansible-option-title

      **one_to_one**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_one" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      List of 1:1 NAT rules.


      .. raw:: html

        </div>
    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_one/allowed_inbound"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_one/allowed_inbound:

      .. rst-class:: ansible-option-title

      **allowed_inbound**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_one/allowed_inbound" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      The ports this mapping will provide access on, and the remote IPs that will be allowed access to the resource.


      .. raw:: html

        </div>
    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_one/allowed_inbound/allowed_ips"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_one/allowed_inbound/allowed_ips:

      .. rst-class:: ansible-option-title

      **allowed_ips**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_one/allowed_inbound/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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges, or 'any'.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_one/allowed_inbound/destination_ports"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_one/allowed_inbound/destination_ports:

      .. rst-class:: ansible-option-title

      **destination_ports**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_one/allowed_inbound/destination_ports" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of ports or port ranges that will be forwarded to the host on the LAN.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_one/allowed_inbound/protocol"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_one/allowed_inbound/protocol:

      .. rst-class:: ansible-option-title

      **protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_one/allowed_inbound/protocol" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Protocol to apply NAT rule to.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`"any"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"icmp-ping"`
      - :ansible-option-choices-entry:`"tcp"`
      - :ansible-option-choices-entry:`"udp"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_one/lan_ip"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_one/lan_ip:

      .. rst-class:: ansible-option-title

      **lan_ip**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_one/lan_ip" 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-indent-desc"></div><div class="ansible-option-cell">

      The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_one/name"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_one/name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_one/name" 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-indent-desc"></div><div class="ansible-option-cell">

      A descriptive name for the rule.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_one/public_ip"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_one/public_ip:

      .. rst-class:: ansible-option-title

      **public_ip**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_one/public_ip" 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-indent-desc"></div><div class="ansible-option-cell">

      The IP address that will be used to access the internal resource from the WAN.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-one_to_one/uplink"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-one_to_one/uplink:

      .. rst-class:: ansible-option-title

      **uplink**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-one_to_one/uplink" 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-indent-desc"></div><div class="ansible-option-cell">

      The physical WAN interface on which the traffic will arrive.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"both"`
      - :ansible-option-choices-entry:`"internet1"`
      - :ansible-option-choices-entry:`"internet2"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-org_id"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_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_mx_nat_module__parameter-org_name:
      .. _ansible_collections.cisco.meraki.meraki_mx_nat_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.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-output_format"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_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_mx_nat_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-port_forwarding"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-port_forwarding:

      .. rst-class:: ansible-option-title

      **port_forwarding**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-port_forwarding" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      List of port forwarding rules.


      .. raw:: html

        </div>
    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-port_forwarding/allowed_ips"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-port_forwarding/allowed_ips:

      .. rst-class:: ansible-option-title

      **allowed_ips**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-port_forwarding/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-indent-desc"></div><div class="ansible-option-cell">

      List of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges (or any).


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-port_forwarding/lan_ip"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-port_forwarding/lan_ip:

      .. rst-class:: ansible-option-title

      **lan_ip**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-port_forwarding/lan_ip" 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-indent-desc"></div><div class="ansible-option-cell">

      The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-port_forwarding/local_port"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-port_forwarding/local_port:

      .. rst-class:: ansible-option-title

      **local_port**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-port_forwarding/local_port" 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-indent-desc"></div><div class="ansible-option-cell">

      A port or port ranges that will receive the forwarded traffic from the WAN.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-port_forwarding/name"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-port_forwarding/name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-port_forwarding/name" 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-indent-desc"></div><div class="ansible-option-cell">

      A descriptive name for the rule.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-port_forwarding/protocol"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-port_forwarding/protocol:

      .. rst-class:: ansible-option-title

      **protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-port_forwarding/protocol" 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-indent-desc"></div><div class="ansible-option-cell">

      Protocol to forward traffic for.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"tcp"`
      - :ansible-option-choices-entry:`"udp"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-port_forwarding/public_port"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-port_forwarding/public_port:

      .. rst-class:: ansible-option-title

      **public_port**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-port_forwarding/public_port" 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-indent-desc"></div><div class="ansible-option-cell">

      A port or port ranges that will be forwarded to the host on the LAN.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-port_forwarding/uplink"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-port_forwarding/uplink:

      .. rst-class:: ansible-option-title

      **uplink**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-port_forwarding/uplink" 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-indent-desc"></div><div class="ansible-option-cell">

      The physical WAN interface on which the traffic will arrive.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"both"`
      - :ansible-option-choices-entry:`"internet1"`
      - :ansible-option-choices-entry:`"internet2"`


      .. 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_mx_nat_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-state"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_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">

      Create or modify an organization.


      .. 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-subset"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__parameter-subset:

      .. rst-class:: ansible-option-title

      **subset**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-subset" 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">

      Specifies which NAT components to query.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"1:1"`
      - :ansible-option-choices-entry:`"1:many"`
      - :ansible-option-choices-entry-default:`"all"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"port\_forwarding"`


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`["all"]`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-timeout"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_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_mx_nat_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_mx_nat_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_mx_nat_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: Query all NAT rules
      meraki_nat:
        auth_key: abc123
        org_name: YourOrg
        net_name: YourNet
        state: query
        subset: all
      delegate_to: localhost

    - name: Query 1:1 NAT rules
      meraki_nat:
        auth_key: abc123
        org_name: YourOrg
        net_name: YourNet
        state: query
        subset: '1:1'
      delegate_to: localhost

    - name: Create 1:1 rule
      meraki_nat:
        auth_key: abc123
        org_name: YourOrg
        net_name: YourNet
        state: present
        one_to_one:
          - name: Service behind NAT
            public_ip: 1.2.1.2
            lan_ip: 192.168.128.1
            uplink: internet1
            allowed_inbound:
              - protocol: tcp
                destination_ports:
                  - 80
                allowed_ips:
                  - 10.10.10.10
      delegate_to: localhost

    - name: Create 1:many rule
      meraki_nat:
        auth_key: abc123
        org_name: YourOrg
        net_name: YourNet
        state: present
        one_to_many:
          - public_ip: 1.1.1.1
            uplink: internet1
            port_rules:
              - name: Test rule
                protocol: tcp
                public_port: 10
                local_ip: 192.168.128.1
                local_port: 11
                allowed_ips:
                  - any
      delegate_to: localhost

    - name: Create port forwarding rule
      meraki_nat:
        auth_key: abc123
        org_name: YourOrg
        net_name: YourNet
        state: present
        port_forwarding:
          - name: Test map
            lan_ip: 192.168.128.1
            uplink: both
            protocol: tcp
            allowed_ips:
              - 1.1.1.1
            public_port: 10
            local_port: 11
      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_mx_nat_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">

      Information about the created or manipulated object.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success


      .. raw:: html

        </div>

    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many:

      .. rst-class:: ansible-option-title

      **one_to_many**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many" 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-indent-desc"></div><div class="ansible-option-cell">

      Information about 1:many NAT object.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:many NAT object is in task


      .. raw:: html

        </div>

    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules:

      .. rst-class:: ansible-option-title

      **rules**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of 1:many NAT rules.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:many NAT object is in task


      .. raw:: html

        </div>

    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules/portRules"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules/portrules:

      .. rst-class:: ansible-option-title

      **portRules**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules/portRules" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of NAT port rules.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:many NAT object is in task


      .. raw:: html

        </div>

    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules/portRules/allowedIps"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules/portrules/allowedips:

      .. rst-class:: ansible-option-title

      **allowedIps**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules/portRules/allowedIps" title="Permalink to this return value"></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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of IP addresses to be forwarded.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["10.80.100.0/24"]`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules/portRules/localIp"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules/portrules/localip:

      .. rst-class:: ansible-option-title

      **localIp**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules/portRules/localIp" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Local IP address traffic will be forwarded.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.2.10"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules/portRules/localPort"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules/portrules/localport:

      .. rst-class:: ansible-option-title

      **localPort**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules/portRules/localPort" title="Permalink to this return value"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Destination port to be forwarded to.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`443`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules/portRules/name"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules/portrules/name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules/portRules/name" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Name of NAT object.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:many NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"Web server behind NAT"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules/portRules/protocol"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules/portrules/protocol:

      .. rst-class:: ansible-option-title

      **protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules/portRules/protocol" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Protocol to apply NAT rule to.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"tcp"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules/portRules/publicPort"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules/portrules/publicport:

      .. rst-class:: ansible-option-title

      **publicPort**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules/portRules/publicPort" title="Permalink to this return value"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Destination port of the traffic that is arriving on WAN.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`9443`


      .. raw:: html

        </div>



  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules/publicIp"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules/publicip:

      .. rst-class:: ansible-option-title

      **publicIp**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules/publicIp" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Public IP address to be mapped.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:many NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"148.2.5.100"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_many/rules/uplink"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_many/rules/uplink:

      .. rst-class:: ansible-option-title

      **uplink**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_many/rules/uplink" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Internet port where rule is applied.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:many NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"internet1"`


      .. raw:: html

        </div>




  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one:

      .. rst-class:: ansible-option-title

      **one_to_one**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one" 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-indent-desc"></div><div class="ansible-option-cell">

      Information about 1:1 NAT object.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task


      .. raw:: html

        </div>

    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one/rules"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one/rules:

      .. rst-class:: ansible-option-title

      **rules**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one/rules" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of 1:1 NAT rules.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task


      .. raw:: html

        </div>

    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one/rules/allowedInbound"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one/rules/allowedinbound:

      .. rst-class:: ansible-option-title

      **allowedInbound**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one/rules/allowedInbound" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of inbound forwarding rules.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task


      .. raw:: html

        </div>

    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one/rules/allowedInbound/allowedIps"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one/rules/allowedinbound/allowedips:

      .. rst-class:: ansible-option-title

      **allowedIps**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one/rules/allowedInbound/allowedIps" title="Permalink to this return value"></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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of IP addresses to be forwarded.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["10.80.100.0/24"]`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one/rules/allowedInbound/destinationPorts"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one/rules/allowedinbound/destinationports:

      .. rst-class:: ansible-option-title

      **destinationPorts**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one/rules/allowedInbound/destinationPorts" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Ports to apply NAT rule to.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"80"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one/rules/allowedInbound/protocol"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one/rules/allowedinbound/protocol:

      .. rst-class:: ansible-option-title

      **protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one/rules/allowedInbound/protocol" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Protocol to apply NAT rule to.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"tcp"`


      .. raw:: html

        </div>



  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one/rules/lanIp"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one/rules/lanip:

      .. rst-class:: ansible-option-title

      **lanIp**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one/rules/lanIp" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Local IP address to be mapped.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.168.128.22"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one/rules/name"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one/rules/name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one/rules/name" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Name of NAT object.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"Web server behind NAT"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one/rules/publicIp"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one/rules/publicip:

      .. rst-class:: ansible-option-title

      **publicIp**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one/rules/publicIp" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Public IP address to be mapped.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"148.2.5.100"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/one_to_one/rules/uplink"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/one_to_one/rules/uplink:

      .. rst-class:: ansible-option-title

      **uplink**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/one_to_one/rules/uplink" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Internet port where rule is applied.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when 1:1 NAT object is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"internet1"`


      .. raw:: html

        </div>




  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/port_forwarding"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/port_forwarding:

      .. rst-class:: ansible-option-title

      **port_forwarding**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/port_forwarding" 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-indent-desc"></div><div class="ansible-option-cell">

      Information about port forwarding rules.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when port forwarding is in task


      .. raw:: html

        </div>

    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/port_forwarding/rules"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/port_forwarding/rules:

      .. rst-class:: ansible-option-title

      **rules**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/port_forwarding/rules" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of port forwarding rules.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when port forwarding is in task


      .. raw:: html

        </div>

    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/port_forwarding/rules/allowedIps"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/port_forwarding/rules/allowedips:

      .. rst-class:: ansible-option-title

      **allowedIps**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/port_forwarding/rules/allowedIps" title="Permalink to this return value"></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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of IP addresses to be forwarded.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when port forwarding is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["10.80.100.0/24"]`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/port_forwarding/rules/lanIp"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/port_forwarding/rules/lanip:

      .. rst-class:: ansible-option-title

      **lanIp**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/port_forwarding/rules/lanIp" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Local IP address to be mapped.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when port forwarding is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.168.128.22"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/port_forwarding/rules/localPort"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/port_forwarding/rules/localport:

      .. rst-class:: ansible-option-title

      **localPort**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/port_forwarding/rules/localPort" title="Permalink to this return value"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Destination port to be forwarded to.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when port forwarding is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`443`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/port_forwarding/rules/name"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/port_forwarding/rules/name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/port_forwarding/rules/name" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Name of NAT object.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when port forwarding is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"Web server behind NAT"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/port_forwarding/rules/protocol"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/port_forwarding/rules/protocol:

      .. rst-class:: ansible-option-title

      **protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/port_forwarding/rules/protocol" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Protocol to apply NAT rule to.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when port forwarding is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"tcp"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/port_forwarding/rules/publicPort"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/port_forwarding/rules/publicport:

      .. rst-class:: ansible-option-title

      **publicPort**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/port_forwarding/rules/publicPort" title="Permalink to this return value"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Destination port of the traffic that is arriving on WAN.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when port forwarding is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`9443`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-data/port_forwarding/rules/uplink"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_nat_module__return-data/port_forwarding/rules/uplink:

      .. rst-class:: ansible-option-title

      **uplink**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-data/port_forwarding/rules/uplink" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Internet port where rule is applied.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success, when port forwarding is in task

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"internet1"`


      .. 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