community.network.avi_api_version – Avi API Version Module

Note

This plugin is part of the community.network collection (version 1.3.2).

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

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

Authors

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