summaryrefslogtreecommitdiff
path: root/doc/source/cli/nova.rst
blob: c3c6caf42a642bf45a0397a4108bc03af6cf2c76 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
======
 nova
======


SYNOPSIS
========

  `nova` [options] <command> [command-options]

  `nova help`

  `nova help` <command>


DESCRIPTION
===========

`nova` is a command line client for controlling OpenStack Nova, the cloud
computing fabric controller. It implements 100% of the Nova API, allowing
management of instances, images, quotas and much more.

Before you can issue commands with `nova`, you must ensure that your
environment contains the necessary variables so that you can prove to the CLI
who you are and what credentials you have to issue the commands. See
`Getting Credentials for a CLI` section of `OpenStack CLI Guide` for more
info.

See `OpenStack Nova CLI Guide` for a full-fledged guide.


OPTIONS
=======

To get a list of available commands and options run::

    nova help

To get usage and options of a command run::

    nova help <command>


EXAMPLES
========

Get information about boot command::

    nova help boot

List available images::

    nova image-list

List available flavors::

    nova flavor-list

Launch an instance::

    nova boot myserver --image some-image --flavor 2

View instance information::

    nova show myserver

List instances::

    nova list

Terminate an instance::

    nova delete myserver


SEE ALSO
========

OpenStack Nova CLI Guide: http://docs.openstack.org/cli-reference/nova.html


BUGS
====

Nova client is hosted in Launchpad so you can view current bugs at https://bugs.launchpad.net/python-novaclient/.