cisco.meraki.devices_info 模块 – 设备信息模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在剧本中使用它，请指定： cisco.meraki.devices_info。
cisco.meraki 2.16.0 中的新增功能
概要
获取所有设备。
按 ID 获取设备。
列出组织中的设备。
返回单个设备。
注意
此模块具有相应的 动作插件。
要求
以下是执行此模块的主机所需的条件。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
ConfigurationUpdatedAfter 查询参数。根据设备的配置是否在给定时间戳后更新来筛选结果。 |
|
方向 (字符串)，分页方向，为“next”（默认）或“prev”页 默认值： |
|
EndingBefore 查询参数。服务器用来指示页面结尾的标记。通常是时间戳或 ID，但不限于这些。客户端应用程序不应定义此参数。HTTP Link 头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
附加头。 |
|
Mac 查询参数。可选参数，用于按 MAC 地址筛选设备。所有返回的设备都将具有包含搜索词或完全匹配的 MAC 地址。 |
|
Macs 查询参数。可选参数，用于按一个或多个 MAC 地址筛选设备。所有返回的设备都将具有完全匹配的 MAC 地址。 |
|
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 速率限制错误则重试？ 选项
|
|
模型查询参数。可选参数，用于按型号筛选设备。所有返回的设备都将具有包含搜索词或完全匹配的型号。 |
|
模型查询参数。可选参数，用于按一个或多个型号筛选设备。所有返回的设备都将具有完全匹配的型号。 |
|
名称查询参数。可选参数，用于按名称筛选设备。所有返回的设备名称都将包含搜索词或完全匹配。 |
|
NetworkIds 查询参数。可选参数，用于按网络筛选设备。 |
|
OrganizationId 路径参数。组织 ID。 |
|
PerPage 查询参数。每页返回的条目数。可接受的范围是 3-1000。默认值为 1000。 |
|
ProductTypes 查询参数。可选参数，用于按产品类型筛选设备。有效类型包括：无线、设备、交换机、系统管理器、摄像头、蜂窝网关和传感器。 |
|
SensorAlertProfileIds 查询参数。可选参数，用于按绑定到它们的警报配置文件筛选设备。仅适用于传感器设备。 |
|
SensorMetrics 查询参数。可选参数，用于按它们提供的指标筛选设备。仅适用于传感器设备。 |
|
Serial 路径参数。 |
|
Serials 查询参数。可选参数，用于按一个或多个序列号筛选设备。所有返回的设备都将具有完全匹配的序列号。 |
|
StartingAfter 查询参数。服务器用来指示页面开始的令牌。通常是时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
Tags 查询参数。可选参数，用于按标签筛选设备。 |
|
TagsFilterType 查询参数。可选参数，值为“withAnyTags”或“withAllTags”，用于指示是返回包含任何标签还是所有标签的网络。如果未包含类型，则将选择“withAnyTags”。 |
|
total_pages(int)，与 perPage 一起使用以获取最多 total_pages*perPage 的总结果；-1 表示所有页面 |
注释
注意
使用的 SDK 方法为 devices.Devices.get_device、devices.Devices.get_organization_devices。
使用的路径为 get /devices/{serial}、get /organizations/{organizationId}/devices。
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco Meraki SDK 中的嵌入式连接管理器。
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco Meraki 设备 getDevice 文档
getDevice API 的完整参考。
- Cisco Meraki 设备 getOrganizationDevices 文档
getOrganizationDevices API 的完整参考。
示例
- name: Get all devices
cisco.meraki.devices_info:
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}}"
perPage: 0
startingAfter: string
endingBefore: string
configurationUpdatedAfter: string
networkIds: []
productTypes: []
tags: []
tagsFilterType: string
name: string
mac: string
serial: string
model: string
macs: []
serials: []
sensorMetrics: []
sensorAlertProfileIds: []
models: []
organizationId: string
total_pages: -1
direction: next
register: result
- name: Get devices by id
cisco.meraki.devices_info:
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}}"
serial: string
register: result
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco Meraki Python SDK 返回的响应的字典或列表 返回：始终 示例： |