cisco.meraki.meraki_action_batch 模块 – 在 Meraki 仪表板内管理 Action Batch 作业。

注意

此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.meraki。

要在 playbook 中使用它，请指定： cisco.meraki.meraki_action_batch。

已弃用

在以下版本中移除：

3.0.0 版本

原因：

发布了具有增强功能的更新模块

替代方案：

cisco.meraki.organizations_action_batches

概要

• 允许管理 Meraki 的 Action Batch 作业。

参数

参数	注释
action_batch_id 字符串	现有 Action Batch 作业的 ID。
actions 列表 / 元素=字典	作业应执行的操作列表。
body 任意	操作的必需主体。
operation 字符串	操作类型 选项 "create" "destroy" "update" "claim" "bind" "split" "unbind" "combine" "update_order" "cycle" "swap" "assignSeats" "move" "moveSeats" "renewSeats"
resource 字符串	Action Batch 资源的路径。
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
confirmed 布尔值	作业是否要执行。 选项 false ← (默认) true
host 字符串	Meraki 仪表板的主机名。 可用于访问区域 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
net_id 字符串	网络 ID（如果适用）。
net_name 字符串	网络名称（如果适用）。
org_id 字符串	组织的 ID。
org_name 别名：组织 字符串	组织的名称。
output_format 字符串	指示模块响应键是否应为蛇形命名法（例如 net_id）或驼峰命名法（例如 netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间调试输出的数量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
state 字符串	指定是查找、创建还是删除 Action Batch 作业。 选项 "query" "present" ← (默认) "absent"
synchronous 布尔值	作业是同步作业还是异步作业。 选项 false true ← (默认)
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，则将使用 HTTP。否则，将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，则即使在目标主机上定义了环境变量中的代理，也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ← (默认)

备注

注意

• 此模块处于积极开发中，接口可能会更改。

• 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供 Meraki 内部开发人员使用。

• 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法。要使用驼峰命名法，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的 playbook。

• 检查模式会从仪表板下载当前配置，然后将更改与该下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- name: Query all Action Batches
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Query one Action Batch job
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: query
    action_batch_id: 12345
  delegate_to: localhost

- name: Create an Action Batch job
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: present
    actions:
    - resource: '/organizations/org_123/networks'
      operation: 'create'
      body:
        name: 'AnsibleActionBatch1'
        productTypes:
          - 'switch'
  delegate_to: localhost

- name: Update Action Batch job
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: present
    action_batch_id: 12345
    synchronous: false

- name: Create an Action Batch job with multiple actions
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: present
    actions:
    - resource: '/organizations/org_123/networks'
      operation: 'create'
      body:
        name: 'AnsibleActionBatch2'
        productTypes:
          - 'switch'
    - resource: '/organizations/org_123/networks'
      operation: 'create'
      body:
        name: 'AnsibleActionBatch3'
        productTypes:
          - 'switch'
  delegate_to: localhost

- name: Delete an Action Batch job
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: absent
    action_batch_id: 12345
  delegate_to: localhost

返回值

此处记录了常见的返回值 此处，以下是此模块独有的字段

键	描述
data 复杂	有关 Action Batch 作业的信息。 返回：始终
actions 字典	与作业关联的操作列表。 返回：成功
confirmed 布尔值	是否已确认执行动作批处理作业。 返回：成功
id 字符串	动作批处理作业的唯一 ID。 返回：成功 示例： "123"
组织 ID (organization_id) 字符串	拥有该批处理作业的组织的唯一 ID。 返回：成功 示例： "2930418"
状态 (status) 复杂	关于动作批处理作业状态的信息。 返回：成功
已完成 (completed) 布尔值	作业是否已完成。 返回：成功
已创建的资源 (created_resources) 列表 / 元素=字符串	执行期间创建的资源列表。 返回：成功 示例： [{"id": 100, "uri": "/networks/L_XXXXX/groupPolicies/100"}]
错误 (errors) 列表 / 元素=字符串	执行期间产生的错误列表（如有）。 返回：成功
失败 (failed) 布尔值	动作批处理作业执行是否失败。 返回：成功
synchronous 布尔值	动作批处理作业是同步执行还是异步执行。 返回：成功

状态

• 此模块将在 3.0.0 版本中移除。[已弃用]

• 更多信息请参见 已弃用。

作者

• Kevin Breit (@kbreit)

资源链接

• 问题追踪器
• 代码仓库