b5eaca8712
This patch is part of the great doc migration from openstack-manuals to the individual repos. The changes are based on the spec here: https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html The cinder.rst file needs to be renamed index.rst so that the template that is being used by OpenStack manuals team will magically find the documentation. Change-Id: Ia3b5ee2b6aaf17781d3de7546a9477f1c928092f
86 lines
1.8 KiB
ReStructuredText
86 lines
1.8 KiB
ReStructuredText
==============================
|
|
:program:`cinder` CLI man page
|
|
==============================
|
|
|
|
.. program:: cinder
|
|
.. highlight:: bash
|
|
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
:program:`cinder` [options] <command> [command-options]
|
|
|
|
:program:`cinder help`
|
|
|
|
:program:`cinder help` <command>
|
|
|
|
|
|
DESCRIPTION
|
|
===========
|
|
|
|
The :program:`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 :option:`--os-username`, :option:`--os-password`,
|
|
:option:`--os-tenant-name` or :option:`--os-tenant-id`, and
|
|
:option:`--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 :option:`--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>
|
|
|
|
You can see more details about the Cinder Command-Line Client at
|
|
:doc:`details`.
|
|
|
|
EXAMPLES
|
|
========
|
|
|
|
Get information about volume create command::
|
|
|
|
cinder help create
|
|
|
|
List all the volumes::
|
|
|
|
cinder list
|
|
|
|
Create new volume::
|
|
|
|
cinder create 1 --name volume01
|
|
|
|
Describe a specific volume::
|
|
|
|
cinder show 65d23a41-b13f-4345-ab65-918a4b8a6fe6
|
|
|
|
Create a snapshot::
|
|
|
|
cinder snapshot-create 65d23a41-b13f-4345-ab65-918a4b8a6fe6 \
|
|
--name qt-snap
|
|
|
|
|
|
BUGS
|
|
====
|
|
|
|
Cinder client is hosted in Launchpad so you can view current bugs at
|
|
https://bugs.launchpad.net/python-cinderclient/.
|