forked from hphelion/documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cli.nova.reference.html
1244 lines (1132 loc) · 52.3 KB
/
cli.nova.reference.html
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<title>cli.nova.reference</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<style type="text/css">
/* GitHub stylesheet for MarkdownPad (http://markdownpad.com) */
/* Author: Nicolas Hery - http://nicolashery.com */
/* Version: b13fe65ca28d2e568c6ed5d7f06581183df8f2ff */
/* Source: https://github.com/nicolahery/markdownpad-github */
/* RESET
=============================================================================*/
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
margin: 0;
padding: 0;
border: 0;
}
/* BODY
=============================================================================*/
body {
font-family: Helvetica, arial, freesans, clean, sans-serif;
font-size: 14px;
line-height: 1.6;
color: #333;
background-color: #fff;
padding: 20px;
max-width: 960px;
margin: 0 auto;
}
body>*:first-child {
margin-top: 0 !important;
}
body>*:last-child {
margin-bottom: 0 !important;
}
/* BLOCKS
=============================================================================*/
p, blockquote, ul, ol, dl, table, pre {
margin: 15px 0;
}
/* HEADERS
=============================================================================*/
h1, h2, h3, h4, h5, h6 {
margin: 20px 0 10px;
padding: 0;
font-weight: bold;
-webkit-font-smoothing: antialiased;
}
h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {
font-size: inherit;
}
h1 {
font-size: 28px;
color: #000;
}
h2 {
font-size: 24px;
border-bottom: 1px solid #ccc;
color: #000;
}
h3 {
font-size: 18px;
}
h4 {
font-size: 16px;
}
h5 {
font-size: 14px;
}
h6 {
color: #777;
font-size: 14px;
}
body>h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child {
margin-top: 0;
padding-top: 0;
}
a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
margin-top: 0;
padding-top: 0;
}
h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {
margin-top: 10px;
}
/* LINKS
=============================================================================*/
a {
color: #4183C4;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* LISTS
=============================================================================*/
ul, ol {
padding-left: 30px;
}
ul li > :first-child,
ol li > :first-child,
ul li ul:first-of-type,
ol li ol:first-of-type,
ul li ol:first-of-type,
ol li ul:first-of-type {
margin-top: 0px;
}
ul ul, ul ol, ol ol, ol ul {
margin-bottom: 0;
}
dl {
padding: 0;
}
dl dt {
font-size: 14px;
font-weight: bold;
font-style: italic;
padding: 0;
margin: 15px 0 5px;
}
dl dt:first-child {
padding: 0;
}
dl dt>:first-child {
margin-top: 0px;
}
dl dt>:last-child {
margin-bottom: 0px;
}
dl dd {
margin: 0 0 15px;
padding: 0 15px;
}
dl dd>:first-child {
margin-top: 0px;
}
dl dd>:last-child {
margin-bottom: 0px;
}
/* CODE
=============================================================================*/
pre, code, tt {
font-size: 12px;
font-family: Consolas, "Liberation Mono", Courier, monospace;
}
code, tt {
margin: 0 0px;
padding: 0px 0px;
white-space: nowrap;
border: 1px solid #eaeaea;
background-color: #f8f8f8;
border-radius: 3px;
}
pre>code {
margin: 0;
padding: 0;
white-space: pre;
border: none;
background: transparent;
}
pre {
background-color: #f8f8f8;
border: 1px solid #ccc;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
border-radius: 3px;
}
pre code, pre tt {
background-color: transparent;
border: none;
}
kbd {
-moz-border-bottom-colors: none;
-moz-border-left-colors: none;
-moz-border-right-colors: none;
-moz-border-top-colors: none;
background-color: #DDDDDD;
background-image: linear-gradient(#F1F1F1, #DDDDDD);
background-repeat: repeat-x;
border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;
border-image: none;
border-radius: 2px 2px 2px 2px;
border-style: solid;
border-width: 1px;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
line-height: 10px;
padding: 1px 4px;
}
/* QUOTES
=============================================================================*/
blockquote {
border-left: 4px solid #DDD;
padding: 0 15px;
color: #777;
}
blockquote>:first-child {
margin-top: 0px;
}
blockquote>:last-child {
margin-bottom: 0px;
}
/* HORIZONTAL RULES
=============================================================================*/
hr {
clear: both;
margin: 15px 0;
height: 0px;
overflow: hidden;
border: none;
background: transparent;
border-bottom: 4px solid #ddd;
padding: 0;
}
/* TABLES
=============================================================================*/
table th {
font-weight: bold;
}
table th, table td {
border: 1px solid #ccc;
padding: 6px 13px;
}
table tr {
border-top: 1px solid #ccc;
background-color: #fff;
}
table tr:nth-child(2n) {
background-color: #f8f8f8;
}
/* IMAGES
=============================================================================*/
img {
max-width: 100%
}
</style>
</head>
<body>
<hr />
<p>layout: default
title: "Python Novaclient CLI: Command Line Reference"
permalink: /cli/nova/reference/
product: nova-cli</p>
<hr />
<!--PUBLISHED-->
<h1>Python Novaclient CLI: Command Line Reference#</h1>
<p>Below you can find a full reference of supported Python Novaclient command-line interface (CLI) commands. The commands are alphabetized. You can also use the nova help tool using the name of the command on which you want help, for example:</p>
<pre><code>nova help volume-create
</code></pre>
<p>provides you the usage, description, and option information for the <a href="#volume-create"><code>volume-create</code></a> command. <code>nova help</code> without any arguments provides you a list of all the available Novaclient commands.</p>
<h2>add-floating-ip## {#add-floating-ip}</h2>
<p>Add a floating IP address to a server</p>
<h3>Syntax</h3>
<p><code>nova add-floating-ip <server> <address></code></p>
<p><strong>server</strong>
: Name or ID of a server</p>
<p><strong>address</strong>
: IP address to be added</p>
<h3>Example</h3>
<p>Add the floating IP address 15.185.105.97 to instance ID 694541:</p>
<pre><code>nova add-floating-ip 694541 15.185.105.97
</code></pre>
<h2>add-secgroup## {#add-secgroup}</h2>
<p>Adds a security group to an instance</p>
<h3>Syntax</h3>
<p><code>nova add-secgroup <server> <secgroup></code></p>
<p><strong>server</strong>
: Name or ID of a server</p>
<p><strong>secgroup</strong>
: IP address of a server</p>
<h3>Example</h3>
<p>Add the security group `default' to instance ID 694541:</p>
<pre><code>nova add-secgroup 694541 default
</code></pre>
<h2>backup-create## {#backup-create}</h2>
<p>Creates a backup of a Volume.</p>
<h3>Syntax</h3>
<p><code>nova backup-create [--container <container>] [--display_name <display_name>] [--display_description <display_description>] <volume_id></code></p>
<p><strong>container</strong>
: Name of the container (default is <code>hpvolumebackups</code>).</p>
<p><strong>display_name</strong>
: Name of the backup (default is none).</p>
<p><strong>display_description</strong>
: Description of the backup (default is none).</p>
<p><strong>volume_id</strong>
: ID of the volume to back up.</p>
<h3>Example</h3>
<p>Creates a backup of volume 68453 to a container named <code>my-backup-container</code> in your HP Helion Public Cloud Object Storage account:</p>
<pre><code>nova backup-create --container my-backup-container 68453
</code></pre>
<p>This example creates a backup of volume <code>68453</code> to a directory in the container <code>my-backup-container</code>. If you do not specify a container name, the default container name <code>hpvolumebackups</code> is used. The directory name consists of the volume ID, a timestamp, the availability zone and the backup ID.</p>
<h2>backup-delete## {#backup-delete}</h2>
<p>Remove a backup.</p>
<h3>Syntax</h3>
<p><code>nova backup-delete <backup_id></code></p>
<p><strong>backup_id</strong>
: ID of the volume to delete.</p>
<h3>Example</h3>
<p>Delete backup ID <code>3</code> from your account:</p>
<pre><code>nova backup-delete 3
</code></pre>
<h2>backup-list## {#backup-list}</h2>
<p>List all the backups</p>
<h3>Syntax</h3>
<p><code>nova backup-list</code></p>
<h3>Example</h3>
<p>Display all the created backups:</p>
<pre><code>~$ nova backup-list
+-----------+------+-----------+-------------+-------------+-----------------+---------------------+---------+--------------------+-----------+------+
| Backup ID | Name | Status | Fail Reason | Description | Swift Container | Created At | Size GB | Swift Object Count | Volume ID | AZ |
+-----------+------+-----------+-------------+-------------+-----------------+---------------------+---------+--------------------+-----------+------+
| 37 | None | creating | None | None | backup | 2013-01-17 18:29:11 | 10 | None | 68453 | None |
+-----------+------+-----------+-------------+-------------+-----------------+---------------------+---------+--------------------+-----------+------+
$ nova backup-list
+-----------+------+-----------+-------------+-------------+-----------------+---------------------+---------+--------------------+-----------+-----+
| Backup ID | Name | Status | Fail Reason | Description | Swift Container | Created At | Size GB | Swift Object Count | Volume ID | AZ |
+-----------+------+-----------+-------------+-------------+-----------------+---------------------+---------+--------------------+-----------+-----+
| 37 | None | available | None | None | backup | 2013-01-17 18:29:11 | 10 | 206 | 68453 | az1 |
+-----------+------+-----------+-------------+-------------+-----------------+---------------------+---------+--------------------+-----------+-----+
</code></pre>
<h2>backup-restore## {#backup-restore}</h2>
<p>Restore a backup</p>
<h3>Syntax</h3>
<p><code>nova backup-restore [--volume_id <volume_id>] <backup_id></code></p>
<p><strong>backup_id</strong>
: ID of the backup to restore.</p>
<p><strong>volume_id</strong>
: ID of the restore target volume (optional) </p>
<h3>Example</h3>
<p>Restore backup ID <code>37</code> to volume ID <code>68495</code>:</p>
<pre><code>nova backup-restore --volume_id 68495 37
</code></pre>
<p><strong>Note</strong>: If you specify a <code>volume_id</code>, the contents of the referenced volume are over-written with the restored backup.</p>
<h2>backup-show## {#backup-show}</h2>
<p>Show details about a backup.</p>
<h3>Syntax</h3>
<p><code>nova backup-show <backup_id></code></p>
<p><strong>backup_id</strong>
: ID of the backup to display.</p>
<h3>Example</h3>
<p>List the details about backup <code>37</code>:</p>
<pre><code>$ nova backup-show 37
+---------------------+---------------------+
| Property | Value |
+---------------------+---------------------+
| availability_zone | az1 |
| container | backup |
| created_at | 2013-01-17 18:29:11 |
| display_description | None |
| display_name | None |
| fail_reason | None |
| id | 37 |
| object_count | 206 |
| size | 10 |
| status | available |
| volume_id | 68453 |
+---------------------+---------------------+
</code></pre>
<h2>boot## {#boot}</h2>
<p>Boot a new server</p>
<h3>Syntax</h3>
<p><code>nova boot [--flavor <flavor>] [--image <image>] [--meta <key=value>] [--file <dst-path=src-path>] [--key_name <key_name>] [--user_data <user-data>] [--security_groups <security_groups>] [--block_device_mapping <dev_name=mapping>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr>] [--config-drive <value>] <backup></code></p>
<p><strong>backup</strong>
: Name for the new server.</p>
<p><strong>flavor</strong>
: Flavor ID (see <code>nova flavor-list</code>).</p>
<p><strong>image</strong>
: Image ID (see 'nova image-list').</p>
<p><strong>meta</strong>
: Record arbitrary key/value metadata. May be give multiple times.</p>
<p><strong>file</strong>
: Store arbitrary files from <src-path> locally to <dst-path> on the new server. You may store up to 5 files.</p>
<p><strong>key_name</strong>
: Key name of keypair that should be created earlier with the command keypair-add.</p>
<p><strong>user_data</strong>
: User data file to pass to be exposed by the metadata server.</p>
<p><strong>security_groups</strong>
: Comma-separated list of security group names.</p>
<p><strong>block_device<em>mapping</strong>
: Block device mapping in the format <dev</em>name=<id>:<type>:<size(GB)>:<delete_on_terminate>.</p>
<p><strong>nic</strong>
: Create a NIC on the server. Specify option multiple times to create multiple NICs. net-id: attach NIC to network with this UUID (optional) v4-fixed-ip: IPv4 fixed address for NIC (optional).</p>
<p><strong>config-drive</strong>
: Enable the configuration drive.</p>
<h3>Example</h3>
<p>Create an XSmall Ubuntu 12.04 instance with key pair <code>az1</code> and Security Group <code>default</code> bound to it with a display name of <code>test</code>:</p>
<pre><code>$ nova boot --flavor "100" --image "75845" --key_name "az1" --security_groups "default" test
+-----------------+----------------------------------------------------------+
| Property | Value |
+-----------------+----------------------------------------------------------+
| accessIPv4 | |
| accessIPv6 | |
| adminPass | U7ptPHdygX2YnyTy |
| config_drive | |
| created | 2013-01-17T18:55:07Z |
| flavor | standard.xsmall |
| hostId | 6689454bf62324974d5d9d8bf62e8fbe0587530328d421044a0c8232 |
| id | 703829 |
| image | Ubuntu Precise 12.04 LTS Server 64-bit 20121026 |
| key_name | az1 |
| metadata | {} |
| name | test |
| security_groups | default |
| status | BUILD(networking) |
| tenant_id | 65589599430509 |
| updated | 2013-01-17T18:55:08Z |
| user_id | 52552375567809 |
| uuid | d41ecb12-b232-444a-8580-6f2e3fbcb33a |
+-----------------+----------------------------------------------------------+
</code></pre>
<h2>delete## {#delete}</h2>
<p>Immediately shut down and delete a server.</p>
<h3>Syntax</h3>
<p><code>nova delete <server></code></p>
<p><strong>server</strong>
: Name or ID of the server.</p>
<h3>Example</h3>
<p>Delete instance 703829 from your account:</p>
<pre><code>nova delete 703829
</code></pre>
<h2>flavor-list## {#flavor-list}</h2>
<p>Print a list of available 'flavors' (sizes of servers).</p>
<h3>Syntax</h3>
<p><code>nova flavor-list</code></p>
<h3>Example</h3>
<p>List all available flavors:</p>
<pre><code>$ nova flavor-list
+-----+------------------+-----------+------+----------+-------+------------+----------+
| ID | Name | Memory_MB | Swap | Local_GB | VCPUs | RXTX_Quota | RXTX_Cap |
+-----+------------------+-----------+------+----------+-------+------------+----------+
| 100 | standard.xsmall | 1024 | 0 | 30 | 1 | 0 | 0 |
| 101 | standard.small | 2048 | 0 | 60 | 2 | 0 | 0 |
| 102 | standard.medium | 4096 | 0 | 120 | 2 | 0 | 0 |
| 103 | standard.large | 8192 | 0 | 240 | 4 | 0 | 0 |
| 104 | standard.xlarge | 16384 | 0 | 480 | 4 | 0 | 0 |
| 105 | standard.2xlarge | 32768 | 0 | 960 | 8 | 0 | 0 |
+-----+------------------+-----------+------+----------+-------+------------+----------+
</code></pre>
<h2>floating-ip-create## {#floating-ip-create}</h2>
<p>Allocate a floating IP for the current tenant.</p>
<h3>Syntax</h3>
<p><code>nova floating-ip-create</code></p>
<h3>Example</h3>
<p>Allocate a floating IP for the current tenant:</p>
<pre><code>$ nova floating-ip-create
+---------------+-------------+----------+
| Ip | Instance Id | Fixed Ip |
+---------------+-------------+----------+
| 15.185.100.75 | None | None |
+---------------+-------------+----------+
</code></pre>
<h2>floating-ip-delete## {#floating-ip-delete}</h2>
<p>De-allocate a floating IP.</p>
<h3>Syntax</h3>
<p><code>nova floating-ip-delete <address></code></p>
<p><strong>address</strong>
: Address of the floating IP to be deleted.</p>
<h3>Example</h3>
<p>Remove floating IP 15.185.100.75 from your account:</p>
<pre><code>nova floating-ip-delete 15.185.100.75
</code></pre>
<h2>floating-ip-list## {#floating-ip-list}</h2>
<p>List floating IPs for the current tenant.</p>
<h3>Syntax</h3>
<p><code>nova floating-ip-list</code></p>
<h3>Example</h3>
<p>List the floating IPs for the current tenant:</p>
<pre><code>$ nova floating-ip-list
+----------------+-------------+--------------+
| Ip | Instance Id | Fixed Ip |
+----------------+-------------+--------------+
| 15.185.100.75 | None | None |
+----------------+-------------+--------------+
</code></pre>
<h2>get-console-output## {#get-console-output}</h2>
<p>Retrieves server log.</p>
<h3>Syntax</h3>
<p><code>nova get-console-output [--lines <lines>] <server></code></p>
<p><strong>server</strong>
: Name or ID of the server.</p>
<p><strong>lines</strong>
: Number of lines to be displayed.</p>
<h3>Example</h3>
<p>Display the first 10 lines of your console output:</p>
<pre><code>$ nova get-console-output --lines 10 703829
[ 0.000000] Initializing cgroup subsys cpuset
[ 0.000000] Initializing cgroup subsys cpu
[ 0.000000] Linux version 3.2.0-32-virtual (buildd@batsu) (gcc version 4.6.3 (Ubuntu/Linaro 4.6.3-1ubuntu5) ) #51-Ubuntu SMP Wed Sep 26 21:53:42 UTC 2012 (Ubuntu 3.2.0-32.51-virtual 3.2.30)
[ 0.000000] Command line: BOOT_IMAGE=/boot/vmlinuz-3.2.0-32-virtual root=LABEL=cloudimg-rootfs ro console=ttyS0
[ 0.000000] KERNEL supported cpus:
[ 0.000000] Intel GenuineIntel
[ 0.000000] AMD AuthenticAMD
[ 0.000000] Centaur CentaurHauls
[ 0.000000] BIOS-provided physical RAM map:
[ 0.000000] BIOS-e820: 0000000000000000 - 000000000009bc00 (usable)
</code></pre>
<h2>get-vnc-console## {#get-vnc-console}</h2>
<p>Get a virtual network computing (VNC) console for a server.</p>
<h3>Syntax</h3>
<p><code>get-vnc-console <server> <console-type></code></p>
<p><strong>server</strong>
: Name or ID of server.</p>
<p><strong>console-type</strong>
: Type of VNC console (currently supports type novnc).</p>
<h3>Example</h3>
<p>Get a VNC console of type <code>novnc</code> for the server with the ID 122:</p>
<pre><code>nova get-vnc-console 122 novnc
</code></pre>
<h2>image-create## {#image-create}</h2>
<p>Create a new image by taking a snapshot of a running server.</p>
<h3>Syntax</h3>
<p><code>nova image-create <server> <name></code></p>
<p><strong>server</strong>
: Name or ID of server.</p>
<p><strong>name</strong>
: Name of snapshot.</p>
<h3>Example</h3>
<p>Create a snapshot of your instance ID 703829 with a display name of <code>testimage</code>:</p>
<pre><code>nova image-create 703829 testimage
</code></pre>
<h2>image-delete## {#image-delete}</h2>
<p>Delete an image.</p>
<h3>Syntax</h3>
<p><code>nova image-delete <image></code></p>
<p><strong>image</strong>
: Name or ID of the image to delete.</p>
<h3>Example</h3>
<p>Delete the snapshot image <code>77935</code>:</p>
<pre><code>nova image-delete 77935
</code></pre>
<h2>image-list## {#image-list}</h2>
<p>Display a list of available images to boot from.</p>
<h3>Syntax</h3>
<p><code>nova image-list</code></p>
<h3>Examples</h3>
<p>Display a list of the available bootable images:</p>
<pre><code>$ nova image-list
+-------+------------------------------------------------------------------------ +--------+--------------------------------------+
| ID | Name | Status | Server |
+-------+------------------------------------------------------------------------+--------+--------------------------------------+
| 1232 | CentOS 5.6 Server 64-bit 20111207 (Kernel) (deprecated) | ACTIVE | |
| 1233 | CentOS 5.6 Server 64-bit 20111207 (Ramdisk) (deprecated) | ACTIVE | |
| 1234 | CentOS 5.6 Server 64-bit 20111207 (deprecated) | ACTIVE | |
| 1235 | Ubuntu Lucid 10.04 LTS Server 64-bit 20111212 (Kernel) | ACTIVE | |
| 1236 | Ubuntu Lucid 10.04 LTS Server 64-bit 20111212 | ACTIVE | |
| 1237 | Ubuntu Maverick 10.10 Server 64-bit 20111212 (Kernel) | ACTIVE | |
| 1238 | Ubuntu Maverick 10.10 Server 64-bit 20111212 | ACTIVE | |
| 1239 | Ubuntu Natty 11.04 Server 64-bit 20111212 (Kernel) | ACTIVE | |
| 9127 | ActiveState Stackato v1.2.5 - Partner Image (deprecated) | ACTIVE | |
| 9953 | EnterpriseDB PPAS 9.1.2 - Partner Image | ACTIVE | |
| 9995 | EnterpriseDB PSQL 9.1.3 - Partner Image | ACTIVE | |
+-------+------------------------------------------------------------------------+--------+--------------------------------------+
</code></pre>
<h2>image-meta## {#image-meta}</h2>
<p>Set or Delete metadata on an image.</p>
<h3>Syntax</h3>
<p><code>nova image-meta <image> [<action> <key=value> [<key=value> ]]</code></p>
<p><strong>image</strong>
: Name or ID of image.</p>
<p><strong>action</strong>
: Actions: <code>set</code> or <code>delete</code>.</p>
<p><strong>key=value</strong>
: Metadata to add/update or delete.</p>
<h3>Example</h3>
<p>Set a metadata key <code>purpose</code> with value <code>test</code> on image ID 77937</p>
<pre><code>nova image-meta 77937 set purpose=test
</code></pre>
<h2>image-show## {#image-show}</h2>
<p>Display details about the given image.</p>
<h3>Syntax</h3>
<p><code>nova image-show <image></code></p>
<p><strong>image</strong>
: Name or ID of the image.</p>
<h3>Example</h3>
<p>Display details of your image including all set metadata values:</p>
<pre><code>$ nova image-show 77937
+-------------------------+------------------------------------------------------------------------------------------------------+
| Property | Value |
+-------------------------+------------------------------------------------------------------------------------------------------+
| created | 2013-01-17T19:08:10Z |
| id | 77937 |
| metadata architecture | amd64 |
| metadata backup_type | None |
| metadata image_location | snapshot |
| metadata image_state | available |
| metadata image_type | snapshot |
| metadata instance_ref | https://az-1.region-a.geo-1.compute.hpcloudsvc.com/v1.1/servers/d41ecb12-b232-444a-8580-6f2e3fbcb33a |
| metadata instance_uuid | d41ecb12-b232-444a-8580-6f2e3fbcb33a |
| metadata kernel_id | None |
| metadata min_disk | 0 |
| metadata min_ram | 0 |
| metadata owner | 65589599430509 |
| metadata owner_id | 65589599430509 |
| metadata purpose | test |
| metadata ramdisk_id | None |
| metadata true | false |
| metadata user_id | 52552375567809 |
| name | testimage |
| progress | 100 |
| server | d41ecb12-b232-444a-8580-6f2e3fbcb33a |
| status | ACTIVE |
| updated | 2013-01-17T19:08:38Z |
+-------------------------+------------------------------------------------------------------------------------------------------+
</code></pre>
<h2>keypair-add## {#keypair-add}</h2>
<p>Create a new key pair for use with instances</p>
<h3>Syntax</h3>
<p><code>nova keypair-add [--pub_key <pub-key>] <name></code></p>
<p><strong>name</strong>
: Name of the key pair.</p>
<p><strong>pub_key</strong>
: Path to the public SSH key.</p>
<h3>Examples</h3>
<p>Create a new key pair to use with instances:</p>
<pre><code>$ nova keypair-add testkeypair
-----BEGIN RSA PRIVATE KEY-----
MIICXQIBAAKBgQC4H2v8lZAgikx/1hYX/cfoDT7Z9JbxVyTYS31urEZMa07qh8MT
76VudZbWkZZ8nw38nQEqVChhhxUXLUdUbzWboIytx/JJETbiEF9sfUj9nQe4I81C
dll0cTYSREUmwmbZgXXXXXXSIiT0uTRia6E2SL6m3PVaURThkqz+G9EjswIDAQAB
AoGBAIgt9Vij5i2rHFmQplaoRSrEYTAjT2DA62durh8lG/l5hKzCLO6Z2OmR3zZk
B8G0gkvMdAgypos7tcWmn5M7jZGDvlTjQNC7rizN6mOvLJ8haGFI6xiq898uVzi+
K+syLjxvVO1lzcaIV/3abhMlXXXXXX9+Ve01gLELzlu11ReBAkEA5lHeAgh4cwjR
pZz/j+gs48SjdEebVK6fplftUedyqfD9F9chlAPXPr6oOhPGEqhu6YzT6hCYhA1K
gC6u5TsR2wJBAMym7dj7Exj3uf3h5OmS7yeqwELJX4aqe2CSei5hX0PjFnG0TMTz
Llw0HSmXGIv0N/gpNDRP4ylGbOGXXXXXXXXCQBxeKQIHGQ7SH0BOvgtzhVPofFlu
GGuttmw+mDRmVXEpBYNSNAiPEIvh38aHePYDWOXbOp6xvJdHK83t8gy54dECQBVH
Leengz7PUvlAXXXXXXXXXXJAubvosddCo4169kq6q7S6yFiZ6DISAQ439YdnpwIY
VqMxwy6hceSuoo4WgvECQQC1eZgEGoRqrOK7XEfc3zDrJa6iXILmhUQhIQEXgxyB
c5S1JbVjp8HwF+imbEz5rSxjqOSniY1aFbYWQmzW/cqM
-----END RSA PRIVATE KEY----
</code></pre>
<p>Create a new key pair to use with instances, using the <code>publickeyfile.pub</code> public SSH key.</p>
<pre><code>$ nova keypair-add --pub_key publickeyfile.pub testkeypair
$
</code></pre>
<h2>keypair-delete## {#keypair-delete}</h2>
<p>Delete a key pair (designatedby its ID).</p>
<h3>Syntax</h3>
<p><code>nova keypair-delete <name></code></p>
<p><strong>name</strong>
: Name of the key pair.</p>
<h3>Example</h3>
<p>Delete the key pair <code>testkeypair</code>:</p>
<pre><code>nova keypair-delete testkeypair
</code></pre>
<h2>keypair-list## {#keypair-list}</h2>
<p>Display the key pairs for a user</p>
<h3>Syntax</h3>
<p><code>nova keypair-list</code></p>
<h3>Example</h3>
<p>Display the key pairs:</p>
<pre><code>$ nova keypair-list
+-------------+-------------------------------------------------+
| Name | Fingerprint |
+-------------+-------------------------------------------------+
| testkeypair | 02:fb:dc:3d:e9:c8:26:29:f9:0e:9d:53:71:5c:05:92 |
+-------------+-------------------------------------------------+
</code></pre>
<h2>list## {#list}</h2>
<p>List active servers.</p>
<h3>Syntax</h3>
<p><code>nova list [--reservation_id <reservation_id>] [--recurse_zones <0|1>] [--ip <ip_regexp>] [--ip6 <ip6_regexp>] [--name <name_regexp>] [--instance_name <name_regexp>] [--status <status>] [--flavor <flavor>] [--image <image>] [--host <hostname>]</code></p>
<p><strong>reservation<em>id</strong>
: Only return instances that match reservation</em>id.</p>
<p><strong>recurse_zones</strong>
: Recurse through all zones if set.</p>
<p><strong>ip</strong>
: Search with regular expression match by IP address.</p>
<p><strong>ip6</strong>
: Search with regular expression match by IPv6 address.</p>
<p><strong>name</strong>
: Search with regular expression match by name.</p>
<p><strong>instance_name</strong>
: Search with regular expression match by instance name.</p>
<p><strong>status</strong>
: Search by server status. </p>
<p><strong>flavor</strong>
: Search by flavor ID.</p>
<p><strong>image</strong>
: Search by image ID.</p>
<p><strong>host</strong>
: Search instances by hostname to which they are assigned</p>
<h3>Example</h3>
<p>List the active servers:</p>
<pre><code>$ nova list
+--------+---------------------------------------+--------+-----------------------------------------------------------------------------------+
| ID | Name | Status | Networks |
+--------+---------------------------------------+--------+-----------------------------------------------------------------------------------+
| 703829 | test | ACTIVE | private=10.4.160.226, 15.185.102.46 |
+--------+---------------------------------------+--------+-----------------------------------------------------------------------------------+
</code></pre>
<h2>meta## {#meta}</h2>
<p>Set or Delete metadata on a server.</p>
<h3>Syntax</h3>
<p><code>nova meta <server> [<action> <key=value> [<key=value> ]]</code></p>
<p><strong>server</strong>
: Name or ID of server.</p>
<p><strong>action</strong>
: Actions: <code>set</code> or <code>delete</code>.</p>
<p><strong>key=value</strong>
: Metadata to add/update or delete.</p>
<h3>Example</h3>
<p>Set metadata for server <code>703829</code> for test purposes:</p>
<pre><code>nova meta 703829 set purpose=test
</code></pre>
<h2>reboot## {#reboot}</h2>
<p>Reboot a server.</p>
<h3>Syntax</h3>
<p><code>nova reboot [--hard] <server></code></p>
<p><strong>hard</strong>
: Perform a hard reboot of the server.</p>
<h3>Example</h3>
<p>Perform a hard reboot on the server 703829:</p>
<pre><code>nova reboot 703829
</code></pre>
<h2>rebuild## {#rebuild}</h2>
<p>Shutdown, re-image, and re-boot a server.</p>
<h3>Syntax</h3>
<p><code>nova rebuild [--rebuild_password <rebuild_password>] <server> <image></code></p>
<p><strong>rebuild_password</strong>
: Password for the rebuild instance.</p>
<p><strong>server</strong>
: Name or ID of the server.</p>
<p><strong>image</strong>
: Name or ID of the new image.</p>
<h3>Example</h3>
<p>Rebuild serveer 703829 with image 75845:</p>
<pre><code>$ nova rebuild 703829 75845
+-----------------+----------------------------------------------------------+
| Property | Value |
+-----------------+----------------------------------------------------------+
| accessIPv4 | |
| accessIPv6 | |
| adminPass | vhDogQ6Y2pfqbGDP |
| config_drive | |
| created | 2013-01-17T18:55:07Z |
| flavor | standard.xsmall |
| hostId | 6689454bf62324974d5d9d8bf62e8fbe0587530328d421044a0c8232 |
| id | 703829 |
| image | Ubuntu Precise 12.04 LTS Server 64-bit 20121026 |
| key_name | az1 |
| metadata | {} |
| name | test |
| private network | 10.4.160.226, 15.185.102.46 |
| security_groups | default |
| status | REBUILD |
| tenant_id | 65589599430509 |
| updated | 2013-01-17T19:15:30Z |
| user_id | 52552375567809 |
| uuid | d41ecb12-b232-444a-8580-6f2e3fbcb33a |
+-----------------+----------------------------------------------------------+
</code></pre>
<h2>remove-floating-ip## {#remove-floating-ip}</h2>
<p>Remove a floating IP address from a server.</p>
<h3>Syntax</h3>
<p><code>nova remove-floating-ip <server> <address></code></p>
<p><strong>server</strong>
: Name or ID of the server.</p>
<p><strong>address</strong>
: IP address.</p>
<h3>Example</h3>
<p>Remove floating IP value <code>15.185.105.97</code> from server <code>694541</code>:</p>
<pre><code>nova remove-floating-ip 694541 15.185.105.97
</code></pre>
<h2>remove-secgroup## {#remove-secgroup}</h2>
<p>Removes a security group from an instance</p>
<h3>Syntax</h3>
<p><code>nova remove-secgroup <server> <secgroup></code></p>
<p><strong>server</strong>
: Name or ID of the server.</p>
<p><strong>secgroup</strong>
: Name of the security group.</p>
<h3>Example</h3>
<p>Remove security group default from server <code>703829</code>:</p>
<pre><code> nova remove-secgroup 703829 default
</code></pre>
<h2>rename## {#rename}</h2>
<p>Rename a server.</p>
<h3>Syntax</h3>
<p><code>nova rename <server> <name></code></p>
<p><strong>server</strong>
: The current name of the server you want to change.</p>
<p><strong>name</strong>
: New name for the server.</p>
<h3>Example</h3>
<p>Rename server <code>703829</code> to <code>test</code>:</p>
<pre><code>nova rename 703829 test
</code></pre>
<!--##root-password## {#root-password}
Change the root password for a server.
###Syntax
`nova root-password <server>`
**server**
: Name or ID of the server.
###Examples-->
<h2>secgroup-add-group-rule## {#secgroup-add-group-rule}</h2>
<p>Add a source group rule to a security group.</p>
<h3>Syntax</h3>
<p><code>nova secgroup-add-group-rule [--ip_proto <ip_proto>] [--from_port <from_port>] [--to_port <to_port>] <secgroup> <source_group></code></p>
<p><strong>secgroup</strong>
: ID of the security group.</p>
<p><strong>source_group</strong>
: ID of source group.</p>
<p><strong>ip_proto</strong>
: IP protocol type (ICMP, TCP, or UDP).</p>
<p><strong>from_port</strong>
: Port at start of range.</p>
<p><strong>to_port</strong>
: Port at the end of range.</p>
<h3>Examples</h3>
<p>Example 1</p>
<p>Add a single rule to the <code>pgroup</code> security group to allows all traffic between instances that are associated with it:</p>
<pre><code>$ nova secgroup-add-group-rule pgroup pgroup
+-------------+-----------+---------+----------+--------------+
| IP Protocol | From Port | To Port | IP Range | Source Group |
+-------------+-----------+---------+----------+--------------+
| | | | | pgroup |
+-------------+-----------+---------+----------+--------------+
</code></pre>
<p>Example 2</p>
<p>Enable any instance assigned the <code>default</code> security group to access any instance assigned the <code>pgroup</code> security group over TCP Port 80:</p>
<pre><code>$ nova secgroup-add-group-rule --ip_proto "TCP" --from_port "80" --to_port "80" pgroup default
+-------------+-----------+---------+----------+--------------+
| IP Protocol | From Port | To Port | IP Range | Source Group |
+-------------+-----------+---------+----------+--------------+
| tcp | 80 | 80 | | default |
+-------------+-----------+---------+----------+--------------+
</code></pre>
<h2>secgroup-add-rule## {#secgroup-add-rule}</h2>
<p>Add a rule to a security group.</p>
<h3>Syntax</h3>
<p><code>nova secgroup-add-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr></code></p>
<p><strong>secgroup</strong>
: ID of the security group.</p>
<p><strong>ip_proto</strong>
: IP protocol type (ICMP, TCP, or UDP).</p>
<p><strong>from_port</strong>
: Port at start of range.</p>
<p><strong>to_port</strong>
: Port at the end of range.</p>
<p><strong>cidr</strong>
: Classless inter-domain routing (CIDR) for the address range.</p>
<h3>Examples</h3>
<p>Add a rule to group <code>pgroup</code>:</p>
<pre><code>$ nova secgroup-add-rule pgroup TCP 80 80 0.0.0.0/0
+-------------+-----------+---------+-----------+--------------+
| IP Protocol | From Port | To Port | IP Range | Source Group |
+-------------+-----------+---------+-----------+--------------+
| tcp | 80 | 80 | 0.0.0.0/0 | |
+-------------+-----------+---------+-----------+--------------+
</code></pre>
<h2>secgroup-create## {#secgroup-create}</h2>
<p>Create a security group.</p>
<h3>Syntax</h3>
<p><code>nova secgroup-create <name> <description></code></p>
<p><strong>name</strong>
: Name of the security group.</p>
<p><strong>description</strong>
: Description of the security group.</p>
<h3>Examples</h3>
<p>Create a security group <code>pgroup</code>:</p>
<pre><code>$ nova secgroup-create pgroup testing
+--------+-------------+
| Name | Description |
+--------+-------------+
| pgroup | testing |
+--------+-------------+
</code></pre>
<h2>secgroup-delete## {#secgroup-delete}</h2>
<p>Delete a security group.</p>
<h3>Syntax</h3>
<p><code>nova secgroup-delete <secgroup></code></p>
<p><strong>secgroup</strong>
: Name of the security group.</p>
<h3>Examples</h3>
<p>Delete the security group <code>pgroup</code>:</p>
<pre><code>nova secgroup-delete pgroup
</code></pre>
<h2>secgroup-delete-group-rule## {#secgroup-delete-group-rule}</h2>
<p>Delete a source group rule from a security group.</p>
<h3>Syntax</h3>
<p><code>nova secgroup-delete-group-rule[--ip_proto <ip_proto>] [--from_port <from_port>] [--to_port <to_port>] <secgroup> <source_group></code></p>
<p><strong>secgroup</strong>
: ID of the security group.</p>
<p><strong>source_group</strong>
: ID of source group.</p>
<p><strong>ip_proto</strong>
: IP protocol type (ICMP, TCP, or UDP).</p>
<p><strong>from_port</strong>
: Port at start of range.</p>
<p><strong>to_port</strong>
: Port at the end of range.</p>
<h3>Examples</h3>
<p>Delete a group rule from security group <code>pgroup</code>:</p>
<pre><code>nova secgroup-delete-group-rule pgroup pgroup
</code></pre>
<h2>secgroup-delete-rule## {#secgroup-delete-rule}</h2>
<p>Delete a rule from a security group.</p>
<h3>Syntax</h3>
<p><code>nova secgroup-delete-rule <secgroup> <ip_proto> <from_port> <to_port> <cidr></code></p>
<p><strong>secgroup</strong>
: ID of the security group.</p>
<p><strong>ip_proto</strong>