cisco.meraki.meraki_webhook_payload_template (2.18.0) — module

Install collection

Install with ansible-galaxy collection install cisco.meraki:==2.18.0

Add to requirements.yml

  collections:
    - name: cisco.meraki
      version: 2.18.0

Description

Allows for querying, deleting, creating, and updating of webhook payload templates.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Query all configuration templates
  meraki_webhook_payload_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Query specific configuration templates
  meraki_webhook_payload_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
    name: Twitter
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete a configuration template
  meraki_config_template:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    name: TestTemplate
  delegate_to: localhost

Inputs

    
body:
    description:
    - The liquid template used for the body of the webhook message.
    type: str

host:
    default: api.meraki.com
    description:
    - Hostname for Meraki dashboard.
    - Can be used to access regional Meraki environments, such as China.
    type: str

name:
    description:
    - Name of the template.
    type: str

state:
    choices:
    - absent
    - query
    - present
    default: query
    description:
    - Specifies whether payload template should be queried, created, modified, or deleted.
    type: str

net_id:
    description:
    - ID of network containing access points.
    type: str

org_id:
    description:
    - ID of organization.
    type: str

headers:
    default: []
    description:
    - List of the liquid templates used with the webhook headers.
    elements: dict
    suboptions:
      name:
        description:
        - The name of the header template.
        type: str
      template:
        description:
        - The liquid template for the headers
        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 containing access points.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization.
    type: str

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

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

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

Outputs

data:
  contains:
    body:
      description:
      - The liquid template used for the body of the webhook message.
      returned: success
      sample:
        client_payload:
          text: '{{alertData}}'
        event_type: '{{alertTypeId}}'
      type: str
    headers:
      contains:
        name:
          description:
          - The name of the template
          returned: success
          sample: testTemplate
          type: str
        template:
          description:
          - The liquid template for the header
          returned: success
          sample: Bearer {{sharedSecret}}
          type: str
      description: List of the liquid templates used with the webhook headers.
      returned: success
      type: list
    name:
      description:
      - The name of the template
      returned: success
      sample: testTemplate
      type: str
  description: Information about queried object.
  returned: success
  type: complex