cisco.meraki.organizations_action_batches 模块 – 用于 organizations _actionbatches 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。
要在 playbook 中使用它，请指定：cisco.meraki.organizations_action_batches。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源 organizations _actionbatches 的创建、更新和删除操作。
创建操作批处理。
删除操作批处理。
更新操作批处理。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
ActionBatchId 路径参数。操作批处理 ID。 |
|
作为此操作一部分进行的一组更改（<a href=’https //developer.cisco.com/meraki/api/#… 详细信息</a>）。 |
|
操作的主体。 |
|
要使用的操作。 |
|
要对其执行操作的资源的唯一标识符。 |
|
回调的详细信息。请包括 httpServerId 或 url 和 sharedSecret。 |
|
用于回调 webhook 的 webhook 接收器。 |
|
将接收信息的 webhook 接收器 ID。如果指定此项，请将 url 和 sharedSecret 字段留空。 |
|
用于回调的 webhook 的有效负载模板。 |
|
有效负载模板的 ID。对于回调（包含的）模板，默认为 ‘wpt_00005’。 |
|
一个共享密钥，它将包含在发送到回调 URL 的请求中。它可以用来验证请求是否由 Meraki 发送。如果使用此字段，请同时指定 url。 |
|
webhook 目标的回调 URL。如果使用此字段，请同时指定 sharedSecret。 |
|
设置为 true 以立即执行。如果应在执行之前预览操作，则设置为 false。此属性一旦为 true，就无法取消设置。默认为 false。 选择
|
|
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。 |
|
设置为 true 以强制批处理同步运行。同步批处理中最多可以有 20 个操作。默认为 false。 选择
|
备注
注意
使用的 SDK 方法是 organizations.Organizations.create_organization_action_batch、organizations.Organizations.delete_organization_action_batch、organizations.Organizations.update_organization_action_batch，
使用的路径是 post /organizations/{organizationId}/actionBatches、delete /organizations/{organizationId}/actionBatches/{actionBatchId}、put /organizations/{organizationId}/actionBatches/{actionBatchId}，
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数供 Cisco DNAC Python SDK 用于建立连接
参见
参见
- Cisco Meraki 文档，关于 organizations createOrganizationActionBatch
createOrganizationActionBatch API 的完整参考。
- Cisco Meraki 文档，关于 organizations deleteOrganizationActionBatch
deleteOrganizationActionBatch API 的完整参考。
- Cisco Meraki 文档，关于 organizations updateOrganizationActionBatch
updateOrganizationActionBatch API 的完整参考。
示例
- name: Create
cisco.meraki.organizations_action_batches:
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}}"
state: present
actions:
- operation: create
resource: /devices/QXXX-XXXX-XXXX/switch/ports/3
callback:
httpServer:
id: aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
payloadTemplate:
id: wpt_2100
sharedSecret: secret
url: https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031
confirmed: true
organizationId: string
synchronous: true
- name: Delete by id
cisco.meraki.organizations_action_batches:
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}}"
state: absent
actionBatchId: string
organizationId: string
- name: Update by id
cisco.meraki.organizations_action_batches:
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}}"
state: present
actionBatchId: string
confirmed: true
organizationId: string
synchronous: false
返回值
常见的返回值记录在这里，以下是此模块独有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco Meraki Python SDK 返回的响应 返回：始终 示例： |