openstack
/
cinder
Code Issues Proposed changes

Merge "Fix indentation in docs"

This commit is contained in:
Zuul 2018-09-12 21:10:01 +00:00 committed by Gerrit Code Review
parent f5c5403087 290240abe0
commit 11ccfed656
1 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
doc/source/man/cinder-manage.rst
View File

@ -14,7 +14,7 @@ Control and manage OpenStack block storage
SYNOPSIS
========
cinder-manage <category> <action> [<args>]
cinder-manage <category> <action> [<args>]
DESCRIPTION
===========
@ -48,123 +48,123 @@ Cinder Db
``cinder-manage db version``
Print the current database version.
Print the current database version.
``cinder-manage db sync [--bump-versions] [version]``
Sync the database up to the most recent version. This is the standard way to create the db as well.
Sync the database up to the most recent version. This is the standard way to create the db as well.
This command interprets the following options when it is invoked:
This command interprets the following options when it is invoked:
version Database version
version Database version
--bump-versions Update RPC and Objects versions when doing offline
upgrades, with this we no longer need to restart the
services twice after the upgrade to prevent ServiceTooOld
exceptions.
--bump-versions Update RPC and Objects versions when doing offline
upgrades, with this we no longer need to restart the
services twice after the upgrade to prevent ServiceTooOld
exceptions.
``cinder-manage db purge [<number of days>]``
Purge database entries that are marked as deleted, that are older than the number of days specified.
Purge database entries that are marked as deleted, that are older than the number of days specified.
``cinder-manage db online_data_migrations``
Perform online data migrations for database upgrade between releases in batches.
Perform online data migrations for database upgrade between releases in batches.
This command interprets the following options when it is invoked:
This command interprets the following options when it is invoked:
--max_count Maximum number of objects to consider.
--ignore_state Force records to migrate even if another operation is
performed on them. This may be dangerous, please refer to
release notes for more information.
--max_count Maximum number of objects to consider.
--ignore_state Force records to migrate even if another operation is
performed on them. This may be dangerous, please refer to
release notes for more information.
Cinder Logs
~~~~~~~~~~~
``cinder-manage logs errors``
Displays cinder errors from log files.
Displays cinder errors from log files.
``cinder-manage logs syslog [<number>]``
Displays cinder the most recent entries from syslog. The optional number argument specifies the number of entries to display (default 10).
Displays cinder the most recent entries from syslog. The optional number argument specifies the number of entries to display (default 10).
Cinder Shell
~~~~~~~~~~~~
``cinder-manage shell bpython``
Starts a new bpython shell.
Starts a new bpython shell.
``cinder-manage shell ipython``
Starts a new ipython shell.
Starts a new ipython shell.
``cinder-manage shell python``
Starts a new python shell.
Starts a new python shell.
``cinder-manage shell run``
Starts a new shell using python.
Starts a new shell using python.
``cinder-manage shell script <path/scriptname>``
Runs the named script from the specified path with flags set.
Runs the named script from the specified path with flags set.
Cinder Volume
~~~~~~~~~~~~~
``cinder-manage volume delete <volume_id>``
Delete a volume without first checking that the volume is available.
Delete a volume without first checking that the volume is available.
``cinder-manage volume update_host --currenthost <current host> --newhost <new host>``
Updates the host name of all volumes currently associated with a specified host.
Updates the host name of all volumes currently associated with a specified host.
Cinder Host
~~~~~~~~~~~
``cinder-manage host list [<zone>]``
Displays a list of all physical hosts and their zone. The optional zone argument allows the list to be filtered on the requested zone.
Displays a list of all physical hosts and their zone. The optional zone argument allows the list to be filtered on the requested zone.
Cinder Service
~~~~~~~~~~~~~~
``cinder-manage service list``
Displays a list of all cinder services and their host, zone, status, state and when the information was last updated.
Displays a list of all cinder services and their host, zone, status, state and when the information was last updated.
``cinder-manage service remove <service> <host>``
Removes a specified cinder service from a specified host.
Removes a specified cinder service from a specified host.
Cinder Backup
~~~~~~~~~~~~~
``cinder-manage backup list``
Displays a list of all backups (including ones in progress) and the host on which the backup operation is running.
Displays a list of all backups (including ones in progress) and the host on which the backup operation is running.
``cinder-manage backup update_backup_host --currenthost <current host> --newhost <new host>``
Updates the host name of all backups currently associated with a specified host.
Updates the host name of all backups currently associated with a specified host.
Cinder Version
~~~~~~~~~~~~~~
``cinder-manage version list``
Displays the codebase version cinder is running upon.
Displays the codebase version cinder is running upon.
Cinder Config
~~~~~~~~~~~~~
``cinder-manage config list [<param>]``
Displays the current configuration parameters (options) for Cinder. The optional flag parameter may be used to display the configuration of one parameter.
Displays the current configuration parameters (options) for Cinder. The optional flag parameter may be used to display the configuration of one parameter.
FILES
=====