cisco.meraki.organizations_devices_statuses_info 模块 – 机构设备状态信息模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.meraki。您需要满足其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定： cisco.meraki.organizations_devices_statuses_info。
cisco.meraki 2.16.0 中的新增功能
概要
获取所有机构设备状态。
列出机构中每个 Meraki 设备的状态。
注意
此模块具有相应的 动作插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
direction (字符串), 分页方向，"next"（默认）或 "prev" 页 默认值： |
|
EndingBefore 查询参数。服务器用来指示页面结尾的令牌。通常是时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
附加的头部。 |
|
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 筛选设备。 |
|
OrganizationId 路径参数。组织 ID。 |
|
PerPage 查询参数。每页返回的条目数。可接受的范围是 3-1000。默认为 1000。 |
|
ProductTypes 查询参数。一个可选参数，用于根据产品类型筛选设备状态。有效类型包括：无线 (wireless)、设备 (appliance)、交换机 (switch)、系统管理器 (systemsManager)、摄像头 (camera)、蜂窝网关 (cellularGateway) 和传感器 (sensor)。 |
|
Serials 查询参数。可选参数，用于根据序列号筛选设备。 |
|
StartingAfter 查询参数。服务器使用的令牌，指示页面的起始位置。通常是时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
Statuses 查询参数。可选参数，用于根据状态筛选设备。有效状态包括：“在线 (online)”、“告警 (alerting)”、“离线 (offline)”、“休眠 (dormant)”。 |
|
Tags 查询参数。可选参数，用于根据标签筛选设备。筛选区分大小写。如果包含标签，则也应包含 `tagsFilterType`（见下文）。 |
|
TagsFilterType 查询参数。可选参数，值为 `withAnyTags` 或 `withAllTags`，用于指示是返回包含任何 (ANY) 标签还是所有 (ALL) 标签的设备。如果未包含类型，则选择 `withAnyTags`。 |
|
total_pages(int)，与 perPage 一起使用以获取总结果，最多 total_pages*perPage；-1 表示所有页面。 |
注释
注意
使用的 SDK 方法是 organizations.Organizations.get_organization_devices_statuses，
使用的路径是 get /organizations/{organizationId}/devices/statuses，
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco Meraki SDK 的嵌入式连接管理器。
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接。
另请参见
另请参见
- Cisco Meraki 文档，关于 organizations getOrganizationDevicesStatuses
getOrganizationDevicesStatuses API 的完整参考。
示例
- name: Get all organizations _devices _statuses
cisco.meraki.organizations_devices_statuses_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
networkIds: []
serials: []
statuses: []
productTypes: []
models: []
tags: []
tagsFilterType: string
organizationId: string
total_pages: -1
direction: next
register: result
返回值
常用返回值已在此处 记录，以下是此模块特有的字段：
键 |
描述 |
|---|---|
包含 Cisco Meraki Python SDK 返回的响应的字典或列表。 返回值：始终 示例： |