cisco.meraki.meraki_webhook_payload_template module – Manage webhook payload templates for a network in the Meraki cloud
Note
This module is part of the cisco.meraki collection (version 2.13.0).
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_webhook_payload_template
.
Synopsis
Allows for querying, deleting, creating, and updating of webhook payload templates.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
The liquid template used for the body of the webhook message. |
|
List of the liquid templates used with the webhook headers. Default: |
|
The name of the header template. |
|
The liquid template for the headers |
|
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: |
|
Name of the template. |
|
ID of network containing access points. |
|
Name of network containing access points. |
|
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 payload template should be queried, created, modified, or deleted. 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
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 configuration templates
meraki_webhook_payload_template:
auth_key: abc12345
org_name: YourOrg
state: query
delegate_to: localhost
- name: Query specific configuration templates
meraki_webhook_payload_template:
auth_key: abc12345
org_name: YourOrg
state: query
name: Twitter
delegate_to: localhost
- name: Create payload template
meraki_webhook_payload_template:
auth_key: abc12345
org_name: YourOrg
state: query
name: TestTemplate
body: Testbody
headers:
- name: testheader
template: testheadertemplate
delegate_to: localhost
- name: Delete a configuration template
meraki_config_template:
auth_key: abc123
state: absent
org_name: YourOrg
name: TestTemplate
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Information about queried object. Returned: success |
|
The liquid template used for the body of the webhook message. Returned: success Sample: |
|
List of the liquid templates used with the webhook headers. Returned: success |
|
The name of the template Returned: success Sample: |
|
The liquid template for the header Returned: success Sample: |
|
The name of the template Returned: success Sample: |