community.network.avi_api_version module – Avi API Version Module
Note
This module is part of the community.network collection (version 5.1.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 community.network
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.network.avi_api_version
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This collection and all content in it is unmaintained and deprecated.
- Alternative:
Unknown.
Synopsis
This module can be used to obtain the version of the Avi REST API. https://avinetworks.com/
Aliases: network.avi.avi_api_version
Requirements
The below requirements are needed on the host that executes this module.
avisdk
Parameters
Parameter |
Comments |
---|---|
Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. |
|
Avi API version of to use for Avi API and objects. Default: |
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. |
|
Avi controller version Default: |
|
Avi controller IP or SQDN |
|
Avi controller API csrftoken to reuse existing session with session id Default: |
|
Avi controller password |
|
Avi controller port |
|
Avi controller API session id to reuse existing session with csrftoken Default: |
|
Avi controller tenant Default: |
|
Avi controller tenant UUID Default: |
|
Avi controller request timeout Default: |
|
Avi controller API token Default: |
|
Avi controller username |
|
It disables avi session information to be cached as a fact. Choices:
|
|
IP address or hostname of the controller. The default value is the environment variable |
|
Password of Avi user in Avi controller. The default value is the environment variable |
|
Name of tenant used for all Avi API calls and context of object. Default: |
|
UUID of tenant used for all Avi API calls and context of object. 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
community.network.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 |
Description |
---|---|
Avi REST resource Returned: success, changed |
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.