Installing the LBaaS CLI Shell

The CLI shell provides access to the NSX Advanced Load Balancer 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, click here.
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 NSX Advanced Load Balancer Controller setup and also can be configured later.) To install this version of the CLI shell, continue with this article.

Requirements to Enable Remote CLI Shell

CLI shell server listens on TCP port 5054. To use the remote CLI shell, port 5054 must be permitted in the firewall rules between the CLI client and the NSX Advanced Load Balancer 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.

Prerequisites

The NSX Advanced Load Balancer CLI shell requires the following software:

pip (install package manager for Python).
Virtual environment (virtualenv): command syntax included below.
NSX Advanced Load Balancer CLI shell installation file: from AWS S3.

Additionally, the LBaaS version of the CLI shell is applicable if the NSX Advanced Load Balancer Controller is deployed into an OpenStack cloud and Keystone support is enabled. A Keystone catalog entry such as the following is required:

source admincc
keystone catalog
Service: avi-lbaas
+-----------+----------------------------------+
|  Property |              Value               |
+-----------+----------------------------------+
|     id    | db5e92e8740c4850ba3d81c73b6c4f23 |
| publicURL |     https://10.10.25.201/api     |
|   region  |            regionOne             |
+-----------+----------------------------------+
...
...

If the Keystone catalog does not contain an entry for NSX Advanced Load Balancer, one will need to be added using the steps in the following section.

Adding a Keystone Catalog Entry for NSX Advanced Load Balancer

Adding a Keystone entry requires an administrator.

This section provides the command strings the administrator can use to create the Keystone entry for NSX Advanced Load Balancer. The command strings differ slightly depending on whether they are entered using openstack client or keystone client.

Make sure to replace the following with the values that are applicable to your deployment:

NSX Advanced Load Balancer-Controller-IP:: Management IP address of the NSX Advanced Load Balancer Controller.
RegionOne:: Name of the region the NSX Advanced Load Balancer Controller is allowed to use. If there is only one region, enter keystone catalog and select the region name that is used for other services.

If Using `openstack-client`

Depending on the version of open-stack client, use one or the other set of commands shown here. If the openrc credentials contain “OS_IDENTITY_API_VERSION=3,” use the second set of commands. Otherwise, use the first set of commands.

If openrc credentials do not contain “OS_IDENTITY_API_VERSION=3”:

openstack service create  --name avi --description "Avi LBaaS" avi-lbaas
openstack endpoint create --publicurl https://AviControllerIP/api --region RegionOne avi-lbaas

If openrc credentials contain “OS_IDENTITY_API_VERSION=3”:

openstack service create  --name avi --description "Avi LBaaS" avi-lbaas
openstack endpoint create --region RegionOne avi-lbaas public https://AviControllerIP/api

If Using keystone-client

keystone service-create --name avi --type avi-lbaas --description "Avi LBaaS"
keystone endpoint-create --service-id $(keystone service-list | awk '/ avi-lbaas / {print $2}') --publicurl https://AviControllerIP/api --region RegionOne