cisco.meraki.meraki_mx_third_party_vpn_peers 模块 – 管理 MX 设备的第三方 (IPSec) VPN 对等体

注意

此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.meraki。

要在剧本中使用它，请指定：cisco.meraki.meraki_mx_third_party_vpn_peers。

已弃用

在以下版本中删除:

3.0.0 版

原因:

更新的模块发布，功能增强

替代方案:

cisco.meraki.organizations_appliance_vpn_third_party_vpnpeers

概要

  • 在 Meraki 环境中创建、编辑、查询或删除第三方 VPN 对等体。

参数

参数

注释

auth_key

字符串 / 必需

仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需。

host

字符串

Meraki 仪表板的主机名。

可用于访问区域性 Meraki 环境，例如中国。

默认: "api.meraki.com"

internal_error_retry_time

整数

如果服务器返回内部服务器错误，则重试的秒数。

默认: 60

org_id

字符串

组织 ID。

org_name

别名: organization

字符串

组织名称。

output_format

字符串

指示模块响应键应为蛇形命名（例如 net_id）还是驼峰命名（例如 netId）。

选择

  • "snakecase" ← (默认)

  • "camelcase"

output_level

字符串

设置模块执行期间的调试输出量。

选择

  • "debug"

  • "normal" ← (默认)

peers

列表 / 元素=字典

VPN 对等体的列表。

ike_version

字符串

用于 IPsec VPN 对等体配置的 IKE 版本。

选择

  • "1" ← (默认)

  • "2"

ipsec_policies

字典

VPN 对等体的自定义 IPSec 策略。如果未包含且未选择预设，则将使用 IPSec 策略的默认预设。

child_auth_algo

列表 / 元素=字符串

这是在第二阶段中使用的身份验证算法。

选择

  • "sha256"

  • "sha1"

  • "md5"

child_cipher_algo

列表 / 元素=字符串

这是在第二阶段中使用的密码算法。

选择

  • "aes256"

  • "aes192"

  • "aes128"

  • "tripledes"

  • "des"

  • "null"

child_lifetime

整数

第二阶段 SA 的生命周期（以秒为单位）。

child_pfs_group

列表 / 元素=字符串

这是用于第二阶段完美前向保密的 Diffie-Hellman 组。

选择

  • "disabled"

  • "group14"

  • "group5"

  • "group2"

  • "group1"

ike_auth_algo

列表 / 元素=字符串

这是在第一阶段中使用的身份验证算法。

选择

  • "sha256"

  • "sha1"

  • "md5"

ike_cipher_algo

列表 / 元素=字符串

这是在第一阶段中使用的密码算法。

选择

  • "aes256"

  • "aes192"

  • "aes128"

  • "tripledes"

  • "des"

ike_diffie_hellman_group

列表 / 元素=字符串

这是在第一阶段中使用的 Diffie-Hellman 组。

选择

  • "group14"

  • "group5"

  • "group2"

  • "group1"

ike_lifetime

整数

第一阶段 SA 的生命周期（以秒为单位）。

ike_prf_algo

列表 / 元素=字符串

这是在 IKE_SA 中使用的伪随机函数。

选择

  • "prfsha256"

  • "prfsha1"

  • "prfmd5"

  • "default"

ipsec_policies_preset

字符串

指定 IPsec 预设值。如果提供了此参数，则忽略 “ipsecPolicies” 参数。

选择

  • "default"

  • "aws"

  • "azure"

name

字符串

VPN 对等体的名称。

当状态为 present 时，为必需。

network_tags

列表 / 元素=字符串

将与此对等体连接的网络标记列表。如果未包含，则默认值为 [‘all’]。

private_subnets

列表 / 元素=字符串

VPN 对等体的专用子网列表。

当状态为 present 时，为必需。

public_ip

字符串

VPN 对等体的公共 IP。

当状态为 present 时，为必需。

remote_id

字符串

远程 ID 用于标识连接的 VPN 对等体。它可以是有效的 IPv4 地址、FQDN 或用户 FQDN。

secret

字符串

与 VPN 对等体共享的密钥。

当状态为 present 时，为必需。

rate_limit_retry_time

整数

如果触发速率限制器，则重试的秒数。

默认: 165

state

字符串

指定是否应查询、创建/修改或删除对象。

选择

  • "absent"

  • "present"

  • "query" ← (默认)

timeout

整数

HTTP 请求的超时时间。

默认值： 30

use_https

布尔值

如果为 no，将使用 HTTP。否则将使用 HTTPS。

仅对 Meraki 内部开发人员有用。

选择

  • false

  • true ← (默认)

use_proxy

布尔值

如果为 no，即使目标主机上的环境变量中定义了代理，也不会使用代理。

选择

  • false ← (默认)

  • true

validate_certs

布尔值

是否验证 HTTP 证书。

选择

  • false

  • true ← (默认)

注意

注意

  • 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

  • 某些选项可能仅供 Meraki 内部的开发人员使用。

  • 从 Ansible 2.9 开始，Meraki 模块以蛇形命名法输出键。要使用驼峰命名法，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

  • Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的 playbook。

  • 检查模式会从仪表板下载当前配置，然后将更改与此下载进行比较。如果配置存在差异，检查模式将报告更改，但不会将更改提交到 API 进行验证。

示例

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

返回值

常见的返回值记录在此处，以下是此模块独有的字段

键

描述

response

复杂

有关已创建或修改的组织的信息

返回值：成功

appliance_ip

字符串

VLAN 中 Meraki 设备的 IP 地址

返回值：成功

示例： "192.0.1.1"

dnsnamservers

字符串

VLAN 默认应使用的 IP 地址或 Meraki 定义的 DNS 服务器

返回值：成功

示例： "upstream_dns"

peers

复杂

VPN 对等体的列表。

返回值：成功

ike_version

字符串

用于 IPsec VPN 对等体配置的 IKE 版本。

返回值：成功

示例： "1"

ipsec_policies

复杂

VPN 对等方的自定义 IPSec 策略。

返回值：成功

child_auth_algo

列表 / 元素=字符串

这是在第二阶段中使用的身份验证算法。

返回值：成功

示例： ["sha1"]

child_cipher_algo

列表 / 元素=字符串

这是在第二阶段中使用的密码算法。

返回值：成功

示例： ["aes192"]

child_lifetime

字符串

第二阶段 SA 的生命周期（以秒为单位）。

返回值：成功

示例： "60"

child_pfs_group

列表 / 元素=字符串

这是用于第二阶段完美前向保密的 Diffie-Hellman 组。

返回值：成功

示例： ["group14"]

ike_auth_algo

列表 / 元素=字符串

这是在第一阶段中使用的身份验证算法。

返回值：成功

示例： ["sha1"]

ike_cipher_algo

列表 / 元素=字符串

这是在第一阶段中使用的密码算法。

返回值：成功

示例： ["aes128"]

ike_diffie_hellman_group

列表 / 元素=字符串

这是在第一阶段中使用的 Diffie-Hellman 组。

返回值：成功

示例： ["group14"]

ike_lifetime

字符串

第一阶段 SA 的生命周期（以秒为单位）。

返回值：成功

示例： "60"

ike_prf_algo

列表 / 元素=字符串

这是在 IKE_SA 中使用的伪随机函数。

返回值：成功

示例： ["prfmd5"]

ipsec_policies_preset

字符串

预配置的 IPsec 设置。

返回值：成功

示例： "aws"

name

字符串

VPN 对等体的名称。

返回值：成功

示例： "MyVPNPeer"

network_tags

列表 / 元素=字符串

将与此对等方连接的网络标签列表。

返回值：成功

示例： ["all"]

private_subnets

列表 / 元素=字符串

VPN 对等体的专用子网列表。

返回值：成功

示例： ["192.0.2.0/24"]

public_ip

字符串

VPN 对等体的公共 IP。

返回值：成功

示例： "198.51.100.1"

remote_id

字符串

远程 ID 用于标识连接的 VPN 对等方。

返回值：成功

示例： "s3cret"

状态

  • 此模块将在 3.0.0 版本中移除。[已弃用]

  • 有关详细信息，请参见 已弃用。

作者

  • Kevin Breit (@kbreit)