netbox.netbox.netbox_webhook module – Creates, updates or deletes webhook configuration within NetBox
Note
This module is part of the netbox.netbox collection (version 3.20.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 netbox.netbox
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netbox.netbox.netbox_webhook
.
New in netbox.netbox 3.6.0
Synopsis
Creates, updates or removes webhook configuration within NetBox
Requirements
The below requirements are needed on the host that executes this module.
pynetbox
Parameters
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the custom field |
|
User-supplied HTTP headers. Supports jinja2 code. |
|
Body template for webhook. Supports jinja2 code. |
|
CA certificate file to use for SSL verification |
|
A set of conditions which determine whether the webhook will be generated. |
|
The content type(s) to apply this webhook to Required when state=present |
|
Enable/disable the webhook. Choices:
|
|
The HTTP content type. |
|
HTTP method of the webhook. |
|
Name of the webhook |
|
URL for the webhook to use. Required when state=present |
|
Secret key to generate X-Hook-Signature to include in the payload. |
|
Enable ssl verification. Choices:
|
|
Call this webhook when a matching object is created Choices:
|
|
Call this webhook when a matching object is deleted Choices:
|
|
Call this webhook when a matching object is updated Choices:
|
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. |
|
The state of the object. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: |
Notes
Note
This should be ran with connection
local
and hostslocalhost
Use
!unsafe
when adding jinja2 code toadditional_headers
orbody_template
Examples
- name: "Test NetBox webhook module"
connection: local
hosts: localhost
tasks:
- name: Create a webhook
netbox_webhook:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
content_types:
- dcim.device
name: Example Webhook
type_create: true
payload_url: https://payload.url/
body_template: !unsafe >-
{{ data }}
- name: Update the webhook to run on delete
netbox_webhook:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Example Webhook
type_create: true
type_delete: true
payload_url: https://payload.url/
body_template: !unsafe >-
{{ data }}
- name: Delete the webhook
netbox_webhook:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Example Webhook
type_create: true
type_delete: true
payload_url: https://payload.url/
body_template: !unsafe >-
{{ data }}
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Message indicating failure or info about what has been achieved Returned: always |
|
Serialized object as created/existent/updated/deleted within NetBox Returned: always |