cisco.meraki.networks_wireless_ssids_vpn 模块 – 网络无线SSID VPN 资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

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

cisco.meraki 2.16.0 中的新增功能

概要

• 管理资源 networks_wireless_ssids_vpn 的操作更新。

• 更新 SSID 的 VPN 设置。

注意

此模块具有相应的 动作插件。

要求

执行此模块的主机需要以下要求。

• meraki >= 2.4.9

• python >= 3.5

参数

参数	注释
concentrator 字典	此 SSID 的 VPN 集中器设置。
networkId 字符串	应设置的集中器的 NAT ID。
vlanId 整数	应为集中器添加标签的 VLAN。
failover 字典	辅助 VPN 集中器设置。仅当在 SSID 上配置了两个 VPN 集中器时才使用。
heartbeatInterval 整数	空闲计时器间隔（秒）。
idleTimeout 整数	空闲计时器超时（秒）。
requestIp 字符串	SSID 将终止的 DHCP 服务器上保留的 IP 地址。
meraki_action_batch_retry_wait_time 整数	meraki_action_batch_retry_wait_time（整数），动作批量并发错误重试等待时间 默认值： 60
meraki_api_key 字符串 / 必需	meraki_api_key（字符串），在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY
meraki_base_url 字符串	meraki_base_url（字符串），位于所有端点资源之前 默认值： "https://api.meraki.com/api/v1"
meraki_be_geo_id 字符串	meraki_be_geo_id（字符串），用于 API 使用跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： ""
meraki_caller 字符串	meraki_caller（字符串），用于 API 使用跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： ""
meraki_certificate_path 字符串	meraki_certificate_path（字符串），如果位于本地代理后面，则用于 TLS/SSL 证书验证的路径 默认值： ""
meraki_inherit_logging_config 布尔值	meraki_inherit_logging_config（布尔值），继承您自己的日志记录实例 选项 false ← (默认) true
meraki_log_file_prefix 字符串	meraki_log_file_prefix（字符串），日志文件名后附加日期和时间戳 默认值： "meraki_api_"
meraki_log_path 字符串	log_path（字符串），输出日志的路径；如果未指定，则默认为脚本的工作目录 默认值： ""
meraki_maximum_retries 整数	meraki_maximum_retries（整数），遇到 429 或其他服务器端错误时最多重试这么多次 默认值： 2
meraki_nginx_429_retry_wait_time 整数	meraki_nginx_429_retry_wait_time（整数），Nginx 429 重试等待时间 默认值： 60
meraki_output_log 布尔值	meraki_output_log（布尔值），创建输出日志文件？ 选项 false true ← (默认)
meraki_print_console 布尔值	meraki_print_console（布尔值），将日志输出打印到控制台？ 选项 false true ← (默认)
meraki_requests_proxy 字符串	meraki_requests_proxy（字符串），如果需要，用于 HTTPS 的代理服务器和端口 默认值： ""
meraki_retry_4xx_error 布尔值	meraki_retry_4xx_error（布尔值），如果遇到其他 4XX 错误（除了 429）则重试？ 选项 false ← (默认) true
meraki_retry_4xx_error_wait_time 整数	meraki_retry_4xx_error_wait_time（整数），其他 4XX 错误重试等待时间 默认值： 60
meraki_simulate 布尔值	meraki_simulate（布尔值），模拟 POST/PUT/DELETE 调用以防止更改？ 选项 false ← (默认) true
meraki_single_request_timeout 整数	meraki_single_request_timeout（整数），每个 API 调用的最大秒数 默认值： 60
meraki_suppress_logging 布尔值	meraki_suppress_logging（布尔值），禁用所有日志记录？那你就自求多福吧！ 选项 false ← (默认) true
meraki_use_iterator_for_get_pages 布尔值	meraki_use_iterator_for_get_pages（布尔值），list* 方法将返回包含每个对象的迭代器，而不是包含所有项目的完整列表 选项 false ← (默认) true
meraki_wait_on_rate_limit 布尔值	meraki_wait_on_rate_limit（布尔值），如果遇到 429 速率限制错误则重试？ 选项 false true ← (默认)
networkId 字符串	NetworkId 路径参数。网络 ID。
数字 字符串	数字路径参数。
splitTunnel 字典	此 SSID 的 VPN 分裂隧道设置。
enabled 布尔值	如果为 true，则启用 VPN 分裂隧道。 选项 false true
rules 列表 / 元素=字典	VPN 分裂隧道规则列表。
comment 字符串	此分裂隧道规则的描述（可选）。
destCidr 字符串	此分裂隧道规则的目标。IP 地址、完全限定域名 (FQDN) 或“any”。
destPort 字符串	此分裂隧道规则的目标端口（1-65535 范围内的整数）或“any”。
policy 字符串	为此分裂隧道规则指定的流量策略，“allow”或“deny”。
protocol 字符串	此分裂隧道规则的协议。

备注

注意

• 使用的SDK方法为wireless.Wireless.update_network_wireless_ssid_vpn。

• 使用的路径为put /networks/{networkId}/wireless/ssids/{number}/vpn。

• 不支持check_mode

• 该插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco DNAC SDK的嵌入式连接管理器。

• 以dnac_开头的参数由Cisco DNAC Python SDK用于建立连接。

另请参见

另请参见

Cisco Meraki关于wireless updateNetworkWirelessSsidVpn的文档。

updateNetworkWirelessSsidVpn API的完整参考。

示例

- name: Update all
  cisco.meraki.networks_wireless_ssids_vpn:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    concentrator:
      name: some concentrator name
      networkId: N_123
      vlanId: 44
    failover:
      heartbeatInterval: 10
      idleTimeout: 30
      requestIp: 1.1.1.1
    networkId: string
    number: string
    splitTunnel:
      enabled: true
      rules:
      - comment: split tunnel rule 1
        destCidr: 1.1.1.1/32
        destPort: any
        policy: allow
        protocol: Any
      - comment: split tunnel rule 2
        destCidr: foo.com
        destPort: any
        policy: deny

返回值

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

键	描述
meraki_response 字典	Cisco Meraki Python SDK返回的响应的字典或列表。 返回值：始终返回 示例：{}

作者

• Francisco Munoz (@fmunoz)

资源链接

• 问题追踪器
• 代码仓库