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 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
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 Subcommands:
48 add-fixed-ip
50 DEPRECATED Add new IP address on a network to server.
51 add-secgroup
53 Add a Security Group to a server.
54 agent-create
56 Create new agent build.
57 agent-delete
59 Delete existing agent build.
60 agent-list
62 List all builds.
63 agent-modify
65 Modify existing agent build.
66 aggregate-add-host
68 Add the host to the specified aggregate.
69 aggregate-cache-images
71 Request images be pre-cached on hosts within an aggregate.
72 (Supported by API versions '2.81' - '2.latest')
73 aggregate-create
75 Create a new aggregate with the specified details.
76 aggregate-delete
78 Delete the aggregate.
79 aggregate-list
81 Print a list of all aggregates.
82 aggregate-remove-host
84 Remove the specified host from the specified aggregate.
85 aggregate-set-metadata
87 Update the metadata associated with the aggregate.
88 aggregate-show
90 Show details of the specified aggregate.
91 aggregate-update
93 Update the aggregate's name and optionally availability zone.
94 availability-zone-list
96 List all the availability zones.
97 backup Backup a server by creating a 'backup' type snapshot.
99 boot Boot a new server.
101 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 cloudpipe-configure
108 DEPRECATED Update the VPN IP/port of a cloudpipe instance.
109 cloudpipe-create
111 DEPRECATED Create a cloudpipe instance for the given project.
112 cloudpipe-list
114 DEPRECATED Print a list of all cloudpipe instances.
115 console-log
117 Get console log output of a server.
118 delete Immediately shut down and delete specified server(s).
120 diagnostics
122 Retrieve server diagnostics.
123 evacuate
125 Evacuate server from failed host.
126 flavor-access-add
128 Add flavor access for the given tenant.
129 flavor-access-list
131 Print access information about the given flavor.
132 flavor-access-remove
134 Remove flavor access for the given tenant.
135 flavor-create
137 Create a new flavor.
138 flavor-delete
140 Delete a specific flavor
141 flavor-key
143 Set or unset extra_spec for a flavor.
144 flavor-list
146 Print a list of available 'flavors' (sizes of servers).
147 flavor-show
149 Show details about the given flavor.
150 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 floating-ip-associate
157 DEPRECATED Associate a floating IP address to a server.
158 floating-ip-disassociate
160 DEPRECATED Disassociate a floating IP address from a server.
161 force-delete
163 Force delete a server.
164 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 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 get-rdp-console
176 Get a rdp console to a server.
177 get-serial-console
179 Get a serial console to a server.
180 get-spice-console
182 Get a spice console to a server.
183 get-vnc-console
185 Get a vnc console to a server.
186 host-action
188 DEPRECATED Perform a power action on a host.
189 host-describe
191 DEPRECATED Describe a specific host.
192 host-evacuate
194 Evacuate all instances from failed host.
195 host-evacuate-live
197 Live migrate all instances off the specified host to other
198 available hosts.
199 host-list
201 DEPRECATED List all hosts by service.
202 host-meta
204 Set or Delete metadata on all instances of a host.
205 host-servers-migrate
207 Cold migrate all instances off the specified host to other
208 available hosts.
209 host-update
211 DEPRECATED Update host settings.
212 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 hypervisor-servers
219 List servers belonging to specific hypervisors.
220 hypervisor-show
222 Display the details of the specified hypervisor.
223 hypervisor-stats
225 Get hypervisor statistics over all compute nodes.
226 hypervisor-uptime
228 Display the uptime of the specified hypervisor.
229 image-create
231 Create a new image by taking a snapshot of a running server.
232 instance-action
234 Show an action.
235 instance-action-list
237 List actions on a server.
238 instance-usage-audit-log
240 List/Get server usage audits.
241 interface-attach
243 Attach a network interface to a server.
244 interface-detach
246 Detach a network interface from a server.
247 interface-list
249 List interfaces attached to a server.
250 keypair-add
252 Create a new key pair for use with servers.
253 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 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 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 limits Print rate and absolute limits.
270 list List servers.
272 list-secgroup
274 List Security Group(s) of a server.
275 live-migration
277 Migrate running server to a new machine.
278 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 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 lock Lock a server. A normal (non-admin) user will not be able to ex‐
290 ecute actions on a locked server.
291 meta Set or delete metadata on a server.
293 migrate
295 Migrate a server. The new host will be selected by the sched‐
296 uler.
297 migration-list
299 Print a list of migrations.
300 pause Pause a server.
302 quota-class-show
304 List the quotas for a quota class.
305 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 quota-defaults
312 List the default quotas for a tenant.
313 quota-delete
315 Delete quota for a tenant/user so their quota will Revert back
316 to default.
317 quota-show
319 List the quotas for a tenant/user.
320 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 reboot Reboot a server.
327 rebuild
329 Shutdown, re-image, and re-boot a server.
330 refresh-network
332 Refresh server network information.
333 remove-fixed-ip
335 DEPRECATED Remove an IP address from a server.
336 remove-secgroup
338 Remove a Security Group from a server.
339 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 reset-network
345 Reset network of a server.
346 reset-state
348 Reset the state of a server.
349 resize Resize a server.
351 resize-confirm
353 Confirm a previous resize.
354 resize-revert
356 Revert a previous resize (and return to the previous VM).
357 restore
359 Restore a soft-deleted server.
360 resume Resume a server.
362 server-group-create
364 Create a new server group with the specified details.
365 server-group-delete
367 Delete specific server group(s).
368 server-group-get
370 Get a specific server group.
371 server-group-list
373 Print a list of all server groups.
374 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 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 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 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 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 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 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 server-topology
411 Retrieve NUMA topology of the given server. (Supported by API
412 versions '2.78' - '2.latest')
413 service-delete
415 Delete the service.
416 service-disable
418 Disable the service.
419 service-enable
421 Enable the service.
422 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 service-list
429 Show a list of all running services. Filter by host & binary.
430 set-password
432 Change the admin password for a server.
433 shelve Shelve a server.
435 shelve-offload
437 Remove a shelved server from the compute node.
438 show Show details about the given server.
440 ssh SSH into a server.
442 start Start the server(s).
444 stop Stop the server(s).
446 suspend
448 Suspend a server.
449 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 unlock Unlock a server.
456 unpause
458 Unpause a server.
459 unrescue
461 Restart the server from normal boot disk again.
462 unshelve
464 Unshelve a server.
465 update Update the name or the description for a server.
467 usage Show usage data for a single tenant.
469 usage-list
471 List usage data for all tenants.
472 version-list
474 List all API versions.
475 virtual-interface-list
477 DEPRECATED Show virtual interface info about the given server.
478 volume-attach
480 Attach a volume to a server.
481 volume-attachments
483 List all the volumes attached to a server.
484 volume-detach
486 Detach a volume from a server.
487 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 x509-create-cert
497 DEPRECATED Create x509 cert for a user in tenant.
498 x509-get-root-cert
500 DEPRECATED Fetch the x509 root cert.
501 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 help Display help about this program or one of its subcommands.
507
509 --version
510 show program's version number and exit
511 --debug
513 Print debugging output.
514 --os-cache
516 Use the auth token cache. Defaults to False if env[OS_CACHE] is
517 not set.
518 --timings
520 Print call timing info.
521 --os-region-name <region-name>
523 Defaults to env[OS_REGION_NAME].
524 --service-type <service-type>
526 Defaults to compute for most actions.
527 --service-name <service-name>
529 Defaults to env[NOVA_SERVICE_NAME].
530 --os-endpoint-type <endpoint-type>
532 Defaults to env[NOVA_ENDPOINT_TYPE], env[OS_ENDPOINT_TYPE] or
533 publicURL.
534 --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 --os-endpoint-override <bypass-url>
540 Use this API endpoint instead of the Service Catalog. Defaults
541 to env[OS_ENDPOINT_OVERRIDE].
542 --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 --os-auth-type <name>, --os-auth-plugin <name>
552 Authentication type to use
553 nova add-secgroup
555 usage: nova add-secgroup <server> <secgroup>
556 Add a Security Group to a server.
558 Positional arguments:
560 <server>
562 Name or ID of server.
563 <secgroup>
565 Name or ID of Security Group.
566 nova agent-create
568 usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
569 <hypervisor>
570 Create new agent build.
572 Positional arguments:
574 <os> Type of OS.
576 <architecture>
578 Type of architecture.
579 <version>
581 Version.
582 <url> URL.
584 <md5hash>
586 MD5 hash.
587 <hypervisor>
589 Type of hypervisor.
590 nova agent-delete
592 usage: nova agent-delete <id>
593 Delete existing agent build.
595 Positional arguments:
597 <id> ID of the agent-build.
599 nova agent-list
601 usage: nova agent-list [--hypervisor <hypervisor>]
602 List all builds.
604 Optional arguments:
606 --hypervisor <hypervisor>
608 Type of hypervisor.
609 nova agent-modify
611 usage: nova agent-modify <id> <version> <url> <md5hash>
612 Modify existing agent build.
614 Positional arguments:
616 <id> ID of the agent-build.
618 <version>
620 Version.
621 <url> URL
623 <md5hash>
625 MD5 hash.
626 nova aggregate-add-host
628 usage: nova aggregate-add-host <aggregate> <host>
629 Add the host to the specified aggregate.
631 Positional arguments:
633 <aggregate>
635 Name or ID of aggregate.
636 <host> The host to add to the aggregate.
638 nova aggregate-cache-images
640 usage: nova aggregate-cache-images <aggregate> <image> [<image> ..]
641 Request image(s) be pre-cached on hosts within the aggregate. (Sup‐
643 ported by API versions '2.81' - '2.latest')
644 New in version 16.0.0.
646 Positional arguments:
649 <aggregate>
651 Name or ID of aggregate.
652 <image>
654 Name or ID of image(s) to cache.
655 nova aggregate-create
657 usage: nova aggregate-create <name> [<availability-zone>]
658 Create a new aggregate with the specified details.
660 Positional arguments:
662 <name> Name of aggregate.
664 <availability-zone>
666 The availability zone of the aggregate (optional).
667 nova aggregate-delete
669 usage: nova aggregate-delete <aggregate>
670 Delete the aggregate.
672 Positional arguments:
674 <aggregate>
676 Name or ID of aggregate to delete.
677 nova aggregate-list
679 usage: nova aggregate-list
680 Print a list of all aggregates.
682 nova aggregate-remove-host
684 usage: nova aggregate-remove-host <aggregate> <host>
685 Remove the specified host from the specified aggregate.
687 Positional arguments:
689 <aggregate>
691 Name or ID of aggregate.
692 <host> The host to remove from the aggregate.
694 nova aggregate-set-metadata
696 usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
697 Update the metadata associated with the aggregate.
699 Positional arguments:
701 <aggregate>
703 Name or ID of aggregate to update.
704 <key=value>
706 Metadata to add/update to aggregate. Specify only the key to
707 delete a metadata item.
708 nova aggregate-show
710 usage: nova aggregate-show <aggregate>
711 Show details of the specified aggregate.
713 Positional arguments:
715 <aggregate>
717 Name or ID of aggregate.
718 nova aggregate-update
720 usage: nova aggregate-update [--name NAME]
721 [--availability-zone <availability-zone>]
722 <aggregate>
723 Update the aggregate's name and optionally availability zone.
725 Positional arguments:
727 <aggregate>
729 Name or ID of aggregate to update.
730 Optional arguments:
732 --name NAME
734 New name for aggregate.
735 --availability-zone <availability-zone>
737 New availability zone for aggregate.
738 nova availability-zone-list
740 usage: nova availability-zone-list
741 List all the availability zones.
743 nova backup
745 usage: nova backup <server> <name> <backup-type> <rotation>
746 Backup a server by creating a 'backup' type snapshot.
748 Positional arguments:
750 <server>
752 Name or ID of server.
753 <name> Name of the backup image.
755 <backup-type>
757 The backup type, like "daily" or "weekly".
758 <rotation>
760 Int parameter representing how many backups to keep around.
761 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 [--hostname <hostname>]
784 <name>
785 Boot a new server.
787 In order to create a server with pre-existing ports that contain a re‐
789 source_request value, such as for guaranteed minimum bandwidth quality
790 of service support, microversion 2.72 is required.
791 Positional arguments:
793 <name> Name for the new server.
795 Optional arguments:
797 --flavor <flavor>
799 Name or ID of flavor (see 'nova flavor-list').
800 --image <image>
802 Name or ID of image (see 'glance image-list').
803 --image-with <key=value>
805 Image metadata property (see 'glance image-show').
806 --boot-volume <volume_id>
808 Volume ID to boot from.
809 --snapshot <snapshot_id>
811 Snapshot ID to boot from (will create a volume).
812 --min-count <number>
814 Boot at least <number> servers (limited by quota).
815 --max-count <number>
817 Boot up to <number> servers (limited by quota).
818 --meta <key=value>
820 Record arbitrary key/value metadata to /meta_data.json on the
821 metadata server. Can be specified multiple times.
822 --key-name <key-name>
824 Key name of keypair that should be created earlier with the com‐
825 mand keypair-add.
826 --user-data <user-data>
828 user data file to pass to be exposed by the metadata server.
829 --availability-zone <availability-zone>
831 The availability zone for server placement.
832 --security-groups <security-groups>
834 Comma separated list of security group names.
835 --block-device-mapping <dev-name=mapping>
837 Block device mapping in the format
838 <dev-name>=<id>:<type>:<size(GiB)>:<delete-on-terminate>.
839 --block-device
841 key1=value1[,key2=value2...] Block device mapping with the
842 keys: id=UUID (image_id, snapshot_id or volume_id only if using
843 source image, snapshot or volume) source=source type (image,
844 snapshot, volume or blank), dest=destination type of the block
845 device (volume or local), bus=device's bus (e.g. uml, lxc, vir‐
846 tio, ...; if omitted, hypervisor driver chooses a suitable de‐
847 fault, honoured only if device type is supplied) type=device
848 type (e.g. disk, cdrom, ...; defaults to 'disk') device=name of
849 the device (e.g. vda, xda, ...; if omitted, hypervisor driver
850 chooses suitable device depending on selected bus; note the lib‐
851 virt driver always uses default device names), size=size of the
852 block device in MiB(for swap) and in GiB(for other formats) (if
853 omitted, hypervisor driver calculates size), format=device will
854 be formatted (e.g. swap, ntfs, ...; optional), bootindex=integer
855 used for ordering the boot disks (for image backed instances it
856 is equal to 0, for others need to be specified), shutdown=shut‐
857 down behaviour (either preserve or remove, for local destination
858 set to remove), tag=device metadata tag (optional; supported by
859 API versions '2.42' - '2.latest'), and volume_type=type of vol‐
860 ume to create (either ID or name) when source is blank, image or
861 snapshot and dest is volume (optional; supported by API versions
862 '2.67' - '2.latest').
863 --swap <swap_size>
865 Create and attach a local swap block device of <swap_size> MiB.
866 --ephemeral
868 size=<size>[,format=<format>] Create and attach a local
869 ephemeral block device of <size> GiB and format it to <format>.
870 --hint <key=value>
872 Send arbitrary key/value pairs to the scheduler for custom use.
873 --nic <auto,none,net-id=net-uuid,net-name=net‐
875 work-name,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag>
876 Create a NIC on the server. Specify option multiple times to
877 create multiple nics unless using the special 'auto' or 'none'
878 values. auto: automatically allocate network resources if none
879 are available. This cannot be specified with any other nic value
880 and cannot be specified multiple times. none: do not attach a
881 NIC at all. This cannot be specified with any other nic value
882 and cannot be specified multiple times. net-id: attach NIC to
883 network with a specific UUID. net-name: attach NIC to network
884 with this name (either port-id or net-id or net-name must be
885 provided), v4-fixed-ip: IPv4 fixed address for NIC (optional),
886 v6-fixed-ip: IPv6 fixed address for NIC (optional), port-id: at‐
887 tach NIC to port with this UUID tag: interface metadata tag (op‐
888 tional) (either port-id or net-id must be provided). (Supported
889 by API versions '2.42' - '2.latest')
890 --config-drive <value>
892 Enable config drive. The value must be a boolean value.
893 --poll Report the new server boot progress until it completes.
895 --admin-pass <value>
897 Admin password for the instance.
898 --access-ip-v4 <value>
900 Alternative access IPv4 of the instance.
901 --access-ip-v6 <value>
903 Alternative access IPv6 of the instance.
904 --description <description>
906 Description for the server. (Supported by API versions '2.19' -
907 '2.latest')
908 --tags <tags>
910 Tags for the server.Tags must be separated by commas: --tags
911 <tag1,tag2> (Supported by API versions '2.52' - '2.latest')
912 --return-reservation-id
914 Return a reservation id bound to created servers.
915 --trusted-image-certificate-id <trusted-image-certificate-id>
917 Trusted image certificate IDs used to validate certificates dur‐
918 ing the image signature verification process. Defaults to
919 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
920 ple times to pass multiple trusted image certificate IDs. (Sup‐
921 ported by API versions '2.63' - '2.latest')
922 --host <host>
924 Requested host to create servers. Admin only by default. (Sup‐
925 ported by API versions '2.74' - '2.latest')
926 --hypervisor-hostname <hypervisor-hostname>
928 Requested hypervisor hostname to create servers. Admin only by
929 default. (Supported by API versions '2.74' - '2.latest')
930 --hostname <hostname>
932 Hostname for the instance. This sets the hostname stored in the
933 metadata server: a utility such as cloud-init running on the
934 guest is required to propagate these changes to the guest.
935 (Supported by API versions '2.90' - '2.latest')
936 nova clear-password
938 usage: nova clear-password <server>
939 Clear the admin password for a server from the metadata server. This
941 action does not actually change the instance server password.
942 Positional arguments:
944 <server>
946 Name or ID of server.
947 nova console-log
949 usage: nova console-log [--length <length>] <server>
950 Get console log output of a server.
952 Locale encoding issues
954 If you encounter an error such as:
956 UnicodeEncodeError: 'ascii' codec can't encode characters in position
958 The solution to these problems is different depending on which locale
960 your computer is running in.
961 For instance, if you have a German Linux machine, you can fix the prob‐
963 lem by exporting the locale to de_DE.utf-8:
964 export LC_ALL=de_DE.utf-8
966 export LANG=de_DE.utf-8
967 If you are on a US machine, en_US.utf-8 is the encoding of choice. On
969 some newer Linux systems, you could also try C.UTF-8 as the locale:
970 export LC_ALL=C.UTF-8
972 export LANG=C.UTF-8
973 Positional arguments:
975 <server>
977 Name or ID of server.
978 Optional arguments:
980 --length <length>
982 Length in lines to tail.
983 nova delete
985 usage: nova delete [--all-tenants] <server> [<server> ...]
986 Immediately shut down and delete specified server(s).
988 Positional arguments:
990 <server>
992 Name or ID of server(s).
993 Optional arguments:
995 --all-tenants
997 Delete server(s) in another tenant by name (Admin only).
998 nova diagnostics
1000 usage: nova diagnostics <server>
1001 Retrieve server diagnostics.
1003 Positional arguments:
1005 <server>
1007 Name or ID of server.
1008 nova evacuate
1010 usage: nova evacuate [--password <password>] [--on-shared-storage] [--force] <server> [<host>]
1011 Evacuate server from failed host.
1013 Positional arguments:
1015 <server>
1017 Name or ID of server.
1018 <host> Name or ID of the target host. If no host is specified, the
1020 scheduler will choose one.
1021 Optional arguments:
1023 --password <password>
1025 Set the provided admin password on the evacuated server. Not ap‐
1026 plicable if the server is on shared storage.
1027 --on-shared-storage
1029 Specifies whether server files are located on shared storage.
1030 (Supported by API versions '2.0' - '2.13')
1031 --force
1033 Force an evacuation by not verifying the provided destination
1034 host by the scheduler. (Supported by API versions '2.29' -
1035 '2.67')
1036 WARNING:
1038 This could result in failures to actually evacuate the server
1039 to the specified host. It is recommended to either not spec‐
1040 ify a host so that the scheduler will pick one, or specify a
1041 host without --force.
1042 nova flavor-access-add
1044 usage: nova flavor-access-add <flavor> <tenant_id>
1045 Add flavor access for the given tenant.
1047 Positional arguments:
1049 <flavor>
1051 Flavor name or ID to add access for the given tenant.
1052 <tenant_id>
1054 Tenant ID to add flavor access for.
1055 nova flavor-access-list
1057 usage: nova flavor-access-list [--flavor <flavor>]
1058 Print access information about the given flavor.
1060 Optional arguments:
1062 --flavor <flavor>
1064 Filter results by flavor name or ID.
1065 nova flavor-access-remove
1067 usage: nova flavor-access-remove <flavor> <tenant_id>
1068 Remove flavor access for the given tenant.
1070 Positional arguments:
1072 <flavor>
1074 Flavor name or ID to remove access for the given tenant.
1075 <tenant_id>
1077 Tenant ID to remove flavor access for.
1078 nova flavor-create
1080 usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
1081 [--rxtx-factor <factor>] [--is-public <is-public>]
1082 [--description <description>]
1083 <name> <id> <ram> <disk> <vcpus>
1084 Create a new flavor.
1086 Positional arguments:
1088 <name> Unique name of the new flavor.
1090 <id> Unique ID of the new flavor. Specifying 'auto' will generated a
1092 UUID for the ID.
1093 <ram> Memory size in MiB.
1095 <disk> Disk size in GiB.
1097 <vcpus>
1099 Number of vcpus
1100 Optional arguments:
1102 --ephemeral <ephemeral>
1104 Ephemeral space size in GiB (default 0).
1105 --swap <swap>
1107 Swap space size in MiB (default 0).
1108 --rxtx-factor <factor>
1110 RX/TX factor (default 1).
1111 --is-public <is-public>
1113 Make flavor accessible to the public (default true).
1114 --description <description>
1116 A free form description of the flavor. Limited to 65535 charac‐
1117 ters in length. Only printable characters are allowed. (Sup‐
1118 ported by API versions '2.55' - '2.latest')
1119 nova flavor-delete
1121 usage: nova flavor-delete <flavor>
1122 Delete a specific flavor
1124 Positional arguments:
1126 <flavor>
1128 Name or ID of the flavor to delete.
1129 nova flavor-key
1131 usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
1132 Set or unset extra_spec for a flavor.
1134 Positional arguments:
1136 <flavor>
1138 Name or ID of flavor.
1139 <action>
1141 Actions: 'set' or 'unset'.
1142 <key=value>
1144 Extra_specs to set/unset (only key is necessary on unset).
1145 nova flavor-list
1147 usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
1148 [--min-disk <min-disk>] [--min-ram <min-ram>]
1149 [--limit <limit>] [--sort-key <sort-key>]
1150 [--sort-dir <sort-dir>]
1151 Print a list of available 'flavors' (sizes of servers).
1153 Optional arguments:
1155 --extra-specs
1157 Get extra-specs of each flavor.
1158 --all Display all flavors (Admin only).
1160 --marker <marker>
1162 The last flavor ID of the previous page; displays list of fla‐
1163 vors after "marker".
1164 --min-disk <min-disk>
1166 Filters the flavors by a minimum disk space, in GiB.
1167 --min-ram <min-ram>
1169 Filters the flavors by a minimum RAM, in MiB.
1170 --limit <limit>
1172 Maximum number of flavors to display. If limit is bigger than
1173 'CONF.api.max_limit' option of Nova API, limit
1174 'CONF.api.max_limit' will be used instead.
1175 --sort-key <sort-key>
1177 Flavors list sort key.
1178 --sort-dir <sort-dir>
1180 Flavors list sort direction.
1181 nova flavor-show
1183 usage: nova flavor-show <flavor>
1184 Show details about the given flavor.
1186 Positional arguments:
1188 <flavor>
1190 Name or ID of flavor.
1191 nova flavor-update
1193 usage: nova flavor-update <flavor> <description>
1194 Update the description of an existing flavor. (Supported by API ver‐
1196 sions '2.55' - '2.latest') [hint: use '--os-compute-api-version' flag
1197 to show help message for proper version]
1198 New in version 10.0.0.
1200 Positional arguments
1203 <flavor>
1205 Name or ID of the flavor to update.
1206 <description>
1208 A free form description of the flavor. Limited to 65535 charac‐
1209 ters in length. Only printable characters are allowed.
1210 nova force-delete
1212 usage: nova force-delete <server>
1213 Force delete a server.
1215 Positional arguments:
1217 <server>
1219 Name or ID of server.
1220 nova get-mks-console
1222 usage: nova get-mks-console <server>
1223 Get an MKS console to a server. (Supported by API versions '2.8' -
1225 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1226 message for proper version]
1227 New in version 3.0.0.
1229 Positional arguments:
1232 <server>
1234 Name or ID of server.
1235 nova get-password
1237 usage: nova get-password <server> [<private-key>]
1238 Get the admin password for a server. This operation calls the metadata
1240 service to query metadata information and does not read password infor‐
1241 mation from the server itself.
1242 Positional arguments:
1244 <server>
1246 Name or ID of server.
1247 <private-key>
1249 Private key (used locally to decrypt password) (Optional). When
1250 specified, the command displays the clear (decrypted) VM pass‐
1251 word. When not specified, the ciphered VM password is displayed.
1252 nova get-rdp-console
1254 usage: nova get-rdp-console <server> <console-type>
1255 Get a rdp console to a server.
1257 Positional arguments:
1259 <server>
1261 Name or ID of server.
1262 <console-type>
1264 Type of rdp console ("rdp-html5").
1265 nova get-serial-console
1267 usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>
1268 Get a serial console to a server.
1270 Positional arguments:
1272 <server>
1274 Name or ID of server.
1275 Optional arguments:
1277 --console-type CONSOLE_TYPE
1279 Type of serial console, default="serial".
1280 nova get-spice-console
1282 usage: nova get-spice-console <server> <console-type>
1283 Get a spice console to a server.
1285 Positional arguments:
1287 <server>
1289 Name or ID of server.
1290 <console-type>
1292 Type of spice console ("spice-html5").
1293 nova get-vnc-console
1295 usage: nova get-vnc-console <server> <console-type>
1296 Get a vnc console to a server.
1298 Positional arguments:
1300 <server>
1302 Name or ID of server.
1303 <console-type>
1305 Type of vnc console ("novnc" or "xvpvnc").
1306 nova host-evacuate
1308 usage: nova host-evacuate [--target_host <target_host>] [--force] [--strict]
1309 <host>
1310 Evacuate all instances from failed host.
1312 Positional arguments:
1314 <host> The hypervisor hostname (or pattern) to search for.
1316 WARNING:
1318 Use a fully qualified domain name if you only want to evacu‐
1319 ate from a specific host.
1320 Optional arguments:
1322 --target_host <target_host>
1324 Name of target host. If no host is specified the scheduler will
1325 select a target.
1326 --force
1328 Force an evacuation by not verifying the provided destination
1329 host by the scheduler. (Supported by API versions '2.29' -
1330 '2.67')
1331 WARNING:
1333 This could result in failures to actually evacuate the server
1334 to the specified host. It is recommended to either not spec‐
1335 ify a host so that the scheduler will pick one, or specify a
1336 host without --force.
1337 --strict
1339 Evacuate host with exact hypervisor hostname match
1340 nova host-evacuate-live
1342 usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
1343 [--max-servers <max_servers>] [--force]
1344 [--strict]
1345 <host>
1346 Live migrate all instances off the specified host to other available
1348 hosts.
1349 Positional arguments:
1351 <host> Name of host. The hypervisor hostname (or pattern) to search
1353 for.
1354 WARNING:
1356 Use a fully qualified domain name if you only want to live
1357 migrate from a specific host.
1358 Optional arguments:
1360 --target-host <target_host>
1362 Name of target host. If no host is specified, the scheduler will
1363 choose one.
1364 --block-migrate
1366 Enable block migration. (Default=auto) (Supported by API ver‐
1367 sions '2.25' - '2.latest')
1368 --max-servers <max_servers>
1370 Maximum number of servers to live migrate simultaneously
1371 --force
1373 Force a live-migration by not verifying the provided destination
1374 host by the scheduler. (Supported by API versions '2.30' -
1375 '2.67')
1376 WARNING:
1378 This could result in failures to actually live migrate the
1379 servers to the specified host. It is recommended to either
1380 not specify a host so that the scheduler will pick one, or
1381 specify a host without --force.
1382 --strict
1384 live Evacuate host with exact hypervisor hostname match
1385 nova host-meta
1387 usage: nova host-meta [--strict] <host> <action> <key=value> [<key=value> ...]
1388 Set or Delete metadata on all instances of a host.
1390 Positional arguments:
1392 <host> The hypervisor hostname (or pattern) to search for.
1394 WARNING:
1396 Use a fully qualified domain name if you only want to update
1397 metadata for servers on a specific host.
1398 <action>
1400 Actions: 'set' or 'delete'
1401 <key=value>
1403 Metadata to set or delete (only key is necessary on delete)
1404 Optional arguments:
1406 --strict
1408 Set host-meta to the hypervisor with exact hostname match
1409 nova host-servers-migrate
1411 usage: nova host-servers-migrate [--strict] <host>
1412 Cold migrate all instances off the specified host to other available
1414 hosts.
1415 Positional arguments:
1417 <host> Name of host. The hypervisor hostname (or pattern) to search
1419 for.
1420 WARNING:
1422 Use a fully qualified domain name if you only want to cold
1423 migrate from a specific host.
1424 Optional arguments:
1426 --strict
1428 Migrate host with exact hypervisor hostname match
1429 nova hypervisor-list
1431 usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
1432 [--limit <limit>]
1433 List hypervisors. (Supported by API versions '2.0' - '2.latest') [hint:
1435 use '--os-compute-api-version' flag to show help message for proper
1436 version]
1437 Optional arguments:
1439 --matching <hostname>
1441 List hypervisors matching the given <hostname>. If matching is
1442 used limit and marker options will be ignored.
1443 --marker <marker>
1445 The last hypervisor of the previous page; displays list of hy‐
1446 pervisors after "marker". (Supported by API versions '2.33' -
1447 '2.latest')
1448 --limit <limit>
1450 Maximum number of hypervisors to display. If limit is bigger
1451 than 'CONF.api.max_limit' option of Nova API, limit
1452 'CONF.api.max_limit' will be used instead. (Supported by API
1453 versions '2.33' - '2.latest')
1454 nova hypervisor-servers
1456 usage: nova hypervisor-servers <hostname>
1457 List servers belonging to specific hypervisors.
1459 Positional arguments:
1461 <hostname>
1463 The hypervisor hostname (or pattern) to search for.
1464 nova hypervisor-show
1466 usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
1467 Display the details of the specified hypervisor.
1469 Positional arguments:
1471 <hypervisor>
1473 Name or ID of the hypervisor. Starting with microversion 2.53
1474 the ID must be a UUID.
1475 Optional arguments:
1477 --wrap <integer>
1479 Wrap the output to a specified length. Default is 40 or 0 to
1480 disable
1481 nova hypervisor-stats
1483 usage: nova hypervisor-stats
1484 Get hypervisor statistics over all compute nodes.
1486 nova hypervisor-uptime
1488 usage: nova hypervisor-uptime <hypervisor>
1489 Display the uptime of the specified hypervisor.
1491 Positional arguments:
1493 <hypervisor>
1495 Name or ID of the hypervisor. Starting with microversion 2.53
1496 the ID must be a UUID.
1497 nova image-create
1499 usage: nova image-create [--metadata <key=value>] [--show] [--poll]
1500 <server> <name>
1501 Create a new image by taking a snapshot of a running server.
1503 Positional arguments:
1505 <server>
1507 Name or ID of server.
1508 <name> Name of snapshot.
1510 Optional arguments:
1512 --metadata <key=value>
1514 Record arbitrary key/value metadata to /meta_data.json on the
1515 metadata server. Can be specified multiple times.
1516 --show Print image info.
1518 --poll Report the snapshot progress and poll until image creation is
1520 complete.
1521 nova instance-action
1523 usage: nova instance-action <server> <request_id>
1524 Show an action.
1526 Positional arguments:
1528 <server>
1530 Name or UUID of the server to show actions for. Only UUID can be
1531 used to show actions for a deleted server. (Supported by API
1532 versions '2.21' - '2.latest')
1533 <request_id>
1535 Request ID of the action to get.
1536 nova instance-action-list
1538 usage: nova instance-action-list [--marker <marker>] [--limit <limit>]
1539 [--changes-since <changes_since>]
1540 [--changes-before <changes_before>]
1541 <server>
1542 List actions on a server.
1544 Positional arguments:
1546 <server>
1548 Name or UUID of the server to list actions for. Only UUID can be
1549 used to list actions on a deleted server. (Supported by API ver‐
1550 sions '2.21' - '2.latest')
1551 Optional arguments:
1553 --marker <marker>
1555 The last instance action of the previous page; displays list of
1556 actions after "marker". (Supported by API versions '2.58' -
1557 '2.latest')
1558 --limit <limit>
1560 Maximum number of instance actions to display. Note that there
1561 is a configurable max limit on the server, and the limit that is
1562 used will be the minimum of what is requested here and what is
1563 configured in the server. (Supported by API versions '2.58' -
1564 '2.latest')
1565 --changes-since <changes_since>
1567 List only instance actions changed later or equal to a certain
1568 point of time. The provided time should be an ISO 8061 formatted
1569 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1570 '2.58' - '2.latest')
1571 --changes-before <changes_before>
1573 List only instance actions changed earlier or equal to a certain
1574 point of time. The provided time should be an ISO 8061 formatted
1575 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1576 '2.66' - '2.latest')
1577 nova instance-usage-audit-log
1579 usage: nova instance-usage-audit-log [--before <before>]
1580 List/Get server usage audits.
1582 Optional arguments:
1584 --before <before>
1586 Filters the response by the date and time before which to list
1587 usage audits. The date and time stamp format is as follows:
1588 CCYY-MM-DD hh:mm:ss.NNNNNN ex 2015-08-27 09:49:58 or 2015-08-27
1589 09:49:58.123456.
1590 nova interface-attach
1592 usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
1593 [--fixed-ip <fixed_ip>] [--tag <tag>]
1594 <server>
1595 Attach a network interface to a server.
1597 Positional arguments:
1599 <server>
1601 Name or ID of server.
1602 Optional arguments:
1604 --port-id <port_id>
1606 Port ID.
1607 --net-id <net_id>
1609 Network ID
1610 --fixed-ip <fixed_ip>
1612 Requested fixed IP.
1613 --tag <tag>
1615 Tag for the attached interface. (Supported by API versions
1616 '2.49' - '2.latest')
1617 nova interface-detach
1619 usage: nova interface-detach <server> <port_id>
1620 Detach a network interface from a server.
1622 Positional arguments:
1624 <server>
1626 Name or ID of server.
1627 <port_id>
1629 Port ID.
1630 nova interface-list
1632 usage: nova interface-list <server>
1633 List interfaces attached to a server.
1635 Positional arguments:
1637 <server>
1639 Name or ID of server.
1640 nova keypair-add
1642 usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
1643 [--user <user-id>]
1644 <name>
1645 Create a new key pair for use with servers.
1647 Positional arguments:
1649 <name> Name of key.
1651 Optional arguments:
1653 --pub-key <pub-key>
1655 Path to a public ssh key.
1656 --key-type <key-type>
1658 Keypair type. Can be ssh or x509. (Supported by API versions
1659 '2.2' - '2.latest')
1660 --user <user-id>
1662 ID of user to whom to add key-pair (Admin only). (Supported by
1663 API versions '2.10' - '2.latest')
1664 nova keypair-delete
1666 usage: nova keypair-delete [--user <user-id>] <name>
1667 Delete keypair given by its name. (Supported by API versions '2.0' -
1669 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1670 message for proper version]
1671 Positional arguments:
1673 <name> Keypair name to delete.
1675 Optional arguments:
1677 --user <user-id>
1679 ID of key-pair owner (Admin only).
1680 nova keypair-list
1682 usage: nova keypair-list [--user <user-id>] [--marker <marker>]
1683 [--limit <limit>]
1684 Print a list of keypairs for a user (Supported by API versions '2.0' -
1686 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1687 message for proper version]
1688 Optional arguments:
1690 --user <user-id>
1692 List key-pairs of specified user ID (Admin only).
1693 --marker <marker>
1695 The last keypair of the previous page; displays list of keypairs
1696 after "marker".
1697 --limit <limit>
1699 Maximum number of keypairs to display. If limit is bigger than
1700 'CONF.api.max_limit' option of Nova API, limit
1701 'CONF.api.max_limit' will be used instead.
1702 nova keypair-show
1704 usage: nova keypair-show [--user <user-id>] <keypair>
1705 Show details about the given keypair. (Supported by API versions '2.0'
1707 - '2.latest') [hint: use '--os-compute-api-version' flag to show help
1708 message for proper version]
1709 Positional arguments:
1711 <keypair>
1713 Name of keypair.
1714 Optional arguments:
1716 --user <user-id>
1718 ID of key-pair owner (Admin only).
1719 nova limits
1721 usage: nova limits [--tenant [<tenant>]] [--reserved]
1722 Print rate and absolute limits.
1724 Optional arguments:
1726 --tenant [<tenant>]
1728 Display information from single tenant (Admin only).
1729 --reserved
1731 Include reservations count.
1732 nova list
1734 usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>]
1735 [--ip6 <ip6-regexp>] [--name <name-regexp>]
1736 [--status <status>] [--flavor <flavor>] [--image <image>]
1737 [--host <hostname>] [--all-tenants [<0|1>]]
1738 [--tenant [<tenant>]] [--user [<user>]] [--deleted]
1739 [--fields <fields>] [--minimal]
1740 [--sort <key>[:<direction>]] [--marker <marker>]
1741 [--limit <limit>] [--availability-zone <availability_zone>]
1742 [--key-name <key_name>] [--[no-]config-drive]
1743 [--progress <progress>] [--vm-state <vm_state>]
1744 [--task-state <task_state>] [--power-state <power_state>]
1745 [--changes-since <changes_since>]
1746 [--changes-before <changes_before>]
1747 [--tags <tags>] [--tags-any <tags-any>]
1748 [--not-tags <not-tags>] [--not-tags-any <not-tags-any>]
1749 [--locked]
1750 List servers.
1752 Note that from microversion 2.69, during partial infrastructure fail‐
1754 ures in the deployment, the output of this command may return partial
1755 results for the servers present in the failure domain.
1756 Optional arguments:
1758 --reservation-id <reservation-id>
1760 Only return servers that match reservation-id.
1761 --ip <ip-regexp>
1763 Search with regular expression match by IP address.
1764 --ip6 <ip6-regexp>
1766 Search with regular expression match by IPv6 address.
1767 --name <name-regexp>
1769 Search with regular expression match by name.
1770 --status <status>
1772 Search by server status.
1773 --flavor <flavor>
1775 Search by flavor name or ID.
1776 --image <image>
1778 Search by image name or ID.
1779 --host <hostname>
1781 Search servers by hostname to which they are assigned (Admin
1782 only).
1783 --all-tenants [<0|1>]
1785 Display information from all tenants (Admin only).
1786 --tenant [<tenant>]
1788 Display information from single tenant (Admin only).
1789 --user [<user>]
1791 Display information from single user (Admin only until microver‐
1792 sion 2.82).
1793 --deleted
1795 Only display deleted servers (Admin only).
1796 --fields <fields>
1798 Comma-separated list of fields to display. Use the show command
1799 to see which fields are available.
1800 --minimal
1802 Get only UUID and name.
1803 --sort <key>[:<direction>]
1805 Comma-separated list of sort keys and directions in the form of
1806 <key>[:<asc|desc>]. The direction defaults to descending if not
1807 specified.
1808 --marker <marker>
1810 The last server UUID of the previous page; displays list of
1811 servers after "marker".
1812 --limit <limit>
1814 Maximum number of servers to display. If limit == -1, all
1815 servers will be displayed. If limit is bigger than
1816 'CONF.api.max_limit' option of Nova API, limit
1817 'CONF.api.max_limit' will be used instead.
1818 --availability-zone <availability_zone>
1820 Display servers based on their availability zone (Admin only un‐
1821 til microversion 2.82).
1822 --key-name <key_name>
1824 Display servers based on their keypair name (Admin only until
1825 microversion 2.82).
1826 --config-drive
1828 Display servers that have a config drive attached. It is mutu‐
1829 ally exclusive with '--no-config-drive'. (Admin only until mi‐
1830 croversion 2.82).
1831 --no-config-drive
1833 Display servers that do not have a config drive attached. It is
1834 mutually exclusive with '--config-drive'. (Admin only until mi‐
1835 croversion 2.82).
1836 --progress <progress>
1838 Display servers based on their progress value (Admin only until
1839 microversion 2.82).
1840 --vm-state <vm_state>
1842 Display servers based on their vm_state value (Admin only until
1843 microversion 2.82).
1844 --task-state <task_state>
1846 Display servers based on their task_state value (Admin only un‐
1847 til microversion 2.82).
1848 --power-state <power_state>
1850 Display servers based on their power_state value (Admin only un‐
1851 til microversion 2.82).
1852 --changes-since <changes_since>
1854 List only servers changed later or equal to a certain point of
1855 time. The provided time should be an ISO 8061 formatted time.
1856 e.g. 2016-03-04T06:27:59Z .
1857 --changes-before <changes_before>
1859 List only servers changed earlier or equal to a certain point of
1860 time. The provided time should be an ISO 8061 formatted time.
1861 e.g. 2016-03-05T06:27:59Z . (Supported by API versions '2.66' -
1862 '2.latest')
1863 --tags <tags>
1865 The given tags must all be present for a server to be included
1866 in the list result. Boolean expression in this case is 't1 AND
1867 t2'. Tags must be separated by commas: --tags <tag1,tag2> (Sup‐
1868 ported by API versions '2.26' - '2.latest')
1869 --tags-any <tags-any>
1871 If one of the given tags is present the server will be included
1872 in the list result. Boolean expression in this case is 't1 OR
1873 t2'. Tags must be separated by commas: --tags-any <tag1,tag2>
1874 (Supported by API versions '2.26' - '2.latest')
1875 --not-tags <not-tags>
1877 Only the servers that do not have any of the given tags will be
1878 included in the list results. Boolean expression in this case is
1879 'NOT(t1 AND t2)'. Tags must be separated by commas: --not-tags
1880 <tag1,tag2> (Supported by API versions '2.26' - '2.latest')
1881 --not-tags-any <not-tags-any>
1883 Only the servers that do not have at least one of the given tags
1884 will be included in the list result. Boolean expression in this
1885 case is 'NOT(t1 OR t2)'. Tags must be separated by commas:
1886 --not-tags-any <tag1,tag2> (Supported by API versions '2.26' -
1887 '2.latest')
1888 --locked <locked>
1890 Display servers based on their locked value. A value must be
1891 specified; eg. 'true' will list only locked servers and 'false'
1892 will list only unlocked servers. (Supported by API versions
1893 '2.73' - '2.latest')
1894 nova list-secgroup
1896 usage: nova list-secgroup <server>
1897 List Security Group(s) of a server.
1899 Positional arguments:
1901 <server>
1903 Name or ID of server.
1904 nova live-migration
1906 usage: nova live-migration [--block-migrate] [--force] <server> [<host>]
1907 Migrate running server to a new machine.
1909 Positional arguments:
1911 <server>
1913 Name or ID of server.
1914 <host> Destination host name. If no host is specified, the scheduler
1916 will choose one.
1917 Optional arguments:
1919 --block-migrate
1921 True in case of block_migration. (Default=auto:live_migration)
1922 (Supported by API versions '2.25' - '2.latest')
1923 --force
1925 Force a live-migration by not verifying the provided destination
1926 host by the scheduler. (Supported by API versions '2.30' -
1927 '2.67')
1928 WARNING:
1930 This could result in failures to actually live migrate the
1931 server to the specified host. It is recommended to either not
1932 specify a host so that the scheduler will pick one, or spec‐
1933 ify a host without --force.
1934 nova live-migration-abort
1936 usage: nova live-migration-abort <server> <migration>
1937 Abort an on-going live migration. (Supported by API versions '2.24' -
1939 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1940 message for proper version]
1941 For microversions from 2.24 to 2.64 the migration status must be run‐
1943 ning; for microversion 2.65 and greater, the migration status can also
1944 be queued and preparing.
1945 New in version 3.3.0.
1947 Positional arguments:
1950 <server>
1952 Name or ID of server.
1953 <migration>
1955 ID of migration.
1956 nova live-migration-force-complete
1958 usage: nova live-migration-force-complete <server> <migration>
1959 Force on-going live migration to complete. (Supported by API versions
1961 '2.22' - '2.latest') [hint: use '--os-compute-api-version' flag to show
1962 help message for proper version]
1963 New in version 3.3.0.
1965 Positional arguments:
1968 <server>
1970 Name or ID of server.
1971 <migration>
1973 ID of migration.
1974 nova lock
1976 usage: nova lock [--reason <reason>] <server>
1977 Lock a server. A normal (non-admin) user will not be able to execute
1979 actions on a locked server.
1980 Positional arguments:
1982 <server>
1984 Name or ID of server.
1985 Optional arguments:
1987 --reason <reason>
1989 Reason for locking the server. (Supported by API versions '2.73'
1990 - '2.latest')
1991 nova meta
1993 usage: nova meta <server> <action> <key=value> [<key=value> ...]
1994 Set or delete metadata on a server.
1996 Positional arguments:
1998 <server>
2000 Name or ID of server.
2001 <action>
2003 Actions: 'set' or 'delete'.
2004 <key=value>
2006 Metadata to set or delete (only key is necessary on delete).
2007 nova migrate
2009 usage: nova migrate [--host <host>] [--poll] <server>
2010 Migrate a server. The new host will be selected by the scheduler.
2012 Positional arguments:
2014 <server>
2016 Name or ID of server.
2017 Optional arguments:
2019 --host <host>
2021 Destination host name. (Supported by API versions '2.56' -
2022 '2.latest')
2023 --poll Report the server migration progress until it completes.
2025 nova migration-list
2027 usage: nova migration-list [--instance-uuid <instance_uuid>]
2028 [--host <host>]
2029 [--status <status>]
2030 [--migration-type <migration_type>]
2031 [--source-compute <source_compute>]
2032 [--marker <marker>]
2033 [--limit <limit>]
2034 [--changes-since <changes_since>]
2035 [--changes-before <changes_before>]
2036 [--project-id <project_id>]
2037 [--user-id <user_id>]
2038 Print a list of migrations.
2040 Examples
2042 To see the list of evacuation operations from a compute service host:
2044 nova migration-list --migration-type evacuation --source-compute host.foo.bar
2046 Optional arguments:
2048 --instance-uuid <instance_uuid>
2050 Fetch migrations for the given instance.
2051 --host <host>
2053 Fetch migrations for the given source or destination host.
2054 --status <status>
2056 Fetch migrations for the given status.
2057 --migration-type <migration_type>
2059 Filter migrations by type. Valid values are:
2060 • evacuation
2062 • live-migration
2064 • migration
2066 NOTE:
2068 This is a cold migration.
2069 • resize
2071 --source-compute <source_compute>
2073 Filter migrations by source compute host name.
2074 --marker <marker>
2076 The last migration of the previous page; displays list of migra‐
2077 tions after "marker". Note that the marker is the migration
2078 UUID. (Supported by API versions '2.59' - '2.latest')
2079 --limit <limit>
2081 Maximum number of migrations to display. Note that there is a
2082 configurable max limit on the server, and the limit that is used
2083 will be the minimum of what is requested here and what is con‐
2084 figured in the server. (Supported by API versions '2.59' -
2085 '2.latest')
2086 --changes-since <changes_since>
2088 List only migrations changed later or equal to a certain point
2089 of time. The provided time should be an ISO 8061 formatted time.
2090 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.59' -
2091 '2.latest')
2092 --changes-before <changes_before>
2094 List only migrations changed earlier or equal to a certain point
2095 of time. The provided time should be an ISO 8061 formatted time.
2096 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.66' -
2097 '2.latest')
2098 --project-id <project_id>
2100 Filter the migrations by the given project ID. (Supported by
2101 API versions '2.80' - '2.latest')
2102 --user-id <user_id>
2104 Filter the migrations by the given user ID. (Supported by API
2105 versions '2.80' - '2.latest')
2106 nova pause
2108 usage: nova pause <server>
2109 Pause a server.
2111 Positional arguments:
2113 <server>
2115 Name or ID of server.
2116 nova quota-class-show
2118 usage: nova quota-class-show <class>
2119 List the quotas for a quota class.
2121 Positional arguments:
2123 <class>
2125 Name of quota class to list the quotas for.
2126 nova quota-class-update
2128 usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
2129 [--ram <ram>]
2130 [--metadata-items <metadata-items>]
2131 [--key-pairs <key-pairs>]
2132 [--server-groups <server-groups>]
2133 [--server-group-members <server-group-members>]
2134 <class>
2135 Update the quotas for a quota class. (Supported by API versions '2.0' -
2137 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2138 message for proper version]
2139 Positional arguments:
2141 <class>
2143 Name of quota class to set the quotas for.
2144 Optional arguments:
2146 --instances <instances>
2148 New value for the "instances" quota.
2149 --cores <cores>
2151 New value for the "cores" quota.
2152 --ram <ram>
2154 New value for the "ram" quota.
2155 --metadata-items <metadata-items>
2157 New value for the "metadata-items" quota.
2158 --key-pairs <key-pairs>
2160 New value for the "key-pairs" quota.
2161 --server-groups <server-groups>
2163 New value for the "server-groups" quota.
2164 --server-group-members <server-group-members>
2166 New value for the "server-group-members" quota.
2167 nova quota-defaults
2169 usage: nova quota-defaults [--tenant <tenant-id>]
2170 List the default quotas for a tenant.
2172 Optional arguments:
2174 --tenant <tenant-id>
2176 ID of tenant to list the default quotas for.
2177 nova quota-delete
2179 usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
2180 Delete quota for a tenant/user so their quota will Revert back to de‐
2182 fault.
2183 Optional arguments:
2185 --tenant <tenant-id>
2187 ID of tenant to delete quota for.
2188 --user <user-id>
2190 ID of user to delete quota for.
2191 nova quota-show
2193 usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]
2194 List the quotas for a tenant/user.
2196 Optional arguments:
2198 --tenant <tenant-id>
2200 ID of tenant to list the quotas for.
2201 --user <user-id>
2203 ID of user to list the quotas for.
2204 --detail
2206 Show detailed info (limit, reserved, in-use).
2207 nova quota-update
2209 usage: nova quota-update [--user <user-id>] [--instances <instances>]
2210 [--cores <cores>] [--ram <ram>]
2211 [--metadata-items <metadata-items>]
2212 [--key-pairs <key-pairs>]
2213 [--server-groups <server-groups>]
2214 [--server-group-members <server-group-members>]
2215 [--force]
2216 <tenant-id>
2217 Update the quotas for a tenant/user. (Supported by API versions '2.0' -
2219 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2220 message for proper version]
2221 Positional arguments:
2223 <tenant-id>
2225 ID of tenant to set the quotas for.
2226 Optional arguments:
2228 --user <user-id>
2230 ID of user to set the quotas for.
2231 --instances <instances>
2233 New value for the "instances" quota.
2234 --cores <cores>
2236 New value for the "cores" quota.
2237 --ram <ram>
2239 New value for the "ram" quota.
2240 --metadata-items <metadata-items>
2242 New value for the "metadata-items" quota.
2243 --key-pairs <key-pairs>
2245 New value for the "key-pairs" quota.
2246 --server-groups <server-groups>
2248 New value for the "server-groups" quota.
2249 --server-group-members <server-group-members>
2251 New value for the "server-group-members" quota.
2252 --force
2254 Whether force update the quota even if the already used and re‐
2255 served exceeds the new quota.
2256 nova reboot
2258 usage: nova reboot [--hard] [--poll] <server> [<server> ...]
2259 Reboot a server.
2261 Positional arguments:
2263 <server>
2265 Name or ID of server(s).
2266 Optional arguments:
2268 --hard Perform a hard reboot (instead of a soft one). Note: Ironic does
2270 not currently support soft reboot; consequently, bare metal
2271 nodes will always do a hard reboot, regardless of the use of
2272 this option.
2273 --poll Poll until reboot is complete.
2275 nova rebuild
2277 usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
2278 [--minimal] [--preserve-ephemeral] [--name <name>]
2279 [--description <description>] [--meta <key=value>]
2280 [--key-name <key-name>] [--key-unset]
2281 [--user-data <user-data>] [--user-data-unset]
2282 [--trusted-image-certificate-id <trusted-image-certificate-id>]
2283 [--trusted-image-certificates-unset]
2284 [--hostname <hostname>]
2285 <server> <image>
2286 Shutdown, re-image, and re-boot a server.
2288 Positional arguments:
2290 <server>
2292 Name or ID of server.
2293 <image>
2295 Name or ID of new image.
2296 Optional arguments:
2298 --rebuild-password <rebuild-password>
2300 Set the provided admin password on the rebuilt server.
2301 --poll Report the server rebuild progress until it completes.
2303 --minimal
2305 Skips flavor/image lookups when showing servers.
2306 --preserve-ephemeral
2308 Preserve the default ephemeral storage partition on rebuild.
2309 --name <name>
2311 Name for the new server.
2312 --description <description>
2314 New description for the server. (Supported by API versions
2315 '2.19' - '2.latest')
2316 --meta <key=value>
2318 Record arbitrary key/value metadata to /meta_data.json on the
2319 metadata server. Can be specified multiple times.
2320 --key-name <key-name>
2322 Keypair name to set in the server. Cannot be specified with the
2323 '--key-unset' option. (Supported by API versions '2.54' -
2324 '2.latest')
2325 --key-unset
2327 Unset keypair in the server. Cannot be specified with the
2328 '--key-name' option. (Supported by API versions '2.54' -
2329 '2.latest')
2330 --user-data <user-data>
2332 User data file to pass to be exposed by the metadata server.
2333 (Supported by API versions '2.57' - '2.latest')
2334 --user-data-unset
2336 Unset user_data in the server. Cannot be specified with the
2337 '--user-data' option. (Supported by API versions '2.57' -
2338 '2.latest')
2339 --trusted-image-certificate-id <trusted-image-certificate-id>
2341 Trusted image certificate IDs used to validate certificates dur‐
2342 ing the image signature verification process. Defaults to
2343 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
2344 ple times to pass multiple trusted image certificate IDs. (Sup‐
2345 ported by API versions '2.63' - '2.latest')
2346 --trusted-image-certificates-unset
2348 Unset trusted_image_certificates in the server. Cannot be speci‐
2349 fied with the --trusted-image-certificate-id option. (Supported
2350 by API versions '2.63' - '2.latest')
2351 --hostname <hostname>
2353 New hostname for the instance. This only updates the hostname
2354 stored in the metadata server: a utility running on the guest is
2355 required to propagate these changes to the guest. (Supported by
2356 API versions '2.90' - '2.latest')
2357 nova refresh-network
2359 usage: nova refresh-network <server>
2360 Refresh server network information.
2362 Positional arguments:
2364 <server>
2366 Name or ID of a server for which the network cache should be re‐
2367 freshed from neutron (Admin only).
2368 nova remove-secgroup
2370 usage: nova remove-secgroup <server> <secgroup>
2371 Remove a Security Group from a server.
2373 Positional arguments:
2375 <server>
2377 Name or ID of server.
2378 <secgroup>
2380 Name of Security Group.
2381 nova rescue
2383 usage: nova rescue [--password <password>] [--image <image>] <server>
2384 Reboots a server into rescue mode, which starts the machine from either
2386 the initial image or a specified image, attaching the current boot disk
2387 as secondary.
2388 Positional arguments:
2390 <server>
2392 Name or ID of server.
2393 Optional arguments:
2395 --password <password>
2397 The admin password to be set in the rescue environment.
2398 --image <image>
2400 The image to rescue with.
2401 nova reset-network
2403 usage: nova reset-network <server>
2404 Reset network of a server.
2406 Positional arguments:
2408 <server>
2410 Name or ID of server.
2411 nova reset-state
2413 usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]
2414 Reset the state of a server.
2416 Positional arguments:
2418 <server>
2420 Name or ID of server(s).
2421 Optional arguments:
2423 --all-tenants
2425 Reset state server(s) in another tenant by name (Admin only).
2426 --active
2428 Request the server be reset to "active" state instead of "error"
2429 state (the default).
2430 nova resize
2432 usage: nova resize [--poll] <server> <flavor>
2433 Resize a server.
2435 Positional arguments:
2437 <server>
2439 Name or ID of server.
2440 <flavor>
2442 Name or ID of new flavor.
2443 Optional arguments:
2445 --poll Report the server resize progress until it completes.
2447 nova resize-confirm
2449 usage: nova resize-confirm <server>
2450 Confirm a previous resize.
2452 Positional arguments:
2454 <server>
2456 Name or ID of server.
2457 nova resize-revert
2459 usage: nova resize-revert <server>
2460 Revert a previous resize (and return to the previous VM).
2462 Positional arguments:
2464 <server>
2466 Name or ID of server.
2467 nova restore
2469 usage: nova restore <server>
2470 Restore a soft-deleted server.
2472 Positional arguments:
2474 <server>
2476 Name or ID of server.
2477 nova resume
2479 usage: nova resume <server>
2480 Resume a server.
2482 Positional arguments:
2484 <server>
2486 Name or ID of server.
2487 nova server-group-create
2489 usage: nova server-group-create [--rules <key=value>] <name> <policy>
2490 Create a new server group with the specified details.
2492 Positional arguments:
2494 <name> Server group name.
2496 <policy>
2498 Policy for the server groups.
2499 Optional arguments:
2501 --rule Policy rules for the server groups. (Supported by API versions
2503 '2.64' - '2.latest'）. Currently, only the max_server_per_host
2504 rule is supported for the anti-affinity policy. The
2505 max_server_per_host rule allows specifying how many members of
2506 the anti-affinity group can reside on the same compute host. If
2507 not specified, only one member from the same anti-affinity group
2508 can reside on a given host.
2509 nova server-group-delete
2511 usage: nova server-group-delete <id> [<id> ...]
2512 Delete specific server group(s).
2514 Positional arguments:
2516 <id> Unique ID(s) of the server group to delete.
2518 nova server-group-get
2520 usage: nova server-group-get <id>
2521 Get a specific server group.
2523 Positional arguments:
2525 <id> Unique ID of the server group to get.
2527 nova server-group-list
2529 usage: nova server-group-list [--limit <limit>] [--offset <offset>]
2530 [--all-projects]
2531 Print a list of all server groups.
2533 Optional arguments:
2535 --limit <limit>
2537 Maximum number of server groups to display. If limit is bigger
2538 than 'CONF.api.max_limit' option of Nova API, limit
2539 'CONF.api.max_limit' will be used instead.
2540 --offset <offset>
2542 The offset of groups list to display; use with limit to return a
2543 slice of server groups.
2544 --all-projects
2546 Display server groups from all projects (Admin only).
2547 nova server-migration-list
2549 usage: nova server-migration-list <server>
2550 Get the migrations list of specified server. (Supported by API versions
2552 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2553 help message for proper version]
2554 New in version 3.3.0.
2556 Positional arguments:
2559 <server>
2561 Name or ID of server.
2562 nova server-migration-show
2564 usage: nova server-migration-show <server> <migration>
2565 Get the migration of specified server. (Supported by API versions
2567 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2568 help message for proper version]
2569 New in version 3.3.0.
2571 Positional arguments:
2574 <server>
2576 Name or ID of server.
2577 <migration>
2579 ID of migration.
2580 nova server-tag-add
2582 usage: nova server-tag-add <server> <tag> [<tag> ...]
2583 Add one or more tags to a server. (Supported by API versions '2.26' -
2585 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2586 message for proper version]
2587 New in version 4.1.0.
2589 Positional arguments:
2592 <server>
2594 Name or ID of server.
2595 <tag> Tag(s) to add.
2597 nova server-tag-delete
2599 usage: nova server-tag-delete <server> <tag> [<tag> ...]
2600 Delete one or more tags from a server. (Supported by API versions
2602 '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2603 help message for proper version]
2604 New in version 4.1.0.
2606 Positional arguments:
2609 <server>
2611 Name or ID of server.
2612 <tag> Tag(s) to delete.
2614 nova server-tag-delete-all
2616 usage: nova server-tag-delete-all <server>
2617 Delete all tags from a server. (Supported by API versions '2.26' -
2619 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2620 message for proper version]
2621 New in version 4.1.0.
2623 Positional arguments:
2626 <server>
2628 Name or ID of server.
2629 nova server-tag-list
2631 usage: nova server-tag-list <server>
2632 Get list of tags from a server. (Supported by API versions '2.26' -
2634 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2635 message for proper version]
2636 New in version 4.1.0.
2638 Positional arguments:
2641 <server>
2643 Name or ID of server.
2644 nova server-tag-set
2646 usage: nova server-tag-set <server> <tags> [<tags> ...]
2647 Set list of tags to a server. (Supported by API versions '2.26' -
2649 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2650 message for proper version]
2651 New in version 4.1.0.
2653 Positional arguments:
2656 <server>
2658 Name or ID of server.
2659 <tags> Tag(s) to set.
2661 nova server-topology
2663 usage: nova server-topology <server>
2664 Retrieve server NUMA topology information. Host specific fields are
2666 only visible to users with the administrative role. (Supported by API
2667 versions '2.78' - '2.latest')
2668 New in version 15.1.0.
2670 Positional arguments:
2673 <server>
2675 Name or ID of server.
2676 nova service-delete
2678 usage: nova service-delete <id>
2679 Delete the service.
2681 IMPORTANT:
2683 If deleting a nova-compute service, be sure to stop the actual
2684 nova-compute process on the physical host before deleting the ser‐
2685 vice with this command. Failing to do so can lead to the running
2686 service re-creating orphaned compute_nodes table records in the
2687 database.
2688 Positional arguments:
2690 <id> ID of service as a UUID. (Supported by API versions '2.53' -
2692 '2.latest')
2693 nova service-disable
2695 usage: nova service-disable [--reason <reason>] <id>
2696 Disable the service.
2698 Positional arguments:
2700 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2702 '2.latest')
2703 Optional arguments:
2705 --reason <reason>
2707 Reason for disabling the service.
2708 nova service-enable
2710 usage: nova service-enable <id>
2711 Enable the service.
2713 Positional arguments:
2715 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2717 '2.latest')
2718 nova service-force-down
2720 usage: nova service-force-down [--unset] <id>
2721 Force service to down. (Supported by API versions '2.11' - '2.latest')
2723 [hint: use '--os-compute-api-version' flag to show help message for
2724 proper version]
2725 New in version 2.27.0.
2727 Positional arguments:
2730 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2732 '2.latest')
2733 Optional arguments:
2735 --unset
2737 Unset the forced_down state of the service.
2738 nova service-list
2740 usage: nova service-list [--host <hostname>] [--binary <binary>]
2741 Show a list of all running services. Filter by host & binary.
2743 Note that from microversion 2.69, during partial infrastructure fail‐
2745 ures in the deployment, the output of this command may return partial
2746 results for the services present in the failure domain.
2747 Optional arguments:
2749 --host <hostname>
2751 Name of host.
2752 --binary <binary>
2754 Service binary.
2755 nova set-password
2757 usage: nova set-password <server>
2758 Change the admin password for a server.
2760 Positional arguments:
2762 <server>
2764 Name or ID of server.
2765 nova shelve
2767 usage: nova shelve <server>
2768 Shelve a server.
2770 Positional arguments:
2772 <server>
2774 Name or ID of server.
2775 nova shelve-offload
2777 usage: nova shelve-offload <server>
2778 Remove a shelved server from the compute node.
2780 Positional arguments:
2782 <server>
2784 Name or ID of server.
2785 nova show
2787 usage: nova show [--minimal] [--wrap <integer>] <server>
2788 Show details about the given server.
2790 Note that from microversion 2.69, during partial infrastructure fail‐
2792 ures in the deployment, the output of this command may return partial
2793 results for the server if it exists in the failure domain.
2794 Positional arguments:
2796 <server>
2798 Name or ID of server.
2799 Optional arguments:
2801 --minimal
2803 Skips flavor/image lookups when showing servers.
2804 --wrap <integer>
2806 Wrap the output to a specified length, or 0 to disable.
2807 nova ssh
2809 usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE]
2810 [--network <network>] [--ipv6] [--login <login>] [-i IDENTITY]
2811 [--extra-opts EXTRA]
2812 <server>
2813 SSH into a server.
2815 Positional arguments:
2817 <server>
2819 Name or ID of server.
2820 Optional arguments:
2822 --port PORT
2824 Optional flag to indicate which port to use for ssh. (De‐
2825 fault=22)
2826 --address-type ADDRESS_TYPE
2828 Optional flag to indicate which IP type to use. Possible values
2829 includes fixed and floating (the Default).
2830 --network <network>
2832 Network to use for the ssh.
2833 --ipv6 Optional flag to indicate whether to use an IPv6 address at‐
2835 tached to a server. (Defaults to IPv4 address)
2836 --login <login>
2838 Login to use.
2839 -i IDENTITY, --identity IDENTITY
2841 Private key file, same as the -i option to the ssh command.
2842 --extra-opts EXTRA
2844 Extra options to pass to ssh. see: man ssh.
2845 nova start
2847 usage: nova start [--all-tenants] <server> [<server> ...]
2848 Start the server(s).
2850 Positional arguments:
2852 <server>
2854 Name or ID of server(s).
2855 Optional arguments:
2857 --all-tenants
2859 Start server(s) in another tenant by name (Admin only).
2860 nova stop
2862 usage: nova stop [--all-tenants] <server> [<server> ...]
2863 Stop the server(s).
2865 Positional arguments:
2867 <server>
2869 Name or ID of server(s).
2870 Optional arguments:
2872 --all-tenants
2874 Stop server(s) in another tenant by name (Admin only).
2875 nova suspend
2877 usage: nova suspend <server>
2878 Suspend a server.
2880 Positional arguments:
2882 <server>
2884 Name or ID of server.
2885 nova trigger-crash-dump
2887 usage: nova trigger-crash-dump <server>
2888 Trigger crash dump in an instance. (Supported by API versions '2.17' -
2890 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2891 message for proper version]
2892 New in version 3.3.0.
2894 Positional arguments:
2897 <server>
2899 Name or ID of server.
2900 nova unlock
2902 usage: nova unlock <server>
2903 Unlock a server.
2905 Positional arguments:
2907 <server>
2909 Name or ID of server.
2910 nova unpause
2912 usage: nova unpause <server>
2913 Unpause a server.
2915 Positional arguments:
2917 <server>
2919 Name or ID of server.
2920 nova unrescue
2922 usage: nova unrescue <server>
2923 Restart the server from normal boot disk again.
2925 Positional arguments:
2927 <server>
2929 Name or ID of server.
2930 nova unshelve
2932 usage: nova unshelve [--availability-zone <availability_zone>] <server>
2933 Unshelve a server.
2935 Positional arguments:
2937 <server>
2939 Name or ID of server.
2940 Optional arguments:
2942 --availability-zone <availability_zone>
2944 Name of the availability zone in which to unshelve a
2945 SHELVED_OFFLOADED server. (Supported by API versions '2.77' -
2946 '2.latest')
2947 nova update
2949 usage: nova update [--name <name>] [--description <description>]
2950 [--hostname <hostname>]
2951 <server>
2952 Update attributes of a server.
2954 Positional arguments:
2956 <server>
2958 Name (old name) or ID of server.
2959 Optional arguments:
2961 --name <name>
2963 New name for the server.
2964 --description <description>
2966 New description for the server. If it equals to empty string
2967 (i.g. ""), the server description will be removed. (Supported by
2968 API versions '2.19' - '2.latest')
2969 --hostname <hostname>
2971 New hostname for the instance. This only updates the hostname
2972 stored in the metadata server: a utility running on the guest is
2973 required to propagate these changes to the guest. (Supported by
2974 API versions '2.90' - '2.latest')
2975 nova usage
2977 usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
2978 Show usage data for a single tenant.
2980 Optional arguments:
2982 --start <start>
2984 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2985 --end <end>
2987 Usage range end date, ex 2012-01-20. (default: tomorrow)
2988 --tenant <tenant-id>
2990 UUID of tenant to get usage for.
2991 nova usage-list
2993 usage: nova usage-list [--start <start>] [--end <end>]
2994 List usage data for all tenants.
2996 Optional arguments:
2998 --start <start>
3000 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
3001 --end <end>
3003 Usage range end date, ex 2012-01-20. (default: tomorrow)
3004 nova version-list
3006 usage: nova version-list
3007 List all API versions.
3009 nova volume-attach
3011 usage: nova volume-attach [--delete-on-termination] [--tag <tag>]
3012 <server> <volume> [<device>]
3013 Attach a volume to a server.
3015 Positional arguments:
3017 <server>
3019 Name or ID of server.
3020 <volume>
3022 ID of the volume to attach.
3023 <device>
3025 Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if
3026 supported). Libvirt driver will use default device name.
3027 Optional arguments:
3029 --tag <tag>
3031 Tag for the attached volume. (Supported by API versions '2.49' -
3032 '2.latest')
3033 --delete-on-termination
3035 Specify if the attached volume should be deleted when the server
3036 is destroyed. By default the attached volume is not deleted when
3037 the server is destroyed. (Supported by API versions '2.79' -
3038 '2.latest')
3039 nova volume-attachments
3041 usage: nova volume-attachments <server>
3042 List all the volumes attached to a server.
3044 Positional arguments:
3046 <server>
3048 Name or ID of server.
3049 nova volume-detach
3051 usage: nova volume-detach <server> <volume>
3052 Detach a volume from a server.
3054 Positional arguments:
3056 <server>
3058 Name or ID of server.
3059 <volume>
3061 ID of the volume to detach.
3062 nova volume-update
3064 usage: nova volume-update [--[no-]delete-on-termination]
3065 <server> <src_volume> <dest_volume>
3066 Update the attachment on the server. Migrates the data from an attached
3068 volume to the specified available volume and swaps out the active at‐
3069 tachment to the new volume.
3070 Positional arguments:
3072 <server>
3074 Name or ID of server.
3075 <src_volume>
3077 ID of the source (original) volume.
3078 <dest_volume>
3080 ID of the destination volume.
3081 Optional arguments:
3083 --delete-on-termination
3085 Specify that the volume should be deleted when the server is de‐
3086 stroyed. It is mutually exclusive with '--no-delete-on-termina‐
3087 tion'. (Supported by API versions '2.85' - '2.latest')
3088 --no-delete-on-termination
3090 Specify that the attached volume should not be deleted when the
3091 server is destroyed. It is mutually exclusive with
3092 '--delete-on-termination'. (Supported by API versions '2.85' -
3093 '2.latest')
3094 nova bash-completion
3096 usage: nova bash-completion
3097 Prints all of the commands and options to stdout so that the
3099 nova.bash_completion script doesn't have to hard code them.
3100
3102 OpenStack Contributors
3103
3105 OpenStack Contributors
310617.7.0 Jul 22, 2022 NOVA(1)