33c897d87e
Updated README.rst and shell.rst to match changes in the cinder command and novaclient README.rst. Change-Id: Ifaa53d5c06e6d7d8e3d4d858672717954303bea7 Fixes: bug #1074125
68 lines
1.5 KiB
ReStructuredText
68 lines
1.5 KiB
ReStructuredText
The :mod:`cinderclient` Python API
|
|
==================================
|
|
|
|
.. module:: cinderclient
|
|
:synopsis: A client for the OpenStack Cinder API.
|
|
|
|
.. currentmodule:: cinderclient
|
|
|
|
Usage
|
|
-----
|
|
|
|
First create an instance of :class:`OpenStack` with your credentials::
|
|
|
|
>>> from cinderclient import OpenStack
|
|
>>> cinder = OpenStack(USERNAME, PASSWORD, AUTH_URL)
|
|
|
|
Then call methods on the :class:`OpenStack` object:
|
|
|
|
.. class:: OpenStack
|
|
|
|
.. attribute:: backup_schedules
|
|
|
|
A :class:`BackupScheduleManager` -- manage automatic backup images.
|
|
|
|
.. attribute:: flavors
|
|
|
|
A :class:`FlavorManager` -- query available "flavors" (hardware
|
|
configurations).
|
|
|
|
.. attribute:: images
|
|
|
|
An :class:`ImageManager` -- query and create server disk images.
|
|
|
|
.. attribute:: ipgroups
|
|
|
|
A :class:`IPGroupManager` -- manage shared public IP addresses.
|
|
|
|
.. attribute:: servers
|
|
|
|
A :class:`ServerManager` -- start, stop, and manage virtual machines.
|
|
|
|
.. automethod:: authenticate
|
|
|
|
For example::
|
|
|
|
>>> cinder.servers.list()
|
|
[<Server: buildslave-ubuntu-9.10>]
|
|
|
|
>>> cinder.flavors.list()
|
|
[<Flavor: 256 server>,
|
|
<Flavor: 512 server>,
|
|
<Flavor: 1GB server>,
|
|
<Flavor: 2GB server>,
|
|
<Flavor: 4GB server>,
|
|
<Flavor: 8GB server>,
|
|
<Flavor: 15.5GB server>]
|
|
|
|
>>> fl = cinder.flavors.find(ram=512)
|
|
>>> cinder.servers.create("my-server", flavor=fl)
|
|
<Server: my-server>
|
|
|
|
For more information, see the reference:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
ref/index
|