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

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

cisco.meraki.meraki_mx_third_party_vpn_peers module -- Manage third party (IPSec) VPN peers for MX devices
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

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

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

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

.. version_added


.. contents::
   :local:
   :depth: 1

.. Deprecated

DEPRECATED
----------
:Removed in: version 3.0.0
:Why: Updated modules released with increased functionality
:Alternative: cisco.meraki.organizations\_appliance\_vpn\_third\_party\_vpnpeers

Synopsis
--------

.. Description

- Create, edit, query, or delete third party VPN peers in a Meraki environment.


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

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


      .. 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_third_party_vpn_peers_module__parameter-org_name:
      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_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_third_party_vpn_peers_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_third_party_vpn_peers_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-peers"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers:

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

      **peers**

      .. raw:: html

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

      The list of VPN peers.


      .. raw:: html

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

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-peers/ike_version"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ike_version:

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

      **ike_version**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/ike_version" 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 IKE version to be used for the IPsec VPN peer configuration.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`"1"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"2"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-peers/ipsec_policies"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies:

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

      **ipsec_policies**

      .. raw:: html

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

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

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Custom IPSec policies for the VPN peer. If not included and a preset has not been chosen, the default preset for IPSec policies will be used.


      .. 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-peers/ipsec_policies/child_auth_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies/child_auth_algo:

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

      **child_auth_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/ipsec_policies/child_auth_algo" 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">

      This is the authentication algorithms to be used in Phase 2.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"sha256"`
      - :ansible-option-choices-entry:`"sha1"`
      - :ansible-option-choices-entry:`"md5"`


      .. 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-peers/ipsec_policies/child_cipher_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies/child_cipher_algo:

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

      **child_cipher_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/ipsec_policies/child_cipher_algo" 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">

      This is the cipher algorithms to be used in Phase 2.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"aes256"`
      - :ansible-option-choices-entry:`"aes192"`
      - :ansible-option-choices-entry:`"aes128"`
      - :ansible-option-choices-entry:`"tripledes"`
      - :ansible-option-choices-entry:`"des"`
      - :ansible-option-choices-entry:`"null"`


      .. 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-peers/ipsec_policies/child_lifetime"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies/child_lifetime:

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

      **child_lifetime**

      .. raw:: html

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

      The lifetime of the Phase 2 SA in seconds.


      .. 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-peers/ipsec_policies/child_pfs_group"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies/child_pfs_group:

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

      **child_pfs_group**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/ipsec_policies/child_pfs_group" 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">

      This is the Diffie-Hellman group to be used for Perfect Forward Secrecy in Phase 2.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"disabled"`
      - :ansible-option-choices-entry:`"group14"`
      - :ansible-option-choices-entry:`"group5"`
      - :ansible-option-choices-entry:`"group2"`
      - :ansible-option-choices-entry:`"group1"`


      .. 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-peers/ipsec_policies/ike_auth_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies/ike_auth_algo:

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

      **ike_auth_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/ipsec_policies/ike_auth_algo" 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">

      This is the authentication algorithm to be used in Phase 1.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"sha256"`
      - :ansible-option-choices-entry:`"sha1"`
      - :ansible-option-choices-entry:`"md5"`


      .. 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-peers/ipsec_policies/ike_cipher_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies/ike_cipher_algo:

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

      **ike_cipher_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/ipsec_policies/ike_cipher_algo" 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">

      This is the cipher algorithm to be used in Phase 1.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"aes256"`
      - :ansible-option-choices-entry:`"aes192"`
      - :ansible-option-choices-entry:`"aes128"`
      - :ansible-option-choices-entry:`"tripledes"`
      - :ansible-option-choices-entry:`"des"`


      .. 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-peers/ipsec_policies/ike_diffie_hellman_group"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies/ike_diffie_hellman_group:

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

      **ike_diffie_hellman_group**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/ipsec_policies/ike_diffie_hellman_group" 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">

      This is the Diffie-Hellman group to be used in Phase 1.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"group14"`
      - :ansible-option-choices-entry:`"group5"`
      - :ansible-option-choices-entry:`"group2"`
      - :ansible-option-choices-entry:`"group1"`


      .. 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-peers/ipsec_policies/ike_lifetime"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies/ike_lifetime:

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

      **ike_lifetime**

      .. raw:: html

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

      The lifetime of the Phase 1 SA in seconds.


      .. 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-peers/ipsec_policies/ike_prf_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies/ike_prf_algo:

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

      **ike_prf_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/ipsec_policies/ike_prf_algo" 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">

      This is the pseudo-random function to be used in IKE\_SA.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"prfsha256"`
      - :ansible-option-choices-entry:`"prfsha1"`
      - :ansible-option-choices-entry:`"prfmd5"`
      - :ansible-option-choices-entry:`"default"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-peers/ipsec_policies_preset"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/ipsec_policies_preset:

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

      **ipsec_policies_preset**

      .. raw:: html

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

      Specifies IPsec preset values. If this is provided, the 'ipsecPolicies' parameter is ignored.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"default"`
      - :ansible-option-choices-entry:`"aws"`
      - :ansible-option-choices-entry:`"azure"`


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/name:

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

      **name**

      .. raw:: html

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

      The name of the VPN peer.

      Required when state is present.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-peers/network_tags"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/network_tags:

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

      **network_tags**

      .. raw:: html

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

      A list of network tags that will connect with this peer. If not included, the default is ['all'].


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-peers/private_subnets"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/private_subnets:

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

      **private_subnets**

      .. raw:: html

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

      The list of the private subnets of the VPN peer.

      Required when state is present.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/public_ip:

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

      **public_ip**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/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 public IP of the VPN peer.

      Required when state is present.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-peers/remote_id"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/remote_id:

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

      **remote_id**

      .. raw:: html

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

      The remote ID is used to identify the connecting VPN peer. This can either be a valid IPv4 Address, FQDN or User FQDN.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-peers/secret"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__parameter-peers/secret:

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

      **secret**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-peers/secret" 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 shared secret with the VPN peer.

      Required when state is present.


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

      Specifies whether object should be queried, created/modified, or removed.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"absent"`
      - :ansible-option-choices-entry:`"present"`
      - :ansible-option-choices-entry-default:`"query"` :ansible-option-choices-default-mark:`← (default)`


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_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_third_party_vpn_peers_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_third_party_vpn_peers_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_third_party_vpn_peers_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 VPN peers
      meraki_mx_third_party_vpn_peers:
        auth_key: abc123
        state: query
        org_name: orgName
    - name: Create VPN peer with an IPsec policy
      meraki_mx_third_party_vpn_peers:
        auth_key: abc123
        state: present
        org_name: orgName
        peers:
          - name: Test peer
            public_ip: 198.51.100.1
            secret: s3cret
            private_subnets:
              - 192.0.2.0/24
            ike_version: '2'
            network_tags:
              - none
            remote_id: 192.0.2.0
            ipsec_policies:
              child_lifetime: 600
              ike_lifetime: 600
              child_auth_algo:
                - md5
              child_cipher_algo:
                - tripledes
                - aes192
              child_pfs_group:
                - disabled
              ike_auth_algo:
                - sha256
              ike_cipher_algo:
                - tripledes
              ike_diffie_hellman_group:
                - group2
              ike_prf_algo:
                - prfmd5




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

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response:

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

      **response**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response" 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 organization which was created or modified


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

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/appliance_ip:

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

      **appliance_ip**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/appliance_ip" 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">

      IP address of Meraki appliance in the VLAN


      .. 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.1"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-response/dnsnamservers"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/dnsnamservers:

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

      **dnsnamservers**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/dnsnamservers" 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">

      IP address or Meraki defined DNS servers which VLAN should use by default


      .. 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:`"upstream\_dns"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-response/peers"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers:

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

      **peers**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers" 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">

      The list of VPN peers.


      .. 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-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-response/peers/ike_version"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ike_version:

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

      **ike_version**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ike_version" 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-cell">

      The IKE version to be used for the IPsec VPN peer configuration.


      .. 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:`"1"`


      .. 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-response/peers/ipsec_policies"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies:

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

      **ipsec_policies**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies" 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">

      Custom IPSec policies for the VPN peer.


      .. 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-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-response/peers/ipsec_policies/child_auth_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies/child_auth_algo:

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

      **child_auth_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies/child_auth_algo" 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">

      This is the authentication algorithms to be used in Phase 2.


      .. 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:`["sha1"]`


      .. 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-response/peers/ipsec_policies/child_cipher_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies/child_cipher_algo:

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

      **child_cipher_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies/child_cipher_algo" 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">

      This is the cipher algorithms to be used in Phase 2.


      .. 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:`["aes192"]`


      .. 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-response/peers/ipsec_policies/child_lifetime"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies/child_lifetime:

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

      **child_lifetime**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies/child_lifetime" 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">

      The lifetime of the Phase 2 SA in seconds.


      .. 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:`"60"`


      .. 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-response/peers/ipsec_policies/child_pfs_group"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies/child_pfs_group:

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

      **child_pfs_group**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies/child_pfs_group" 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">

      This is the Diffie-Hellman group to be used for Perfect Forward Secrecy in Phase 2.


      .. 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:`["group14"]`


      .. 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-response/peers/ipsec_policies/ike_auth_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies/ike_auth_algo:

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

      **ike_auth_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies/ike_auth_algo" 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">

      This is the authentication algorithm to be used in Phase 1.


      .. 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:`["sha1"]`


      .. 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-response/peers/ipsec_policies/ike_cipher_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies/ike_cipher_algo:

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

      **ike_cipher_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies/ike_cipher_algo" 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">

      This is the cipher algorithm to be used in Phase 1.


      .. 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:`["aes128"]`


      .. 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-response/peers/ipsec_policies/ike_diffie_hellman_group"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies/ike_diffie_hellman_group:

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

      **ike_diffie_hellman_group**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies/ike_diffie_hellman_group" 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">

      This is the Diffie-Hellman group to be used in Phase 1.


      .. 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:`["group14"]`


      .. 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-response/peers/ipsec_policies/ike_lifetime"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies/ike_lifetime:

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

      **ike_lifetime**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies/ike_lifetime" 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">

      The lifetime of the Phase 1 SA in seconds.


      .. 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:`"60"`


      .. 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-response/peers/ipsec_policies/ike_prf_algo"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies/ike_prf_algo:

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

      **ike_prf_algo**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies/ike_prf_algo" 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">

      This is the pseudo-random function to be used in IKE\_SA.


      .. 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:`["prfmd5"]`


      .. 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-response/peers/ipsec_policies_preset"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/ipsec_policies_preset:

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

      **ipsec_policies_preset**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/ipsec_policies_preset" 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-cell">

      Preconfigured IPsec settings.


      .. 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:`"aws"`


      .. 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-response/peers/name"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/name:

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

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/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-cell">

      The name of the VPN peer.


      .. 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:`"MyVPNPeer"`


      .. 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-response/peers/network_tags"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/network_tags:

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

      **network_tags**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/network_tags" 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-cell">

      A list of network tags that will connect with this peer.


      .. 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:`["all"]`


      .. 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-response/peers/private_subnets"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/private_subnets:

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

      **private_subnets**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/private_subnets" 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-cell">

      The list of the private subnets of the VPN peer.


      .. 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.2.0/24"]`


      .. 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-response/peers/public_ip"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/public_ip:

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

      **public_ip**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/public_ip" 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-cell">

      The public IP of the VPN peer.


      .. 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:`"198.51.100.1"`


      .. 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-response/peers/remote_id"></div>

      .. _ansible_collections.cisco.meraki.meraki_mx_third_party_vpn_peers_module__return-response/peers/remote_id:

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

      **remote_id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response/peers/remote_id" 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-cell">

      The remote ID is used to identify the connecting VPN peer.


      .. 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:`"s3cret"`


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