cisco.meraki.meraki_mx_site_to_site_vpn 模块 – 管理 Meraki 中的 AutoVPN 连接

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.meraki.meraki_mx_site_to_site_vpn。

cisco.meraki 1.1.0 中的新增功能

已弃用

在以下版本中删除:

版本 3.0.0

原因:

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

替代方案:

cisco.meraki.networks_appliance_vpn_site_to_site_vpn

概要

• 允许创建、管理和查看在 Meraki MX 防火墙上实现的 AutoVPN。

参数

参数	注释
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需。
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，如中国。 默认值: "api.meraki.com"
hubs 列表 / 元素=字典	要分配给分支的 Hub 列表。
hub_id 字符串	Hub 的网络 ID
use_default_route 布尔值	指示是否应将默认路由流量发送到此 Hub。 仅在分支模式下有效。 选项 false true
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值: 60
mode 字符串	设置网络的 VPN 模式 选项 "none" "hub" "spoke"
net_id 字符串	MX 防火墙所在的网络的 ID。
net_name 字符串	MX 防火墙所在的网络的名称。
org_id 字符串	组织的 ID。
org_name 别名: organization 字符串	组织的名称。
output_format 字符串	指示模块响应键应为蛇形命名（例如 net_id）还是驼峰命名（例如 netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值: 165
state 字符串	创建或修改组织。 选项 "present" ← (默认) "query"
subnets 列表 / 元素=字典	要通过 VPN 广播的子网列表。
local_subnet 字符串	CIDR 格式的子网。
use_vpn 布尔值	是否通过 VPN 广播。 选项 false true
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: Set hub mode
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: hub_network
    mode: hub
  delegate_to: localhost
  register: set_hub

- name: Set spoke mode
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: spoke_network
    mode: spoke
    hubs:
      - hub_id: N_1234
        use_default_route: false
  delegate_to: localhost
  register: set_spoke

- name: Add subnet to hub for VPN. Hub is required.
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: hub_network
    mode: hub
    hubs:
      - hub_id: N_1234
        use_default_route: false
    subnets:
      - local_subnet: 192.168.1.0/24
        use_vpn: true
  delegate_to: localhost
  register: set_hub

- name: Query rules for hub
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: hub_network
  delegate_to: localhost
  register: query_all_hub

返回值

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

键	描述
数据 复合	VPN 设置。 返回值: 成功
hubs 复合	要关联的 Hub 网络。 返回值: 总是
hub_id 复合	Hub 网络的 ID。 返回值: 总是 示例: "N_12345"
use_default_route 布尔值	是否通过 VPN 发送所有默认路由流量。 返回值: 总是 示例: true
mode 字符串	分配给网络的模式。 返回值: 总是 示例: "spoke"
subnets 复合	要通过 VPN 广播的子网列表。 返回值: 总是
local_subnet 字符串	CIDR 格式的子网。 返回值: 总是 示例: "192.168.1.0/24"
use_vpn 布尔值	子网是否应使用 VPN。 返回值: 总是 示例: true

状态

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

• 有关更多信息，请参阅 已弃用。

作者

• Kevin Breit (@kbreit)

集合链接

• 问题跟踪器
• 存储库（源代码）