cisco.meraki.organizations_firmware_upgrades_by_device_info 模块 – 用于 organizations _firmware _upgrades _bydevice 的信息模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.meraki.organizations_firmware_upgrades_by_device_info。
cisco.meraki 2.16.0 中的新增功能
概要
获取所有 organizations _firmware _upgrades _bydevice。
获取筛选设备的固件升级状态。此端点当前仅支持 Meraki 交换机。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
direction（字符串），分页方向，可以是“next”（默认）或“prev”页 默认值： |
|
EndingBefore 查询参数。服务器用来指示页面结尾的令牌。通常这是一个时间戳或 ID，但不限于这些。客户端应用程序不应定义此参数。HTTP Link 标头中第一个、最后一个、上一个或下一个页面的链接应定义它。 |
|
FirmwareUpgradeBatchIds 查询参数。用于按固件升级批次 ID 筛选的可选参数。 |
|
其他标头。 |
|
Macs 查询参数。用于按属于设备的一个或多个 MAC 地址筛选的可选参数。返回的所有设备都属于精确匹配的 MAC 地址。 |
|
meraki_action_batch_retry_wait_time (integer)，操作批次并发错误重试等待时间 默认值： |
|
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。 默认值为 50。 |
|
Serials 查询参数。 可选参数，用于按序列号筛选。 所有返回的设备都将具有完全匹配的序列号。 |
|
StartingAfter 查询参数。 服务器用于指示页面开始的令牌。 通常这是一个时间戳或 ID，但不仅限于这些。 客户端应用程序不应定义此参数。 HTTP Link 标头中的第一页、最后一页、上一页或下一页的链接应定义它。 |
|
total_pages(整数), 与 perPage 一起使用以获取最多 total_pages*perPage 的结果；-1 表示所有页面 |
|
UpgradeStatuses 查询参数。 可选参数，用于按固件升级状态筛选。 |
说明
注意
使用的 SDK 方法是 organizations.Organizations.get_organization_firmware_upgrades_by_device,
使用的路径是 get /organizations/{organizationId}/firmware/upgrades/byDevice,
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco Meraki SDK 中的嵌入式连接管理器
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 关于 organizations getOrganizationFirmwareUpgradesByDevice 的文档
getOrganizationFirmwareUpgradesByDevice API 的完整参考。
示例
- name: Get all organizations _firmware _upgrades _bydevice
cisco.meraki.organizations_firmware_upgrades_by_device_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: []
macs: []
firmwareUpgradeBatchIds: []
upgradeStatuses: []
organizationId: string
total_pages: -1
direction: next
register: result
返回值
常见返回值在此处记录 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
包含 Cisco Meraki Python SDK 返回的响应的字典或列表 返回: 总是 示例: |