community.network.avi lookup – Look up ``Avi`` objects.
Note
This lookup plugin is part of the community.network collection (version 5.0.3).
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
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
Synopsis
Given an object_type, fetch all the objects of that type or fetch the specific object that matches the name/uuid given via options.
For single object lookup. If you want the output to be a list, you may want to pass option wantlist=True to the plugin.
Keyword parameters
This describes keyword parameters of the lookup. These are the values key1=value1
, key2=value2
and so on in the following
examples: lookup('community.network.avi', key1=value1, key2=value2, ...)
and query('community.network.avi', key1=value1, key2=value2, ...)
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 |
|
name of the object to query |
|
type of object to query |
|
UUID of the object to query |
|
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
# Lookup query for all the objects of a specific type.
- ansible.builtin.debug: msg="{{ lookup('community.network.avi', avi_credentials=avi_credentials, obj_type='virtualservice') }}"
# Lookup query for an object with the given name and type.
- ansible.builtin.debug: msg="{{ lookup('community.network.avi', avi_credentials=avi_credentials, obj_name='vs1', obj_type='virtualservice', wantlist=True) }}"
# Lookup query for an object with the given UUID and type.
- ansible.builtin.debug: msg="{{ lookup('community.network.avi', obj_uuid='virtualservice-5c0e183a-690a-45d8-8d6f-88c30a52550d', obj_type='virtualservice') }}"
# We can replace lookup with query function to always the get the output as list.
# This is helpful for looping.
- ansible.builtin.debug: msg="{{ query('community.network.avi', obj_uuid='virtualservice-5c0e183a-690a-45d8-8d6f-88c30a52550d', obj_type='virtualservice') }}"
Return Value
Key |
Description |
---|---|
One ore more objects returned from ``Avi`` API. Returned: success |