cisco.meraki.organizations_appliance_vpn_third_party_vpnpeers 模块 – 用于 organizations _appliance _vpn _thirdpartyvpnpeers 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要满足更多要求才能使用此模块，请参阅 要求 了解详情。
要在 playbook 中使用它，请指定：cisco.meraki.organizations_appliance_vpn_third_party_vpnpeers。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源 organizations _appliance _vpn _thirdpartyvpnpeers 的操作更新。
更新组织的第三方 VPN 对等方。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
meraki_action_batch_retry_wait_time (整数)，操作批处理并发错误重试等待时间 默认值： |
|
meraki_api_key (字符串)，在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (字符串)，所有端点资源的前缀 默认值： |
|
meraki_be_geo_id (字符串)，用于 API 使用跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： |
|
meraki_caller (字符串)，用于 API 使用跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： |
|
meraki_certificate_path (字符串)，如果位于本地代理之后，用于 TLS/SSL 证书验证的路径 默认值： |
|
meraki_inherit_logging_config (布尔值)，继承您自己的记录器实例 选项
|
|
meraki_log_file_prefix (字符串)，日志文件名，附加日期和时间戳 默认值： |
|
log_path (字符串)，输出日志的路径；如果未指定，则默认为脚本的工作目录 默认值： |
|
meraki_maximum_retries (整数)，在遇到 429 或其他服务器端错误时，最多重试此次数 默认值： |
|
meraki_nginx_429_retry_wait_time (整数)，Nginx 429 重试等待时间 默认值： |
|
meraki_output_log (布尔值)，创建输出日志文件？ 选项
|
|
meraki_print_console (布尔值)，将日志输出打印到控制台？ 选项
|
|
meraki_requests_proxy (字符串)，如果需要，用于 HTTPS 的代理服务器和端口 默认值： |
|
meraki_retry_4xx_error (布尔值)，如果遇到其他 4XX 错误（除了 429）是否重试？ 选项
|
|
meraki_retry_4xx_error_wait_time (整数)，其他 4XX 错误重试等待时间 默认值： |
|
meraki_simulate (布尔值)，模拟 POST/PUT/DELETE 调用以防止更改？ 选项
|
|
meraki_single_request_timeout (整数)，每次 API 调用的最大秒数 默认值： |
|
meraki_suppress_logging (布尔值)，禁用所有日志记录？那您就靠自己了！ 选项
|
|
meraki_use_iterator_for_get_pages (布尔值)，list* 方法将返回一个迭代器，其中包含每个对象，而不是包含所有项的完整列表 选项
|
|
meraki_wait_on_rate_limit (布尔值)，如果遇到 429 速率限制错误是否重试？ 选项
|
|
OrganizationId 路径参数。组织 ID。 |
|
VPN 对等方列表。 |
|
可选。用于 IPsec VPN 对等方配置的 IKE 版本。省略时默认为“1”。 |
|
VPN 对等方的自定义 IPSec 策略。如果未包含并且未选择预设，则将使用 IPSec 策略的默认预设。 |
|
这是在第 2 阶段中使用的身份验证算法。该值应是一个数组，包含以下算法之一：“sha256”、“sha1”、“md5”。 |
|
这是在第 2 阶段中使用的密码算法。该值应是一个或多个以下算法的数组：“aes256”、“aes192”、“aes128”、“tripledes”、“des”、“null”。 |
|
第 2 阶段 SA 的生命周期（以秒为单位）。 |
|
这是在第 2 阶段中用于完全正向保密性的 Diffie-Hellman 组。该值应是一个数组，包含以下值之一：“disabled”、“group14”、“group5”、“group2”、“group1”。 |
|
这是在第 1 阶段中使用的身份验证算法。该值应是一个数组，包含以下算法之一：“sha256”、“sha1”、“md5”。 |
|
这是在第一阶段使用的加密算法。该值应该是一个数组，包含以下算法之一：'aes256'、'aes192'、'aes128'、'tripledes'、'des'。 |
|
这是在第一阶段使用的 Diffie-Hellman 群组。该值应该是一个数组，包含以下算法之一：'group14'、'group5'、'group2'、'group1'。 |
|
第一阶段 SA 的生命周期（以秒为单位）。 |
|
可选。这是在 IKE_SA 中使用的伪随机函数。该值应该是一个数组，包含以下算法之一：'prfsha256'、'prfsha1'、'prfmd5'、'default'。可以使用 'default' 选项来默认为身份验证算法。 |
|
以下可用预设之一：'default'、'aws'、'azure'。如果提供了此项，则忽略 'ipsecPolicies' 参数。 |
|
可选。本地 ID 用于向对等方标识 MX。这将应用于此对等方适用的所有 MX。 |
|
VPN 对等方的名称。 |
|
将与此对等方连接的网络标签列表。使用 'all' 表示所有网络。使用 'none' 表示无网络。如果未包含，则默认为 'all'。 |
|
VPN 对等方的私有子网列表。 |
|
可选。VPN 对等方的公共 IP。 |
|
可选。远程 ID 用于标识连接的 VPN 对等方。它可以是有效的 IPv4 地址、FQDN 或用户 FQDN。 |
|
与 VPN 对等方共享的密钥。 |
注释
注意
使用的 SDK 方法是 appliance.Appliance.update_organization_appliance_vpn_third_party_vpnpeers。
使用的路径是 put /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers。
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中嵌入的连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco Meraki 文档，了解 appliance updateOrganizationApplianceVpnThirdPartyVPNPeers
updateOrganizationApplianceVpnThirdPartyVPNPeers API 的完整参考。
示例
- name: Update all
cisco.meraki.organizations_appliance_vpn_third_party_vpnpeers:
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
organizationId: string
peers:
- ikeVersion: '2'
ipsecPolicies:
childAuthAlgo:
- sha1
childCipherAlgo:
- aes128
childLifetime: 28800
childPfsGroup:
- disabled
ikeAuthAlgo:
- sha1
ikeCipherAlgo:
- tripledes
ikeDiffieHellmanGroup:
- group2
ikeLifetime: 28800
ikePrfAlgo:
- prfsha1
ipsecPoliciesPreset: default
localId: [email protected]
name: Peer Name
networkTags:
- none
privateSubnets:
- 192.168.1.0/24
- 192.168.128.0/24
publicIp: 123.123.123.1
remoteId: [email protected]
secret: Sample Password
返回值
常用返回值记录在这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco Meraki Python SDK 返回的响应。 返回： 始终 示例： |