1NOVA(1)                        python-novaclient                       NOVA(1)
2
3
4

NAME

6       nova - OpenStack Nova command line client
7
8       The  nova  client  is  the command-line interface (CLI) for the Compute
9       service (nova) API and its extensions.
10
11       For help on a specific nova command, enter:
12
13          $ nova help COMMAND
14
15       NOTE:
16          Over time, command line functionality will be phased out of the nova
17          CLI  and  into  the  openstack CLI. Using the openstack client where
18          possible is preferred but there is not full parity yet  for  all  of
19          the  nova commands.  For information on using the openstack CLI, see
20          OpenStackClient.
21

NOVA USAGE

23          usage: nova [--version] [--debug] [--os-cache] [--timings]
24                      [--os-region-name <region-name>] [--service-type <service-type>]
25                      [--service-name <service-name>]
26                      [--os-endpoint-type <endpoint-type>]
27                      [--os-compute-api-version <compute-api-ver>]
28                      [--os-endpoint-override <bypass-url>] [--profile HMAC_KEY]
29                      [--insecure] [--os-cacert <ca-certificate>]
30                      [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
31                      [--collect-timing] [--os-auth-type <name>]
32                      [--os-auth-url OS_AUTH_URL] [--os-system-scope OS_SYSTEM_SCOPE]
33                      [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME]
34                      [--os-project-id OS_PROJECT_ID]
35                      [--os-project-name OS_PROJECT_NAME]
36                      [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
37                      [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
38                      [--os-trust-id OS_TRUST_ID]
39                      [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
40                      [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
41                      [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
42                      [--os-user-domain-id OS_USER_DOMAIN_ID]
43                      [--os-user-domain-name OS_USER_DOMAIN_NAME]
44                      [--os-password OS_PASSWORD]
45                      <subcommand> ...
46
47       Subcommands:
48
49       add-fixed-ip
50              DEPRECATED Add new IP address on a network to server.
51
52       add-secgroup
53              Add a Security Group to a server.
54
55       agent-create
56              Create new agent build.
57
58       agent-delete
59              Delete existing agent build.
60
61       agent-list
62              List all builds.
63
64       agent-modify
65              Modify existing agent build.
66
67       aggregate-add-host
68              Add the host to the specified aggregate.
69
70       aggregate-cache-images
71              Request images be  pre-cached  on  hosts  within  an  aggregate.
72              (Supported by API versions '2.81' - '2.latest')
73
74       aggregate-create
75              Create a new aggregate with the specified details.
76
77       aggregate-delete
78              Delete the aggregate.
79
80       aggregate-list
81              Print a list of all aggregates.
82
83       aggregate-remove-host
84              Remove the specified host from the specified aggregate.
85
86       aggregate-set-metadata
87              Update the metadata associated with the aggregate.
88
89       aggregate-show
90              Show details of the specified aggregate.
91
92       aggregate-update
93              Update the aggregate's name and optionally availability zone.
94
95       availability-zone-list
96              List all the availability zones.
97
98       backup Backup a server by creating a 'backup' type snapshot.
99
100       boot   Boot a new server.
101
102       clear-password
103              Clear  the admin password for a server from the metadata server.
104              This action does not actually change the instance  server  pass‐
105              word.
106
107       cloudpipe-configure
108              DEPRECATED Update the VPN IP/port of a cloudpipe instance.
109
110       cloudpipe-create
111              DEPRECATED Create a cloudpipe instance for the given project.
112
113       cloudpipe-list
114              DEPRECATED Print a list of all cloudpipe instances.
115
116       console-log
117              Get console log output of a server.
118
119       delete Immediately shut down and delete specified server(s).
120
121       diagnostics
122              Retrieve server diagnostics.
123
124       evacuate
125              Evacuate server from failed host.
126
127       flavor-access-add
128              Add flavor access for the given tenant.
129
130       flavor-access-list
131              Print access information about the given flavor.
132
133       flavor-access-remove
134              Remove flavor access for the given tenant.
135
136       flavor-create
137              Create a new flavor.
138
139       flavor-delete
140              Delete a specific flavor
141
142       flavor-key
143              Set or unset extra_spec for a flavor.
144
145       flavor-list
146              Print a list of available 'flavors' (sizes of servers).
147
148       flavor-show
149              Show details about the given flavor.
150
151       flavor-update
152              Update the description of an existing flavor.  (Supported by API
153              versions '2.55' - '2.latest') [hint: use  '--os-compute-api-ver‐
154              sion' flag to show help message for proper version]
155
156       floating-ip-associate
157              DEPRECATED Associate a floating IP address to a server.
158
159       floating-ip-disassociate
160              DEPRECATED Disassociate a floating IP address from a server.
161
162       force-delete
163              Force delete a server.
164
165       get-mks-console
166              Get an MKS console to a server. (Supported by API versions '2.8'
167              - '2.latest') [hint: use '--os-compute-api-version' flag to show
168              help message for proper version]
169
170       get-password
171              Get  the  admin  password for a server. This operation calls the
172              metadata service to query metadata information and does not read
173              password information from the server itself.
174
175       get-rdp-console
176              Get a rdp console to a server.
177
178       get-serial-console
179              Get a serial console to a server.
180
181       get-spice-console
182              Get a spice console to a server.
183
184       get-vnc-console
185              Get a vnc console to a server.
186
187       host-action
188              DEPRECATED Perform a power action on a host.
189
190       host-describe
191              DEPRECATED Describe a specific host.
192
193       host-evacuate
194              Evacuate all instances from failed host.
195
196       host-evacuate-live
197              Live  migrate  all  instances  off  the  specified host to other
198              available hosts.
199
200       host-list
201              DEPRECATED List all hosts by service.
202
203       host-meta
204              Set or Delete metadata on all instances of a host.
205
206       host-servers-migrate
207              Cold migrate all instances  off  the  specified  host  to  other
208              available hosts.
209
210       host-update
211              DEPRECATED Update host settings.
212
213       hypervisor-list
214              List hypervisors. (Supported by API versions '2.0' - '2.latest')
215              [hint: use '--os-compute-api-version' flag to show help  message
216              for proper version]
217
218       hypervisor-servers
219              List servers belonging to specific hypervisors.
220
221       hypervisor-show
222              Display the details of the specified hypervisor.
223
224       hypervisor-stats
225              Get hypervisor statistics over all compute nodes.
226
227       hypervisor-uptime
228              Display the uptime of the specified hypervisor.
229
230       image-create
231              Create a new image by taking a snapshot of a running server.
232
233       instance-action
234              Show an action.
235
236       instance-action-list
237              List actions on a server.
238
239       instance-usage-audit-log
240              List/Get server usage audits.
241
242       interface-attach
243              Attach a network interface to a server.
244
245       interface-detach
246              Detach a network interface from a server.
247
248       interface-list
249              List interfaces attached to a server.
250
251       keypair-add
252              Create a new key pair for use with servers.
253
254       keypair-delete
255              Delete  keypair  given  by  its name. (Supported by API versions
256              '2.0' - '2.latest') [hint: use  '--os-compute-api-version'  flag
257              to show help message for proper version]
258
259       keypair-list
260              Print  a  list of keypairs for a user (Supported by API versions
261              '2.0' - '2.latest') [hint: use  '--os-compute-api-version'  flag
262              to show help message for proper version]
263
264       keypair-show
265              Show  details  about  the given keypair.  (Supported by API ver‐
266              sions '2.0' - '2.latest') [hint: use  '--os-compute-api-version'
267              flag to show help message for proper version]
268
269       limits Print rate and absolute limits.
270
271       list   List servers.
272
273       list-secgroup
274              List Security Group(s) of a server.
275
276       live-migration
277              Migrate running server to a new machine.
278
279       live-migration-abort
280              Abort  an  on-going  live  migration. (Supported by API versions
281              '2.24' - '2.latest') [hint: use '--os-compute-api-version'  flag
282              to show help message for proper version]
283
284       live-migration-force-complete
285              Force  on-going  live  migration to complete.  (Supported by API
286              versions '2.22' - '2.latest') [hint: use  '--os-compute-api-ver‐
287              sion' flag to show help message for proper version]
288
289       lock   Lock a server. A normal (non-admin) user will not be able to ex‐
290              ecute actions on a locked server.
291
292       meta   Set or delete metadata on a server.
293
294       migrate
295              Migrate a server. The new host will be selected  by  the  sched‐
296              uler.
297
298       migration-list
299              Print a list of migrations.
300
301       pause  Pause a server.
302
303       quota-class-show
304              List the quotas for a quota class.
305
306       quota-class-update
307              Update the quotas for a quota class.  (Supported by API versions
308              '2.0' - '2.latest') [hint: use  '--os-compute-api-version'  flag
309              to show help message for proper version]
310
311       quota-defaults
312              List the default quotas for a tenant.
313
314       quota-delete
315              Delete  quota  for a tenant/user so their quota will Revert back
316              to default.
317
318       quota-show
319              List the quotas for a tenant/user.
320
321       quota-update
322              Update the quotas for a tenant/user.  (Supported by API versions
323              '2.0'  -  '2.latest') [hint: use '--os-compute-api-version' flag
324              to show help message for proper version]
325
326       reboot Reboot a server.
327
328       rebuild
329              Shutdown, re-image, and re-boot a server.
330
331       refresh-network
332              Refresh server network information.
333
334       remove-fixed-ip
335              DEPRECATED Remove an IP address from a server.
336
337       remove-secgroup
338              Remove a Security Group from a server.
339
340       rescue Reboots a server into rescue mode, which starts the machine from
341              either  the  initial  image  or a specified image, attaching the
342              current boot disk as secondary.
343
344       reset-network
345              Reset network of a server.
346
347       reset-state
348              Reset the state of a server.
349
350       resize Resize a server.
351
352       resize-confirm
353              Confirm a previous resize.
354
355       resize-revert
356              Revert a previous resize (and return to the previous VM).
357
358       restore
359              Restore a soft-deleted server.
360
361       resume Resume a server.
362
363       server-group-create
364              Create a new server group with the specified details.
365
366       server-group-delete
367              Delete specific server group(s).
368
369       server-group-get
370              Get a specific server group.
371
372       server-group-list
373              Print a list of all server groups.
374
375       server-migration-list
376              Get the migrations list of specified server.  (Supported by  API
377              versions  '2.23' - '2.latest') [hint: use '--os-compute-api-ver‐
378              sion' flag to show help message for proper version]
379
380       server-migration-show
381              Get the migration of specified server.  (Supported by  API  ver‐
382              sions '2.23' - '2.latest') [hint: use '--os-compute-api-version'
383              flag to show help message for proper version]
384
385       server-tag-add
386              Add one or more tags to a server.  (Supported  by  API  versions
387              '2.26'  - '2.latest') [hint: use '--os-compute-api-version' flag
388              to show help message for proper version]
389
390       server-tag-delete
391              Delete one or more tags from a server.  (Supported by  API  ver‐
392              sions '2.26' - '2.latest') [hint: use '--os-compute-api-version'
393              flag to show help message for proper version]
394
395       server-tag-delete-all
396              Delete all tags from a server. (Supported by API versions '2.26'
397              - '2.latest') [hint: use '--os-compute-api-version' flag to show
398              help message for proper version]
399
400       server-tag-list
401              Get list of tags from  a  server.  (Supported  by  API  versions
402              '2.26'  - '2.latest') [hint: use '--os-compute-api-version' flag
403              to show help message for proper version]
404
405       server-tag-set
406              Set list of tags to a server. (Supported by API versions  '2.26'
407              - '2.latest') [hint: use '--os-compute-api-version' flag to show
408              help message for proper version]
409
410       server-topology
411              Retrieve NUMA topology of the given server.  (Supported  by  API
412              versions '2.78' - '2.latest')
413
414       service-delete
415              Delete the service.
416
417       service-disable
418              Disable the service.
419
420       service-enable
421              Enable the service.
422
423       service-force-down
424              Force  service  to  down.  (Supported  by  API versions '2.11' -
425              '2.latest') [hint: use '--os-compute-api-version' flag  to  show
426              help message for proper version]
427
428       service-list
429              Show a list of all running services. Filter by host & binary.
430
431       set-password
432              Change the admin password for a server.
433
434       shelve Shelve a server.
435
436       shelve-offload
437              Remove a shelved server from the compute node.
438
439       show   Show details about the given server.
440
441       ssh    SSH into a server.
442
443       start  Start the server(s).
444
445       stop   Stop the server(s).
446
447       suspend
448              Suspend a server.
449
450       trigger-crash-dump
451              Trigger  crash  dump  in an instance. (Supported by API versions
452              '2.17' - '2.latest') [hint: use '--os-compute-api-version'  flag
453              to show help message for proper version]
454
455       unlock Unlock a server.
456
457       unpause
458              Unpause a server.
459
460       unrescue
461              Restart the server from normal boot disk again.
462
463       unshelve
464              Unshelve a server.
465
466       update Update the name or the description for a server.
467
468       usage  Show usage data for a single tenant.
469
470       usage-list
471              List usage data for all tenants.
472
473       version-list
474              List all API versions.
475
476       virtual-interface-list
477              DEPRECATED Show virtual interface info about the given server.
478
479       volume-attach
480              Attach a volume to a server.
481
482       volume-attachments
483              List all the volumes attached to a server.
484
485       volume-detach
486              Detach a volume from a server.
487
488       volume-update
489              Update  the  attachment on the server. Migrates the data from an
490              attached volume to the specified available volume and swaps  out
491              the  active  attachment  to  the new volume.  Since microversion
492              2.85, support  for  updating  the  delete_on_termination  delete
493              flag,  which  allows changing the behavior of volume deletion on
494              instance deletion.
495
496       x509-create-cert
497              DEPRECATED Create x509 cert for a user in tenant.
498
499       x509-get-root-cert
500              DEPRECATED Fetch the x509 root cert.
501
502       bash-completion
503              Prints all of the commands and options to  stdout  so  that  the
504              nova.bash_completion script doesn't have to hard code them.
505
506       help   Display help about this program or one of its subcommands.
507

NOVA OPTIONAL ARGUMENTS

509       --version
510              show program's version number and exit
511
512       --debug
513              Print debugging output.
514
515       --os-cache
516              Use  the auth token cache. Defaults to False if env[OS_CACHE] is
517              not set.
518
519       --timings
520              Print call timing info.
521
522       --os-region-name <region-name>
523              Defaults to env[OS_REGION_NAME].
524
525       --service-type <service-type>
526              Defaults to compute for most actions.
527
528       --service-name <service-name>
529              Defaults to env[NOVA_SERVICE_NAME].
530
531       --os-endpoint-type <endpoint-type>
532              Defaults to  env[NOVA_ENDPOINT_TYPE],  env[OS_ENDPOINT_TYPE]  or
533              publicURL.
534
535       --os-compute-api-version <compute-api-ver>
536              Accepts X, X.Y (where X is major and Y is minor part) or "X.lat‐
537              est", defaults to env[OS_COMPUTE_API_VERSION].
538
539       --os-endpoint-override <bypass-url>
540              Use this API endpoint instead of the Service  Catalog.  Defaults
541              to env[OS_ENDPOINT_OVERRIDE].
542
543       --profile HMAC_KEY
544              HMAC key to use for encrypting context data for performance pro‐
545              filing of operation. This key should be the value  of  the  HMAC
546              key  configured  for  the  OSprofiler  middleware in nova; it is
547              specified    in    the    Nova     configuration     file     at
548              "/etc/nova/nova.conf".   Without  the key, profiling will not be
549              triggered even if OSprofiler is enabled on the server side.
550
551       --os-auth-type <name>, --os-auth-plugin <name>
552              Authentication type to use
553
554   nova add-secgroup
555          usage: nova add-secgroup <server> <secgroup>
556
557       Add a Security Group to a server.
558
559       Positional arguments:
560
561       <server>
562              Name or ID of server.
563
564       <secgroup>
565              Name or ID of Security Group.
566
567   nova agent-create
568          usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
569                                   <hypervisor>
570
571       Create new agent build.
572
573       Positional arguments:
574
575       <os>   Type of OS.
576
577       <architecture>
578              Type of architecture.
579
580       <version>
581              Version.
582
583       <url>  URL.
584
585       <md5hash>
586              MD5 hash.
587
588       <hypervisor>
589              Type of hypervisor.
590
591   nova agent-delete
592          usage: nova agent-delete <id>
593
594       Delete existing agent build.
595
596       Positional arguments:
597
598       <id>   ID of the agent-build.
599
600   nova agent-list
601          usage: nova agent-list [--hypervisor <hypervisor>]
602
603       List all builds.
604
605       Optional arguments:
606
607       --hypervisor <hypervisor>
608              Type of hypervisor.
609
610   nova agent-modify
611          usage: nova agent-modify <id> <version> <url> <md5hash>
612
613       Modify existing agent build.
614
615       Positional arguments:
616
617       <id>   ID of the agent-build.
618
619       <version>
620              Version.
621
622       <url>  URL
623
624       <md5hash>
625              MD5 hash.
626
627   nova aggregate-add-host
628          usage: nova aggregate-add-host <aggregate> <host>
629
630       Add the host to the specified aggregate.
631
632       Positional arguments:
633
634       <aggregate>
635              Name or ID of aggregate.
636
637       <host> The host to add to the aggregate.
638
639   nova aggregate-cache-images
640          usage: nova aggregate-cache-images <aggregate> <image> [<image> ..]
641
642       Request image(s) be pre-cached on hosts within  the  aggregate.   (Sup‐
643       ported by API versions '2.81' - '2.latest')
644
645       New in version 16.0.0.
646
647
648       Positional arguments:
649
650       <aggregate>
651              Name or ID of aggregate.
652
653       <image>
654              Name or ID of image(s) to cache.
655
656   nova aggregate-create
657          usage: nova aggregate-create <name> [<availability-zone>]
658
659       Create a new aggregate with the specified details.
660
661       Positional arguments:
662
663       <name> Name of aggregate.
664
665       <availability-zone>
666              The availability zone of the aggregate (optional).
667
668   nova aggregate-delete
669          usage: nova aggregate-delete <aggregate>
670
671       Delete the aggregate.
672
673       Positional arguments:
674
675       <aggregate>
676              Name or ID of aggregate to delete.
677
678   nova aggregate-list
679          usage: nova aggregate-list
680
681       Print a list of all aggregates.
682
683   nova aggregate-remove-host
684          usage: nova aggregate-remove-host <aggregate> <host>
685
686       Remove the specified host from the specified aggregate.
687
688       Positional arguments:
689
690       <aggregate>
691              Name or ID of aggregate.
692
693       <host> The host to remove from the aggregate.
694
695   nova aggregate-set-metadata
696          usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
697
698       Update the metadata associated with the aggregate.
699
700       Positional arguments:
701
702       <aggregate>
703              Name or ID of aggregate to update.
704
705       <key=value>
706              Metadata  to  add/update  to  aggregate. Specify only the key to
707              delete a metadata item.
708
709   nova aggregate-show
710          usage: nova aggregate-show <aggregate>
711
712       Show details of the specified aggregate.
713
714       Positional arguments:
715
716       <aggregate>
717              Name or ID of aggregate.
718
719   nova aggregate-update
720          usage: nova aggregate-update [--name NAME]
721                                       [--availability-zone <availability-zone>]
722                                       <aggregate>
723
724       Update the aggregate's name and optionally availability zone.
725
726       Positional arguments:
727
728       <aggregate>
729              Name or ID of aggregate to update.
730
731       Optional arguments:
732
733       --name NAME
734              New name for aggregate.
735
736       --availability-zone <availability-zone>
737              New availability zone for aggregate.
738
739   nova availability-zone-list
740          usage: nova availability-zone-list
741
742       List all the availability zones.
743
744   nova backup
745          usage: nova backup <server> <name> <backup-type> <rotation>
746
747       Backup a server by creating a 'backup' type snapshot.
748
749       Positional arguments:
750
751       <server>
752              Name or ID of server.
753
754       <name> Name of the backup image.
755
756       <backup-type>
757              The backup type, like "daily" or "weekly".
758
759       <rotation>
760              Int parameter representing how many backups to keep around.
761
762   nova boot
763          usage: nova boot [--flavor <flavor>] [--image <image>]
764                           [--image-with <key=value>] [--boot-volume <volume_id>]
765                           [--snapshot <snapshot_id>] [--min-count <number>]
766                           [--max-count <number>] [--meta <key=value>]
767                           [--key-name <key-name>] [--user-data <user-data>]
768                           [--availability-zone <availability-zone>]
769                           [--security-groups <security-groups>]
770                           [--block-device-mapping <dev-name=mapping>]
771                           [--block-device key1=value1[,key2=value2...]]
772                           [--swap <swap_size>]
773                           [--ephemeral size=<size>[,format=<format>]]
774                           [--hint <key=value>]
775                           [--nic <auto,none,net-id=net-uuid,net-name=network-name,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag>]
776                           [--config-drive <value>] [--poll] [--admin-pass <value>]
777                           [--access-ip-v4 <value>] [--access-ip-v6 <value>]
778                           [--description <description>] [--tags <tags>]
779                           [--return-reservation-id]
780                           [--trusted-image-certificate-id <trusted-image-certificate-id>]
781                           [--host <host>]
782                           [--hypervisor-hostname <hypervisor-hostname>]
783                           <name>
784
785       Boot a new server.
786
787       In order to create a server with pre-existing ports that contain a  re‐
788       source_request  value, such as for guaranteed minimum bandwidth quality
789       of service support, microversion 2.72 is required.
790
791       Positional arguments:
792
793       <name> Name for the new server.
794
795       Optional arguments:
796
797       --flavor <flavor>
798              Name or ID of flavor (see 'nova flavor-list').
799
800       --image <image>
801              Name or ID of image (see 'glance image-list').
802
803       --image-with <key=value>
804              Image metadata property (see 'glance image-show').
805
806       --boot-volume <volume_id>
807              Volume ID to boot from.
808
809       --snapshot <snapshot_id>
810              Snapshot ID to boot from (will create a volume).
811
812       --min-count <number>
813              Boot at least <number> servers (limited by quota).
814
815       --max-count <number>
816              Boot up to <number> servers (limited by quota).
817
818       --meta <key=value>
819              Record arbitrary key/value metadata to  /meta_data.json  on  the
820              metadata server. Can be specified multiple times.
821
822       --key-name <key-name>
823              Key name of keypair that should be created earlier with the com‐
824              mand keypair-add.
825
826       --user-data <user-data>
827              user data file to pass to be exposed by the metadata server.
828
829       --availability-zone <availability-zone>
830              The availability zone for server placement.
831
832       --security-groups <security-groups>
833              Comma separated list of security group names.
834
835       --block-device-mapping <dev-name=mapping>
836              Block       device       mapping       in       the       format
837              <dev-name>=<id>:<type>:<size(GiB)>:<delete-on-terminate>.
838
839       --block-device
840              key1=value1[,key2=value2...]   Block  device  mapping  with  the
841              keys: id=UUID (image_id, snapshot_id or volume_id only if  using
842              source  image,  snapshot  or  volume) source=source type (image,
843              snapshot, volume or blank), dest=destination type of  the  block
844              device  (volume or local), bus=device's bus (e.g. uml, lxc, vir‐
845              tio, ...; if omitted, hypervisor driver chooses a  suitable  de‐
846              fault,  honoured  only  if  device type is supplied) type=device
847              type (e.g. disk, cdrom, ...; defaults to 'disk') device=name  of
848              the  device  (e.g.  vda, xda, ...; if omitted, hypervisor driver
849              chooses suitable device depending on selected bus; note the lib‐
850              virt  driver always uses default device names), size=size of the
851              block device in MiB(for swap) and in GiB(for other formats)  (if
852              omitted,  hypervisor driver calculates size), format=device will
853              be formatted (e.g. swap, ntfs, ...; optional), bootindex=integer
854              used  for ordering the boot disks (for image backed instances it
855              is equal to 0, for others need to be specified),  shutdown=shut‐
856              down behaviour (either preserve or remove, for local destination
857              set to remove), tag=device metadata tag (optional; supported  by
858              API  versions '2.42' - '2.latest'), and volume_type=type of vol‐
859              ume to create (either ID or name) when source is blank, image or
860              snapshot and dest is volume (optional; supported by API versions
861              '2.67' - '2.latest').
862
863       --swap <swap_size>
864              Create and attach a local swap block device of <swap_size> MiB.
865
866       --ephemeral
867              size=<size>[,format=<format>]  Create   and   attach   a   local
868              ephemeral block device of <size> GiB and format it to <format>.
869
870       --hint <key=value>
871              Send arbitrary key/value pairs to the scheduler for custom use.
872
873       --nic                          <auto,none,net-id=net-uuid,net-name=net‐
874       work-name,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag>
875              Create  a  NIC  on  the server. Specify option multiple times to
876              create multiple nics unless using the special 'auto'  or  'none'
877              values.   auto: automatically allocate network resources if none
878              are available. This cannot be specified with any other nic value
879              and  cannot  be  specified multiple times. none: do not attach a
880              NIC at all. This cannot be specified with any  other  nic  value
881              and  cannot  be  specified multiple times. net-id: attach NIC to
882              network with a specific UUID. net-name: attach  NIC  to  network
883              with  this  name  (either  port-id or net-id or net-name must be
884              provided), v4-fixed-ip: IPv4 fixed address for  NIC  (optional),
885              v6-fixed-ip: IPv6 fixed address for NIC (optional), port-id: at‐
886              tach NIC to port with this UUID tag: interface metadata tag (op‐
887              tional)  (either port-id or net-id must be provided). (Supported
888              by API versions '2.42' - '2.latest')
889
890       --config-drive <value>
891              Enable config drive. The value must be a boolean value.
892
893       --poll Report the new server boot progress until it completes.
894
895       --admin-pass <value>
896              Admin password for the instance.
897
898       --access-ip-v4 <value>
899              Alternative access IPv4 of the instance.
900
901       --access-ip-v6 <value>
902              Alternative access IPv6 of the instance.
903
904       --description <description>
905              Description for the server. (Supported by API versions '2.19'  -
906              '2.latest')
907
908       --tags <tags>
909              Tags  for  the  server.Tags  must be separated by commas: --tags
910              <tag1,tag2> (Supported by API versions '2.52' - '2.latest')
911
912       --return-reservation-id
913              Return a reservation id bound to created servers.
914
915       --trusted-image-certificate-id <trusted-image-certificate-id>
916              Trusted image certificate IDs used to validate certificates dur‐
917              ing  the  image  signature  verification  process.   Defaults to
918              env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS].  May be specified  multi‐
919              ple  times to pass multiple trusted image certificate IDs. (Sup‐
920              ported by API versions '2.63' - '2.latest')
921
922       --host <host>
923              Requested host to create servers. Admin only by default.   (Sup‐
924              ported by API versions '2.74' - '2.latest')
925
926       --hypervisor-hostname <hypervisor-hostname>
927              Requested  hypervisor  hostname to create servers. Admin only by
928              default.  (Supported by API versions '2.74' - '2.latest')
929
930   nova clear-password
931          usage: nova clear-password <server>
932
933       Clear the admin password for a server from the  metadata  server.  This
934       action does not actually change the instance server password.
935
936       Positional arguments:
937
938       <server>
939              Name or ID of server.
940
941   nova console-log
942          usage: nova console-log [--length <length>] <server>
943
944       Get console log output of a server.
945
946       Locale encoding issues
947
948       If you encounter an error such as:
949
950          UnicodeEncodeError: 'ascii' codec can't encode characters in position
951
952       The  solution  to these problems is different depending on which locale
953       your computer is running in.
954
955       For instance, if you have a German Linux machine, you can fix the prob‐
956       lem by exporting the locale to de_DE.utf-8:
957
958          export LC_ALL=de_DE.utf-8
959          export LANG=de_DE.utf-8
960
961       If  you  are on a US machine, en_US.utf-8 is the encoding of choice. On
962       some newer Linux systems, you could also try C.UTF-8 as the locale:
963
964          export LC_ALL=C.UTF-8
965          export LANG=C.UTF-8
966
967       Positional arguments:
968
969       <server>
970              Name or ID of server.
971
972       Optional arguments:
973
974       --length <length>
975              Length in lines to tail.
976
977   nova delete
978          usage: nova delete [--all-tenants] <server> [<server> ...]
979
980       Immediately shut down and delete specified server(s).
981
982       Positional arguments:
983
984       <server>
985              Name or ID of server(s).
986
987       Optional arguments:
988
989       --all-tenants
990              Delete server(s) in another tenant by name (Admin only).
991
992   nova diagnostics
993          usage: nova diagnostics <server>
994
995       Retrieve server diagnostics.
996
997       Positional arguments:
998
999       <server>
1000              Name or ID of server.
1001
1002   nova evacuate
1003          usage: nova evacuate [--password <password>] [--on-shared-storage] [--force] <server> [<host>]
1004
1005       Evacuate server from failed host.
1006
1007       Positional arguments:
1008
1009       <server>
1010              Name or ID of server.
1011
1012       <host> Name or ID of the target host. If  no  host  is  specified,  the
1013              scheduler will choose one.
1014
1015       Optional arguments:
1016
1017       --password <password>
1018              Set the provided admin password on the evacuated server. Not ap‐
1019              plicable if the server is on shared storage.
1020
1021       --on-shared-storage
1022              Specifies whether server files are located  on  shared  storage.
1023              (Supported by API versions '2.0' - '2.13')
1024
1025       --force
1026              Force  an  evacuation  by not verifying the provided destination
1027              host by the scheduler.  (Supported  by  API  versions  '2.29'  -
1028              '2.67')
1029
1030              WARNING:
1031                 This could result in failures to actually evacuate the server
1032                 to the specified host. It is recommended to either not  spec‐
1033                 ify  a host so that the scheduler will pick one, or specify a
1034                 host without --force.
1035
1036   nova flavor-access-add
1037          usage: nova flavor-access-add <flavor> <tenant_id>
1038
1039       Add flavor access for the given tenant.
1040
1041       Positional arguments:
1042
1043       <flavor>
1044              Flavor name or ID to add access for the given tenant.
1045
1046       <tenant_id>
1047              Tenant ID to add flavor access for.
1048
1049   nova flavor-access-list
1050          usage: nova flavor-access-list [--flavor <flavor>]
1051
1052       Print access information about the given flavor.
1053
1054       Optional arguments:
1055
1056       --flavor <flavor>
1057              Filter results by flavor name or ID.
1058
1059   nova flavor-access-remove
1060          usage: nova flavor-access-remove <flavor> <tenant_id>
1061
1062       Remove flavor access for the given tenant.
1063
1064       Positional arguments:
1065
1066       <flavor>
1067              Flavor name or ID to remove access for the given tenant.
1068
1069       <tenant_id>
1070              Tenant ID to remove flavor access for.
1071
1072   nova flavor-create
1073          usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
1074                                    [--rxtx-factor <factor>] [--is-public <is-public>]
1075                                    [--description <description>]
1076                                    <name> <id> <ram> <disk> <vcpus>
1077
1078       Create a new flavor.
1079
1080       Positional arguments:
1081
1082       <name> Unique name of the new flavor.
1083
1084       <id>   Unique ID of the new flavor. Specifying 'auto' will generated  a
1085              UUID for the ID.
1086
1087       <ram>  Memory size in MiB.
1088
1089       <disk> Disk size in GiB.
1090
1091       <vcpus>
1092              Number of vcpus
1093
1094       Optional arguments:
1095
1096       --ephemeral <ephemeral>
1097              Ephemeral space size in GiB (default 0).
1098
1099       --swap <swap>
1100              Swap space size in MiB (default 0).
1101
1102       --rxtx-factor <factor>
1103              RX/TX factor (default 1).
1104
1105       --is-public <is-public>
1106              Make flavor accessible to the public (default true).
1107
1108       --description <description>
1109              A  free form description of the flavor. Limited to 65535 charac‐
1110              ters in length. Only printable characters  are  allowed.   (Sup‐
1111              ported by API versions '2.55' - '2.latest')
1112
1113   nova flavor-delete
1114          usage: nova flavor-delete <flavor>
1115
1116       Delete a specific flavor
1117
1118       Positional arguments:
1119
1120       <flavor>
1121              Name or ID of the flavor to delete.
1122
1123   nova flavor-key
1124          usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
1125
1126       Set or unset extra_spec for a flavor.
1127
1128       Positional arguments:
1129
1130       <flavor>
1131              Name or ID of flavor.
1132
1133       <action>
1134              Actions: 'set' or 'unset'.
1135
1136       <key=value>
1137              Extra_specs to set/unset (only key is necessary on unset).
1138
1139   nova flavor-list
1140          usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
1141                                  [--min-disk <min-disk>] [--min-ram <min-ram>]
1142                                  [--limit <limit>] [--sort-key <sort-key>]
1143                                  [--sort-dir <sort-dir>]
1144
1145       Print a list of available 'flavors' (sizes of servers).
1146
1147       Optional arguments:
1148
1149       --extra-specs
1150              Get extra-specs of each flavor.
1151
1152       --all  Display all flavors (Admin only).
1153
1154       --marker <marker>
1155              The  last  flavor ID of the previous page; displays list of fla‐
1156              vors after "marker".
1157
1158       --min-disk <min-disk>
1159              Filters the flavors by a minimum disk space, in GiB.
1160
1161       --min-ram <min-ram>
1162              Filters the flavors by a minimum RAM, in MiB.
1163
1164       --limit <limit>
1165              Maximum number of flavors to display. If limit  is  bigger  than
1166              'CONF.api.max_limit'     option     of     Nova    API,    limit
1167              'CONF.api.max_limit' will be used instead.
1168
1169       --sort-key <sort-key>
1170              Flavors list sort key.
1171
1172       --sort-dir <sort-dir>
1173              Flavors list sort direction.
1174
1175   nova flavor-show
1176          usage: nova flavor-show <flavor>
1177
1178       Show details about the given flavor.
1179
1180       Positional arguments:
1181
1182       <flavor>
1183              Name or ID of flavor.
1184
1185   nova flavor-update
1186          usage: nova flavor-update <flavor> <description>
1187
1188       Update the description of an existing flavor.  (Supported by  API  ver‐
1189       sions  '2.55'  - '2.latest') [hint: use '--os-compute-api-version' flag
1190       to show help message for proper version]
1191
1192       New in version 10.0.0.
1193
1194
1195       Positional arguments
1196
1197       <flavor>
1198              Name or ID of the flavor to update.
1199
1200       <description>
1201              A free form description of the flavor. Limited to 65535  charac‐
1202              ters in length. Only printable characters are allowed.
1203
1204   nova force-delete
1205          usage: nova force-delete <server>
1206
1207       Force delete a server.
1208
1209       Positional arguments:
1210
1211       <server>
1212              Name or ID of server.
1213
1214   nova get-mks-console
1215          usage: nova get-mks-console <server>
1216
1217       Get  an  MKS  console  to  a server. (Supported by API versions '2.8' -
1218       '2.latest') [hint: use '--os-compute-api-version'  flag  to  show  help
1219       message for proper version]
1220
1221       New in version 3.0.0.
1222
1223
1224       Positional arguments:
1225
1226       <server>
1227              Name or ID of server.
1228
1229   nova get-password
1230          usage: nova get-password <server> [<private-key>]
1231
1232       Get  the admin password for a server. This operation calls the metadata
1233       service to query metadata information and does not read password infor‐
1234       mation from the server itself.
1235
1236       Positional arguments:
1237
1238       <server>
1239              Name or ID of server.
1240
1241       <private-key>
1242              Private key (used locally to decrypt password) (Optional).  When
1243              specified, the command displays the clear (decrypted)  VM  pass‐
1244              word. When not specified, the ciphered VM password is displayed.
1245
1246   nova get-rdp-console
1247          usage: nova get-rdp-console <server> <console-type>
1248
1249       Get a rdp console to a server.
1250
1251       Positional arguments:
1252
1253       <server>
1254              Name or ID of server.
1255
1256       <console-type>
1257              Type of rdp console ("rdp-html5").
1258
1259   nova get-serial-console
1260          usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>
1261
1262       Get a serial console to a server.
1263
1264       Positional arguments:
1265
1266       <server>
1267              Name or ID of server.
1268
1269       Optional arguments:
1270
1271       --console-type CONSOLE_TYPE
1272              Type of serial console, default="serial".
1273
1274   nova get-spice-console
1275          usage: nova get-spice-console <server> <console-type>
1276
1277       Get a spice console to a server.
1278
1279       Positional arguments:
1280
1281       <server>
1282              Name or ID of server.
1283
1284       <console-type>
1285              Type of spice console ("spice-html5").
1286
1287   nova get-vnc-console
1288          usage: nova get-vnc-console <server> <console-type>
1289
1290       Get a vnc console to a server.
1291
1292       Positional arguments:
1293
1294       <server>
1295              Name or ID of server.
1296
1297       <console-type>
1298              Type of vnc console ("novnc" or "xvpvnc").
1299
1300   nova host-evacuate
1301          usage: nova host-evacuate [--target_host <target_host>] [--force] [--strict]
1302                                    <host>
1303
1304       Evacuate all instances from failed host.
1305
1306       Positional arguments:
1307
1308       <host> The hypervisor hostname (or pattern) to search for.
1309
1310              WARNING:
1311                 Use  a fully qualified domain name if you only want to evacu‐
1312                 ate from a specific host.
1313
1314       Optional arguments:
1315
1316       --target_host <target_host>
1317              Name of target host. If no host is specified the scheduler  will
1318              select a target.
1319
1320       --force
1321              Force  an  evacuation  by not verifying the provided destination
1322              host by the scheduler.  (Supported  by  API  versions  '2.29'  -
1323              '2.67')
1324
1325              WARNING:
1326                 This could result in failures to actually evacuate the server
1327                 to the specified host. It is recommended to either not  spec‐
1328                 ify  a host so that the scheduler will pick one, or specify a
1329                 host without --force.
1330
1331       --strict
1332              Evacuate host with exact hypervisor hostname match
1333
1334   nova host-evacuate-live
1335          usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
1336                                         [--max-servers <max_servers>] [--force]
1337                                         [--strict]
1338                                         <host>
1339
1340       Live migrate all instances off the specified host  to  other  available
1341       hosts.
1342
1343       Positional arguments:
1344
1345       <host> Name  of  host.   The hypervisor hostname (or pattern) to search
1346              for.
1347
1348              WARNING:
1349                 Use a fully qualified domain name if you only  want  to  live
1350                 migrate from a specific host.
1351
1352       Optional arguments:
1353
1354       --target-host <target_host>
1355              Name of target host. If no host is specified, the scheduler will
1356              choose one.
1357
1358       --block-migrate
1359              Enable block migration. (Default=auto) (Supported  by  API  ver‐
1360              sions '2.25' - '2.latest')
1361
1362       --max-servers <max_servers>
1363              Maximum number of servers to live migrate simultaneously
1364
1365       --force
1366              Force a live-migration by not verifying the provided destination
1367              host by the scheduler.  (Supported  by  API  versions  '2.30'  -
1368              '2.67')
1369
1370              WARNING:
1371                 This  could  result  in failures to actually live migrate the
1372                 servers to the specified host. It is  recommended  to  either
1373                 not  specify  a  host so that the scheduler will pick one, or
1374                 specify a host without --force.
1375
1376       --strict
1377              live Evacuate host with exact hypervisor hostname match
1378
1379   nova host-meta
1380          usage: nova host-meta [--strict] <host> <action> <key=value> [<key=value> ...]
1381
1382       Set or Delete metadata on all instances of a host.
1383
1384       Positional arguments:
1385
1386       <host> The hypervisor hostname (or pattern) to search for.
1387
1388              WARNING:
1389                 Use a fully qualified domain name if you only want to  update
1390                 metadata for servers on a specific host.
1391
1392       <action>
1393              Actions: 'set' or 'delete'
1394
1395       <key=value>
1396              Metadata to set or delete (only key is necessary on delete)
1397
1398       Optional arguments:
1399
1400       --strict
1401              Set host-meta to the hypervisor with exact hostname match
1402
1403   nova host-servers-migrate
1404          usage: nova host-servers-migrate [--strict] <host>
1405
1406       Cold  migrate  all  instances off the specified host to other available
1407       hosts.
1408
1409       Positional arguments:
1410
1411       <host> Name of host.  The hypervisor hostname (or  pattern)  to  search
1412              for.
1413
1414              WARNING:
1415                 Use  a  fully  qualified domain name if you only want to cold
1416                 migrate from a specific host.
1417
1418       Optional arguments:
1419
1420       --strict
1421              Migrate host with exact hypervisor hostname match
1422
1423   nova hypervisor-list
1424          usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
1425                                      [--limit <limit>]
1426
1427       List hypervisors. (Supported by API versions '2.0' - '2.latest') [hint:
1428       use  '--os-compute-api-version'  flag  to  show help message for proper
1429       version]
1430
1431       Optional arguments:
1432
1433       --matching <hostname>
1434              List hypervisors matching the given <hostname>. If  matching  is
1435              used limit and marker options will be ignored.
1436
1437       --marker <marker>
1438              The  last  hypervisor of the previous page; displays list of hy‐
1439              pervisors after "marker".  (Supported by API versions  '2.33'  -
1440              '2.latest')
1441
1442       --limit <limit>
1443              Maximum  number  of  hypervisors  to display. If limit is bigger
1444              than   'CONF.api.max_limit'   option   of   Nova   API,    limit
1445              'CONF.api.max_limit'  will  be  used instead.  (Supported by API
1446              versions '2.33' - '2.latest')
1447
1448   nova hypervisor-servers
1449          usage: nova hypervisor-servers <hostname>
1450
1451       List servers belonging to specific hypervisors.
1452
1453       Positional arguments:
1454
1455       <hostname>
1456              The hypervisor hostname (or pattern) to search for.
1457
1458   nova hypervisor-show
1459          usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
1460
1461       Display the details of the specified hypervisor.
1462
1463       Positional arguments:
1464
1465       <hypervisor>
1466              Name or ID of the hypervisor.  Starting with  microversion  2.53
1467              the ID must be a UUID.
1468
1469       Optional arguments:
1470
1471       --wrap <integer>
1472              Wrap  the  output  to  a specified length. Default is 40 or 0 to
1473              disable
1474
1475   nova hypervisor-stats
1476          usage: nova hypervisor-stats
1477
1478       Get hypervisor statistics over all compute nodes.
1479
1480   nova hypervisor-uptime
1481          usage: nova hypervisor-uptime <hypervisor>
1482
1483       Display the uptime of the specified hypervisor.
1484
1485       Positional arguments:
1486
1487       <hypervisor>
1488              Name or ID of the hypervisor.  Starting with  microversion  2.53
1489              the ID must be a UUID.
1490
1491   nova image-create
1492          usage: nova image-create [--metadata <key=value>] [--show] [--poll]
1493                                   <server> <name>
1494
1495       Create a new image by taking a snapshot of a running server.
1496
1497       Positional arguments:
1498
1499       <server>
1500              Name or ID of server.
1501
1502       <name> Name of snapshot.
1503
1504       Optional arguments:
1505
1506       --metadata <key=value>
1507              Record  arbitrary  key/value  metadata to /meta_data.json on the
1508              metadata server. Can be specified multiple times.
1509
1510       --show Print image info.
1511
1512       --poll Report the snapshot progress and poll until  image  creation  is
1513              complete.
1514
1515   nova instance-action
1516          usage: nova instance-action <server> <request_id>
1517
1518       Show an action.
1519
1520       Positional arguments:
1521
1522       <server>
1523              Name or UUID of the server to show actions for. Only UUID can be
1524              used to show actions for a deleted  server.  (Supported  by  API
1525              versions '2.21' - '2.latest')
1526
1527       <request_id>
1528              Request ID of the action to get.
1529
1530   nova instance-action-list
1531          usage: nova instance-action-list [--marker <marker>] [--limit <limit>]
1532                                           [--changes-since <changes_since>]
1533                                           [--changes-before <changes_before>]
1534                                           <server>
1535
1536       List actions on a server.
1537
1538       Positional arguments:
1539
1540       <server>
1541              Name or UUID of the server to list actions for. Only UUID can be
1542              used to list actions on a deleted server. (Supported by API ver‐
1543              sions '2.21' - '2.latest')
1544
1545       Optional arguments:
1546
1547       --marker <marker>
1548              The  last instance action of the previous page; displays list of
1549              actions after "marker". (Supported  by  API  versions  '2.58'  -
1550              '2.latest')
1551
1552       --limit <limit>
1553              Maximum  number  of instance actions to display. Note that there
1554              is a configurable max limit on the server, and the limit that is
1555              used  will  be the minimum of what is requested here and what is
1556              configured in the server. (Supported by API  versions  '2.58'  -
1557              '2.latest')
1558
1559       --changes-since <changes_since>
1560              List  only  instance actions changed later or equal to a certain
1561              point of time. The provided time should be an ISO 8061 formatted
1562              time.   e.g.  2016-03-04T06:27:59Z.  (Supported  by API versions
1563              '2.58' - '2.latest')
1564
1565       --changes-before <changes_before>
1566              List only instance actions changed earlier or equal to a certain
1567              point of time. The provided time should be an ISO 8061 formatted
1568              time.  e.g. 2016-03-04T06:27:59Z.  (Supported  by  API  versions
1569              '2.66' - '2.latest')
1570
1571   nova instance-usage-audit-log
1572          usage: nova instance-usage-audit-log [--before <before>]
1573
1574       List/Get server usage audits.
1575
1576       Optional arguments:
1577
1578       --before <before>
1579              Filters  the  response by the date and time before which to list
1580              usage audits.  The date and time stamp  format  is  as  follows:
1581              CCYY-MM-DD  hh:mm:ss.NNNNNN ex 2015-08-27 09:49:58 or 2015-08-27
1582              09:49:58.123456.
1583
1584   nova interface-attach
1585          usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
1586                                       [--fixed-ip <fixed_ip>] [--tag <tag>]
1587                                       <server>
1588
1589       Attach a network interface to a server.
1590
1591       Positional arguments:
1592
1593       <server>
1594              Name or ID of server.
1595
1596       Optional arguments:
1597
1598       --port-id <port_id>
1599              Port ID.
1600
1601       --net-id <net_id>
1602              Network ID
1603
1604       --fixed-ip <fixed_ip>
1605              Requested fixed IP.
1606
1607       --tag <tag>
1608              Tag for the attached  interface.   (Supported  by  API  versions
1609              '2.49' - '2.latest')
1610
1611   nova interface-detach
1612          usage: nova interface-detach <server> <port_id>
1613
1614       Detach a network interface from a server.
1615
1616       Positional arguments:
1617
1618       <server>
1619              Name or ID of server.
1620
1621       <port_id>
1622              Port ID.
1623
1624   nova interface-list
1625          usage: nova interface-list <server>
1626
1627       List interfaces attached to a server.
1628
1629       Positional arguments:
1630
1631       <server>
1632              Name or ID of server.
1633
1634   nova keypair-add
1635          usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
1636                                  [--user <user-id>]
1637                                  <name>
1638
1639       Create a new key pair for use with servers.
1640
1641       Positional arguments:
1642
1643       <name> Name of key.
1644
1645       Optional arguments:
1646
1647       --pub-key <pub-key>
1648              Path to a public ssh key.
1649
1650       --key-type <key-type>
1651              Keypair  type.  Can  be  ssh or x509. (Supported by API versions
1652              '2.2' - '2.latest')
1653
1654       --user <user-id>
1655              ID of user to whom to add key-pair (Admin only).  (Supported  by
1656              API versions '2.10' - '2.latest')
1657
1658   nova keypair-delete
1659          usage: nova keypair-delete [--user <user-id>] <name>
1660
1661       Delete  keypair  given  by its name. (Supported by API versions '2.0' -
1662       '2.latest') [hint: use '--os-compute-api-version'  flag  to  show  help
1663       message for proper version]
1664
1665       Positional arguments:
1666
1667       <name> Keypair name to delete.
1668
1669       Optional arguments:
1670
1671       --user <user-id>
1672              ID of key-pair owner (Admin only).
1673
1674   nova keypair-list
1675          usage: nova keypair-list [--user <user-id>] [--marker <marker>]
1676                                   [--limit <limit>]
1677
1678       Print  a list of keypairs for a user (Supported by API versions '2.0' -
1679       '2.latest') [hint: use '--os-compute-api-version'  flag  to  show  help
1680       message for proper version]
1681
1682       Optional arguments:
1683
1684       --user <user-id>
1685              List key-pairs of specified user ID (Admin only).
1686
1687       --marker <marker>
1688              The last keypair of the previous page; displays list of keypairs
1689              after "marker".
1690
1691       --limit <limit>
1692              Maximum number of keypairs to display. If limit is  bigger  than
1693              'CONF.api.max_limit'     option     of     Nova    API,    limit
1694              'CONF.api.max_limit' will be used instead.
1695
1696   nova keypair-show
1697          usage: nova keypair-show [--user <user-id>] <keypair>
1698
1699       Show details about the given keypair. (Supported by API versions  '2.0'
1700       -  '2.latest')  [hint: use '--os-compute-api-version' flag to show help
1701       message for proper version]
1702
1703       Positional arguments:
1704
1705       <keypair>
1706              Name of keypair.
1707
1708       Optional arguments:
1709
1710       --user <user-id>
1711              ID of key-pair owner (Admin only).
1712
1713   nova limits
1714          usage: nova limits [--tenant [<tenant>]] [--reserved]
1715
1716       Print rate and absolute limits.
1717
1718       Optional arguments:
1719
1720       --tenant [<tenant>]
1721              Display information from single tenant (Admin only).
1722
1723       --reserved
1724              Include reservations count.
1725
1726   nova list
1727          usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>]
1728                           [--ip6 <ip6-regexp>] [--name <name-regexp>]
1729                           [--status <status>] [--flavor <flavor>] [--image <image>]
1730                           [--host <hostname>] [--all-tenants [<0|1>]]
1731                           [--tenant [<tenant>]] [--user [<user>]] [--deleted]
1732                           [--fields <fields>] [--minimal]
1733                           [--sort <key>[:<direction>]] [--marker <marker>]
1734                           [--limit <limit>] [--availability-zone <availability_zone>]
1735                           [--key-name <key_name>] [--[no-]config-drive]
1736                           [--progress <progress>] [--vm-state <vm_state>]
1737                           [--task-state <task_state>] [--power-state <power_state>]
1738                           [--changes-since <changes_since>]
1739                           [--changes-before <changes_before>]
1740                           [--tags <tags>] [--tags-any <tags-any>]
1741                           [--not-tags <not-tags>] [--not-tags-any <not-tags-any>]
1742                           [--locked]
1743
1744       List servers.
1745
1746       Note that from microversion 2.69, during partial  infrastructure  fail‐
1747       ures  in  the deployment, the output of this command may return partial
1748       results for the servers present in the failure domain.
1749
1750       Optional arguments:
1751
1752       --reservation-id <reservation-id>
1753              Only return servers that match reservation-id.
1754
1755       --ip <ip-regexp>
1756              Search with regular expression match by IP address.
1757
1758       --ip6 <ip6-regexp>
1759              Search with regular expression match by IPv6 address.
1760
1761       --name <name-regexp>
1762              Search with regular expression match by name.
1763
1764       --status <status>
1765              Search by server status.
1766
1767       --flavor <flavor>
1768              Search by flavor name or ID.
1769
1770       --image <image>
1771              Search by image name or ID.
1772
1773       --host <hostname>
1774              Search servers by hostname to which  they  are  assigned  (Admin
1775              only).
1776
1777       --all-tenants [<0|1>]
1778              Display information from all tenants (Admin only).
1779
1780       --tenant [<tenant>]
1781              Display information from single tenant (Admin only).
1782
1783       --user [<user>]
1784              Display information from single user (Admin only until microver‐
1785              sion 2.82).
1786
1787       --deleted
1788              Only display deleted servers (Admin only).
1789
1790       --fields <fields>
1791              Comma-separated list of fields to display. Use the show  command
1792              to see which fields are available.
1793
1794       --minimal
1795              Get only UUID and name.
1796
1797       --sort <key>[:<direction>]
1798              Comma-separated  list of sort keys and directions in the form of
1799              <key>[:<asc|desc>].  The direction defaults to descending if not
1800              specified.
1801
1802       --marker <marker>
1803              The  last  server  UUID  of  the previous page; displays list of
1804              servers after "marker".
1805
1806       --limit <limit>
1807              Maximum number of servers  to  display.  If  limit  ==  -1,  all
1808              servers   will   be   displayed.   If   limit   is  bigger  than
1809              'CONF.api.max_limit'    option    of     Nova     API,     limit
1810              'CONF.api.max_limit' will be used instead.
1811
1812       --availability-zone <availability_zone>
1813              Display servers based on their availability zone (Admin only un‐
1814              til microversion 2.82).
1815
1816       --key-name <key_name>
1817              Display servers based on their keypair name  (Admin  only  until
1818              microversion 2.82).
1819
1820       --config-drive
1821              Display  servers that have a config drive attached.  It is mutu‐
1822              ally exclusive with '--no-config-drive'.  (Admin only until  mi‐
1823              croversion 2.82).
1824
1825       --no-config-drive
1826              Display servers that do not have a config drive attached.  It is
1827              mutually exclusive with '--config-drive'.  (Admin only until mi‐
1828              croversion 2.82).
1829
1830       --progress <progress>
1831              Display  servers based on their progress value (Admin only until
1832              microversion 2.82).
1833
1834       --vm-state <vm_state>
1835              Display servers based on their vm_state value (Admin only  until
1836              microversion 2.82).
1837
1838       --task-state <task_state>
1839              Display  servers based on their task_state value (Admin only un‐
1840              til microversion 2.82).
1841
1842       --power-state <power_state>
1843              Display servers based on their power_state value (Admin only un‐
1844              til microversion 2.82).
1845
1846       --changes-since <changes_since>
1847              List  only  servers changed later or equal to a certain point of
1848              time. The provided time should be an ISO  8061  formatted  time.
1849              e.g.  2016-03-04T06:27:59Z .
1850
1851       --changes-before <changes_before>
1852              List only servers changed earlier or equal to a certain point of
1853              time. The provided time should be an ISO  8061  formatted  time.
1854              e.g.  2016-03-05T06:27:59Z . (Supported by API versions '2.66' -
1855              '2.latest')
1856
1857       --tags <tags>
1858              The given tags must all be present for a server to  be  included
1859              in  the list result.  Boolean expression in this case is 't1 AND
1860              t2'. Tags must be separated by commas: --tags <tag1,tag2>  (Sup‐
1861              ported by API versions '2.26' - '2.latest')
1862
1863       --tags-any <tags-any>
1864              If  one of the given tags is present the server will be included
1865              in the list result. Boolean expression in this case  is  't1  OR
1866              t2'.  Tags  must  be separated by commas: --tags-any <tag1,tag2>
1867              (Supported by API versions '2.26' - '2.latest')
1868
1869       --not-tags <not-tags>
1870              Only the servers that do not have any of the given tags will  be
1871              included in the list results. Boolean expression in this case is
1872              'NOT(t1 AND t2)'. Tags must be separated by  commas:  --not-tags
1873              <tag1,tag2> (Supported by API versions '2.26' - '2.latest')
1874
1875       --not-tags-any <not-tags-any>
1876              Only the servers that do not have at least one of the given tags
1877              will be included in the list result. Boolean expression in  this
1878              case  is  'NOT(t1  OR  t2)'.  Tags  must be separated by commas:
1879              --not-tags-any <tag1,tag2> (Supported by API versions  '2.26'  -
1880              '2.latest')
1881
1882       --locked <locked>
1883              Display  servers  based  on  their locked value. A value must be
1884              specified; eg. 'true' will list only locked servers and  'false'
1885              will  list  only  unlocked  servers.  (Supported by API versions
1886              '2.73' - '2.latest')
1887
1888   nova list-secgroup
1889          usage: nova list-secgroup <server>
1890
1891       List Security Group(s) of a server.
1892
1893       Positional arguments:
1894
1895       <server>
1896              Name or ID of server.
1897
1898   nova live-migration
1899          usage: nova live-migration [--block-migrate] [--force] <server> [<host>]
1900
1901       Migrate running server to a new machine.
1902
1903       Positional arguments:
1904
1905       <server>
1906              Name or ID of server.
1907
1908       <host> Destination host name. If no host is  specified,  the  scheduler
1909              will choose one.
1910
1911       Optional arguments:
1912
1913       --block-migrate
1914              True  in case of block_migration.  (Default=auto:live_migration)
1915              (Supported by API versions '2.25' - '2.latest')
1916
1917       --force
1918              Force a live-migration by not verifying the provided destination
1919              host  by  the  scheduler.  (Supported  by  API versions '2.30' -
1920              '2.67')
1921
1922              WARNING:
1923                 This could result in failures to actually  live  migrate  the
1924                 server to the specified host. It is recommended to either not
1925                 specify a host so that the scheduler will pick one, or  spec‐
1926                 ify a host without --force.
1927
1928   nova live-migration-abort
1929          usage: nova live-migration-abort <server> <migration>
1930
1931       Abort  an  on-going live migration. (Supported by API versions '2.24' -
1932       '2.latest') [hint: use '--os-compute-api-version'  flag  to  show  help
1933       message for proper version]
1934
1935       For  microversions  from 2.24 to 2.64 the migration status must be run‐
1936       ning; for microversion 2.65 and greater, the migration status can  also
1937       be queued and preparing.
1938
1939       New in version 3.3.0.
1940
1941
1942       Positional arguments:
1943
1944       <server>
1945              Name or ID of server.
1946
1947       <migration>
1948              ID of migration.
1949
1950   nova live-migration-force-complete
1951          usage: nova live-migration-force-complete <server> <migration>
1952
1953       Force  on-going  live migration to complete. (Supported by API versions
1954       '2.22' - '2.latest') [hint: use '--os-compute-api-version' flag to show
1955       help message for proper version]
1956
1957       New in version 3.3.0.
1958
1959
1960       Positional arguments:
1961
1962       <server>
1963              Name or ID of server.
1964
1965       <migration>
1966              ID of migration.
1967
1968   nova lock
1969          usage: nova lock [--reason <reason>] <server>
1970
1971       Lock  a  server.  A normal (non-admin) user will not be able to execute
1972       actions on a locked server.
1973
1974       Positional arguments:
1975
1976       <server>
1977              Name or ID of server.
1978
1979       Optional arguments:
1980
1981       --reason <reason>
1982              Reason for locking the server. (Supported by API versions '2.73'
1983              - '2.latest')
1984
1985   nova meta
1986          usage: nova meta <server> <action> <key=value> [<key=value> ...]
1987
1988       Set or delete metadata on a server.
1989
1990       Positional arguments:
1991
1992       <server>
1993              Name or ID of server.
1994
1995       <action>
1996              Actions: 'set' or 'delete'.
1997
1998       <key=value>
1999              Metadata to set or delete (only key is necessary on delete).
2000
2001   nova migrate
2002          usage: nova migrate [--host <host>] [--poll] <server>
2003
2004       Migrate a server. The new host will be selected by the scheduler.
2005
2006       Positional arguments:
2007
2008       <server>
2009              Name or ID of server.
2010
2011       Optional arguments:
2012
2013       --host <host>
2014              Destination  host  name.  (Supported  by  API  versions '2.56' -
2015              '2.latest')
2016
2017       --poll Report the server migration progress until it completes.
2018
2019   nova migration-list
2020          usage: nova migration-list [--instance-uuid <instance_uuid>]
2021                                     [--host <host>]
2022                                     [--status <status>]
2023                                     [--migration-type <migration_type>]
2024                                     [--source-compute <source_compute>]
2025                                     [--marker <marker>]
2026                                     [--limit <limit>]
2027                                     [--changes-since <changes_since>]
2028                                     [--changes-before <changes_before>]
2029                                     [--project-id <project_id>]
2030                                     [--user-id <user_id>]
2031
2032       Print a list of migrations.
2033
2034       Examples
2035
2036       To see the list of evacuation operations from a compute service host:
2037
2038          nova migration-list --migration-type evacuation --source-compute host.foo.bar
2039
2040       Optional arguments:
2041
2042       --instance-uuid <instance_uuid>
2043              Fetch migrations for the given instance.
2044
2045       --host <host>
2046              Fetch migrations for the given source or destination host.
2047
2048       --status <status>
2049              Fetch migrations for the given status.
2050
2051       --migration-type <migration_type>
2052              Filter migrations by type. Valid values are:
2053
2054              • evacuation
2055
2056              • live-migration
2057
2058              • migration
2059
2060                NOTE:
2061                   This is a cold migration.
2062
2063              • resize
2064
2065       --source-compute <source_compute>
2066              Filter migrations by source compute host name.
2067
2068       --marker <marker>
2069              The last migration of the previous page; displays list of migra‐
2070              tions  after  "marker".  Note  that  the marker is the migration
2071              UUID.  (Supported by API versions '2.59' - '2.latest')
2072
2073       --limit <limit>
2074              Maximum number of migrations to display. Note that  there  is  a
2075              configurable max limit on the server, and the limit that is used
2076              will be the minimum of what is requested here and what  is  con‐
2077              figured  in  the  server.   (Supported  by API versions '2.59' -
2078              '2.latest')
2079
2080       --changes-since <changes_since>
2081              List only migrations changed later or equal to a  certain  point
2082              of time. The provided time should be an ISO 8061 formatted time.
2083              e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.59'  -
2084              '2.latest')
2085
2086       --changes-before <changes_before>
2087              List only migrations changed earlier or equal to a certain point
2088              of time. The provided time should be an ISO 8061 formatted time.
2089              e.g.  2016-03-04T06:27:59Z . (Supported by API versions '2.66' -
2090              '2.latest')
2091
2092       --project-id <project_id>
2093              Filter the migrations by the given project  ID.   (Supported  by
2094              API versions '2.80' - '2.latest')
2095
2096       --user-id <user_id>
2097              Filter  the  migrations by the given user ID.  (Supported by API
2098              versions '2.80' - '2.latest')
2099
2100   nova pause
2101          usage: nova pause <server>
2102
2103       Pause a server.
2104
2105       Positional arguments:
2106
2107       <server>
2108              Name or ID of server.
2109
2110   nova quota-class-show
2111          usage: nova quota-class-show <class>
2112
2113       List the quotas for a quota class.
2114
2115       Positional arguments:
2116
2117       <class>
2118              Name of quota class to list the quotas for.
2119
2120   nova quota-class-update
2121          usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
2122                                         [--ram <ram>]
2123                                         [--metadata-items <metadata-items>]
2124                                         [--key-pairs <key-pairs>]
2125                                         [--server-groups <server-groups>]
2126                                         [--server-group-members <server-group-members>]
2127                                         <class>
2128
2129       Update the quotas for a quota class. (Supported by API versions '2.0' -
2130       '2.latest')  [hint:  use  '--os-compute-api-version'  flag to show help
2131       message for proper version]
2132
2133       Positional arguments:
2134
2135       <class>
2136              Name of quota class to set the quotas for.
2137
2138       Optional arguments:
2139
2140       --instances <instances>
2141              New value for the "instances" quota.
2142
2143       --cores <cores>
2144              New value for the "cores" quota.
2145
2146       --ram <ram>
2147              New value for the "ram" quota.
2148
2149       --metadata-items <metadata-items>
2150              New value for the "metadata-items" quota.
2151
2152       --key-pairs <key-pairs>
2153              New value for the "key-pairs" quota.
2154
2155       --server-groups <server-groups>
2156              New value for the "server-groups" quota.
2157
2158       --server-group-members <server-group-members>
2159              New value for the "server-group-members" quota.
2160
2161   nova quota-defaults
2162          usage: nova quota-defaults [--tenant <tenant-id>]
2163
2164       List the default quotas for a tenant.
2165
2166       Optional arguments:
2167
2168       --tenant <tenant-id>
2169              ID of tenant to list the default quotas for.
2170
2171   nova quota-delete
2172          usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
2173
2174       Delete quota for a tenant/user so their quota will Revert back  to  de‐
2175       fault.
2176
2177       Optional arguments:
2178
2179       --tenant <tenant-id>
2180              ID of tenant to delete quota for.
2181
2182       --user <user-id>
2183              ID of user to delete quota for.
2184
2185   nova quota-show
2186          usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]
2187
2188       List the quotas for a tenant/user.
2189
2190       Optional arguments:
2191
2192       --tenant <tenant-id>
2193              ID of tenant to list the quotas for.
2194
2195       --user <user-id>
2196              ID of user to list the quotas for.
2197
2198       --detail
2199              Show detailed info (limit, reserved, in-use).
2200
2201   nova quota-update
2202          usage: nova quota-update [--user <user-id>] [--instances <instances>]
2203                                   [--cores <cores>] [--ram <ram>]
2204                                   [--metadata-items <metadata-items>]
2205                                   [--key-pairs <key-pairs>]
2206                                   [--server-groups <server-groups>]
2207                                   [--server-group-members <server-group-members>]
2208                                   [--force]
2209                                   <tenant-id>
2210
2211       Update the quotas for a tenant/user. (Supported by API versions '2.0' -
2212       '2.latest') [hint: use '--os-compute-api-version'  flag  to  show  help
2213       message for proper version]
2214
2215       Positional arguments:
2216
2217       <tenant-id>
2218              ID of tenant to set the quotas for.
2219
2220       Optional arguments:
2221
2222       --user <user-id>
2223              ID of user to set the quotas for.
2224
2225       --instances <instances>
2226              New value for the "instances" quota.
2227
2228       --cores <cores>
2229              New value for the "cores" quota.
2230
2231       --ram <ram>
2232              New value for the "ram" quota.
2233
2234       --metadata-items <metadata-items>
2235              New value for the "metadata-items" quota.
2236
2237       --key-pairs <key-pairs>
2238              New value for the "key-pairs" quota.
2239
2240       --server-groups <server-groups>
2241              New value for the "server-groups" quota.
2242
2243       --server-group-members <server-group-members>
2244              New value for the "server-group-members" quota.
2245
2246       --force
2247              Whether  force update the quota even if the already used and re‐
2248              served exceeds the new quota.
2249
2250   nova reboot
2251          usage: nova reboot [--hard] [--poll] <server> [<server> ...]
2252
2253       Reboot a server.
2254
2255       Positional arguments:
2256
2257       <server>
2258              Name or ID of server(s).
2259
2260       Optional arguments:
2261
2262       --hard Perform a hard reboot (instead of a soft one). Note: Ironic does
2263              not  currently  support  soft  reboot;  consequently, bare metal
2264              nodes will always do a hard reboot, regardless  of  the  use  of
2265              this option.
2266
2267       --poll Poll until reboot is complete.
2268
2269   nova rebuild
2270          usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
2271                              [--minimal] [--preserve-ephemeral] [--name <name>]
2272                              [--description <description>] [--meta <key=value>]
2273                              [--key-name <key-name>] [--key-unset]
2274                              [--user-data <user-data>] [--user-data-unset]
2275                              [--trusted-image-certificate-id <trusted-image-certificate-id>]
2276                              [--trusted-image-certificates-unset]
2277                              <server> <image>
2278
2279       Shutdown, re-image, and re-boot a server.
2280
2281       Positional arguments:
2282
2283       <server>
2284              Name or ID of server.
2285
2286       <image>
2287              Name or ID of new image.
2288
2289       Optional arguments:
2290
2291       --rebuild-password <rebuild-password>
2292              Set the provided admin password on the rebuilt server.
2293
2294       --poll Report the server rebuild progress until it completes.
2295
2296       --minimal
2297              Skips flavor/image lookups when showing servers.
2298
2299       --preserve-ephemeral
2300              Preserve the default ephemeral storage partition on rebuild.
2301
2302       --name <name>
2303              Name for the new server.
2304
2305       --description <description>
2306              New  description  for  the  server.  (Supported  by API versions
2307              '2.19' - '2.latest')
2308
2309       --meta <key=value>
2310              Record arbitrary key/value metadata to  /meta_data.json  on  the
2311              metadata server. Can be specified multiple times.
2312
2313       --key-name <key-name>
2314              Keypair  name to set in the server. Cannot be specified with the
2315              '--key-unset' option.   (Supported  by  API  versions  '2.54'  -
2316              '2.latest')
2317
2318       --key-unset
2319              Unset  keypair  in  the  server.  Cannot  be  specified with the
2320              '--key-name'  option.   (Supported  by  API  versions  '2.54'  -
2321              '2.latest')
2322
2323       --user-data <user-data>
2324              User  data  file  to  pass to be exposed by the metadata server.
2325              (Supported by API versions '2.57' - '2.latest')
2326
2327       --user-data-unset
2328              Unset user_data in the server.  Cannot  be  specified  with  the
2329              '--user-data'  option.   (Supported  by  API  versions  '2.57' -
2330              '2.latest')
2331
2332       --trusted-image-certificate-id <trusted-image-certificate-id>
2333              Trusted image certificate IDs used to validate certificates dur‐
2334              ing  the  image  signature  verification  process.   Defaults to
2335              env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS].  May be specified  multi‐
2336              ple  times to pass multiple trusted image certificate IDs. (Sup‐
2337              ported by API versions '2.63' - '2.latest')
2338
2339       --trusted-image-certificates-unset
2340              Unset trusted_image_certificates in the server. Cannot be speci‐
2341              fied with the --trusted-image-certificate-id option.  (Supported
2342              by API versions '2.63' - '2.latest')
2343
2344   nova refresh-network
2345          usage: nova refresh-network <server>
2346
2347       Refresh server network information.
2348
2349       Positional arguments:
2350
2351       <server>
2352              Name or ID of a server for which the network cache should be re‐
2353              freshed from neutron (Admin only).
2354
2355   nova remove-secgroup
2356          usage: nova remove-secgroup <server> <secgroup>
2357
2358       Remove a Security Group from a server.
2359
2360       Positional arguments:
2361
2362       <server>
2363              Name or ID of server.
2364
2365       <secgroup>
2366              Name of Security Group.
2367
2368   nova rescue
2369          usage: nova rescue [--password <password>] [--image <image>] <server>
2370
2371       Reboots a server into rescue mode, which starts the machine from either
2372       the initial image or a specified image, attaching the current boot disk
2373       as secondary.
2374
2375       Positional arguments:
2376
2377       <server>
2378              Name or ID of server.
2379
2380       Optional arguments:
2381
2382       --password <password>
2383              The admin password to be set in the rescue environment.
2384
2385       --image <image>
2386              The image to rescue with.
2387
2388   nova reset-network
2389          usage: nova reset-network <server>
2390
2391       Reset network of a server.
2392
2393       Positional arguments:
2394
2395       <server>
2396              Name or ID of server.
2397
2398   nova reset-state
2399          usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]
2400
2401       Reset the state of a server.
2402
2403       Positional arguments:
2404
2405       <server>
2406              Name or ID of server(s).
2407
2408       Optional arguments:
2409
2410       --all-tenants
2411              Reset state server(s) in another tenant by name (Admin only).
2412
2413       --active
2414              Request the server be reset to "active" state instead of "error"
2415              state (the default).
2416
2417   nova resize
2418          usage: nova resize [--poll] <server> <flavor>
2419
2420       Resize a server.
2421
2422       Positional arguments:
2423
2424       <server>
2425              Name or ID of server.
2426
2427       <flavor>
2428              Name or ID of new flavor.
2429
2430       Optional arguments:
2431
2432       --poll Report the server resize progress until it completes.
2433
2434   nova resize-confirm
2435          usage: nova resize-confirm <server>
2436
2437       Confirm a previous resize.
2438
2439       Positional arguments:
2440
2441       <server>
2442              Name or ID of server.
2443
2444   nova resize-revert
2445          usage: nova resize-revert <server>
2446
2447       Revert a previous resize (and return to the previous VM).
2448
2449       Positional arguments:
2450
2451       <server>
2452              Name or ID of server.
2453
2454   nova restore
2455          usage: nova restore <server>
2456
2457       Restore a soft-deleted server.
2458
2459       Positional arguments:
2460
2461       <server>
2462              Name or ID of server.
2463
2464   nova resume
2465          usage: nova resume <server>
2466
2467       Resume a server.
2468
2469       Positional arguments:
2470
2471       <server>
2472              Name or ID of server.
2473
2474   nova server-group-create
2475          usage: nova server-group-create [--rules <key=value>] <name> <policy>
2476
2477       Create a new server group with the specified details.
2478
2479       Positional arguments:
2480
2481       <name> Server group name.
2482
2483       <policy>
2484              Policy for the server groups.
2485
2486       Optional arguments:
2487
2488       --rule Policy rules for the server groups. (Supported by  API  versions
2489              '2.64'  -  '2.latest'). Currently, only the max_server_per_host
2490              rule  is   supported   for   the   anti-affinity   policy.   The
2491              max_server_per_host  rule  allows specifying how many members of
2492              the anti-affinity group can reside on the same compute host.  If
2493              not specified, only one member from the same anti-affinity group
2494              can reside on a given host.
2495
2496   nova server-group-delete
2497          usage: nova server-group-delete <id> [<id> ...]
2498
2499       Delete specific server group(s).
2500
2501       Positional arguments:
2502
2503       <id>   Unique ID(s) of the server group to delete.
2504
2505   nova server-group-get
2506          usage: nova server-group-get <id>
2507
2508       Get a specific server group.
2509
2510       Positional arguments:
2511
2512       <id>   Unique ID of the server group to get.
2513
2514   nova server-group-list
2515          usage: nova server-group-list [--limit <limit>] [--offset <offset>]
2516                                        [--all-projects]
2517
2518       Print a list of all server groups.
2519
2520       Optional arguments:
2521
2522       --limit <limit>
2523              Maximum number of server groups to display. If limit  is  bigger
2524              than    'CONF.api.max_limit'   option   of   Nova   API,   limit
2525              'CONF.api.max_limit' will be used instead.
2526
2527       --offset <offset>
2528              The offset of groups list to display; use with limit to return a
2529              slice of server groups.
2530
2531       --all-projects
2532              Display server groups from all projects (Admin only).
2533
2534   nova server-migration-list
2535          usage: nova server-migration-list <server>
2536
2537       Get the migrations list of specified server. (Supported by API versions
2538       '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2539       help message for proper version]
2540
2541       New in version 3.3.0.
2542
2543
2544       Positional arguments:
2545
2546       <server>
2547              Name or ID of server.
2548
2549   nova server-migration-show
2550          usage: nova server-migration-show <server> <migration>
2551
2552       Get  the  migration  of  specified  server.  (Supported by API versions
2553       '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2554       help message for proper version]
2555
2556       New in version 3.3.0.
2557
2558
2559       Positional arguments:
2560
2561       <server>
2562              Name or ID of server.
2563
2564       <migration>
2565              ID of migration.
2566
2567   nova server-tag-add
2568          usage: nova server-tag-add <server> <tag> [<tag> ...]
2569
2570       Add  one  or more tags to a server. (Supported by API versions '2.26' -
2571       '2.latest') [hint: use '--os-compute-api-version'  flag  to  show  help
2572       message for proper version]
2573
2574       New in version 4.1.0.
2575
2576
2577       Positional arguments:
2578
2579       <server>
2580              Name or ID of server.
2581
2582       <tag>  Tag(s) to add.
2583
2584   nova server-tag-delete
2585          usage: nova server-tag-delete <server> <tag> [<tag> ...]
2586
2587       Delete  one  or  more  tags  from  a server. (Supported by API versions
2588       '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2589       help message for proper version]
2590
2591       New in version 4.1.0.
2592
2593
2594       Positional arguments:
2595
2596       <server>
2597              Name or ID of server.
2598
2599       <tag>  Tag(s) to delete.
2600
2601   nova server-tag-delete-all
2602          usage: nova server-tag-delete-all <server>
2603
2604       Delete  all  tags  from  a  server. (Supported by API versions '2.26' -
2605       '2.latest') [hint: use '--os-compute-api-version'  flag  to  show  help
2606       message for proper version]
2607
2608       New in version 4.1.0.
2609
2610
2611       Positional arguments:
2612
2613       <server>
2614              Name or ID of server.
2615
2616   nova server-tag-list
2617          usage: nova server-tag-list <server>
2618
2619       Get  list  of  tags  from a server. (Supported by API versions '2.26' -
2620       '2.latest') [hint: use '--os-compute-api-version'  flag  to  show  help
2621       message for proper version]
2622
2623       New in version 4.1.0.
2624
2625
2626       Positional arguments:
2627
2628       <server>
2629              Name or ID of server.
2630
2631   nova server-tag-set
2632          usage: nova server-tag-set <server> <tags> [<tags> ...]
2633
2634       Set  list  of  tags  to  a  server. (Supported by API versions '2.26' -
2635       '2.latest') [hint: use '--os-compute-api-version'  flag  to  show  help
2636       message for proper version]
2637
2638       New in version 4.1.0.
2639
2640
2641       Positional arguments:
2642
2643       <server>
2644              Name or ID of server.
2645
2646       <tags> Tag(s) to set.
2647
2648   nova server-topology
2649          usage: nova server-topology <server>
2650
2651       Retrieve  server  NUMA  topology  information. Host specific fields are
2652       only visible to users with the administrative role.  (Supported by  API
2653       versions '2.78' - '2.latest')
2654
2655       New in version 15.1.0.
2656
2657
2658       Positional arguments:
2659
2660       <server>
2661              Name or ID of server.
2662
2663   nova service-delete
2664          usage: nova service-delete <id>
2665
2666       Delete the service.
2667
2668       IMPORTANT:
2669          If  deleting  a  nova-compute  service,  be  sure to stop the actual
2670          nova-compute process on the physical host before deleting  the  ser‐
2671          vice  with  this  command.  Failing to do so can lead to the running
2672          service re-creating orphaned  compute_nodes  table  records  in  the
2673          database.
2674
2675       Positional arguments:
2676
2677       <id>   ID  of  service  as  a UUID. (Supported by API versions '2.53' -
2678              '2.latest')
2679
2680   nova service-disable
2681          usage: nova service-disable [--reason <reason>] <id>
2682
2683       Disable the service.
2684
2685       Positional arguments:
2686
2687       <id>   ID of the service as a UUID. (Supported by API versions '2.53' -
2688              '2.latest')
2689
2690       Optional arguments:
2691
2692       --reason <reason>
2693              Reason for disabling the service.
2694
2695   nova service-enable
2696          usage: nova service-enable <id>
2697
2698       Enable the service.
2699
2700       Positional arguments:
2701
2702       <id>   ID of the service as a UUID. (Supported by API versions '2.53' -
2703              '2.latest')
2704
2705   nova service-force-down
2706          usage: nova service-force-down [--unset] <id>
2707
2708       Force service to down. (Supported by API versions '2.11' -  '2.latest')
2709       [hint:  use  '--os-compute-api-version'  flag  to show help message for
2710       proper version]
2711
2712       New in version 2.27.0.
2713
2714
2715       Positional arguments:
2716
2717       <id>   ID of the service as a UUID. (Supported by API versions '2.53' -
2718              '2.latest')
2719
2720       Optional arguments:
2721
2722       --unset
2723              Unset the forced_down state of the service.
2724
2725   nova service-list
2726          usage: nova service-list [--host <hostname>] [--binary <binary>]
2727
2728       Show a list of all running services. Filter by host & binary.
2729
2730       Note  that  from microversion 2.69, during partial infrastructure fail‐
2731       ures in the deployment, the output of this command may  return  partial
2732       results for the services present in the failure domain.
2733
2734       Optional arguments:
2735
2736       --host <hostname>
2737              Name of host.
2738
2739       --binary <binary>
2740              Service binary.
2741
2742   nova set-password
2743          usage: nova set-password <server>
2744
2745       Change the admin password for a server.
2746
2747       Positional arguments:
2748
2749       <server>
2750              Name or ID of server.
2751
2752   nova shelve
2753          usage: nova shelve <server>
2754
2755       Shelve a server.
2756
2757       Positional arguments:
2758
2759       <server>
2760              Name or ID of server.
2761
2762   nova shelve-offload
2763          usage: nova shelve-offload <server>
2764
2765       Remove a shelved server from the compute node.
2766
2767       Positional arguments:
2768
2769       <server>
2770              Name or ID of server.
2771
2772   nova show
2773          usage: nova show [--minimal] [--wrap <integer>] <server>
2774
2775       Show details about the given server.
2776
2777       Note  that  from microversion 2.69, during partial infrastructure fail‐
2778       ures in the deployment, the output of this command may  return  partial
2779       results for the server if it exists in the failure domain.
2780
2781       Positional arguments:
2782
2783       <server>
2784              Name or ID of server.
2785
2786       Optional arguments:
2787
2788       --minimal
2789              Skips flavor/image lookups when showing servers.
2790
2791       --wrap <integer>
2792              Wrap the output to a specified length, or 0 to disable.
2793
2794   nova ssh
2795          usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE]
2796                          [--network <network>] [--ipv6] [--login <login>] [-i IDENTITY]
2797                          [--extra-opts EXTRA]
2798                          <server>
2799
2800       SSH into a server.
2801
2802       Positional arguments:
2803
2804       <server>
2805              Name or ID of server.
2806
2807       Optional arguments:
2808
2809       --port PORT
2810              Optional  flag  to  indicate  which  port  to  use for ssh. (De‐
2811              fault=22)
2812
2813       --address-type ADDRESS_TYPE
2814              Optional flag to indicate which IP type to use. Possible  values
2815              includes fixed and floating (the Default).
2816
2817       --network <network>
2818              Network to use for the ssh.
2819
2820       --ipv6 Optional  flag  to  indicate  whether to use an IPv6 address at‐
2821              tached to a server. (Defaults to IPv4 address)
2822
2823       --login <login>
2824              Login to use.
2825
2826       -i IDENTITY, --identity IDENTITY
2827              Private key file, same as the -i option to the ssh command.
2828
2829       --extra-opts EXTRA
2830              Extra options to pass to ssh. see: man ssh.
2831
2832   nova start
2833          usage: nova start [--all-tenants] <server> [<server> ...]
2834
2835       Start the server(s).
2836
2837       Positional arguments:
2838
2839       <server>
2840              Name or ID of server(s).
2841
2842       Optional arguments:
2843
2844       --all-tenants
2845              Start server(s) in another tenant by name (Admin only).
2846
2847   nova stop
2848          usage: nova stop [--all-tenants] <server> [<server> ...]
2849
2850       Stop the server(s).
2851
2852       Positional arguments:
2853
2854       <server>
2855              Name or ID of server(s).
2856
2857       Optional arguments:
2858
2859       --all-tenants
2860              Stop server(s) in another tenant by name (Admin only).
2861
2862   nova suspend
2863          usage: nova suspend <server>
2864
2865       Suspend a server.
2866
2867       Positional arguments:
2868
2869       <server>
2870              Name or ID of server.
2871
2872   nova trigger-crash-dump
2873          usage: nova trigger-crash-dump <server>
2874
2875       Trigger crash dump in an instance. (Supported by API versions '2.17'  -
2876       '2.latest')  [hint:  use  '--os-compute-api-version'  flag to show help
2877       message for proper version]
2878
2879       New in version 3.3.0.
2880
2881
2882       Positional arguments:
2883
2884       <server>
2885              Name or ID of server.
2886
2887   nova unlock
2888          usage: nova unlock <server>
2889
2890       Unlock a server.
2891
2892       Positional arguments:
2893
2894       <server>
2895              Name or ID of server.
2896
2897   nova unpause
2898          usage: nova unpause <server>
2899
2900       Unpause a server.
2901
2902       Positional arguments:
2903
2904       <server>
2905              Name or ID of server.
2906
2907   nova unrescue
2908          usage: nova unrescue <server>
2909
2910       Restart the server from normal boot disk again.
2911
2912       Positional arguments:
2913
2914       <server>
2915              Name or ID of server.
2916
2917   nova unshelve
2918          usage: nova unshelve [--availability-zone <availability_zone>] <server>
2919
2920       Unshelve a server.
2921
2922       Positional arguments:
2923
2924       <server>
2925              Name or ID of server.
2926
2927       Optional arguments:
2928
2929       --availability-zone <availability_zone>
2930              Name  of  the  availability  zone  in  which   to   unshelve   a
2931              SHELVED_OFFLOADED  server.  (Supported  by API versions '2.77' -
2932              '2.latest')
2933
2934   nova update
2935          usage: nova update [--name <name>] [--description <description>] <server>
2936
2937       Update the name or the description for a server.
2938
2939       Positional arguments:
2940
2941       <server>
2942              Name (old name) or ID of server.
2943
2944       Optional arguments:
2945
2946       --name <name>
2947              New name for the server.
2948
2949       --description <description>
2950              New description for the server. If it  equals  to  empty  string
2951              (i.g. ""), the server description will be removed. (Supported by
2952              API versions '2.19' - '2.latest')
2953
2954   nova usage
2955          usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
2956
2957       Show usage data for a single tenant.
2958
2959       Optional arguments:
2960
2961       --start <start>
2962              Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2963
2964       --end <end>
2965              Usage range end date, ex 2012-01-20. (default: tomorrow)
2966
2967       --tenant <tenant-id>
2968              UUID of tenant to get usage for.
2969
2970   nova usage-list
2971          usage: nova usage-list [--start <start>] [--end <end>]
2972
2973       List usage data for all tenants.
2974
2975       Optional arguments:
2976
2977       --start <start>
2978              Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2979
2980       --end <end>
2981              Usage range end date, ex 2012-01-20. (default: tomorrow)
2982
2983   nova version-list
2984          usage: nova version-list
2985
2986       List all API versions.
2987
2988   nova volume-attach
2989          usage: nova volume-attach [--delete-on-termination] [--tag <tag>]
2990                                    <server> <volume> [<device>]
2991
2992       Attach a volume to a server.
2993
2994       Positional arguments:
2995
2996       <server>
2997              Name or ID of server.
2998
2999       <volume>
3000              ID of the volume to attach.
3001
3002       <device>
3003              Name of the device e.g. /dev/vdb. Use "auto" for autoassign  (if
3004              supported). Libvirt driver will use default device name.
3005
3006       Optional arguments:
3007
3008       --tag <tag>
3009              Tag for the attached volume. (Supported by API versions '2.49' -
3010              '2.latest')
3011
3012       --delete-on-termination
3013              Specify if the attached volume should be deleted when the server
3014              is destroyed. By default the attached volume is not deleted when
3015              the server is destroyed. (Supported by  API  versions  '2.79'  -
3016              '2.latest')
3017
3018   nova volume-attachments
3019          usage: nova volume-attachments <server>
3020
3021       List all the volumes attached to a server.
3022
3023       Positional arguments:
3024
3025       <server>
3026              Name or ID of server.
3027
3028   nova volume-detach
3029          usage: nova volume-detach <server> <volume>
3030
3031       Detach a volume from a server.
3032
3033       Positional arguments:
3034
3035       <server>
3036              Name or ID of server.
3037
3038       <volume>
3039              ID of the volume to detach.
3040
3041   nova volume-update
3042          usage: nova volume-update [--[no-]delete-on-termination]
3043                                    <server> <src_volume> <dest_volume>
3044
3045       Update the attachment on the server. Migrates the data from an attached
3046       volume to the specified available volume and swaps out the  active  at‐
3047       tachment to the new volume.
3048
3049       Positional arguments:
3050
3051       <server>
3052              Name or ID of server.
3053
3054       <src_volume>
3055              ID of the source (original) volume.
3056
3057       <dest_volume>
3058              ID of the destination volume.
3059
3060       Optional arguments:
3061
3062       --delete-on-termination
3063              Specify that the volume should be deleted when the server is de‐
3064              stroyed.  It is mutually exclusive with '--no-delete-on-termina‐
3065              tion'.  (Supported by API versions '2.85' - '2.latest')
3066
3067       --no-delete-on-termination
3068              Specify  that the attached volume should not be deleted when the
3069              server   is   destroyed.   It   is   mutually   exclusive   with
3070              '--delete-on-termination'.   (Supported by API versions '2.85' -
3071              '2.latest')
3072
3073   nova bash-completion
3074          usage: nova bash-completion
3075
3076       Prints  all  of  the  commands  and  options  to  stdout  so  that  the
3077       nova.bash_completion script doesn't have to hard code them.
3078

AUTHOR

3080       OpenStack Contributors
3081
3083       OpenStack Contributors
3084
3085
3086
3087
308817.4.0                           Jan 21, 2022                          NOVA(1)
Impressum