Jakub Ruzicka e04232b552 Provide cinder CLI man page.

Provide basic but hopefully useful man page.

shell.rst was merged into and replaced by the man page in HTML docs.

pbr is used to determine version.

Docs copyright was changed to more accurate "OpenStack Contributors".

Fixes: bug 1206968
Implements: blueprint clients-man-pages
Change-Id: Iedd7b4b161ced564833fd9433762b87a4c1a374d

2013-08-05 16:00:01 -04:00

1.3 KiB

Raw Blame History

`cinder` CLI man page

cinder

SYNOPSIS

cinder [options] <command> [command-options]

cinder help

cinder help <command>

DESCRIPTION

The cinder command line utility interacts with OpenStack Block Storage Service (Cinder).

In order to use the CLI, you must provide your OpenStack username, password, project (historically called tenant), and auth endpoint. You can use configuration options --os-username, --os-password, --os-tenant-name or --os-tenant-id, and --os-auth-url or set corresponding environment variables:

export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://auth.example.com:5000/v2.0

You can select an API version to use by --os-volume-api-version option or by setting corresponding environment variable:

export OS_VOLUME_API_VERSION=2

OPTIONS

To get a list of available commands and options run:

cinder help

To get usage and options of a command:

cinder help <command>

BUGS

Cinder client is hosted in Launchpad so you can view current bugs at https://bugs.launchpad.net/python-cinderclient/.

1.3 KiB Raw Blame History

cinder CLI man page