2011-02-24 13:54:10 -04:00
|
|
|
The :program:`nova` shell utility
|
2011-01-25 14:01:22 -06:00
|
|
|
=========================================
|
|
|
|
|
|
2011-02-24 13:54:10 -04:00
|
|
|
.. program:: nova
|
2011-01-25 14:01:22 -06:00
|
|
|
.. highlight:: bash
|
|
|
|
|
|
2011-02-24 13:54:10 -04:00
|
|
|
The :program:`nova` shell utility interacts with OpenStack Nova API
|
2011-02-08 09:27:22 -04:00
|
|
|
from the command line. It supports the entirety of the OpenStack Nova API.
|
2011-01-25 14:01:22 -06:00
|
|
|
|
2011-02-08 09:27:22 -04: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
|
|
|
|
2011-02-24 13:54:10 -04:00
|
|
|
You'll need to provide :program:`nova` with your OpenStack username and
|
2011-11-09 07:10:46 -08:00
|
|
|
API key. You can do this with the :option:`--username`, :option:`--password`
|
2011-06-13 16:16:58 +04:00
|
|
|
and :option:`--projectid` options, but it's easier to just set them as
|
|
|
|
|
environment variables by setting two environment variables:
|
2011-01-25 14:01:22 -06:00
|
|
|
|
2011-02-14 14:27:21 -08:00
|
|
|
.. envvar:: NOVA_USERNAME
|
2011-01-25 14:01:22 -06:00
|
|
|
|
2011-02-08 09:27:22 -04:00
|
|
|
Your OpenStack Nova username.
|
2011-01-25 14:01:22 -06:00
|
|
|
|
2011-11-09 07:10:46 -08:00
|
|
|
.. envvar:: NOVA_PASSWORD
|
2011-01-25 14:01:22 -06:00
|
|
|
|
2011-11-09 07:10:46 -08:00
|
|
|
Your password.
|
2011-01-25 14:01:22 -06:00
|
|
|
|
2011-06-13 16:16:58 +04:00
|
|
|
.. envvar:: NOVA_PROJECT_ID
|
|
|
|
|
|
|
|
|
|
Project for work.
|
|
|
|
|
|
2011-02-26 05:04:40 -04:00
|
|
|
.. envvar:: NOVA_URL
|
|
|
|
|
|
|
|
|
|
The OpenStack API server URL.
|
|
|
|
|
|
2011-08-07 14:00:23 -05:00
|
|
|
.. envvar:: NOVA_VERSION
|
|
|
|
|
|
|
|
|
|
The OpenStack API version.
|
|
|
|
|
|
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
|
2011-11-09 07:10:46 -08:00
|
|
|
export NOVA_PASSWORD=yadayadayada
|
2011-06-13 16:16:58 +04:00
|
|
|
export NOVA_PROJECT_ID=myproject
|
2011-02-26 05:04:40 -04:00
|
|
|
export NOVA_URL=http://...
|
2011-08-07 14:00:23 -05:00
|
|
|
export NOVA_VERSION=1.0
|
2011-01-25 14:01:22 -06:00
|
|
|
|
|
|
|
|
From there, all shell commands take the form::
|
|
|
|
|
|
2011-02-24 13:54:10 -04:00
|
|
|
nova <command> [arguments...]
|
2011-01-25 14:01:22 -06:00
|
|
|
|
2011-02-24 13:54:10 -04: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
|
2011-02-08 09:27:22 -04:00
|
|
|
command.
|
