e827a0d412
Move CLI sections to common as they are shared between user guide, admin user guide, and config reference guide. Update the appendix (which was already in common) to refer to the new location. Change-Id: Id51aacea15ce70a90e1a49203665b2797d374e48
100 lines
5.2 KiB
XML
100 lines
5.2 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
|
xml:id="cinder_commands">
|
|
<title>cinder commands</title>
|
|
<para>The cinder client is the command-line interface for the
|
|
OpenStack Identity API.</para>
|
|
<para>For help on a specific cinder command, enter:</para>
|
|
<screen><prompt>$</prompt> <userinput><command>cinder</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
<example>
|
|
<title>Usage</title>
|
|
<screen><computeroutput>cinder [--version] [--debug] [--os-username <auth-user-name>]
|
|
[--os-password <auth-password>]
|
|
[--os-tenant-name <auth-tenant-name>]
|
|
[--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
|
|
[--os-region-name <region-name>] [--service-type <service-type>]
|
|
[--service-name <service-name>]
|
|
[--volume-service-name <volume-service-name>]
|
|
[--endpoint-type <endpoint-type>]
|
|
[--os-volume-api-version <compute-api-ver>]
|
|
[--os-cacert <ca-certificate>] [--retries <retries>]
|
|
<subcommand> ...</computeroutput></screen>
|
|
</example>
|
|
<example>
|
|
<title>Positional arguments</title>
|
|
<screen><computeroutput><subcommand>
|
|
absolute-limits Print a list of absolute limits for a user
|
|
backup-create Creates a backup.
|
|
backup-delete Remove a backup.
|
|
backup-list List all the backups.
|
|
backup-restore Restore a backup.
|
|
backup-show Show details about a backup.
|
|
create Add a new volume.
|
|
credentials Show user credentials returned from auth.
|
|
delete Remove a volume.
|
|
endpoints Discover endpoints that get returned from the
|
|
authenticate services.
|
|
extra-specs-list Print a list of current 'volume types and extra specs'
|
|
(Admin Only).
|
|
force-delete Attempt forced removal of a volume, regardless of its
|
|
state.
|
|
list List all the volumes.
|
|
metadata Set or Delete metadata on a volume.
|
|
quota-class-show List the quotas for a quota class.
|
|
quota-class-update Update the default quotas for a quota class.
|
|
quota-defaults List the default quotas for a tenant.
|
|
quota-show List the quotas for a tenant.
|
|
quota-update Update the quotas for a tenant.
|
|
rate-limits Print a list of rate limits for a user
|
|
rename Rename a volume.
|
|
show Show details about a volume.
|
|
snapshot-create Add a new snapshot.
|
|
snapshot-delete Remove a snapshot.
|
|
snapshot-list List all the snapshots.
|
|
snapshot-rename Rename a snapshot.
|
|
snapshot-show Show details about a snapshot.
|
|
type-create Create a new volume type.
|
|
type-delete Delete a specific volume type.
|
|
type-key Set or unset extra_spec for a volume type.
|
|
type-list Print a list of available 'volume types'.
|
|
upload-to-image Upload volume to image service as image.
|
|
bash-completion Print arguments for bash_completion.
|
|
help Display help about this program or one of its
|
|
subcommands.
|
|
list-extensions List all the os-api extensions that are available.</computeroutput></screen>
|
|
</example>
|
|
<example>
|
|
<title>Optional arguments</title>
|
|
<screen><computeroutput> --version show program's version number and exit
|
|
--debug Print debugging output
|
|
--os-username <auth-user-name>
|
|
Defaults to env[OS_USERNAME].
|
|
--os-password <auth-password>
|
|
Defaults to env[OS_PASSWORD].
|
|
--os-tenant-name <auth-tenant-name>
|
|
Defaults to env[OS_TENANT_NAME].
|
|
--os-tenant-id <auth-tenant-id>
|
|
Defaults to env[OS_TENANT_ID].
|
|
--os-auth-url <auth-url>
|
|
Defaults to env[OS_AUTH_URL].
|
|
--os-region-name <region-name>
|
|
Defaults to env[OS_REGION_NAME].
|
|
--service-type <service-type>
|
|
Defaults to compute for most actions
|
|
--service-name <service-name>
|
|
Defaults to env[CINDER_SERVICE_NAME]
|
|
--volume-service-name <volume-service-name>
|
|
Defaults to env[CINDER_VOLUME_SERVICE_NAME]
|
|
--endpoint-type <endpoint-type>
|
|
Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL.
|
|
--os-volume-api-version <compute-api-ver>
|
|
Accepts 1 or 2,defaults to env[OS_VOLUME_API_VERSION].
|
|
--os-cacert <ca-certificate>
|
|
Specify a CA bundle file to use in verifying a TLS
|
|
(https) server certificate. Defaults to env[OS_CACERT]
|
|
--retries <retries> Number of retries.</computeroutput></screen>
|
|
</example>
|
|
</section>
|