1NOVA(1) python-novaclient NOVA(1)
2
6 nova - OpenStack Nova command line client
7 The nova client is the command-line interface (CLI) for the Compute
9 service (nova) API and its extensions.
10 For help on a specific nova command, enter:
12 $ nova help COMMAND
14 Deprecated since version 17.8.0: The nova CLI has been deprecated in
16 favour of the unified openstack CLI. For information on using the open‐
17 stack CLI, see OpenStackClient.
18
21 usage: nova [--version] [--debug] [--os-cache] [--timings]
22 [--os-region-name <region-name>] [--service-type <service-type>]
23 [--service-name <service-name>]
24 [--os-endpoint-type <endpoint-type>]
25 [--os-compute-api-version <compute-api-ver>]
26 [--os-endpoint-override <bypass-url>] [--profile HMAC_KEY]
27 [--insecure] [--os-cacert <ca-certificate>]
28 [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
29 [--collect-timing] [--os-auth-type <name>]
30 [--os-auth-url OS_AUTH_URL] [--os-system-scope OS_SYSTEM_SCOPE]
31 [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME]
32 [--os-project-id OS_PROJECT_ID]
33 [--os-project-name OS_PROJECT_NAME]
34 [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
35 [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
36 [--os-trust-id OS_TRUST_ID]
37 [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
38 [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
39 [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
40 [--os-user-domain-id OS_USER_DOMAIN_ID]
41 [--os-user-domain-name OS_USER_DOMAIN_NAME]
42 [--os-password OS_PASSWORD]
43 <subcommand> ...
44 Subcommands:
46 add-fixed-ip
48 DEPRECATED Add new IP address on a network to server.
49 add-secgroup
51 Add a Security Group to a server.
52 agent-create
54 Create new agent build.
55 agent-delete
57 Delete existing agent build.
58 agent-list
60 List all builds.
61 agent-modify
63 Modify existing agent build.
64 aggregate-add-host
66 Add the host to the specified aggregate.
67 aggregate-cache-images
69 Request images be pre-cached on hosts within an aggregate.
70 (Supported by API versions '2.81' - '2.latest')
71 aggregate-create
73 Create a new aggregate with the specified details.
74 aggregate-delete
76 Delete the aggregate.
77 aggregate-list
79 Print a list of all aggregates.
80 aggregate-remove-host
82 Remove the specified host from the specified aggregate.
83 aggregate-set-metadata
85 Update the metadata associated with the aggregate.
86 aggregate-show
88 Show details of the specified aggregate.
89 aggregate-update
91 Update the aggregate's name and optionally availability zone.
92 availability-zone-list
94 List all the availability zones.
95 backup Backup a server by creating a 'backup' type snapshot.
97 boot Boot a new server.
99 clear-password
101 Clear the admin password for a server from the metadata server.
102 This action does not actually change the instance server pass‐
103 word.
104 cloudpipe-configure
106 DEPRECATED Update the VPN IP/port of a cloudpipe instance.
107 cloudpipe-create
109 DEPRECATED Create a cloudpipe instance for the given project.
110 cloudpipe-list
112 DEPRECATED Print a list of all cloudpipe instances.
113 console-log
115 Get console log output of a server.
116 delete Immediately shut down and delete specified server(s).
118 diagnostics
120 Retrieve server diagnostics.
121 evacuate
123 Evacuate server from failed host.
124 flavor-access-add
126 Add flavor access for the given tenant.
127 flavor-access-list
129 Print access information about the given flavor.
130 flavor-access-remove
132 Remove flavor access for the given tenant.
133 flavor-create
135 Create a new flavor.
136 flavor-delete
138 Delete a specific flavor
139 flavor-key
141 Set or unset extra_spec for a flavor.
142 flavor-list
144 Print a list of available 'flavors' (sizes of servers).
145 flavor-show
147 Show details about the given flavor.
148 flavor-update
150 Update the description of an existing flavor. (Supported by API
151 versions '2.55' - '2.latest') [hint: use '--os-compute-api-ver‐
152 sion' flag to show help message for proper version]
153 floating-ip-associate
155 DEPRECATED Associate a floating IP address to a server.
156 floating-ip-disassociate
158 DEPRECATED Disassociate a floating IP address from a server.
159 force-delete
161 Force delete a server.
162 get-mks-console
164 Get an MKS console to a server. (Supported by API versions '2.8'
165 - '2.latest') [hint: use '--os-compute-api-version' flag to show
166 help message for proper version]
167 get-password
169 Get the admin password for a server. This operation calls the
170 metadata service to query metadata information and does not read
171 password information from the server itself.
172 get-rdp-console
174 Get a rdp console to a server.
175 get-serial-console
177 Get a serial console to a server.
178 get-spice-console
180 Get a spice console to a server.
181 get-vnc-console
183 Get a vnc console to a server.
184 host-action
186 DEPRECATED Perform a power action on a host.
187 host-describe
189 DEPRECATED Describe a specific host.
190 host-evacuate
192 Evacuate all instances from failed host.
193 host-evacuate-live
195 Live migrate all instances off the specified host to other
196 available hosts.
197 host-list
199 DEPRECATED List all hosts by service.
200 host-meta
202 Set or Delete metadata on all instances of a host.
203 host-servers-migrate
205 Cold migrate all instances off the specified host to other
206 available hosts.
207 host-update
209 DEPRECATED Update host settings.
210 hypervisor-list
212 List hypervisors. (Supported by API versions '2.0' - '2.latest')
213 [hint: use '--os-compute-api-version' flag to show help message
214 for proper version]
215 hypervisor-servers
217 List servers belonging to specific hypervisors.
218 hypervisor-show
220 Display the details of the specified hypervisor.
221 hypervisor-stats
223 Get hypervisor statistics over all compute nodes.
224 hypervisor-uptime
226 Display the uptime of the specified hypervisor.
227 image-create
229 Create a new image by taking a snapshot of a running server.
230 instance-action
232 Show an action.
233 instance-action-list
235 List actions on a server.
236 instance-usage-audit-log
238 List/Get server usage audits.
239 interface-attach
241 Attach a network interface to a server.
242 interface-detach
244 Detach a network interface from a server.
245 interface-list
247 List interfaces attached to a server.
248 keypair-add
250 Create a new key pair for use with servers.
251 keypair-delete
253 Delete keypair given by its name. (Supported by API versions
254 '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag
255 to show help message for proper version]
256 keypair-list
258 Print a list of keypairs for a user (Supported by API versions
259 '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag
260 to show help message for proper version]
261 keypair-show
263 Show details about the given keypair. (Supported by API ver‐
264 sions '2.0' - '2.latest') [hint: use '--os-compute-api-version'
265 flag to show help message for proper version]
266 limits Print rate and absolute limits.
268 list List servers.
270 list-secgroup
272 List Security Group(s) of a server.
273 live-migration
275 Migrate running server to a new machine.
276 live-migration-abort
278 Abort an on-going live migration. (Supported by API versions
279 '2.24' - '2.latest') [hint: use '--os-compute-api-version' flag
280 to show help message for proper version]
281 live-migration-force-complete
283 Force on-going live migration to complete. (Supported by API
284 versions '2.22' - '2.latest') [hint: use '--os-compute-api-ver‐
285 sion' flag to show help message for proper version]
286 lock Lock a server. A normal (non-admin) user will not be able to ex‐
288 ecute actions on a locked server.
289 meta Set or delete metadata on a server.
291 migrate
293 Migrate a server. The new host will be selected by the sched‐
294 uler.
295 migration-list
297 Print a list of migrations.
298 pause Pause a server.
300 quota-class-show
302 List the quotas for a quota class.
303 quota-class-update
305 Update the quotas for a quota class. (Supported by API versions
306 '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag
307 to show help message for proper version]
308 quota-defaults
310 List the default quotas for a tenant.
311 quota-delete
313 Delete quota for a tenant/user so their quota will Revert back
314 to default.
315 quota-show
317 List the quotas for a tenant/user.
318 quota-update
320 Update the quotas for a tenant/user. (Supported by API versions
321 '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag
322 to show help message for proper version]
323 reboot Reboot a server.
325 rebuild
327 Shutdown, re-image, and re-boot a server.
328 refresh-network
330 Refresh server network information.
331 remove-fixed-ip
333 DEPRECATED Remove an IP address from a server.
334 remove-secgroup
336 Remove a Security Group from a server.
337 rescue Reboots a server into rescue mode, which starts the machine from
339 either the initial image or a specified image, attaching the
340 current boot disk as secondary.
341 reset-network
343 Reset network of a server.
344 reset-state
346 Reset the state of a server.
347 resize Resize a server.
349 resize-confirm
351 Confirm a previous resize.
352 resize-revert
354 Revert a previous resize (and return to the previous VM).
355 restore
357 Restore a soft-deleted server.
358 resume Resume a server.
360 server-group-create
362 Create a new server group with the specified details.
363 server-group-delete
365 Delete specific server group(s).
366 server-group-get
368 Get a specific server group.
369 server-group-list
371 Print a list of all server groups.
372 server-migration-list
374 Get the migrations list of specified server. (Supported by API
375 versions '2.23' - '2.latest') [hint: use '--os-compute-api-ver‐
376 sion' flag to show help message for proper version]
377 server-migration-show
379 Get the migration of specified server. (Supported by API ver‐
380 sions '2.23' - '2.latest') [hint: use '--os-compute-api-version'
381 flag to show help message for proper version]
382 server-tag-add
384 Add one or more tags to a server. (Supported by API versions
385 '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag
386 to show help message for proper version]
387 server-tag-delete
389 Delete one or more tags from a server. (Supported by API ver‐
390 sions '2.26' - '2.latest') [hint: use '--os-compute-api-version'
391 flag to show help message for proper version]
392 server-tag-delete-all
394 Delete all tags from a server. (Supported by API versions '2.26'
395 - '2.latest') [hint: use '--os-compute-api-version' flag to show
396 help message for proper version]
397 server-tag-list
399 Get list of tags from a server. (Supported by API versions
400 '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag
401 to show help message for proper version]
402 server-tag-set
404 Set list of tags to a server. (Supported by API versions '2.26'
405 - '2.latest') [hint: use '--os-compute-api-version' flag to show
406 help message for proper version]
407 server-topology
409 Retrieve NUMA topology of the given server. (Supported by API
410 versions '2.78' - '2.latest')
411 service-delete
413 Delete the service.
414 service-disable
416 Disable the service.
417 service-enable
419 Enable the service.
420 service-force-down
422 Force service to down. (Supported by API versions '2.11' -
423 '2.latest') [hint: use '--os-compute-api-version' flag to show
424 help message for proper version]
425 service-list
427 Show a list of all running services. Filter by host & binary.
428 set-password
430 Change the admin password for a server.
431 shelve Shelve a server.
433 shelve-offload
435 Remove a shelved server from the compute node.
436 show Show details about the given server.
438 ssh SSH into a server.
440 start Start the server(s).
442 stop Stop the server(s).
444 suspend
446 Suspend a server.
447 trigger-crash-dump
449 Trigger crash dump in an instance. (Supported by API versions
450 '2.17' - '2.latest') [hint: use '--os-compute-api-version' flag
451 to show help message for proper version]
452 unlock Unlock a server.
454 unpause
456 Unpause a server.
457 unrescue
459 Restart the server from normal boot disk again.
460 unshelve
462 Unshelve a server.
463 update Update the name or the description for a server.
465 usage Show usage data for a single tenant.
467 usage-list
469 List usage data for all tenants.
470 version-list
472 List all API versions.
473 virtual-interface-list
475 DEPRECATED Show virtual interface info about the given server.
476 volume-attach
478 Attach a volume to a server.
479 volume-attachments
481 List all the volumes attached to a server.
482 volume-detach
484 Detach a volume from a server.
485 volume-update
487 Update the attachment on the server. Migrates the data from an
488 attached volume to the specified available volume and swaps out
489 the active attachment to the new volume. Since microversion
490 2.85, support for updating the delete_on_termination delete
491 flag, which allows changing the behavior of volume deletion on
492 instance deletion.
493 x509-create-cert
495 DEPRECATED Create x509 cert for a user in tenant.
496 x509-get-root-cert
498 DEPRECATED Fetch the x509 root cert.
499 bash-completion
501 Prints all of the commands and options to stdout so that the
502 nova.bash_completion script doesn't have to hard code them.
503 help Display help about this program or one of its subcommands.
505
507 --version
508 show program's version number and exit
509 --debug
511 Print debugging output.
512 --os-cache
514 Use the auth token cache. Defaults to False if env[OS_CACHE] is
515 not set.
516 --timings
518 Print call timing info.
519 --os-region-name <region-name>
521 Defaults to env[OS_REGION_NAME].
522 --service-type <service-type>
524 Defaults to compute for most actions.
525 --service-name <service-name>
527 Defaults to env[NOVA_SERVICE_NAME].
528 --os-endpoint-type <endpoint-type>
530 Defaults to env[NOVA_ENDPOINT_TYPE], env[OS_ENDPOINT_TYPE] or
531 publicURL.
532 --os-compute-api-version <compute-api-ver>
534 Accepts X, X.Y (where X is major and Y is minor part) or "X.lat‐
535 est", defaults to env[OS_COMPUTE_API_VERSION].
536 --os-endpoint-override <bypass-url>
538 Use this API endpoint instead of the Service Catalog. Defaults
539 to env[OS_ENDPOINT_OVERRIDE].
540 --profile HMAC_KEY
542 HMAC key to use for encrypting context data for performance pro‐
543 filing of operation. This key should be the value of the HMAC
544 key configured for the OSprofiler middleware in nova; it is
545 specified in the Nova configuration file at
546 "/etc/nova/nova.conf". Without the key, profiling will not be
547 triggered even if OSprofiler is enabled on the server side.
548 --os-auth-type <name>, --os-auth-plugin <name>
550 Authentication type to use
551 nova add-secgroup
553 usage: nova add-secgroup <server> <secgroup>
554 Add a Security Group to a server.
556 Positional arguments:
558 <server>
560 Name or ID of server.
561 <secgroup>
563 Name or ID of Security Group.
564 nova agent-create
566 usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
567 <hypervisor>
568 Create new agent build.
570 Positional arguments:
572 <os> Type of OS.
574 <architecture>
576 Type of architecture.
577 <version>
579 Version.
580 <url> URL.
582 <md5hash>
584 MD5 hash.
585 <hypervisor>
587 Type of hypervisor.
588 nova agent-delete
590 usage: nova agent-delete <id>
591 Delete existing agent build.
593 Positional arguments:
595 <id> ID of the agent-build.
597 nova agent-list
599 usage: nova agent-list [--hypervisor <hypervisor>]
600 List all builds.
602 Optional arguments:
604 --hypervisor <hypervisor>
606 Type of hypervisor.
607 nova agent-modify
609 usage: nova agent-modify <id> <version> <url> <md5hash>
610 Modify existing agent build.
612 Positional arguments:
614 <id> ID of the agent-build.
616 <version>
618 Version.
619 <url> URL
621 <md5hash>
623 MD5 hash.
624 nova aggregate-add-host
626 usage: nova aggregate-add-host <aggregate> <host>
627 Add the host to the specified aggregate.
629 Positional arguments:
631 <aggregate>
633 Name or ID of aggregate.
634 <host> The host to add to the aggregate.
636 nova aggregate-cache-images
638 usage: nova aggregate-cache-images <aggregate> <image> [<image> ..]
639 Request image(s) be pre-cached on hosts within the aggregate. (Sup‐
641 ported by API versions '2.81' - '2.latest')
642 New in version 16.0.0.
644 Positional arguments:
647 <aggregate>
649 Name or ID of aggregate.
650 <image>
652 Name or ID of image(s) to cache.
653 nova aggregate-create
655 usage: nova aggregate-create <name> [<availability-zone>]
656 Create a new aggregate with the specified details.
658 Positional arguments:
660 <name> Name of aggregate.
662 <availability-zone>
664 The availability zone of the aggregate (optional).
665 nova aggregate-delete
667 usage: nova aggregate-delete <aggregate>
668 Delete the aggregate.
670 Positional arguments:
672 <aggregate>
674 Name or ID of aggregate to delete.
675 nova aggregate-list
677 usage: nova aggregate-list
678 Print a list of all aggregates.
680 nova aggregate-remove-host
682 usage: nova aggregate-remove-host <aggregate> <host>
683 Remove the specified host from the specified aggregate.
685 Positional arguments:
687 <aggregate>
689 Name or ID of aggregate.
690 <host> The host to remove from the aggregate.
692 nova aggregate-set-metadata
694 usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
695 Update the metadata associated with the aggregate.
697 Positional arguments:
699 <aggregate>
701 Name or ID of aggregate to update.
702 <key=value>
704 Metadata to add/update to aggregate. Specify only the key to
705 delete a metadata item.
706 nova aggregate-show
708 usage: nova aggregate-show <aggregate>
709 Show details of the specified aggregate.
711 Positional arguments:
713 <aggregate>
715 Name or ID of aggregate.
716 nova aggregate-update
718 usage: nova aggregate-update [--name NAME]
719 [--availability-zone <availability-zone>]
720 <aggregate>
721 Update the aggregate's name and optionally availability zone.
723 Positional arguments:
725 <aggregate>
727 Name or ID of aggregate to update.
728 Optional arguments:
730 --name NAME
732 New name for aggregate.
733 --availability-zone <availability-zone>
735 New availability zone for aggregate.
736 nova availability-zone-list
738 usage: nova availability-zone-list
739 List all the availability zones.
741 nova backup
743 usage: nova backup <server> <name> <backup-type> <rotation>
744 Backup a server by creating a 'backup' type snapshot.
746 Positional arguments:
748 <server>
750 Name or ID of server.
751 <name> Name of the backup image.
753 <backup-type>
755 The backup type, like "daily" or "weekly".
756 <rotation>
758 Int parameter representing how many backups to keep around.
759 nova boot
761 usage: nova boot [--flavor <flavor>] [--image <image>]
762 [--image-with <key=value>] [--boot-volume <volume_id>]
763 [--snapshot <snapshot_id>] [--min-count <number>]
764 [--max-count <number>] [--meta <key=value>]
765 [--key-name <key-name>] [--user-data <user-data>]
766 [--availability-zone <availability-zone>]
767 [--security-groups <security-groups>]
768 [--block-device-mapping <dev-name=mapping>]
769 [--block-device key1=value1[,key2=value2...]]
770 [--swap <swap_size>]
771 [--ephemeral size=<size>[,format=<format>]]
772 [--hint <key=value>]
773 [--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>]
774 [--config-drive <value>] [--poll] [--admin-pass <value>]
775 [--access-ip-v4 <value>] [--access-ip-v6 <value>]
776 [--description <description>] [--tags <tags>]
777 [--return-reservation-id]
778 [--trusted-image-certificate-id <trusted-image-certificate-id>]
779 [--host <host>]
780 [--hypervisor-hostname <hypervisor-hostname>]
781 [--hostname <hostname>]
782 <name>
783 Boot a new server.
785 In order to create a server with pre-existing ports that contain a re‐
787 source_request value, such as for guaranteed minimum bandwidth quality
788 of service support, microversion 2.72 is required.
789 Positional arguments:
791 <name> Name for the new server.
793 Optional arguments:
795 --flavor <flavor>
797 Name or ID of flavor (see 'nova flavor-list').
798 --image <image>
800 Name or ID of image (see 'glance image-list').
801 --image-with <key=value>
803 Image metadata property (see 'glance image-show').
804 --boot-volume <volume_id>
806 Volume ID to boot from.
807 --snapshot <snapshot_id>
809 Snapshot ID to boot from (will create a volume).
810 --min-count <number>
812 Boot at least <number> servers (limited by quota).
813 --max-count <number>
815 Boot up to <number> servers (limited by quota).
816 --meta <key=value>
818 Record arbitrary key/value metadata to /meta_data.json on the
819 metadata server. Can be specified multiple times.
820 --key-name <key-name>
822 Key name of keypair that should be created earlier with the com‐
823 mand keypair-add.
824 --user-data <user-data>
826 user data file to pass to be exposed by the metadata server.
827 --availability-zone <availability-zone>
829 The availability zone for server placement.
830 --security-groups <security-groups>
832 Comma separated list of security group names.
833 --block-device-mapping <dev-name=mapping>
835 Block device mapping in the format
836 <dev-name>=<id>:<type>:<size(GiB)>:<delete-on-terminate>.
837 --block-device
839 key1=value1[,key2=value2...] Block device mapping with the
840 keys: id=UUID (image_id, snapshot_id or volume_id only if using
841 source image, snapshot or volume) source=source type (image,
842 snapshot, volume or blank), dest=destination type of the block
843 device (volume or local), bus=device's bus (e.g. uml, lxc, vir‐
844 tio, ...; if omitted, hypervisor driver chooses a suitable de‐
845 fault, honoured only if device type is supplied) type=device
846 type (e.g. disk, cdrom, ...; defaults to 'disk') device=name of
847 the device (e.g. vda, xda, ...; if omitted, hypervisor driver
848 chooses suitable device depending on selected bus; note the lib‐
849 virt driver always uses default device names), size=size of the
850 block device in MiB(for swap) and in GiB(for other formats) (if
851 omitted, hypervisor driver calculates size), format=device will
852 be formatted (e.g. swap, ntfs, ...; optional), bootindex=integer
853 used for ordering the boot disks (for image backed instances it
854 is equal to 0, for others need to be specified), shutdown=shut‐
855 down behaviour (either preserve or remove, for local destination
856 set to remove), tag=device metadata tag (optional; supported by
857 API versions '2.42' - '2.latest'), and volume_type=type of vol‐
858 ume to create (either ID or name) when source is blank, image or
859 snapshot and dest is volume (optional; supported by API versions
860 '2.67' - '2.latest').
861 --swap <swap_size>
863 Create and attach a local swap block device of <swap_size> MiB.
864 --ephemeral
866 size=<size>[,format=<format>] Create and attach a local
867 ephemeral block device of <size> GiB and format it to <format>.
868 --hint <key=value>
870 Send arbitrary key/value pairs to the scheduler for custom use.
871 --nic <auto,none,net-id=net-uuid,net-name=net‐
873 work-name,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag>
874 Create a NIC on the server. Specify option multiple times to
875 create multiple nics unless using the special 'auto' or 'none'
876 values. auto: automatically allocate network resources if none
877 are available. This cannot be specified with any other nic value
878 and cannot be specified multiple times. none: do not attach a
879 NIC at all. This cannot be specified with any other nic value
880 and cannot be specified multiple times. net-id: attach NIC to
881 network with a specific UUID. net-name: attach NIC to network
882 with this name (either port-id or net-id or net-name must be
883 provided), v4-fixed-ip: IPv4 fixed address for NIC (optional),
884 v6-fixed-ip: IPv6 fixed address for NIC (optional), port-id: at‐
885 tach NIC to port with this UUID tag: interface metadata tag (op‐
886 tional) (either port-id or net-id must be provided). (Supported
887 by API versions '2.42' - '2.latest')
888 --config-drive <value>
890 Enable config drive. The value must be a boolean value.
891 --poll Report the new server boot progress until it completes.
893 --admin-pass <value>
895 Admin password for the instance.
896 --access-ip-v4 <value>
898 Alternative access IPv4 of the instance.
899 --access-ip-v6 <value>
901 Alternative access IPv6 of the instance.
902 --description <description>
904 Description for the server. (Supported by API versions '2.19' -
905 '2.latest')
906 --tags <tags>
908 Tags for the server.Tags must be separated by commas: --tags
909 <tag1,tag2> (Supported by API versions '2.52' - '2.latest')
910 --return-reservation-id
912 Return a reservation id bound to created servers.
913 --trusted-image-certificate-id <trusted-image-certificate-id>
915 Trusted image certificate IDs used to validate certificates dur‐
916 ing the image signature verification process. Defaults to
917 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
918 ple times to pass multiple trusted image certificate IDs. (Sup‐
919 ported by API versions '2.63' - '2.latest')
920 --host <host>
922 Requested host to create servers. Admin only by default. (Sup‐
923 ported by API versions '2.74' - '2.latest')
924 --hypervisor-hostname <hypervisor-hostname>
926 Requested hypervisor hostname to create servers. Admin only by
927 default. (Supported by API versions '2.74' - '2.latest')
928 --hostname <hostname>
930 Hostname for the instance. This sets the hostname stored in the
931 metadata server: a utility such as cloud-init running on the
932 guest is required to propagate these changes to the guest.
933 (Supported by API versions '2.90' - '2.latest')
934 nova clear-password
936 usage: nova clear-password <server>
937 Clear the admin password for a server from the metadata server. This
939 action does not actually change the instance server password.
940 Positional arguments:
942 <server>
944 Name or ID of server.
945 nova console-log
947 usage: nova console-log [--length <length>] <server>
948 Get console log output of a server.
950 Locale encoding issues
952 If you encounter an error such as:
954 UnicodeEncodeError: 'ascii' codec can't encode characters in position
956 The solution to these problems is different depending on which locale
958 your computer is running in.
959 For instance, if you have a German Linux machine, you can fix the prob‐
961 lem by exporting the locale to de_DE.utf-8:
962 export LC_ALL=de_DE.utf-8
964 export LANG=de_DE.utf-8
965 If you are on a US machine, en_US.utf-8 is the encoding of choice. On
967 some newer Linux systems, you could also try C.UTF-8 as the locale:
968 export LC_ALL=C.UTF-8
970 export LANG=C.UTF-8
971 Positional arguments:
973 <server>
975 Name or ID of server.
976 Optional arguments:
978 --length <length>
980 Length in lines to tail.
981 nova delete
983 usage: nova delete [--all-tenants] <server> [<server> ...]
984 Immediately shut down and delete specified server(s).
986 Positional arguments:
988 <server>
990 Name or ID of server(s).
991 Optional arguments:
993 --all-tenants
995 Delete server(s) in another tenant by name (Admin only).
996 nova diagnostics
998 usage: nova diagnostics <server>
999 Retrieve server diagnostics.
1001 Positional arguments:
1003 <server>
1005 Name or ID of server.
1006 nova evacuate
1008 usage: nova evacuate [--password <password>] [--on-shared-storage] [--force] <server> [<host>]
1009 Evacuate server from failed host.
1011 Positional arguments:
1013 <server>
1015 Name or ID of server.
1016 <host> Name or ID of the target host. If no host is specified, the
1018 scheduler will choose one.
1019 Optional arguments:
1021 --password <password>
1023 Set the provided admin password on the evacuated server. Not ap‐
1024 plicable if the server is on shared storage.
1025 --on-shared-storage
1027 Specifies whether server files are located on shared storage.
1028 (Supported by API versions '2.0' - '2.13')
1029 --force
1031 Force an evacuation by not verifying the provided destination
1032 host by the scheduler. (Supported by API versions '2.29' -
1033 '2.67')
1034 WARNING:
1036 This could result in failures to actually evacuate the server
1037 to the specified host. It is recommended to either not spec‐
1038 ify a host so that the scheduler will pick one, or specify a
1039 host without --force.
1040 nova flavor-access-add
1042 usage: nova flavor-access-add <flavor> <tenant_id>
1043 Add flavor access for the given tenant.
1045 Positional arguments:
1047 <flavor>
1049 Flavor name or ID to add access for the given tenant.
1050 <tenant_id>
1052 Tenant ID to add flavor access for.
1053 nova flavor-access-list
1055 usage: nova flavor-access-list [--flavor <flavor>]
1056 Print access information about the given flavor.
1058 Optional arguments:
1060 --flavor <flavor>
1062 Filter results by flavor name or ID.
1063 nova flavor-access-remove
1065 usage: nova flavor-access-remove <flavor> <tenant_id>
1066 Remove flavor access for the given tenant.
1068 Positional arguments:
1070 <flavor>
1072 Flavor name or ID to remove access for the given tenant.
1073 <tenant_id>
1075 Tenant ID to remove flavor access for.
1076 nova flavor-create
1078 usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
1079 [--rxtx-factor <factor>] [--is-public <is-public>]
1080 [--description <description>]
1081 <name> <id> <ram> <disk> <vcpus>
1082 Create a new flavor.
1084 Positional arguments:
1086 <name> Unique name of the new flavor.
1088 <id> Unique ID of the new flavor. Specifying 'auto' will generated a
1090 UUID for the ID.
1091 <ram> Memory size in MiB.
1093 <disk> Disk size in GiB.
1095 <vcpus>
1097 Number of vcpus
1098 Optional arguments:
1100 --ephemeral <ephemeral>
1102 Ephemeral space size in GiB (default 0).
1103 --swap <swap>
1105 Swap space size in MiB (default 0).
1106 --rxtx-factor <factor>
1108 RX/TX factor (default 1).
1109 --is-public <is-public>
1111 Make flavor accessible to the public (default true).
1112 --description <description>
1114 A free form description of the flavor. Limited to 65535 charac‐
1115 ters in length. Only printable characters are allowed. (Sup‐
1116 ported by API versions '2.55' - '2.latest')
1117 nova flavor-delete
1119 usage: nova flavor-delete <flavor>
1120 Delete a specific flavor
1122 Positional arguments:
1124 <flavor>
1126 Name or ID of the flavor to delete.
1127 nova flavor-key
1129 usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
1130 Set or unset extra_spec for a flavor.
1132 Positional arguments:
1134 <flavor>
1136 Name or ID of flavor.
1137 <action>
1139 Actions: 'set' or 'unset'.
1140 <key=value>
1142 Extra_specs to set/unset (only key is necessary on unset).
1143 nova flavor-list
1145 usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
1146 [--min-disk <min-disk>] [--min-ram <min-ram>]
1147 [--limit <limit>] [--sort-key <sort-key>]
1148 [--sort-dir <sort-dir>]
1149 Print a list of available 'flavors' (sizes of servers).
1151 Optional arguments:
1153 --extra-specs
1155 Get extra-specs of each flavor.
1156 --all Display all flavors (Admin only).
1158 --marker <marker>
1160 The last flavor ID of the previous page; displays list of fla‐
1161 vors after "marker".
1162 --min-disk <min-disk>
1164 Filters the flavors by a minimum disk space, in GiB.
1165 --min-ram <min-ram>
1167 Filters the flavors by a minimum RAM, in MiB.
1168 --limit <limit>
1170 Maximum number of flavors to display. If limit is bigger than
1171 'CONF.api.max_limit' option of Nova API, limit
1172 'CONF.api.max_limit' will be used instead.
1173 --sort-key <sort-key>
1175 Flavors list sort key.
1176 --sort-dir <sort-dir>
1178 Flavors list sort direction.
1179 nova flavor-show
1181 usage: nova flavor-show <flavor>
1182 Show details about the given flavor.
1184 Positional arguments:
1186 <flavor>
1188 Name or ID of flavor.
1189 nova flavor-update
1191 usage: nova flavor-update <flavor> <description>
1192 Update the description of an existing flavor. (Supported by API ver‐
1194 sions '2.55' - '2.latest') [hint: use '--os-compute-api-version' flag
1195 to show help message for proper version]
1196 New in version 10.0.0.
1198 Positional arguments
1201 <flavor>
1203 Name or ID of the flavor to update.
1204 <description>
1206 A free form description of the flavor. Limited to 65535 charac‐
1207 ters in length. Only printable characters are allowed.
1208 nova force-delete
1210 usage: nova force-delete <server>
1211 Force delete a server.
1213 Positional arguments:
1215 <server>
1217 Name or ID of server.
1218 nova get-mks-console
1220 usage: nova get-mks-console <server>
1221 Get an MKS console to a server. (Supported by API versions '2.8' -
1223 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1224 message for proper version]
1225 New in version 3.0.0.
1227 Positional arguments:
1230 <server>
1232 Name or ID of server.
1233 nova get-password
1235 usage: nova get-password <server> [<private-key>]
1236 Get the admin password for a server. This operation calls the metadata
1238 service to query metadata information and does not read password infor‐
1239 mation from the server itself.
1240 Positional arguments:
1242 <server>
1244 Name or ID of server.
1245 <private-key>
1247 Private key (used locally to decrypt password) (Optional). When
1248 specified, the command displays the clear (decrypted) VM pass‐
1249 word. When not specified, the ciphered VM password is displayed.
1250 nova get-rdp-console
1252 usage: nova get-rdp-console <server> <console-type>
1253 Get a rdp console to a server.
1255 Positional arguments:
1257 <server>
1259 Name or ID of server.
1260 <console-type>
1262 Type of rdp console ("rdp-html5").
1263 nova get-serial-console
1265 usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>
1266 Get a serial console to a server.
1268 Positional arguments:
1270 <server>
1272 Name or ID of server.
1273 Optional arguments:
1275 --console-type CONSOLE_TYPE
1277 Type of serial console, default="serial".
1278 nova get-spice-console
1280 usage: nova get-spice-console <server> <console-type>
1281 Get a spice console to a server.
1283 Positional arguments:
1285 <server>
1287 Name or ID of server.
1288 <console-type>
1290 Type of spice console ("spice-html5").
1291 nova get-vnc-console
1293 usage: nova get-vnc-console <server> <console-type>
1294 Get a vnc console to a server.
1296 Positional arguments:
1298 <server>
1300 Name or ID of server.
1301 <console-type>
1303 Type of vnc console ("novnc" or "xvpvnc").
1304 nova host-evacuate
1306 usage: nova host-evacuate [--target_host <target_host>] [--force] [--strict]
1307 <host>
1308 Evacuate all instances from failed host.
1310 Positional arguments:
1312 <host> The hypervisor hostname (or pattern) to search for.
1314 WARNING:
1316 Use a fully qualified domain name if you only want to evacu‐
1317 ate from a specific host.
1318 Optional arguments:
1320 --target_host <target_host>
1322 Name of target host. If no host is specified the scheduler will
1323 select a target.
1324 --force
1326 Force an evacuation by not verifying the provided destination
1327 host by the scheduler. (Supported by API versions '2.29' -
1328 '2.67')
1329 WARNING:
1331 This could result in failures to actually evacuate the server
1332 to the specified host. It is recommended to either not spec‐
1333 ify a host so that the scheduler will pick one, or specify a
1334 host without --force.
1335 --strict
1337 Evacuate host with exact hypervisor hostname match
1338 nova host-evacuate-live
1340 usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
1341 [--max-servers <max_servers>] [--force]
1342 [--strict]
1343 <host>
1344 Live migrate all instances off the specified host to other available
1346 hosts.
1347 Positional arguments:
1349 <host> Name of host. The hypervisor hostname (or pattern) to search
1351 for.
1352 WARNING:
1354 Use a fully qualified domain name if you only want to live
1355 migrate from a specific host.
1356 Optional arguments:
1358 --target-host <target_host>
1360 Name of target host. If no host is specified, the scheduler will
1361 choose one.
1362 --block-migrate
1364 Enable block migration. (Default=auto) (Supported by API ver‐
1365 sions '2.25' - '2.latest')
1366 --max-servers <max_servers>
1368 Maximum number of servers to live migrate simultaneously
1369 --force
1371 Force a live-migration by not verifying the provided destination
1372 host by the scheduler. (Supported by API versions '2.30' -
1373 '2.67')
1374 WARNING:
1376 This could result in failures to actually live migrate the
1377 servers to the specified host. It is recommended to either
1378 not specify a host so that the scheduler will pick one, or
1379 specify a host without --force.
1380 --strict
1382 live Evacuate host with exact hypervisor hostname match
1383 nova host-meta
1385 usage: nova host-meta [--strict] <host> <action> <key=value> [<key=value> ...]
1386 Set or Delete metadata on all instances of a host.
1388 Positional arguments:
1390 <host> The hypervisor hostname (or pattern) to search for.
1392 WARNING:
1394 Use a fully qualified domain name if you only want to update
1395 metadata for servers on a specific host.
1396 <action>
1398 Actions: 'set' or 'delete'
1399 <key=value>
1401 Metadata to set or delete (only key is necessary on delete)
1402 Optional arguments:
1404 --strict
1406 Set host-meta to the hypervisor with exact hostname match
1407 nova host-servers-migrate
1409 usage: nova host-servers-migrate [--strict] <host>
1410 Cold migrate all instances off the specified host to other available
1412 hosts.
1413 Positional arguments:
1415 <host> Name of host. The hypervisor hostname (or pattern) to search
1417 for.
1418 WARNING:
1420 Use a fully qualified domain name if you only want to cold
1421 migrate from a specific host.
1422 Optional arguments:
1424 --strict
1426 Migrate host with exact hypervisor hostname match
1427 nova hypervisor-list
1429 usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
1430 [--limit <limit>]
1431 List hypervisors. (Supported by API versions '2.0' - '2.latest') [hint:
1433 use '--os-compute-api-version' flag to show help message for proper
1434 version]
1435 Optional arguments:
1437 --matching <hostname>
1439 List hypervisors matching the given <hostname>. If matching is
1440 used limit and marker options will be ignored.
1441 --marker <marker>
1443 The last hypervisor of the previous page; displays list of hy‐
1444 pervisors after "marker". (Supported by API versions '2.33' -
1445 '2.latest')
1446 --limit <limit>
1448 Maximum number of hypervisors to display. If limit is bigger
1449 than 'CONF.api.max_limit' option of Nova API, limit
1450 'CONF.api.max_limit' will be used instead. (Supported by API
1451 versions '2.33' - '2.latest')
1452 nova hypervisor-servers
1454 usage: nova hypervisor-servers <hostname>
1455 List servers belonging to specific hypervisors.
1457 Positional arguments:
1459 <hostname>
1461 The hypervisor hostname (or pattern) to search for.
1462 nova hypervisor-show
1464 usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
1465 Display the details of the specified hypervisor.
1467 Positional arguments:
1469 <hypervisor>
1471 Name or ID of the hypervisor. Starting with microversion 2.53
1472 the ID must be a UUID.
1473 Optional arguments:
1475 --wrap <integer>
1477 Wrap the output to a specified length. Default is 40 or 0 to
1478 disable
1479 nova hypervisor-stats
1481 usage: nova hypervisor-stats
1482 Get hypervisor statistics over all compute nodes.
1484 nova hypervisor-uptime
1486 usage: nova hypervisor-uptime <hypervisor>
1487 Display the uptime of the specified hypervisor.
1489 Positional arguments:
1491 <hypervisor>
1493 Name or ID of the hypervisor. Starting with microversion 2.53
1494 the ID must be a UUID.
1495 nova image-create
1497 usage: nova image-create [--metadata <key=value>] [--show] [--poll]
1498 <server> <name>
1499 Create a new image by taking a snapshot of a running server.
1501 Positional arguments:
1503 <server>
1505 Name or ID of server.
1506 <name> Name of snapshot.
1508 Optional arguments:
1510 --metadata <key=value>
1512 Record arbitrary key/value metadata to /meta_data.json on the
1513 metadata server. Can be specified multiple times.
1514 --show Print image info.
1516 --poll Report the snapshot progress and poll until image creation is
1518 complete.
1519 nova instance-action
1521 usage: nova instance-action <server> <request_id>
1522 Show an action.
1524 Positional arguments:
1526 <server>
1528 Name or UUID of the server to show actions for. Only UUID can be
1529 used to show actions for a deleted server. (Supported by API
1530 versions '2.21' - '2.latest')
1531 <request_id>
1533 Request ID of the action to get.
1534 nova instance-action-list
1536 usage: nova instance-action-list [--marker <marker>] [--limit <limit>]
1537 [--changes-since <changes_since>]
1538 [--changes-before <changes_before>]
1539 <server>
1540 List actions on a server.
1542 Positional arguments:
1544 <server>
1546 Name or UUID of the server to list actions for. Only UUID can be
1547 used to list actions on a deleted server. (Supported by API ver‐
1548 sions '2.21' - '2.latest')
1549 Optional arguments:
1551 --marker <marker>
1553 The last instance action of the previous page; displays list of
1554 actions after "marker". (Supported by API versions '2.58' -
1555 '2.latest')
1556 --limit <limit>
1558 Maximum number of instance actions to display. Note that there
1559 is a configurable max limit on the server, and the limit that is
1560 used will be the minimum of what is requested here and what is
1561 configured in the server. (Supported by API versions '2.58' -
1562 '2.latest')
1563 --changes-since <changes_since>
1565 List only instance actions changed later or equal to a certain
1566 point of time. The provided time should be an ISO 8061 formatted
1567 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1568 '2.58' - '2.latest')
1569 --changes-before <changes_before>
1571 List only instance actions changed earlier or equal to a certain
1572 point of time. The provided time should be an ISO 8061 formatted
1573 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1574 '2.66' - '2.latest')
1575 nova instance-usage-audit-log
1577 usage: nova instance-usage-audit-log [--before <before>]
1578 List/Get server usage audits.
1580 Optional arguments:
1582 --before <before>
1584 Filters the response by the date and time before which to list
1585 usage audits. The date and time stamp format is as follows:
1586 CCYY-MM-DD hh:mm:ss.NNNNNN ex 2015-08-27 09:49:58 or 2015-08-27
1587 09:49:58.123456.
1588 nova interface-attach
1590 usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
1591 [--fixed-ip <fixed_ip>] [--tag <tag>]
1592 <server>
1593 Attach a network interface to a server.
1595 Positional arguments:
1597 <server>
1599 Name or ID of server.
1600 Optional arguments:
1602 --port-id <port_id>
1604 Port ID.
1605 --net-id <net_id>
1607 Network ID
1608 --fixed-ip <fixed_ip>
1610 Requested fixed IP.
1611 --tag <tag>
1613 Tag for the attached interface. (Supported by API versions
1614 '2.49' - '2.latest')
1615 nova interface-detach
1617 usage: nova interface-detach <server> <port_id>
1618 Detach a network interface from a server.
1620 Positional arguments:
1622 <server>
1624 Name or ID of server.
1625 <port_id>
1627 Port ID.
1628 nova interface-list
1630 usage: nova interface-list <server>
1631 List interfaces attached to a server.
1633 Positional arguments:
1635 <server>
1637 Name or ID of server.
1638 nova keypair-add
1640 usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
1641 [--user <user-id>]
1642 <name>
1643 Create a new key pair for use with servers.
1645 Positional arguments:
1647 <name> Name of key.
1649 Optional arguments:
1651 --pub-key <pub-key>
1653 Path to a public ssh key.
1654 --key-type <key-type>
1656 Keypair type. Can be ssh or x509. (Supported by API versions
1657 '2.2' - '2.latest')
1658 --user <user-id>
1660 ID of user to whom to add key-pair (Admin only). (Supported by
1661 API versions '2.10' - '2.latest')
1662 nova keypair-delete
1664 usage: nova keypair-delete [--user <user-id>] <name>
1665 Delete keypair given by its name. (Supported by API versions '2.0' -
1667 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1668 message for proper version]
1669 Positional arguments:
1671 <name> Keypair name to delete.
1673 Optional arguments:
1675 --user <user-id>
1677 ID of key-pair owner (Admin only).
1678 nova keypair-list
1680 usage: nova keypair-list [--user <user-id>] [--marker <marker>]
1681 [--limit <limit>]
1682 Print a list of keypairs for a user (Supported by API versions '2.0' -
1684 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1685 message for proper version]
1686 Optional arguments:
1688 --user <user-id>
1690 List key-pairs of specified user ID (Admin only).
1691 --marker <marker>
1693 The last keypair of the previous page; displays list of keypairs
1694 after "marker".
1695 --limit <limit>
1697 Maximum number of keypairs to display. If limit is bigger than
1698 'CONF.api.max_limit' option of Nova API, limit
1699 'CONF.api.max_limit' will be used instead.
1700 nova keypair-show
1702 usage: nova keypair-show [--user <user-id>] <keypair>
1703 Show details about the given keypair. (Supported by API versions '2.0'
1705 - '2.latest') [hint: use '--os-compute-api-version' flag to show help
1706 message for proper version]
1707 Positional arguments:
1709 <keypair>
1711 Name of keypair.
1712 Optional arguments:
1714 --user <user-id>
1716 ID of key-pair owner (Admin only).
1717 nova limits
1719 usage: nova limits [--tenant [<tenant>]] [--reserved]
1720 Print rate and absolute limits.
1722 Optional arguments:
1724 --tenant [<tenant>]
1726 Display information from single tenant (Admin only).
1727 --reserved
1729 Include reservations count.
1730 nova list
1732 usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>]
1733 [--ip6 <ip6-regexp>] [--name <name-regexp>]
1734 [--status <status>] [--flavor <flavor>] [--image <image>]
1735 [--host <hostname>] [--all-tenants [<0|1>]]
1736 [--tenant [<tenant>]] [--user [<user>]] [--deleted]
1737 [--fields <fields>] [--minimal]
1738 [--sort <key>[:<direction>]] [--marker <marker>]
1739 [--limit <limit>] [--availability-zone <availability_zone>]
1740 [--key-name <key_name>] [--[no-]config-drive]
1741 [--progress <progress>] [--vm-state <vm_state>]
1742 [--task-state <task_state>] [--power-state <power_state>]
1743 [--changes-since <changes_since>]
1744 [--changes-before <changes_before>]
1745 [--tags <tags>] [--tags-any <tags-any>]
1746 [--not-tags <not-tags>] [--not-tags-any <not-tags-any>]
1747 [--locked]
1748 List servers.
1750 Note that from microversion 2.69, during partial infrastructure fail‐
1752 ures in the deployment, the output of this command may return partial
1753 results for the servers present in the failure domain.
1754 Optional arguments:
1756 --reservation-id <reservation-id>
1758 Only return servers that match reservation-id.
1759 --ip <ip-regexp>
1761 Search with regular expression match by IP address.
1762 --ip6 <ip6-regexp>
1764 Search with regular expression match by IPv6 address.
1765 --name <name-regexp>
1767 Search with regular expression match by name.
1768 --status <status>
1770 Search by server status.
1771 --flavor <flavor>
1773 Search by flavor name or ID.
1774 --image <image>
1776 Search by image name or ID.
1777 --host <hostname>
1779 Search servers by hostname to which they are assigned (Admin
1780 only).
1781 --all-tenants [<0|1>]
1783 Display information from all tenants (Admin only).
1784 --tenant [<tenant>]
1786 Display information from single tenant (Admin only).
1787 --user [<user>]
1789 Display information from single user (Admin only until microver‐
1790 sion 2.82).
1791 --deleted
1793 Only display deleted servers (Admin only).
1794 --fields <fields>
1796 Comma-separated list of fields to display. Use the show command
1797 to see which fields are available.
1798 --minimal
1800 Get only UUID and name.
1801 --sort <key>[:<direction>]
1803 Comma-separated list of sort keys and directions in the form of
1804 <key>[:<asc|desc>]. The direction defaults to descending if not
1805 specified.
1806 --marker <marker>
1808 The last server UUID of the previous page; displays list of
1809 servers after "marker".
1810 --limit <limit>
1812 Maximum number of servers to display. If limit == -1, all
1813 servers will be displayed. If limit is bigger than
1814 'CONF.api.max_limit' option of Nova API, limit
1815 'CONF.api.max_limit' will be used instead.
1816 --availability-zone <availability_zone>
1818 Display servers based on their availability zone (Admin only un‐
1819 til microversion 2.82).
1820 --key-name <key_name>
1822 Display servers based on their keypair name (Admin only until
1823 microversion 2.82).
1824 --config-drive
1826 Display servers that have a config drive attached. It is mutu‐
1827 ally exclusive with '--no-config-drive'. (Admin only until mi‐
1828 croversion 2.82).
1829 --no-config-drive
1831 Display servers that do not have a config drive attached. It is
1832 mutually exclusive with '--config-drive'. (Admin only until mi‐
1833 croversion 2.82).
1834 --progress <progress>
1836 Display servers based on their progress value (Admin only until
1837 microversion 2.82).
1838 --vm-state <vm_state>
1840 Display servers based on their vm_state value (Admin only until
1841 microversion 2.82).
1842 --task-state <task_state>
1844 Display servers based on their task_state value (Admin only un‐
1845 til microversion 2.82).
1846 --power-state <power_state>
1848 Display servers based on their power_state value (Admin only un‐
1849 til microversion 2.82).
1850 --changes-since <changes_since>
1852 List only servers changed later or equal to a certain point of
1853 time. The provided time should be an ISO 8061 formatted time.
1854 e.g. 2016-03-04T06:27:59Z .
1855 --changes-before <changes_before>
1857 List only servers changed earlier or equal to a certain point of
1858 time. The provided time should be an ISO 8061 formatted time.
1859 e.g. 2016-03-05T06:27:59Z . (Supported by API versions '2.66' -
1860 '2.latest')
1861 --tags <tags>
1863 The given tags must all be present for a server to be included
1864 in the list result. Boolean expression in this case is 't1 AND
1865 t2'. Tags must be separated by commas: --tags <tag1,tag2> (Sup‐
1866 ported by API versions '2.26' - '2.latest')
1867 --tags-any <tags-any>
1869 If one of the given tags is present the server will be included
1870 in the list result. Boolean expression in this case is 't1 OR
1871 t2'. Tags must be separated by commas: --tags-any <tag1,tag2>
1872 (Supported by API versions '2.26' - '2.latest')
1873 --not-tags <not-tags>
1875 Only the servers that do not have any of the given tags will be
1876 included in the list results. Boolean expression in this case is
1877 'NOT(t1 AND t2)'. Tags must be separated by commas: --not-tags
1878 <tag1,tag2> (Supported by API versions '2.26' - '2.latest')
1879 --not-tags-any <not-tags-any>
1881 Only the servers that do not have at least one of the given tags
1882 will be included in the list result. Boolean expression in this
1883 case is 'NOT(t1 OR t2)'. Tags must be separated by commas:
1884 --not-tags-any <tag1,tag2> (Supported by API versions '2.26' -
1885 '2.latest')
1886 --locked <locked>
1888 Display servers based on their locked value. A value must be
1889 specified; eg. 'true' will list only locked servers and 'false'
1890 will list only unlocked servers. (Supported by API versions
1891 '2.73' - '2.latest')
1892 nova list-secgroup
1894 usage: nova list-secgroup <server>
1895 List Security Group(s) of a server.
1897 Positional arguments:
1899 <server>
1901 Name or ID of server.
1902 nova live-migration
1904 usage: nova live-migration [--block-migrate] [--force] <server> [<host>]
1905 Migrate running server to a new machine.
1907 Positional arguments:
1909 <server>
1911 Name or ID of server.
1912 <host> Destination host name. If no host is specified, the scheduler
1914 will choose one.
1915 Optional arguments:
1917 --block-migrate
1919 True in case of block_migration. (Default=auto:live_migration)
1920 (Supported by API versions '2.25' - '2.latest')
1921 --force
1923 Force a live-migration by not verifying the provided destination
1924 host by the scheduler. (Supported by API versions '2.30' -
1925 '2.67')
1926 WARNING:
1928 This could result in failures to actually live migrate the
1929 server to the specified host. It is recommended to either not
1930 specify a host so that the scheduler will pick one, or spec‐
1931 ify a host without --force.
1932 nova live-migration-abort
1934 usage: nova live-migration-abort <server> <migration>
1935 Abort an on-going live migration. (Supported by API versions '2.24' -
1937 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1938 message for proper version]
1939 For microversions from 2.24 to 2.64 the migration status must be run‐
1941 ning; for microversion 2.65 and greater, the migration status can also
1942 be queued and preparing.
1943 New in version 3.3.0.
1945 Positional arguments:
1948 <server>
1950 Name or ID of server.
1951 <migration>
1953 ID of migration.
1954 nova live-migration-force-complete
1956 usage: nova live-migration-force-complete <server> <migration>
1957 Force on-going live migration to complete. (Supported by API versions
1959 '2.22' - '2.latest') [hint: use '--os-compute-api-version' flag to show
1960 help message for proper version]
1961 New in version 3.3.0.
1963 Positional arguments:
1966 <server>
1968 Name or ID of server.
1969 <migration>
1971 ID of migration.
1972 nova lock
1974 usage: nova lock [--reason <reason>] <server>
1975 Lock a server. A normal (non-admin) user will not be able to execute
1977 actions on a locked server.
1978 Positional arguments:
1980 <server>
1982 Name or ID of server.
1983 Optional arguments:
1985 --reason <reason>
1987 Reason for locking the server. (Supported by API versions '2.73'
1988 - '2.latest')
1989 nova meta
1991 usage: nova meta <server> <action> <key=value> [<key=value> ...]
1992 Set or delete metadata on a server.
1994 Positional arguments:
1996 <server>
1998 Name or ID of server.
1999 <action>
2001 Actions: 'set' or 'delete'.
2002 <key=value>
2004 Metadata to set or delete (only key is necessary on delete).
2005 nova migrate
2007 usage: nova migrate [--host <host>] [--poll] <server>
2008 Migrate a server. The new host will be selected by the scheduler.
2010 Positional arguments:
2012 <server>
2014 Name or ID of server.
2015 Optional arguments:
2017 --host <host>
2019 Destination host name. (Supported by API versions '2.56' -
2020 '2.latest')
2021 --poll Report the server migration progress until it completes.
2023 nova migration-list
2025 usage: nova migration-list [--instance-uuid <instance_uuid>]
2026 [--host <host>]
2027 [--status <status>]
2028 [--migration-type <migration_type>]
2029 [--source-compute <source_compute>]
2030 [--marker <marker>]
2031 [--limit <limit>]
2032 [--changes-since <changes_since>]
2033 [--changes-before <changes_before>]
2034 [--project-id <project_id>]
2035 [--user-id <user_id>]
2036 Print a list of migrations.
2038 Examples
2040 To see the list of evacuation operations from a compute service host:
2042 nova migration-list --migration-type evacuation --source-compute host.foo.bar
2044 Optional arguments:
2046 --instance-uuid <instance_uuid>
2048 Fetch migrations for the given instance.
2049 --host <host>
2051 Fetch migrations for the given source or destination host.
2052 --status <status>
2054 Fetch migrations for the given status.
2055 --migration-type <migration_type>
2057 Filter migrations by type. Valid values are:
2058 • evacuation
2060 • live-migration
2062 • migration
2064 NOTE:
2066 This is a cold migration.
2067 • resize
2069 --source-compute <source_compute>
2071 Filter migrations by source compute host name.
2072 --marker <marker>
2074 The last migration of the previous page; displays list of migra‐
2075 tions after "marker". Note that the marker is the migration
2076 UUID. (Supported by API versions '2.59' - '2.latest')
2077 --limit <limit>
2079 Maximum number of migrations to display. Note that there is a
2080 configurable max limit on the server, and the limit that is used
2081 will be the minimum of what is requested here and what is con‐
2082 figured in the server. (Supported by API versions '2.59' -
2083 '2.latest')
2084 --changes-since <changes_since>
2086 List only migrations changed later or equal to a certain point
2087 of time. The provided time should be an ISO 8061 formatted time.
2088 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.59' -
2089 '2.latest')
2090 --changes-before <changes_before>
2092 List only migrations changed earlier or equal to a certain point
2093 of time. The provided time should be an ISO 8061 formatted time.
2094 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.66' -
2095 '2.latest')
2096 --project-id <project_id>
2098 Filter the migrations by the given project ID. (Supported by
2099 API versions '2.80' - '2.latest')
2100 --user-id <user_id>
2102 Filter the migrations by the given user ID. (Supported by API
2103 versions '2.80' - '2.latest')
2104 nova pause
2106 usage: nova pause <server>
2107 Pause a server.
2109 Positional arguments:
2111 <server>
2113 Name or ID of server.
2114 nova quota-class-show
2116 usage: nova quota-class-show <class>
2117 List the quotas for a quota class.
2119 Positional arguments:
2121 <class>
2123 Name of quota class to list the quotas for.
2124 nova quota-class-update
2126 usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
2127 [--ram <ram>]
2128 [--metadata-items <metadata-items>]
2129 [--key-pairs <key-pairs>]
2130 [--server-groups <server-groups>]
2131 [--server-group-members <server-group-members>]
2132 <class>
2133 Update the quotas for a quota class. (Supported by API versions '2.0' -
2135 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2136 message for proper version]
2137 Positional arguments:
2139 <class>
2141 Name of quota class to set the quotas for.
2142 Optional arguments:
2144 --instances <instances>
2146 New value for the "instances" quota.
2147 --cores <cores>
2149 New value for the "cores" quota.
2150 --ram <ram>
2152 New value for the "ram" quota.
2153 --metadata-items <metadata-items>
2155 New value for the "metadata-items" quota.
2156 --key-pairs <key-pairs>
2158 New value for the "key-pairs" quota.
2159 --server-groups <server-groups>
2161 New value for the "server-groups" quota.
2162 --server-group-members <server-group-members>
2164 New value for the "server-group-members" quota.
2165 nova quota-defaults
2167 usage: nova quota-defaults [--tenant <tenant-id>]
2168 List the default quotas for a tenant.
2170 Optional arguments:
2172 --tenant <tenant-id>
2174 ID of tenant to list the default quotas for.
2175 nova quota-delete
2177 usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
2178 Delete quota for a tenant/user so their quota will Revert back to de‐
2180 fault.
2181 Optional arguments:
2183 --tenant <tenant-id>
2185 ID of tenant to delete quota for.
2186 --user <user-id>
2188 ID of user to delete quota for.
2189 nova quota-show
2191 usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]
2192 List the quotas for a tenant/user.
2194 Optional arguments:
2196 --tenant <tenant-id>
2198 ID of tenant to list the quotas for.
2199 --user <user-id>
2201 ID of user to list the quotas for.
2202 --detail
2204 Show detailed info (limit, reserved, in-use).
2205 nova quota-update
2207 usage: nova quota-update [--user <user-id>] [--instances <instances>]
2208 [--cores <cores>] [--ram <ram>]
2209 [--metadata-items <metadata-items>]
2210 [--key-pairs <key-pairs>]
2211 [--server-groups <server-groups>]
2212 [--server-group-members <server-group-members>]
2213 [--force]
2214 <tenant-id>
2215 Update the quotas for a tenant/user. (Supported by API versions '2.0' -
2217 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2218 message for proper version]
2219 Positional arguments:
2221 <tenant-id>
2223 ID of tenant to set the quotas for.
2224 Optional arguments:
2226 --user <user-id>
2228 ID of user to set the quotas for.
2229 --instances <instances>
2231 New value for the "instances" quota.
2232 --cores <cores>
2234 New value for the "cores" quota.
2235 --ram <ram>
2237 New value for the "ram" quota.
2238 --metadata-items <metadata-items>
2240 New value for the "metadata-items" quota.
2241 --key-pairs <key-pairs>
2243 New value for the "key-pairs" quota.
2244 --server-groups <server-groups>
2246 New value for the "server-groups" quota.
2247 --server-group-members <server-group-members>
2249 New value for the "server-group-members" quota.
2250 --force
2252 Whether force update the quota even if the already used and re‐
2253 served exceeds the new quota.
2254 nova reboot
2256 usage: nova reboot [--hard] [--poll] <server> [<server> ...]
2257 Reboot a server.
2259 Positional arguments:
2261 <server>
2263 Name or ID of server(s).
2264 Optional arguments:
2266 --hard Perform a hard reboot (instead of a soft one). Note: Ironic does
2268 not currently support soft reboot; consequently, bare metal
2269 nodes will always do a hard reboot, regardless of the use of
2270 this option.
2271 --poll Poll until reboot is complete.
2273 nova rebuild
2275 usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
2276 [--minimal] [--preserve-ephemeral] [--name <name>]
2277 [--description <description>] [--meta <key=value>]
2278 [--key-name <key-name>] [--key-unset]
2279 [--user-data <user-data>] [--user-data-unset]
2280 [--trusted-image-certificate-id <trusted-image-certificate-id>]
2281 [--trusted-image-certificates-unset]
2282 [--hostname <hostname>]
2283 <server> <image>
2284 Shutdown, re-image, and re-boot a server.
2286 Positional arguments:
2288 <server>
2290 Name or ID of server.
2291 <image>
2293 Name or ID of new image.
2294 Optional arguments:
2296 --rebuild-password <rebuild-password>
2298 Set the provided admin password on the rebuilt server.
2299 --poll Report the server rebuild progress until it completes.
2301 --minimal
2303 Skips flavor/image lookups when showing servers.
2304 --preserve-ephemeral
2306 Preserve the default ephemeral storage partition on rebuild.
2307 --name <name>
2309 Name for the new server.
2310 --description <description>
2312 New description for the server. (Supported by API versions
2313 '2.19' - '2.latest')
2314 --meta <key=value>
2316 Record arbitrary key/value metadata to /meta_data.json on the
2317 metadata server. Can be specified multiple times.
2318 --key-name <key-name>
2320 Keypair name to set in the server. Cannot be specified with the
2321 '--key-unset' option. (Supported by API versions '2.54' -
2322 '2.latest')
2323 --key-unset
2325 Unset keypair in the server. Cannot be specified with the
2326 '--key-name' option. (Supported by API versions '2.54' -
2327 '2.latest')
2328 --user-data <user-data>
2330 User data file to pass to be exposed by the metadata server.
2331 (Supported by API versions '2.57' - '2.latest')
2332 --user-data-unset
2334 Unset user_data in the server. Cannot be specified with the
2335 '--user-data' option. (Supported by API versions '2.57' -
2336 '2.latest')
2337 --trusted-image-certificate-id <trusted-image-certificate-id>
2339 Trusted image certificate IDs used to validate certificates dur‐
2340 ing the image signature verification process. Defaults to
2341 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
2342 ple times to pass multiple trusted image certificate IDs. (Sup‐
2343 ported by API versions '2.63' - '2.latest')
2344 --trusted-image-certificates-unset
2346 Unset trusted_image_certificates in the server. Cannot be speci‐
2347 fied with the --trusted-image-certificate-id option. (Supported
2348 by API versions '2.63' - '2.latest')
2349 --hostname <hostname>
2351 New hostname for the instance. This only updates the hostname
2352 stored in the metadata server: a utility running on the guest is
2353 required to propagate these changes to the guest. (Supported by
2354 API versions '2.90' - '2.latest')
2355 nova refresh-network
2357 usage: nova refresh-network <server>
2358 Refresh server network information.
2360 Positional arguments:
2362 <server>
2364 Name or ID of a server for which the network cache should be re‐
2365 freshed from neutron (Admin only).
2366 nova remove-secgroup
2368 usage: nova remove-secgroup <server> <secgroup>
2369 Remove a Security Group from a server.
2371 Positional arguments:
2373 <server>
2375 Name or ID of server.
2376 <secgroup>
2378 Name of Security Group.
2379 nova rescue
2381 usage: nova rescue [--password <password>] [--image <image>] <server>
2382 Reboots a server into rescue mode, which starts the machine from either
2384 the initial image or a specified image, attaching the current boot disk
2385 as secondary.
2386 Positional arguments:
2388 <server>
2390 Name or ID of server.
2391 Optional arguments:
2393 --password <password>
2395 The admin password to be set in the rescue environment.
2396 --image <image>
2398 The image to rescue with.
2399 nova reset-network
2401 usage: nova reset-network <server>
2402 Reset network of a server.
2404 Positional arguments:
2406 <server>
2408 Name or ID of server.
2409 nova reset-state
2411 usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]
2412 Reset the state of a server.
2414 Positional arguments:
2416 <server>
2418 Name or ID of server(s).
2419 Optional arguments:
2421 --all-tenants
2423 Reset state server(s) in another tenant by name (Admin only).
2424 --active
2426 Request the server be reset to "active" state instead of "error"
2427 state (the default).
2428 nova resize
2430 usage: nova resize [--poll] <server> <flavor>
2431 Resize a server.
2433 Positional arguments:
2435 <server>
2437 Name or ID of server.
2438 <flavor>
2440 Name or ID of new flavor.
2441 Optional arguments:
2443 --poll Report the server resize progress until it completes.
2445 nova resize-confirm
2447 usage: nova resize-confirm <server>
2448 Confirm a previous resize.
2450 Positional arguments:
2452 <server>
2454 Name or ID of server.
2455 nova resize-revert
2457 usage: nova resize-revert <server>
2458 Revert a previous resize (and return to the previous VM).
2460 Positional arguments:
2462 <server>
2464 Name or ID of server.
2465 nova restore
2467 usage: nova restore <server>
2468 Restore a soft-deleted server.
2470 Positional arguments:
2472 <server>
2474 Name or ID of server.
2475 nova resume
2477 usage: nova resume <server>
2478 Resume a server.
2480 Positional arguments:
2482 <server>
2484 Name or ID of server.
2485 nova server-group-create
2487 usage: nova server-group-create [--rules <key=value>] <name> <policy>
2488 Create a new server group with the specified details.
2490 Positional arguments:
2492 <name> Server group name.
2494 <policy>
2496 Policy for the server groups.
2497 Optional arguments:
2499 --rule Policy rules for the server groups. (Supported by API versions
2501 '2.64' - '2.latest'）. Currently, only the max_server_per_host
2502 rule is supported for the anti-affinity policy. The
2503 max_server_per_host rule allows specifying how many members of
2504 the anti-affinity group can reside on the same compute host. If
2505 not specified, only one member from the same anti-affinity group
2506 can reside on a given host.
2507 nova server-group-delete
2509 usage: nova server-group-delete <id> [<id> ...]
2510 Delete specific server group(s).
2512 Positional arguments:
2514 <id> Unique ID(s) of the server group to delete.
2516 nova server-group-get
2518 usage: nova server-group-get <id>
2519 Get a specific server group.
2521 Positional arguments:
2523 <id> Unique ID of the server group to get.
2525 nova server-group-list
2527 usage: nova server-group-list [--limit <limit>] [--offset <offset>]
2528 [--all-projects]
2529 Print a list of all server groups.
2531 Optional arguments:
2533 --limit <limit>
2535 Maximum number of server groups to display. If limit is bigger
2536 than 'CONF.api.max_limit' option of Nova API, limit
2537 'CONF.api.max_limit' will be used instead.
2538 --offset <offset>
2540 The offset of groups list to display; use with limit to return a
2541 slice of server groups.
2542 --all-projects
2544 Display server groups from all projects (Admin only).
2545 nova server-migration-list
2547 usage: nova server-migration-list <server>
2548 Get the migrations list of specified server. (Supported by API versions
2550 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2551 help message for proper version]
2552 New in version 3.3.0.
2554 Positional arguments:
2557 <server>
2559 Name or ID of server.
2560 nova server-migration-show
2562 usage: nova server-migration-show <server> <migration>
2563 Get the migration of specified server. (Supported by API versions
2565 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2566 help message for proper version]
2567 New in version 3.3.0.
2569 Positional arguments:
2572 <server>
2574 Name or ID of server.
2575 <migration>
2577 ID of migration.
2578 nova server-tag-add
2580 usage: nova server-tag-add <server> <tag> [<tag> ...]
2581 Add one or more tags to a server. (Supported by API versions '2.26' -
2583 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2584 message for proper version]
2585 New in version 4.1.0.
2587 Positional arguments:
2590 <server>
2592 Name or ID of server.
2593 <tag> Tag(s) to add.
2595 nova server-tag-delete
2597 usage: nova server-tag-delete <server> <tag> [<tag> ...]
2598 Delete one or more tags from a server. (Supported by API versions
2600 '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2601 help message for proper version]
2602 New in version 4.1.0.
2604 Positional arguments:
2607 <server>
2609 Name or ID of server.
2610 <tag> Tag(s) to delete.
2612 nova server-tag-delete-all
2614 usage: nova server-tag-delete-all <server>
2615 Delete all tags from a server. (Supported by API versions '2.26' -
2617 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2618 message for proper version]
2619 New in version 4.1.0.
2621 Positional arguments:
2624 <server>
2626 Name or ID of server.
2627 nova server-tag-list
2629 usage: nova server-tag-list <server>
2630 Get list of tags from a server. (Supported by API versions '2.26' -
2632 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2633 message for proper version]
2634 New in version 4.1.0.
2636 Positional arguments:
2639 <server>
2641 Name or ID of server.
2642 nova server-tag-set
2644 usage: nova server-tag-set <server> <tags> [<tags> ...]
2645 Set list of tags to a server. (Supported by API versions '2.26' -
2647 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2648 message for proper version]
2649 New in version 4.1.0.
2651 Positional arguments:
2654 <server>
2656 Name or ID of server.
2657 <tags> Tag(s) to set.
2659 nova server-topology
2661 usage: nova server-topology <server>
2662 Retrieve server NUMA topology information. Host specific fields are
2664 only visible to users with the administrative role. (Supported by API
2665 versions '2.78' - '2.latest')
2666 New in version 15.1.0.
2668 Positional arguments:
2671 <server>
2673 Name or ID of server.
2674 nova service-delete
2676 usage: nova service-delete <id>
2677 Delete the service.
2679 IMPORTANT:
2681 If deleting a nova-compute service, be sure to stop the actual
2682 nova-compute process on the physical host before deleting the ser‐
2683 vice with this command. Failing to do so can lead to the running
2684 service re-creating orphaned compute_nodes table records in the
2685 database.
2686 Positional arguments:
2688 <id> ID of service as a UUID. (Supported by API versions '2.53' -
2690 '2.latest')
2691 nova service-disable
2693 usage: nova service-disable [--reason <reason>] <id>
2694 Disable the service.
2696 Positional arguments:
2698 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2700 '2.latest')
2701 Optional arguments:
2703 --reason <reason>
2705 Reason for disabling the service.
2706 nova service-enable
2708 usage: nova service-enable <id>
2709 Enable the service.
2711 Positional arguments:
2713 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2715 '2.latest')
2716 nova service-force-down
2718 usage: nova service-force-down [--unset] <id>
2719 Force service to down. (Supported by API versions '2.11' - '2.latest')
2721 [hint: use '--os-compute-api-version' flag to show help message for
2722 proper version]
2723 New in version 2.27.0.
2725 Positional arguments:
2728 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2730 '2.latest')
2731 Optional arguments:
2733 --unset
2735 Unset the forced_down state of the service.
2736 nova service-list
2738 usage: nova service-list [--host <hostname>] [--binary <binary>]
2739 Show a list of all running services. Filter by host & binary.
2741 Note that from microversion 2.69, during partial infrastructure fail‐
2743 ures in the deployment, the output of this command may return partial
2744 results for the services present in the failure domain.
2745 Optional arguments:
2747 --host <hostname>
2749 Name of host.
2750 --binary <binary>
2752 Service binary.
2753 nova set-password
2755 usage: nova set-password <server>
2756 Change the admin password for a server.
2758 Positional arguments:
2760 <server>
2762 Name or ID of server.
2763 nova shelve
2765 usage: nova shelve <server>
2766 Shelve a server.
2768 Positional arguments:
2770 <server>
2772 Name or ID of server.
2773 nova shelve-offload
2775 usage: nova shelve-offload <server>
2776 Remove a shelved server from the compute node.
2778 Positional arguments:
2780 <server>
2782 Name or ID of server.
2783 nova show
2785 usage: nova show [--minimal] [--wrap <integer>] <server>
2786 Show details about the given server.
2788 Note that from microversion 2.69, during partial infrastructure fail‐
2790 ures in the deployment, the output of this command may return partial
2791 results for the server if it exists in the failure domain.
2792 Positional arguments:
2794 <server>
2796 Name or ID of server.
2797 Optional arguments:
2799 --minimal
2801 Skips flavor/image lookups when showing servers.
2802 --wrap <integer>
2804 Wrap the output to a specified length, or 0 to disable.
2805 nova ssh
2807 usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE]
2808 [--network <network>] [--ipv6] [--login <login>] [-i IDENTITY]
2809 [--extra-opts EXTRA]
2810 <server>
2811 SSH into a server.
2813 Positional arguments:
2815 <server>
2817 Name or ID of server.
2818 Optional arguments:
2820 --port PORT
2822 Optional flag to indicate which port to use for ssh. (De‐
2823 fault=22)
2824 --address-type ADDRESS_TYPE
2826 Optional flag to indicate which IP type to use. Possible values
2827 includes fixed and floating (the Default).
2828 --network <network>
2830 Network to use for the ssh.
2831 --ipv6 Optional flag to indicate whether to use an IPv6 address at‐
2833 tached to a server. (Defaults to IPv4 address)
2834 --login <login>
2836 Login to use.
2837 -i IDENTITY, --identity IDENTITY
2839 Private key file, same as the -i option to the ssh command.
2840 --extra-opts EXTRA
2842 Extra options to pass to ssh. see: man ssh.
2843 nova start
2845 usage: nova start [--all-tenants] <server> [<server> ...]
2846 Start the server(s).
2848 Positional arguments:
2850 <server>
2852 Name or ID of server(s).
2853 Optional arguments:
2855 --all-tenants
2857 Start server(s) in another tenant by name (Admin only).
2858 nova stop
2860 usage: nova stop [--all-tenants] <server> [<server> ...]
2861 Stop the server(s).
2863 Positional arguments:
2865 <server>
2867 Name or ID of server(s).
2868 Optional arguments:
2870 --all-tenants
2872 Stop server(s) in another tenant by name (Admin only).
2873 nova suspend
2875 usage: nova suspend <server>
2876 Suspend a server.
2878 Positional arguments:
2880 <server>
2882 Name or ID of server.
2883 nova trigger-crash-dump
2885 usage: nova trigger-crash-dump <server>
2886 Trigger crash dump in an instance. (Supported by API versions '2.17' -
2888 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2889 message for proper version]
2890 New in version 3.3.0.
2892 Positional arguments:
2895 <server>
2897 Name or ID of server.
2898 nova unlock
2900 usage: nova unlock <server>
2901 Unlock a server.
2903 Positional arguments:
2905 <server>
2907 Name or ID of server.
2908 nova unpause
2910 usage: nova unpause <server>
2911 Unpause a server.
2913 Positional arguments:
2915 <server>
2917 Name or ID of server.
2918 nova unrescue
2920 usage: nova unrescue <server>
2921 Restart the server from normal boot disk again.
2923 Positional arguments:
2925 <server>
2927 Name or ID of server.
2928 nova unshelve
2930 usage: nova unshelve [--availability-zone <availability_zone>] <server>
2931 Unshelve a server.
2933 Positional arguments:
2935 <server>
2937 Name or ID of server.
2938 Optional arguments:
2940 --availability-zone <availability_zone>
2942 Name of the availability zone in which to unshelve a
2943 SHELVED_OFFLOADED server. (Supported by API versions '2.77' -
2944 '2.latest')
2945 nova update
2947 usage: nova update [--name <name>] [--description <description>]
2948 [--hostname <hostname>]
2949 <server>
2950 Update attributes of a server.
2952 Positional arguments:
2954 <server>
2956 Name (old name) or ID of server.
2957 Optional arguments:
2959 --name <name>
2961 New name for the server.
2962 --description <description>
2964 New description for the server. If it equals to empty string
2965 (i.g. ""), the server description will be removed. (Supported by
2966 API versions '2.19' - '2.latest')
2967 --hostname <hostname>
2969 New hostname for the instance. This only updates the hostname
2970 stored in the metadata server: a utility running on the guest is
2971 required to propagate these changes to the guest. (Supported by
2972 API versions '2.90' - '2.latest')
2973 nova usage
2975 usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
2976 Show usage data for a single tenant.
2978 Optional arguments:
2980 --start <start>
2982 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2983 --end <end>
2985 Usage range end date, ex 2012-01-20. (default: tomorrow)
2986 --tenant <tenant-id>
2988 UUID of tenant to get usage for.
2989 nova usage-list
2991 usage: nova usage-list [--start <start>] [--end <end>]
2992 List usage data for all tenants.
2994 Optional arguments:
2996 --start <start>
2998 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2999 --end <end>
3001 Usage range end date, ex 2012-01-20. (default: tomorrow)
3002 nova version-list
3004 usage: nova version-list
3005 List all API versions.
3007 nova volume-attach
3009 usage: nova volume-attach [--delete-on-termination] [--tag <tag>]
3010 <server> <volume> [<device>]
3011 Attach a volume to a server.
3013 Positional arguments:
3015 <server>
3017 Name or ID of server.
3018 <volume>
3020 ID of the volume to attach.
3021 <device>
3023 Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if
3024 supported). Libvirt driver will use default device name.
3025 Optional arguments:
3027 --tag <tag>
3029 Tag for the attached volume. (Supported by API versions '2.49' -
3030 '2.latest')
3031 --delete-on-termination
3033 Specify if the attached volume should be deleted when the server
3034 is destroyed. By default the attached volume is not deleted when
3035 the server is destroyed. (Supported by API versions '2.79' -
3036 '2.latest')
3037 nova volume-attachments
3039 usage: nova volume-attachments <server>
3040 List all the volumes attached to a server.
3042 Positional arguments:
3044 <server>
3046 Name or ID of server.
3047 nova volume-detach
3049 usage: nova volume-detach <server> <volume>
3050 Detach a volume from a server.
3052 Positional arguments:
3054 <server>
3056 Name or ID of server.
3057 <volume>
3059 ID of the volume to detach.
3060 nova volume-update
3062 usage: nova volume-update [--[no-]delete-on-termination]
3063 <server> <src_volume> <dest_volume>
3064 Update the attachment on the server. Migrates the data from an attached
3066 volume to the specified available volume and swaps out the active at‐
3067 tachment to the new volume.
3068 Positional arguments:
3070 <server>
3072 Name or ID of server.
3073 <src_volume>
3075 ID of the source (original) volume.
3076 <dest_volume>
3078 ID of the destination volume.
3079 Optional arguments:
3081 --delete-on-termination
3083 Specify that the volume should be deleted when the server is de‐
3084 stroyed. It is mutually exclusive with '--no-delete-on-termina‐
3085 tion'. (Supported by API versions '2.85' - '2.latest')
3086 --no-delete-on-termination
3088 Specify that the attached volume should not be deleted when the
3089 server is destroyed. It is mutually exclusive with
3090 '--delete-on-termination'. (Supported by API versions '2.85' -
3091 '2.latest')
3092 nova bash-completion
3094 usage: nova bash-completion
3095 Prints all of the commands and options to stdout so that the
3097 nova.bash_completion script doesn't have to hard code them.
3098
3100 OpenStack Contributors
3101
3103 OpenStack Contributors
310418.3.0 Jul 21, 2023 NOVA(1)