OneQode Documentation
FeedbackSupportStatus
  • 👋Welcome
  • Compute
    • SSH keys
      • Create an SSH key
      • Add your SSH key
    • Instances
      • Create an instance
      • Control an instance
      • Delete an instance
      • Configurations / Flavors
    • Cloud-init
  • Storage
    • Images
      • Create an image
      • Create a snapshot
    • Local storage
    • Volumes
      • Automatically mount a volume
  • Network
    • Floating IPs
    • BGP Communities
  • API
    • API overview
    • Get an API key
    • Install the CLI client
    • Server quick start
  • Dedicated Servers
    • Installing an OS remotely
Powered by GitBook
On this page
  • Quick start version
  • Detailed explanation version
  • Installing the base client
  • Installing additional modules

Was this helpful?

  1. API

Install the CLI client

PreviousGet an API keyNextServer quick start

Last updated 2 years ago

Was this helpful?

Before you begin, check out the to ensure you have everything in place.

The OpenStack client aims to be a feature complete CLI interface to OpenStack. It is modular by design and allows installing extra projects to expand the features of the CLI.

Quick start version

Run the following to install the base OpenStack CLI client and the modules for instance, image and network control:

pip install python-openstackclient python-novaclient \
              python-glanceclient python-neutronclient

source ./openrc

Detailed explanation version

Installing the base client

This command installs the base client:

pip install python-openstackclient

The OpenStack client aims to be a feature complete CLI interface to OpenStack. It is modular by design and allows installing extra projects to expand the features of the CLI.

Installing additional modules

You can install additional modules using the following command, replacing <project> with the project you'd like to install.

pip install python-<project>client

The most relevant OpenStack modules for OneQode Cloud are:

Project
Description

Compute API

Image Service API

Networking API

Orchestration API

Block Storage API

Key Manager Service API

Identity Service API (and extensions)

ceilometer

Telemetry API

gnocchi

Telemetry API (v3)

API overview
nova
glance
neutron
heat
cinder
barbican
keystone