Installing the Avi Vantage CLI Shell

Avi Vantage can be managed through the web interface, REST API, or command line interface (CLI). This article describes how to install the CLI shell onto a client PC.


The CLI shell provides access to the Avi Controller through a PC client version of the Controller’s CLI. Two versions of the CLI shell installation package are available:

  • avi_shell-16.1.5000.tar.gz (or later): Can be used with all infrastructure types. If installing this version of the CLI shell, continue with this article.
  • avi_lbaas-16.1.9014.tar.gz (or later): Can be used if the infrastructure type is OpenStack, and Keystone support is enabled. (This is an option during initial Avi Controller setup and also can be configured later.) To install this version of the CLI shell, Installing LBaaS Driver CLI Shell for OPenStack instead.

Note: The CLI packages are available on the Avi customer portal, below the Avi Controller download option for each version.

For more information on Avi customer portal, refer to Access to Avi Customer Portal.

Requirements to enable remote CLI shell

  • CLI Shell server listens on TCP port 5054. In order to use the remote CLI shell, port 5054 must be permitted in the firewall rules between the CLI client and the Avi Controller.

OS Versions Supported

Versions of the CLI shell are available for Linux and Mac.

  • Linux Ubuntu Docker container
  • Linux (not in a Docker container)
  • Mac

The steps are the same for each OS.


The Avi Vantage CLI shell requires the following software:

  • pip (install package manager for Python).
  • Virtual environment (virtualenv): command syntax included below.
  • Avi Vantage CLI shell installation file: from AWS S3.

The following sections provide steps for installing the Avi Vantage CLI shell.

Installing the CLI Shell on a Ubuntu Docker Container

To install the Avi Vantage CLI shell on a Ubuntu Docker container, download the shell package onto the host, then enter the following commands. Make sure to edit the “/tmp” in “/tmp ubuntu” to the directory where you downloaded the image.

docker run -it -v /tmp:/tmp ubuntu
sudo apt-get update
sudo apt-get install python-pip

Installing the CLI Shell on Linux or Mac

This section provides steps for installing the Avi Vantage CLI shell onto the Linux or Macintosh. The steps are the same for either OS. > Note: If installing a CLI shell to manage an OpenStack write access mode deployment with Keystone support enabled, go here instead.

  1. Install pip, if not already installed.
  2. Install virtualenv, if not already installed:
    sudo pip install virtualenv
      Downloading virtualenv-14.0.6-py2.py3-none-any.whl (1.8MB)
        100% |████████████████████████████████| 1.8MB 178kB/s
    Installing collected packages: virtualenv
    Successfully installed virtualenv-14.0.6
  3. Create a virtual environment for the CLI shell:
    virtualenv avi_shell
    New python executable in /home/user/git/clean/avi-dev/build/avi_shell/bin/python
    Installing setuptools, pip, wheel...done.
  4. Go to the CLI shell virtual environment:
    cd avi_shell/
    source ./bin/activate
  5. Install the CLI shell package:
    pip install /tmp/avi_shell-16.1.5000.tar.gz
    Processing /tmp/avi_shell-16.1.5000.tar.gz
    Collecting cmd2==0.6.8 (from shell-client==16.1)
    Collecting iso8601==0.1.11 (from shell-client==16.1)
      Using cached iso8601-0.1.11-py2.py3-none-any.whl
    Successfully installed cmd2-0.6.8 commentjson-0.6 iso8601-0.1.11 prettytable-0.7.2 pyparsing-2.1.0 pytz-2015.7 requests-2.9.1 requests-toolbelt-0.5.1 shell-client-16.1 urllib3-1.14 virtualenv-13.1.2 wheel-0.26.0 wrapt-1.10.6

Logging Onto the CLI Shell

To log onto the Avi Vantage CLI shell:

avi_shell --address
Login: admin
Password *****

The IPADDR is the IP address of the Controller ( in the example).

After login, Avi Vantage CLI commands can be entered into the shell. The command in the following example displays the Avi Vantage version:

show version controller
| Controller Name | Version                            |
|     | 16.1(5000) 2016-03-03 22:42:48 UTC |

Leaving the CLI Virtual Environment

To exit the CLI shell virtual environment:


Restarting the CLI Shell

After the CLI shell is installed, just enter the following command to start it the next time:

 $> avi_shell/bin/avi_shell 

show version controller
| Controller Name | Version                            |
| node-1          | 16.2(5000) 2016-03-07 16:45:38 UTC |
| node-2          | 16.2(5000) 2016-03-07 16:45:38 UTC |
| node-3          | 16.2(5000) 2016-03-07 16:45:38 UTC |