cisco.meraki.networks_appliance_connectivity_monitoring_destinations 模块 – 用于 networks _appliance _connectivitymonitoringdestinations 的资源模块

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.meraki.networks_appliance_connectivity_monitoring_destinations

cisco.meraki 2.16.0 中的新功能

概要

  • 管理资源 networks _appliance _connectivitymonitoringdestinations 的操作更新。

  • 更新 MX 网络的连接测试目标。

注意

此模块具有相应的 操作插件

要求

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

  • meraki >= 2.4.9

  • python >= 3.5

参数

参数

注释

目标

列表 / elements=字典

连接监控目标的列表。

默认

布尔值

布尔值,指示这是否为默认测试目标 (true),否则为 (false)。默认为 false。只允许一个默认值。

选择

  • false

  • true

描述

字符串

测试目标的描述。可选,默认为 null。

ip

字符串

用于测试连接的 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。

注释

注意

  • 使用的 SDK 方法是 appliance.Appliance.update_network_appliance_connectivity_monitoring_destinations,

  • 使用的路径是 put /networks/{networkId}/appliance/connectivityMonitoringDestinations,

  • 不支持 check_mode

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

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

参见

另请参见

Cisco Meraki 关于 appliance updateNetworkApplianceConnectivityMonitoringDestinations 的文档

updateNetworkApplianceConnectivityMonitoringDestinations API 的完整参考。

示例

- name: Update all
  cisco.meraki.networks_appliance_connectivity_monitoring_destinations:
    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
    destinations:
    - default: false
      description: Google
      ip: 8.8.8.8
    - default: true
      description: test description
      ip: 1.23.45.67
    - ip: 9.8.7.6
    networkId: string

返回值

常用返回值记录在这里,以下是此模块特有的字段

描述

meraki_response

字典

一个字典或列表,包含 Cisco Meraki Python SDK 返回的响应

返回: 总是

示例: {}

作者

  • Francisco Munoz (@fmunoz)