openstack-manuals/doc/playground-user-guide/source/cli.rst

OpenStack command-line clients

Each OpenStack project provides a command-line client, which enables you to access the project API through easy-to-use commands. For example, the Compute service provides a nova command-line client.

You can run the commands from the command line, or include the commands within scripts to automate tasks. If you provide OpenStack credentials, such as your user name and password, you can run these commands on any computer.

Internally, each command uses cURL command-line tools, which embed API requests. OpenStack APIs are RESTful APIs, and use the HTTP protocol. They include methods, URIs, media types, and response codes.

OpenStack APIs are open-source Python clients, and can run on Linux or Mac OS X systems. On some client commands, you can specify a debug parameter to show the underlying API request for the command. This is a good way to become familiar with the OpenStack API calls.

As a cloud end user, you can use the OpenStack dashboard to provision your own resources within the limits set by administrators. You can modify the examples provided in this section to create other types and sizes of server instances.

The following table lists the command-line client for each OpenStack service with its package name and description.

Service	Client	Package	Description
Block Storage	cinder	python-cinderclient	Create and manage volumes.
Compute	nova	python-novaclient	Create and manage images, instances, and flavors.
Database Service	trove	python-troveclient	Create and manage databases.
Identity	keystone	python-keystoneclient	Create and manage users, tenants, roles, endpoints, and credentials.
Image Service	glance	python-glanceclient	Create and manage images.
Networking	neutron	python-neutronclient	Configure networks for guest servers.
Object Storage	swift	python-swiftclient	Gather statistics, list items, update metadata, and upload, download, and delete files stored by the Object Storage service. Gain access to an Object Storage installation for ad hoc processing.
Orchestration	heat	python-heatclient	Launch stacks from templates, view details of running stacks including events and resources, and update and delete stacks.
Telemetry	ceilometer	python-ceilometerclient	Create and collect measurements across OpenStack.
Data Processing	sahara	python-saharaclient	Create and manage Hadoop clusters on OpenStack.
Common client	openstack	python-openstackclient	Common client for the OpenStack project.

cli_cheat_sheet.rst trove-manage-db.rst cli_cheat_sheet.rst cli_launch_instances.rst cli_manage_instances_hosts.rst cli_provide_user_data_to_instances.rst cli_set_quotas.rst manage_projects_users_and_roles.rst nova_cli_manage_projects_security.rst