-----------------
The :mod:`cinder.api` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
.. automodule:: cinder.api
:noindex:
:members:
:show-inheritance:
The :mod:`cinder.api.cloud` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.cloud
:noindex:
-------------
The :mod:`openstack` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
.. automodule:: cinder.api.openstack
:noindex:
:members:
:show-inheritance:
The :mod:`auth` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~
+
.. automodule:: cinder.api.openstack.auth
:noindex:
:members:
-------
The :mod:`cinder.api.ec2` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.ec2
:noindex:
================================
The :mod:`cinder.quota` Module
-----------------------------
+------------------------------
.. automodule:: cinder.quota
:noindex:
The :mod:`cinder.auth.signer` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.auth.signer
:noindex:
------------
The :mod:`cinder.auth.manager` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.auth.manager
:noindex:
The :mod:`cinder.adminclient` Module
-----------------------------------
+------------------------------------
.. automodule:: cinder.adminclient
:noindex:
The :mod:`cinder.context` Module
-------------------------------
+--------------------------------
.. automodule:: cinder.context
:noindex:
The :mod:`cinder.exception` Module
---------------------------------
+----------------------------------
.. automodule:: cinder.exception
:noindex:
The :mod:`cinder.flags` Module
-----------------------------
+------------------------------
.. automodule:: cinder.flags
:noindex:
The :mod:`cinder.process` Module
-------------------------------
+--------------------------------
.. automodule:: cinder.process
:noindex:
The :mod:`cinder.rpc` Module
---------------------------
+----------------------------
.. automodule:: cinder.rpc
:noindex:
The :mod:`cinder.server` Module
------------------------------
+-------------------------------
.. automodule:: cinder.server
:noindex:
The :mod:`cinder.test` Module
----------------------------
+-----------------------------
.. automodule:: cinder.test
:noindex:
The :mod:`cinder.utils` Module
-----------------------------
+------------------------------
.. automodule:: cinder.utils
:noindex:
The :mod:`cinder.validate` Module
--------------------------------
+---------------------------------
.. automodule:: cinder.validate
:noindex:
The :mod:`cinder.wsgi` Module
----------------------------
+-----------------------------
.. automodule:: cinder.wsgi
:noindex:
==================
The :mod:`cinder.db.api` Module
------------------------------
+-------------------------------
.. automodule:: cinder.db.api
:noindex:
---------------------
The :mod:`cinder.db.sqlalchemy.api` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.db.sqlalchemy.api
:noindex:
The :mod:`cinder.db.sqlalchemy.models` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.db.sqlalchemy.models
:noindex:
:show-inheritance:
The :mod:`cinder.db.sqlalchemy.session` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.db.sqlalchemy.session
:noindex:
The :mod:`cinder.virt.fake` Module
---------------------------------
+----------------------------------
.. automodule:: cinder.virt.fake
:noindex:
The :mod:`cinder.auth.fakeldap` Module
-------------------------------------
+--------------------------------------
.. automodule:: cinder.auth.fakeldap
:noindex:
The :mod:`cinder.testing.fake.rabbit` Module
-------------------------------------------
+--------------------------------------------
.. automodule:: cinder.testing.fake.rabbit
:noindex:
The :class:`cinder.volume.driver.FakeAOEDriver` Class
----------------------------------------------------
+-----------------------------------------------------
.. autoclass:: cinder.volume.driver.FakeAOEDriver
:noindex:
The :class:`cinder.tests.service_unittest.FakeManager` Class
-----------------------------------------------------------
+------------------------------------------------------------
.. autoclass:: cinder.tests.service_unittest.FakeManager
:noindex:
The :mod:`cinder.tests.api.openstack.fakes` Module
-------------------------------------------------
+--------------------------------------------------
.. automodule:: cinder.tests.api.openstack.fakes
:noindex:
=========
The :mod:`cinder.scheduler.manager` Module
-----------------------------------------
+------------------------------------------
.. automodule:: cinder.scheduler.manager
:noindex:
The :mod:`cinder.scheduler.driver` Module
----------------------------------------
+-----------------------------------------
.. automodule:: cinder.scheduler.driver
:noindex:
The :mod:`cinder.scheduler.simple` Driver
----------------------------------------
+-----------------------------------------
.. automodule:: cinder.scheduler.simple
:noindex:
The :mod:`cinder.volume.manager` Module
--------------------------------------
+---------------------------------------
.. automodule:: cinder.volume.manager
:noindex:
:show-inheritance:
The :mod:`cinder.volume.driver` Module
--------------------------------------
+--------------------------------------
.. automodule:: cinder.volume.driver
:noindex:
-===========
+=============
cinder-manage
-===========
+=============
------------------------------------------------------
Control and manage OpenStack block storage
These sections describe the available categories and arguments for cinder-manage.
Cinder Db
-~~~~~~~
+~~~~~~~~~
``cinder-manage db version``
Cinder Logs
-~~~~~~~~~
+~~~~~~~~~~~
``cinder-manage logs errors``
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``
Runs the named script from the specified path with flags set.
Cinder Volume
-~~~~~~~~~~
+~~~~~~~~~~~~~
``cinder-manage volume reattach <volume_id>``
Delete a volume without first checking that the volume is available.
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.
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.
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.
Cinder Version
-~~~~~~~~~~
+~~~~~~~~~~~~~~
``cinder-manage version list``
Displays the codebase version cinder is running upon.
Cinder Storage Management
-~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
``cinder-manage sm flavor_create <label> <desc>``
Removes the specified backend.
Cinder Config
-~~~~~~~~~~
+~~~~~~~~~~~~~
``cinder-manage config list``
Displays the current configuration parameters (options) for Cinder.
FILES
-========
+=====
The cinder.conf file contains configuration information in the form of python-gflags.