cisco.meraki.devices_live_tools_cable_test_info 模块 – devices _livetools _cabletest 的信息模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.meraki.devices_live_tools_cable_test_info

cisco.meraki 2.18.0 中的新增功能

概要

  • devices _livetools _cabletest 的信息模块

注意

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

要求

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

  • meraki >= 2.4.9

  • python >= 3.5

参数

参数

注释

headers

字典

其他标头。

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 ← (默认值)

注释

注意

  • 使用的路径是

  • 支持 check_mode

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

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

返回值

常见返回值在此处记录 此处,以下是此模块独有的字段

描述

meraki_response

字典

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

返回: 总是

示例: [{}]

作者

  • Francisco Munoz (@fmunoz)