cisco / cisco.meraki / 2.9.0 / module / meraki_action_batch Manage Action Batch jobs within the Meraki Dashboard. Authors: Kevin Breit (@kbreit) preview | supported by communitycisco.meraki.meraki_action_batch (2.9.0) — module
Install with ansible-galaxy collection install cisco.meraki:==2.9.0
collections: - name: cisco.meraki version: 2.9.0
Allows for management of Action Batch jobs for Meraki.
- 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
host: default: api.meraki.com description: - Hostname for Meraki dashboard. - Can be used to access regional Meraki environments, such as China. type: str state: choices: - query - present - absent default: present description: - Specifies whether to lookup, create, or delete an Action Batch job. type: str net_id: description: - ID of network, if applicable. type: str org_id: description: - ID of organization. type: str actions: description: - List of actions the job should execute. elements: dict suboptions: body: description: - Required body of action. type: raw operation: choices: - create - destroy - update - claim - bind - split - unbind - combine - update_order - cycle - swap - assignSeats - move - moveSeats - renewSeats description: - Operation type of action type: str resource: description: - Path to Action Batch resource. type: str type: list timeout: default: 30 description: - Time to timeout for HTTP requests. type: int auth_key: description: - Authentication key provided by the dashboard. Required if environmental variable C(MERAKI_KEY) is not set. required: true type: str net_name: description: - Name of network, if applicable. type: str org_name: aliases: - organization description: - Name of organization. type: str confirmed: default: false description: - Whether job is to be executed. type: bool use_https: default: true description: - If C(no), it will use HTTP. Otherwise it will use HTTPS. - Only useful for internal Meraki developers. type: bool use_proxy: default: false description: - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. type: bool synchronous: default: true description: - Whether job is a synchronous or asynchronous job. type: bool output_level: choices: - debug - normal default: normal description: - Set amount of debug output during module execution. type: str output_format: choices: - snakecase - camelcase default: snakecase description: - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel case (ex. C(netId)). type: str validate_certs: default: true description: - Whether to validate HTTP certificates. type: bool action_batch_id: description: - ID of an existing Action Batch job. type: str rate_limit_retry_time: default: 165 description: - Number of seconds to retry if rate limiter is triggered. type: int internal_error_retry_time: default: 60 description: - Number of seconds to retry if server returns an internal server error. type: int
data: contains: actions: description: List of actions associated to job. type: dict confirmed: description: Whether action batch job was confirmed for execution. returned: success type: bool id: description: Unique ID of action batch job. returned: success sample: 123 type: str organization_id: description: Unique ID of organization which owns batch job. returned: success sample: 2930418 type: str status: contains: completed: description: Whether job has completed. returned: success type: bool created_resources: description: List of resources created during execution. returned: success sample: - id: 100 uri: /networks/L_XXXXX/groupPolicies/100 type: list errors: description: List of errors, if any, created during execution. returned: success type: list failed: description: Whether execution of action batch job failed. returned: success type: bool description: Information about the action batch job state. type: complex synchronous: description: Whether action batch job executes synchronously or asynchronously. returned: success type: bool description: Information about action batch jobs. returned: always type: complex