New in version 2.5.
The below requirements are needed on the host that executes this module.
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_credentials
(added in 2.5) |
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
controller
|
Default:
|
IP address or hostname of the controller. The default value is the environment variable
AVI_CONTROLLER . |
password
|
Default:
|
Password of Avi user in Avi controller. The default value is the environment variable
AVI_PASSWORD . |
tenant
|
Default:
admin
|
Name of tenant used for all Avi API calls and context of object.
|
tenant_uuid
|
Default:
|
UUID of tenant used for all Avi API calls and context of object.
|
username
|
Default:
|
Username used for accessing Avi controller. The default value is the environment variable
AVI_USERNAME . |
Note
- name: Get AVI API version
avi_api_version:
controller: ""
username: ""
password: ""
tenant: ""
register: avi_controller_version
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
obj
dict
|
success, changed |
Avi REST resource
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.