Documentation

avi_webhook - Module for setup of Webhook Avi RESTful Object

New in version 2.4.

Synopsis

Options

parameter required default choices comments
api_version
no
Avi API version of to use for Avi API and objects.
callback_url
no
Callback url for the webhook.
Field introduced in 17.1.1.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
no
Field introduced in 17.1.1.
name
yes
The name of the webhook profile.
Field introduced in 17.1.1.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
no present
  • absent
  • present
The state that should be applied on the entity.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
no
It is a reference to an object of type tenant.
Field introduced in 17.1.1.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Uuid of the webhook profile.
Field introduced in 17.1.1.
verification_token
no
Verification token sent back with the callback asquery parameters.
Field introduced in 17.1.1.

Examples

- name: Example to create Webhook object
  avi_webhook:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_webhook

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj
Webhook (api/webhook) object
success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.