cisco.meraki.meraki_webhook module – Manage webhooks configured 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
.
Synopsis
Configure and query information about webhooks within the Meraki cloud.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
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 webhook. |
|
ID of network which configuration is applied to. |
|
Name of network which configuration is applied to. |
|
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: |
|
Secret password to use when accessing webhook. |
|
Specifies whether object should be queried, created/modified, or removed. Choices:
|
|
Indicates whether to test or query status. Choices:
|
|
ID of webhook test query. |
|
Time to timeout for HTTP requests. Default: |
|
URL to access when calling webhook. |
|
If Only useful for internal Meraki developers. Choices:
|
|
If Choices:
|
|
Whether to validate HTTP certificates. Choices:
|
|
Unique ID of webhook. |
Notes
Note
Some of the options are likely only used for developers within Meraki.
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: Create webhook
meraki_webhook:
auth_key: abc123
state: present
org_name: YourOrg
net_name: YourNet
name: Test_Hook
url: https://webhook.url/
shared_secret: shhhdonttellanyone
delegate_to: localhost
- name: Query one webhook
meraki_webhook:
auth_key: abc123
state: query
org_name: YourOrg
net_name: YourNet
name: Test_Hook
delegate_to: localhost
- name: Query all webhooks
meraki_webhook:
auth_key: abc123
state: query
org_name: YourOrg
net_name: YourNet
delegate_to: localhost
- name: Delete webhook
meraki_webhook:
auth_key: abc123
state: absent
org_name: YourOrg
net_name: YourNet
name: Test_Hook
delegate_to: localhost
- name: Test webhook
meraki_webhook:
auth_key: abc123
state: present
org_name: YourOrg
net_name: YourNet
test: test
url: https://webhook.url/abc123
delegate_to: localhost
- name: Get webhook status
meraki_webhook:
auth_key: abc123
state: present
org_name: YourOrg
net_name: YourNet
test: status
test_id: abc123531234
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of administrators. Returned: success |
|
Unique ID of webhook. Returned: success Sample: |
|
Descriptive name of webhook. Returned: success Sample: |
|
ID of network containing webhook object. Returned: success Sample: |
|
Password for webhook. Returned: success Sample: |
|
Status of webhook test. Returned: success, when testing webhook Sample: |
|
URL of webhook endpoint. Returned: success Sample: |