cisco.meraki.devices_live_tools_cable_test 模块 – 设备 _livetools _cabletest 资源模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在playbook中使用它，请指定： cisco.meraki.devices_live_tools_cable_test。
cisco.meraki 2.18.0 中的新增功能
概要
管理资源devices _livetools _cabletest的创建操作。
将作业排队以对指定端口上的设备执行电缆测试。
注意
此模块具有相应的 action 插件。
要求
在执行此模块的主机上需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
回调详细信息。请包含 httpServerId 或 url 和 sharedSecret。 |
|
用于回调 webhooks 的 webhook 接收器。 |
|
将接收信息的 webhook 接收器 ID。如果指定此项，请将 url 和 sharedSecret 字段留空。 |
|
用于回调的 webhook 的有效负载模板。 |
|
有效负载模板的 ID。对于回调（包含）模板，默认为“wpt_00005”。 |
|
将包含在发送到回调 URL 的请求中的共享密钥。它可用于验证请求是由 Meraki 发送的。如果使用此字段，请同时指定 url。 |
|
webhook 目标的回调 URL。如果使用此字段，请同时指定 sharedSecret。 |
|
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 (布尔值), 列表*方法将返回一个包含每个对象的迭代器，而不是包含所有项目的完整列表 选项
|
|
meraki_wait_on_rate_limit (布尔值), 遇到429速率限制错误时是否重试？ 选项
|
|
执行电缆测试的端口列表。 |
|
串口路径参数。 |
备注
注意
使用的SDK方法为devices.Devices.create_device_live_tools_cable_test，
使用的路径为post /devices/{serial}/liveTools/cableTest，
不支持
check_mode插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco DNAC SDK的嵌入式连接管理器
以dnac_开头的参数由Cisco DNAC Python SDK用于建立连接
另请参见
另请参见
- Cisco Meraki 设备 createDeviceLiveToolsCableTest 文档
createDeviceLiveToolsCableTest API 的完整参考。
示例
- name: Create
cisco.meraki.devices_live_tools_cable_test:
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
callback:
httpServer:
id: aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
payloadTemplate:
id: wpt_2100
sharedSecret: secret
url: https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031
ports:
- '2'
- '8'
serial: string
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含Cisco Meraki Python SDK返回的响应的字典或列表 返回：始终 示例： |