cisco.meraki.organizations_inventory_devices_info 模块 – 用于 organizations _inventory _devices 的信息模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您使用的是 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定： cisco.meraki.organizations_inventory_devices_info。
cisco.meraki 2.16.0 中的新增功能
概要
获取所有 organizations _inventory _devices。
按 ID 获取 organizations _inventory _devices。
从组织的清单中返回单个设备。
返回组织的设备清单。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
direction（字符串），分页方向，为“next”（默认）或“prev”页 默认值： |
|
EndingBefore 查询参数。服务器用于指示页面结尾的令牌。通常，这是一个时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 标头中第一个、最后一个、上一个或下一个页面的链接应定义它。 |
|
其他标头。 |
|
Macs 查询参数。根据 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 速率限制错误是否重试？ 选择
|
|
Models 查询参数。根据型号在库存中搜索设备。 |
|
NetworkIds 查询参数。根据网络 ID 在库存中搜索设备。使用显式“null”值仅获取可用设备。 |
|
OrderNumbers 查询参数。根据订单号在库存中搜索设备。 |
|
OrganizationId 路径参数。组织 ID。 |
|
PerPage 查询参数。每页返回的条目数。可接受的范围为 3 - 1000。默认值为 1000。 |
|
ProductTypes 查询参数。根据产品类型筛选设备。可接受的值包括 appliance、camera、cellularGateway、sensor、switch、systemsManager 和 wireless。 |
|
Search 查询参数。根据序列号、MAC 地址或型号搜索库存中的设备。 |
|
Serial 路径参数。 |
|
Serials 查询参数。根据序列号搜索库存中的设备。 |
|
StartingAfter 查询参数。服务器用来指示页面开始的令牌。通常这是一个时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 标头中的第一页、最后一页、上一页或下一页的链接应定义它。 |
|
Tags 查询参数。根据标签筛选设备。筛选区分大小写。如果包含标签，则还应包含 ‘tagsFilterType’（见下文）。 |
|
TagsFilterType 查询参数。与 ‘tags’ 参数一起使用，以筛选包含任何或所有给定标签的设备。可接受的值为 ‘withAnyTags’ 或 ‘withAllTags’，默认值为 ‘withAnyTags’。 |
|
total_pages(int)，与 perPage 一起使用以获取最多 total_pages*perPage 的总结果；-1 表示所有页面 |
|
UsedState 查询参数。按已使用或未使用的库存筛选结果。可接受的值为 ‘used’ 或 ‘unused’。 |
备注
注意
使用的 SDK 方法是 organizations.Organizations.get_organization_inventory_device, organizations.Organizations.get_organization_inventory_devices,
使用的路径是 get /organizations/{organizationId}/inventory/devices, get /organizations/{organizationId}/inventory/devices/{serial},
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco meraki SDK 中的嵌入式连接管理器
以 meraki_ 开头的参数由 Cisco meraki Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 文档，关于 organizations getOrganizationInventoryDevice
getOrganizationInventoryDevice API 的完整参考。
- Cisco Meraki 文档，关于 organizations getOrganizationInventoryDevices
getOrganizationInventoryDevices API 的完整参考。
示例
- name: Get all organizations _inventory _devices
cisco.meraki.organizations_inventory_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
usedState: string
search: string
macs: []
networkIds: []
serials: []
models: []
orderNumbers: []
tags: []
tagsFilterType: string
productTypes: []
organizationId: string
total_pages: -1
direction: next
register: result
- name: Get organizations _inventory _devices by id
cisco.meraki.organizations_inventory_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}}"
organizationId: string
serial: string
register: result
返回值
通用返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
由 Cisco Meraki Python SDK 返回的响应字典或列表 已返回： 始终 示例： |