cisco.meraki.meraki_webhook module -- Manage webhooks configured in the Meraki cloud

Note

This module is part of the cisco.meraki collection (version 2.18.2).

To install it, use: ansible-galaxy collection install cisco.meraki.

To use it in a playbook, specify: cisco.meraki.meraki_webhook.

DEPRECATED

Removed in:

version 3.0.0

Why:

Updated modules released with increased functionality

Alternative:

cisco.meraki.networks_webhooks_http_servers

Synopsis

  • Configure and query information about webhooks within the Meraki cloud.

Parameters

Parameter

Comments

auth_key

string / required

Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.

host

string

Hostname for Meraki dashboard.

Can be used to access regional Meraki environments, such as China.

Default: :ansible-option-default:`"api.meraki.com"`

internal_error_retry_time

integer

Number of seconds to retry if server returns an internal server error.

Default: :ansible-option-default:`60`

name

string

Name of webhook.

net_id

string

ID of network which configuration is applied to.

net_name

aliases: network

string

Name of network which configuration is applied to.

org_id

string

ID of organization.

org_name

aliases: organization

string

Name of organization.

output_format

string

Instructs module whether response keys should be snake case (ex. net_id) or camel case (ex. netId).

Choices:

output_level

string

Set amount of debug output during module execution.

Choices:

payload_template_id

string

The ID of the payload template. Overrides payload_template_name if passed too.

payload_template_name

string

The name of the payload template

rate_limit_retry_time

integer

Number of seconds to retry if rate limiter is triggered.

Default: :ansible-option-default:`165`

shared_secret

string

Secret password to use when accessing webhook.

state

string

Specifies whether object should be queried, created/modified, or removed.

Choices:

test

string

Indicates whether to test or query status.

Choices:

test_id

string

ID of webhook test query.

timeout

integer

Time to timeout for HTTP requests.

Default: :ansible-option-default:`30`

url

string

URL to access when calling webhook.

use_https

boolean

If no, it will use HTTP. Otherwise it will use HTTPS.

Only useful for internal Meraki developers.

Choices:

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

validate_certs

boolean

Whether to validate HTTP certificates.

Choices:

webhook_id

string

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 to camelcase.

  • 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
    payload_template_name: 'Slack (included)'
  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

data

complex

List of administrators.

Returned: success

id

string

Unique ID of webhook.

Returned: success

Sample: :ansible-rv-sample-value:`"aHR0cHM6Ly93ZWJob22LnvpdGUvOGViNWI3NmYtYjE2Ny00Y2I4LTlmYzQtND32Mj3F5NzIaMjQ0"`

name

string

Descriptive name of webhook.

Returned: success

Sample: :ansible-rv-sample-value:`"Test\_Hook"`

networkId

string

ID of network containing webhook object.

Returned: success

Sample: :ansible-rv-sample-value:`"N\_12345"`

payloadTemplate

string

The payload template used when posting data to the HTTP server.

Returned: success

Sample: :ansible-rv-sample-value:`"{'name': 'Meraki (included)', 'payloadTemplateId': 'wpt\_00001'}"`

shared_secret

string

Password for webhook.

Returned: success

Sample: :ansible-rv-sample-value:`"VALUE\_SPECIFIED\_IN\_NO\_LOG\_PARAMETER"`

status

string

Status of webhook test.

Returned: success, when testing webhook

Sample: :ansible-rv-sample-value:`"enqueued"`

url

string

URL of webhook endpoint.

Returned: success

Sample: :ansible-rv-sample-value:`"https://webhook.url/abc123"`

Status

  • This module will be removed in version 3.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Kevin Breit (@kbreit)