Files
python-novaclient/docs/shell.rst

43 lines
1.2 KiB
ReStructuredText
Raw Normal View History

The :program:`nova` shell utility
2011-01-25 14:01:22 -06:00
=========================================
.. program:: nova
2011-01-25 14:01:22 -06:00
.. highlight:: bash
The :program:`nova` shell utility interacts with OpenStack Nova API
from the command line. It supports the entirety of the OpenStack Nova API.
2011-01-25 14:01:22 -06:00
First, you'll need an OpenStack Nova account and an API key. You get this
by using the `nova-manage` command in OpenStack Nova.
2011-01-25 14:01:22 -06:00
You'll need to provide :program:`nova` with your OpenStack username and
2011-01-25 14:01:22 -06:00
API key. You can do this with the :option:`--username` and :option:`--apikey`
options, but it's easier to just set them as environment variables by setting
two environment variables:
2011-02-14 14:27:21 -08:00
.. envvar:: NOVA_USERNAME
2011-01-25 14:01:22 -06:00
Your OpenStack Nova username.
2011-01-25 14:01:22 -06:00
2011-02-14 14:27:21 -08:00
.. envvar:: NOVA_API_KEY
2011-01-25 14:01:22 -06:00
Your API key.
.. envvar:: NOVA_URL
The OpenStack API server URL.
2011-01-25 14:01:22 -06:00
For example, in Bash you'd use::
2011-02-14 14:27:21 -08:00
export NOVA_USERNAME=yourname
export NOVA_API_KEY=yadayadayada
export NOVA_URL=http://...
2011-01-25 14:01:22 -06:00
From there, all shell commands take the form::
nova <command> [arguments...]
2011-01-25 14:01:22 -06:00
Run :program:`nova help` to get a full list of all possible commands,
and run :program:`nova help <command>` to get detailed help for that
command.