cisco.meraki.meraki_action_batch module – Manage Action Batch jobs within the Meraki Dashboard.
Note
This module is part of the cisco.meraki collection (version 2.18.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.meraki
.
To use it in a playbook, specify: cisco.meraki.meraki_action_batch
.
DEPRECATED
- Removed in:
version 3.0.0
- Why:
Updated modules released with increased functionality
- Alternative:
cisco.meraki.organizations_action_batches
Synopsis
Allows for management of Action Batch jobs for Meraki.
Parameters
Parameter |
Comments |
---|---|
ID of an existing Action Batch job. |
|
List of actions the job should execute. |
|
Required body of action. |
|
Operation type of action Choices:
|
|
Path to Action Batch resource. |
|
Authentication key provided by the dashboard. Required if environmental variable |
|
Whether job is to be executed. Choices:
|
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: |
|
Number of seconds to retry if server returns an internal server error. Default: |
|
ID of network, if applicable. |
|
Name of network, if applicable. |
|
ID of organization. |
|
Name of organization. |
|
Instructs module whether response keys should be snake case (ex. Choices:
|
|
Set amount of debug output during module execution. Choices:
|
|
Number of seconds to retry if rate limiter is triggered. Default: |
|
Specifies whether to lookup, create, or delete an Action Batch job. Choices:
|
|
Whether job is a synchronous or asynchronous job. Choices:
|
|
Time to timeout for HTTP requests. Default: |
|
If Only useful for internal Meraki developers. Choices:
|
|
If Choices:
|
|
Whether to validate HTTP certificates. Choices:
|
Notes
Note
This module is in active development and the interface may change.
More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
Some of the options are likely only used for developers within Meraki.
As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the
ANSIBLE_MERAKI_FORMAT
environment variable tocamelcase
.Ansible’s Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.
Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Information about action batch jobs. Returned: always |
|
List of actions associated to job. Returned: success |
|
Whether action batch job was confirmed for execution. Returned: success |
|
Unique ID of action batch job. Returned: success Sample: |
|
Unique ID of organization which owns batch job. Returned: success Sample: |
|
Information about the action batch job state. Returned: success |
|
Whether job has completed. Returned: success |
|
List of resources created during execution. Returned: success Sample: |
|
List of errors, if any, created during execution. Returned: success |
|
Whether execution of action batch job failed. Returned: success |
|
Whether action batch job executes synchronously or asynchronously. Returned: success |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.