cisco.meraki.networks_appliance_vpn_bgp 模块 – 网络_设备_VPN_BGP 资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。

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

cisco.meraki 2.16.0 中的新增功能

概要

• 管理资源网络_设备_VPN_BGP 的操作更新。

• 更新集线器 BGP 配置。

注意

此模块具有相应的 action 插件。

要求

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

• meraki >= 2.4.9

• python >= 3.5

参数

参数	注释
asNumber 整数	如果您要运行 BGP 并与 Auto VPN 域外的另一个 BGP 说话者对等，则需要一个自治系统编号 (ASN)。此 ASN 将应用于整个 Auto VPN 域。支持整个 4 字节 ASN 范围。因此，ASN 必须是 1 到 4294967295 之间的整数。不存在时，此字段不会更新。如果不存在值，则默认为 64512。
enabled 布尔值	布尔值用于启用或禁用 BGP 配置。启用 BGP 后，asNumber (ASN) 将使用其他集线器中预配置的 ASN 或默认值（如果未配置 ASN）自动填充。 选项 false true
ibgpHoldTimer 整数	以秒为单位的 iBGP 保持计时器。iBGP 保持计时器必须是 12 到 240 之间的整数。不存在时，此字段不会更新。如果不存在值，则默认为 240。
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 ← (默认)
neighbors 列表 / 元素=字典	BGP 邻居列表。此列表替换现有的邻居集。不存在时，此字段不会更新。
allowTransit 布尔值	启用此功能后，Meraki 设备将通告从其他自治系统学习到的路由，从而允许自治系统之间的流量通过此 AS 传输。不存在时，默认为 false。 选项 false true
authentication 字典	BGP 对等体之间的身份验证设置。
password 字符串	用于配置 BGP 对等体之间 MD5 身份验证的密码。
ebgpHoldTimer 整数	每个邻居的eBGP保持计时器（以秒为单位）。eBGP保持计时器必须是12到240之间的整数。
ebgpMultihop 整数	如果邻居不相邻，则配置此项。eBGP多跳必须是1到255之间的整数。
ip 字符串	邻居的IPv4地址。
ipv6 字典	邻居的IPv6地址信息，如果未提供`ip`，则需要此项。
address 字符串	邻居的IPv6地址。
nextHopIp 字符串	将与本地MX建立TCP会话的远程BGP对等体的IPv4地址。
receiveLimit 整数	接收限制是从任何BGP对等体可以接收的最大路由数。接收限制必须是0到4294967295之间的整数。如果缺失，则默认为0。
remoteAsNumber 整数	邻居的远程ASN。远程ASN必须是1到4294967295之间的整数。
sourceInterface 字符串	与远程BGP对等体对等连接的输出接口。有效值为“wan1”、“wan2”或“vlan{VLAN ID}”（例如，“vlan123”）。
ttlSecurity 字典	BGP TTL安全设置，用于保护BGP对等会话免受伪造IP攻击。
enabled 布尔值	布尔值，用于启用或禁用BGP TTL安全。 选项 false true
networkId 字符串	NetworkId路径参数。网络ID。

注释

注意

• 使用的SDK方法是appliance.Appliance.update_network_appliance_vpn_bgp，

• 使用的路径是put /networks/{networkId}/appliance/vpn/bgp，

• 不支持check_mode

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

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

另请参见

另请参见

Cisco Meraki文档，了解appliance updateNetworkApplianceVpnBgp。

updateNetworkApplianceVpnBgp API的完整参考。

示例

- name: Update all
  cisco.meraki.networks_appliance_vpn_bgp:
    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
    asNumber: 64515
    enabled: true
    ibgpHoldTimer: 120
    neighbors:
    - allowTransit: true
      ebgpHoldTimer: 180
      ebgpMultihop: 2
      ip: 10.10.10.22
      receiveLimit: 120
      remoteAsNumber: 64343
    networkId: string

返回值

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

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

作者

• Francisco Munoz (@fmunoz)

集合链接

• 问题追踪器
• 代码库（源代码）