cisco.meraki.networks_sm_devices_info 模块 – 用于 networks _sm _devices 的信息模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.meraki。 您需要进一步的要求才能使用此模块，请参阅 要求了解详细信息。
要在 playbook 中使用它，请指定： cisco.meraki.networks_sm_devices_info。
cisco.meraki 2.16.0 中的新增功能
概要
获取所有 networks _sm _devices。
列出在 SM 网络中注册的设备，其中包含各种指定的字段和过滤器。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
direction (字符串)，用于分页的方向，可以是 “next”（默认）或 “prev” 页 默认值： |
|
EndingBefore 查询参数。 服务器用来指示页面结尾的令牌。 通常，这是一个时间戳或 ID，但不仅限于这些。 此参数不应由客户端应用程序定义。 HTTP Link 标头中第一个、最后一个、上一个或下一个页面的链接应定义它。 |
|
Fields 查询参数。 将为每个设备显示的附加字段。 默认字段为 id、name、tags、ssid、wifiMac、osName、systemModel、uuid 和 serialNumber。 附加字段为 ip、systemType、availableDeviceCapacity、kioskAppName、biosVersion、lastConnected、missingAppsCount、userSuppliedAddress、location、lastUser、ownerEmail、ownerUsername、osBuild、publicIp、phoneNumber、diskInfoJson、deviceCapacity、isManaged、hadMdm、isSupervised、meid、imei、iccid、simCarrierNetwork、cellularDataUsed、isHotspotEnabled、createdAt、batteryEstCharge、quarantined、avName、avRunning、asName、fwName、isRooted、loginRequired、screenLockEnabled、screenLockDelay、autoLoginDisabled、autoTags、hasMdm、hasDesktopAgent、diskEncryptionEnabled、hardwareEncryptionCaps、passCodeLock、usesHardwareKeystore、androidSecurityPatchVersion、cellular 和 url。 |
|
其他标头。 |
|
Ids 查询参数。 按 id 过滤设备。 |
|
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 (布尔值)，继承您自己的 logger 实例 选择
|
|
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 速率限制错误是否重试？ 选择
|
|
NetworkId 路径参数。网络 ID。 |
|
PerPage 查询参数。每页返回的条目数。可接受的范围是 3 - 1000。默认值为 1000。 |
|
Scope 查询参数。指定一个范围（all、none、withAny、withAll、withoutAny 或 withoutAll 之一）和一组标签。 |
|
Serials 查询参数。按序列号筛选设备。 |
|
StartingAfter 查询参数。服务器用来指示页面开始的令牌。通常这是一个时间戳或 ID，但不限于这些。客户端应用程序不应定义此参数。HTTP Link 标头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
SystemTypes 查询参数。按系统类型筛选设备。 |
|
total_pages(整数)，与 perPage 一起使用可获取总结果，最多为 total_pages*perPage；-1 表示所有页面 |
|
Uuids 查询参数。按 UUID 筛选设备。 |
|
WifiMacs 查询参数。按 WiFi MAC 地址筛选设备。 |
备注
注意
使用的 SDK 方法是 sm.Sm.get_network_sm_devices，
使用的路径是 get /networks/{networkId}/sm/devices，
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco Meraki SDK 的嵌入式连接管理器
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 文档，了解 sm getNetworkSmDevices
getNetworkSmDevices API 的完整参考。
示例
- name: Get all networks _sm _devices
cisco.meraki.networks_sm_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}}"
fields: []
wifiMacs: []
serials: []
ids: []
uuids: []
systemTypes: []
scope: []
perPage: 0
startingAfter: string
endingBefore: string
networkId: string
total_pages: -1
direction: next
register: result
返回值
通用返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco Meraki Python SDK 返回的响应 返回值：总是 示例： |