• API White Paper

  1. Help Center
  2. API White Paper
  3. API Reference
  4. Support from Peripheral Ecosystems
  5. Supporting Native OpenStack Client
  6. Individual Command-line Client

Individual Command-line Client

The OpenStackClient project is provided with a unified CLI client so that users can make calls to desired project APIs by running commands easily. Most OpenStack projects have a dedicated CLI client for each service. For example, the compute service is provided with the Nova CLI client. For details, see https://docs.openstack.org/user-guide/common/cli-overview.html.

Installation Description

You can install and use OpenStackClient by executing the python-openstackclient plug-in. Therefore, before using the tool, ensure that python-openstackclient is running properly.

This tool can be used in all operating systems (OSs) if Python is running properly. The Ubuntu 14.04 OS is recommended. The operations all use Ubuntu 14.04 as an example.

  1. Install Python.

    Install Python and pip based on the OS in use. Python 2.7.12 and versions later than Python 3.4 are supported.

    Generally, Ubuntu 14.04 consists of Python 2.7.12. If Python has not been deployed, run the following command to deploy it:

    sudo apt-get install python

    Run the following command to install pip:

    sudo apt-get install python-pip

    Run the following command to install Dev:

    Sudo apt-get install python-dev

  2. Install python-openstackclient.

    The following python-openstackclient versions are supported by default:

  • python-openstackclient: 3.2.1
  • python-novaclient: 6.0.0
  • python-glanceclient: 2.5.0
  • python-keystoneclient: 3.5.1
  • python-neutronclient: 6.0.0
  • python-cinderclient: 1.9.0
  • python-heatclient: 1.5.1
  • python-designateclient: 2.3.0
  • python-openstacksdk: 0.9.5
  • pbr: 2.0.0
  • requests: 2.12.0

    Run the following command to install python-openstackclient using pip:

    pip install python-openstackclient

    For details on how to install python-openstackclient, see https://github.com/openstack/python-openstackclient.

    After the installation is complete, verify its installation: Run the openstack –h command to check whether the help information is displayed.