python-novaclient/doc/source/api.rst

47 lines
982 B
ReStructuredText

The :mod:`novaclient` Python API
==================================
.. module:: novaclient
:synopsis: A client for the OpenStack Nova API.
.. currentmodule:: novaclient
Usage
-----
First create a client instance with your credentials::
>>> from novaclient.client import Client
>>> nova = Client(VERSION, USERNAME, PASSWORD, PROJECT_ID, AUTH_URL)
Here ``VERSION`` can be: ``1.1``, ``2`` and ``3``.
Then call methods on its managers::
>>> nova.servers.list()
[<Server: buildslave-ubuntu-9.10>]
>>> nova.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 = nova.flavors.find(ram=512)
>>> nova.servers.create("my-server", flavor=fl)
<Server: my-server>
Reference
---------
For more information, see the reference:
.. toctree::
:maxdepth: 2
ref/index
ref/v1_1/index