cisco.meraki.organizations_inventory_claim 模块 – 用于组织机构 _inventory _claim 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，您可能已经安装了这个集合。 它不包含在 ansible-core 中。 要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。 您需要进一步的要求才能使用此模块，请参阅 要求 了解详情。
要在 playbook 中使用它，请指定：cisco.meraki.organizations_inventory_claim。
cisco.meraki 2.16.0 中的新功能
概要
管理资源组织机构 _inventory _claim 的创建操作。
将设备、许可证和/或订单列表声明到组织库存中。当按订单声明时，订单中的所有设备和许可证都将被声明；许可证将被添加到组织中，设备将被放置在组织的库存中。此操作可以在五分钟的时间窗口内最多使用十次。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
应该声明的许可证。 |
|
许可证的密钥。 |
|
仅限协同许可，可以是 “renew” 或 “addDevices”。 “addDevices” 将增加许可证限制，而 “renew” 将延长到期时间。默认为 “addDevices”。 所有许可证必须使用相同的模式声明，并且一次最多只能声明一次续订。不适用于使用按设备许可模式的组织。 |
|
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 速率限制错误是否重试？ 选择
|
|
应该声明的订单号。 |
|
OrganizationId 路径参数。组织 ID。 |
|
应该声明的设备的序列号。 |
注释
注意
使用的 SDK 方法是 organizations.Organizations.claim_into_organization_inventory，
使用的路径是 post /organizations/{organizationId}/inventory/claim，
不支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关组织机构 claimIntoOrganizationInventory 的 Cisco Meraki 文档
claimIntoOrganizationInventory API 的完整参考。
示例
- name: Create
cisco.meraki.organizations_inventory_claim:
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}}"
licenses:
- key: Z2XXXXXXXXXX
mode: addDevices
orders:
- 4CXXXXXXX
organizationId: string
serials:
- Q234-ABCD-5678
返回值
常见的返回值记录在 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco Meraki Python SDK 返回的响应。 返回: 总是 示例: |