• Native OpenStack API

  1. Help Center
  2. Native OpenStack API
  3. Developer Guide
  4. Introduction
  5. Preparations


The OpenStack community provides two types of command-line clients, namely individual command-line client and unified command-line client. For more information, visit http://docs.openstack.org/user-guide/common/cli-overview.html#individual-command-line-clients.

You are advised to use the unified command-line client, but the command-line tool is in the development phase and some commands are not stable. Although the public cloud supports both clients, it is best practice to install only one client to prevent compatibility issues of native OpenStack commands. If you encounter any problems, seek solutions provided in the OpenStack community.

Individual Command-line Client

OpenStack APIs use Keystone v3. Therefore, clients of the OpenStack Kilo release or later are required. The following clients have been tested and are recommended:

  • Nova Client: 2.22.0
  • Cinder Client: 1.1.1
  • Glance Client: 0.15.0
  • Neutron Client: 2.3.11
  • Keystone Client: 1.2.0
  • Heat Client: 0.2.12

For details about how to obtain and install OpenStack clients, see Obtaining and Installing the Individual CLI Clients.

You can run the following command on the clients to query their versions:

Service name--version

Nova is used as an example in the following figure.

Unified Command-line Client

  • python-openstackclient: 2.4.0
  • python-novaclient: 3.4.0
  • python-glanceclient: 2.0.1
  • python-keystoneclient: 2.3.2
  • python-neutronclient: 4.1.2
  • python-cinderclient: 1.6.0
  • python-heatclient: 1.1.0
  • python-designateclient: 2.3.0