You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.network.avi_api_version – Avi API Version Module

Note

This plugin is part of the community.network collection (version 3.0.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.

To use it in a playbook, specify: community.network.avi_api_version.

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	Comments
api_context dictionary	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 string	Avi API version of to use for Avi API and objects. Default: “16.4.4”
avi_credentials dictionary	Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
api_version string	Avi controller version Default: “16.4.4”
controller string	Avi controller IP or SQDN
csrftoken string	Avi controller API csrftoken to reuse existing session with session id
password string	Avi controller password
port string	Avi controller port
session_id string	Avi controller API session id to reuse existing session with csrftoken
tenant string	Avi controller tenant Default: “admin”
tenant_uuid string	Avi controller tenant UUID
timeout string	Avi controller request timeout Default: 300
token string	Avi controller API token
username string	Avi controller username
avi_disable_session_cache_as_fact boolean	It disables avi session information to be cached as a fact. Choices: no ← (default) yes
controller string	IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER. Default: “”
password string	Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD. Default: “”
tenant string	Name of tenant used for all Avi API calls and context of object. Default: “admin”
tenant_uuid string	UUID of tenant used for all Avi API calls and context of object. Default: “”
username string	Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME. Default: “”

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
obj dictionary	Avi REST resource Returned: success, changed

Authors

• Vilian Atmadzhov (@vivobg) <vilian.atmadzhov@paddypowerbetfair.com>