avi_api_version – Avi API Version Module
avi_api_version – Avi API Version Module
New in version 2.5.
Synopsis
- This module can be used to obtain the version of the Avi REST API. https://avinetworks.com/
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_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 |
password - |
Default: "" |
Password of Avi user in Avi controller. The default value is the environment variable |
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 |
Notes
Note
- For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.
Examples
- name: Get AVI API version
avi_api_version:
controller: ""
username: ""
password: ""
tenant: ""
register: avi_controller_version
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
obj dictionary |
success, changed |
Avi REST resource
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Vilian Atmadzhov ([email protected])
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/avi_api_version_module.html