Documentation
  • Docs »
  • avi_webhook - Module for setup of Webhook Avi RESTful Object

avi_webhook - Module for setup of Webhook Avi RESTful Object

New in version 2.4.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • avisdk

Parameters

Parameter Choices/Defaults Comments
api_context
(added in 2.5)
Avi API context that includes current session ID and CSRF Token.
This allows user to perform single login and re-use the session.
api_version Default:
"16.4.4"
Avi API version of to use for Avi API and objects.
avi_api_patch_op
(added in 2.5)
    Choices:
  • add
  • replace
  • delete
Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method
(added in 2.5)
    Choices:
  • put ←
  • patch
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials
(added in 2.5)
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
callback_url
Callback url for the webhook.
Field introduced in 17.1.1.
controller Default:
""
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
Field introduced in 17.1.1.
name
required
The name of the webhook profile.
Field introduced in 17.1.1.
password Default:
""
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
    Choices:
  • absent
  • present ←
The state that should be applied on the entity.
tenant Default:
"admin"
Name of tenant used for all Avi API calls and context of object.
tenant_ref
It is a reference to an object of type tenant.
Field introduced in 17.1.1.
tenant_uuid Default:
""
UUID of tenant used for all Avi API calls and context of object.
url
Avi controller URL of the object.
username Default:
""
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
Uuid of the webhook profile.
Field introduced in 17.1.1.
verification_token
Verification token sent back with the callback asquery parameters.
Field introduced in 17.1.1.

Notes

Note

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, the following are the fields unique to this module:

Key Returned Description
obj
dict
 success, changed
Webhook (api/webhook) object


Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.