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 <name>
784 Boot a new server.
786 In order to create a server with pre-existing ports that contain a re‐
788 source_request value, such as for guaranteed minimum bandwidth quality
789 of service support, microversion 2.72 is required.
790 Positional arguments:
792 <name> Name for the new server.
794 Optional arguments:
796 --flavor <flavor>
798 Name or ID of flavor (see 'nova flavor-list').
799 --image <image>
801 Name or ID of image (see 'glance image-list').
802 --image-with <key=value>
804 Image metadata property (see 'glance image-show').
805 --boot-volume <volume_id>
807 Volume ID to boot from.
808 --snapshot <snapshot_id>
810 Snapshot ID to boot from (will create a volume).
811 --min-count <number>
813 Boot at least <number> servers (limited by quota).
814 --max-count <number>
816 Boot up to <number> servers (limited by quota).
817 --meta <key=value>
819 Record arbitrary key/value metadata to /meta_data.json on the
820 metadata server. Can be specified multiple times.
821 --key-name <key-name>
823 Key name of keypair that should be created earlier with the com‐
824 mand keypair-add.
825 --user-data <user-data>
827 user data file to pass to be exposed by the metadata server.
828 --availability-zone <availability-zone>
830 The availability zone for server placement.
831 --security-groups <security-groups>
833 Comma separated list of security group names.
834 --block-device-mapping <dev-name=mapping>
836 Block device mapping in the format
837 <dev-name>=<id>:<type>:<size(GiB)>:<delete-on-terminate>.
838 --block-device
840 key1=value1[,key2=value2...] Block device mapping with the
841 keys: id=UUID (image_id, snapshot_id or volume_id only if using
842 source image, snapshot or volume) source=source type (image,
843 snapshot, volume or blank), dest=destination type of the block
844 device (volume or local), bus=device's bus (e.g. uml, lxc, vir‐
845 tio, ...; if omitted, hypervisor driver chooses a suitable de‐
846 fault, honoured only if device type is supplied) type=device
847 type (e.g. disk, cdrom, ...; defaults to 'disk') device=name of
848 the device (e.g. vda, xda, ...; if omitted, hypervisor driver
849 chooses suitable device depending on selected bus; note the lib‐
850 virt driver always uses default device names), size=size of the
851 block device in MiB(for swap) and in GiB(for other formats) (if
852 omitted, hypervisor driver calculates size), format=device will
853 be formatted (e.g. swap, ntfs, ...; optional), bootindex=integer
854 used for ordering the boot disks (for image backed instances it
855 is equal to 0, for others need to be specified), shutdown=shut‐
856 down behaviour (either preserve or remove, for local destination
857 set to remove), tag=device metadata tag (optional; supported by
858 API versions '2.42' - '2.latest'), and volume_type=type of vol‐
859 ume to create (either ID or name) when source is blank, image or
860 snapshot and dest is volume (optional; supported by API versions
861 '2.67' - '2.latest').
862 --swap <swap_size>
864 Create and attach a local swap block device of <swap_size> MiB.
865 --ephemeral
867 size=<size>[,format=<format>] Create and attach a local
868 ephemeral block device of <size> GiB and format it to <format>.
869 --hint <key=value>
871 Send arbitrary key/value pairs to the scheduler for custom use.
872 --nic <auto,none,net-id=net-uuid,net-name=net‐
874 work-name,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag>
875 Create a NIC on the server. Specify option multiple times to
876 create multiple nics unless using the special 'auto' or 'none'
877 values. auto: automatically allocate network resources if none
878 are available. This cannot be specified with any other nic value
879 and cannot be specified multiple times. none: do not attach a
880 NIC at all. This cannot be specified with any other nic value
881 and cannot be specified multiple times. net-id: attach NIC to
882 network with a specific UUID. net-name: attach NIC to network
883 with this name (either port-id or net-id or net-name must be
884 provided), v4-fixed-ip: IPv4 fixed address for NIC (optional),
885 v6-fixed-ip: IPv6 fixed address for NIC (optional), port-id: at‐
886 tach NIC to port with this UUID tag: interface metadata tag (op‐
887 tional) (either port-id or net-id must be provided). (Supported
888 by API versions '2.42' - '2.latest')
889 --config-drive <value>
891 Enable config drive. The value must be a boolean value.
892 --poll Report the new server boot progress until it completes.
894 --admin-pass <value>
896 Admin password for the instance.
897 --access-ip-v4 <value>
899 Alternative access IPv4 of the instance.
900 --access-ip-v6 <value>
902 Alternative access IPv6 of the instance.
903 --description <description>
905 Description for the server. (Supported by API versions '2.19' -
906 '2.latest')
907 --tags <tags>
909 Tags for the server.Tags must be separated by commas: --tags
910 <tag1,tag2> (Supported by API versions '2.52' - '2.latest')
911 --return-reservation-id
913 Return a reservation id bound to created servers.
914 --trusted-image-certificate-id <trusted-image-certificate-id>
916 Trusted image certificate IDs used to validate certificates dur‐
917 ing the image signature verification process. Defaults to
918 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
919 ple times to pass multiple trusted image certificate IDs. (Sup‐
920 ported by API versions '2.63' - '2.latest')
921 --host <host>
923 Requested host to create servers. Admin only by default. (Sup‐
924 ported by API versions '2.74' - '2.latest')
925 --hypervisor-hostname <hypervisor-hostname>
927 Requested hypervisor hostname to create servers. Admin only by
928 default. (Supported by API versions '2.74' - '2.latest')
929 nova clear-password
931 usage: nova clear-password <server>
932 Clear the admin password for a server from the metadata server. This
934 action does not actually change the instance server password.
935 Positional arguments:
937 <server>
939 Name or ID of server.
940 nova console-log
942 usage: nova console-log [--length <length>] <server>
943 Get console log output of a server.
945 Locale encoding issues
947 If you encounter an error such as:
949 UnicodeEncodeError: 'ascii' codec can't encode characters in position
951 The solution to these problems is different depending on which locale
953 your computer is running in.
954 For instance, if you have a German Linux machine, you can fix the prob‐
956 lem by exporting the locale to de_DE.utf-8:
957 export LC_ALL=de_DE.utf-8
959 export LANG=de_DE.utf-8
960 If you are on a US machine, en_US.utf-8 is the encoding of choice. On
962 some newer Linux systems, you could also try C.UTF-8 as the locale:
963 export LC_ALL=C.UTF-8
965 export LANG=C.UTF-8
966 Positional arguments:
968 <server>
970 Name or ID of server.
971 Optional arguments:
973 --length <length>
975 Length in lines to tail.
976 nova delete
978 usage: nova delete [--all-tenants] <server> [<server> ...]
979 Immediately shut down and delete specified server(s).
981 Positional arguments:
983 <server>
985 Name or ID of server(s).
986 Optional arguments:
988 --all-tenants
990 Delete server(s) in another tenant by name (Admin only).
991 nova diagnostics
993 usage: nova diagnostics <server>
994 Retrieve server diagnostics.
996 Positional arguments:
998 <server>
1000 Name or ID of server.
1001 nova evacuate
1003 usage: nova evacuate [--password <password>] [--on-shared-storage] [--force] <server> [<host>]
1004 Evacuate server from failed host.
1006 Positional arguments:
1008 <server>
1010 Name or ID of server.
1011 <host> Name or ID of the target host. If no host is specified, the
1013 scheduler will choose one.
1014 Optional arguments:
1016 --password <password>
1018 Set the provided admin password on the evacuated server. Not ap‐
1019 plicable if the server is on shared storage.
1020 --on-shared-storage
1022 Specifies whether server files are located on shared storage.
1023 (Supported by API versions '2.0' - '2.13')
1024 --force
1026 Force an evacuation by not verifying the provided destination
1027 host by the scheduler. (Supported by API versions '2.29' -
1028 '2.67')
1029 WARNING:
1031 This could result in failures to actually evacuate the server
1032 to the specified host. It is recommended to either not spec‐
1033 ify a host so that the scheduler will pick one, or specify a
1034 host without --force.
1035 nova flavor-access-add
1037 usage: nova flavor-access-add <flavor> <tenant_id>
1038 Add flavor access for the given tenant.
1040 Positional arguments:
1042 <flavor>
1044 Flavor name or ID to add access for the given tenant.
1045 <tenant_id>
1047 Tenant ID to add flavor access for.
1048 nova flavor-access-list
1050 usage: nova flavor-access-list [--flavor <flavor>]
1051 Print access information about the given flavor.
1053 Optional arguments:
1055 --flavor <flavor>
1057 Filter results by flavor name or ID.
1058 nova flavor-access-remove
1060 usage: nova flavor-access-remove <flavor> <tenant_id>
1061 Remove flavor access for the given tenant.
1063 Positional arguments:
1065 <flavor>
1067 Flavor name or ID to remove access for the given tenant.
1068 <tenant_id>
1070 Tenant ID to remove flavor access for.
1071 nova flavor-create
1073 usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
1074 [--rxtx-factor <factor>] [--is-public <is-public>]
1075 [--description <description>]
1076 <name> <id> <ram> <disk> <vcpus>
1077 Create a new flavor.
1079 Positional arguments:
1081 <name> Unique name of the new flavor.
1083 <id> Unique ID of the new flavor. Specifying 'auto' will generated a
1085 UUID for the ID.
1086 <ram> Memory size in MiB.
1088 <disk> Disk size in GiB.
1090 <vcpus>
1092 Number of vcpus
1093 Optional arguments:
1095 --ephemeral <ephemeral>
1097 Ephemeral space size in GiB (default 0).
1098 --swap <swap>
1100 Swap space size in MiB (default 0).
1101 --rxtx-factor <factor>
1103 RX/TX factor (default 1).
1104 --is-public <is-public>
1106 Make flavor accessible to the public (default true).
1107 --description <description>
1109 A free form description of the flavor. Limited to 65535 charac‐
1110 ters in length. Only printable characters are allowed. (Sup‐
1111 ported by API versions '2.55' - '2.latest')
1112 nova flavor-delete
1114 usage: nova flavor-delete <flavor>
1115 Delete a specific flavor
1117 Positional arguments:
1119 <flavor>
1121 Name or ID of the flavor to delete.
1122 nova flavor-key
1124 usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
1125 Set or unset extra_spec for a flavor.
1127 Positional arguments:
1129 <flavor>
1131 Name or ID of flavor.
1132 <action>
1134 Actions: 'set' or 'unset'.
1135 <key=value>
1137 Extra_specs to set/unset (only key is necessary on unset).
1138 nova flavor-list
1140 usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
1141 [--min-disk <min-disk>] [--min-ram <min-ram>]
1142 [--limit <limit>] [--sort-key <sort-key>]
1143 [--sort-dir <sort-dir>]
1144 Print a list of available 'flavors' (sizes of servers).
1146 Optional arguments:
1148 --extra-specs
1150 Get extra-specs of each flavor.
1151 --all Display all flavors (Admin only).
1153 --marker <marker>
1155 The last flavor ID of the previous page; displays list of fla‐
1156 vors after "marker".
1157 --min-disk <min-disk>
1159 Filters the flavors by a minimum disk space, in GiB.
1160 --min-ram <min-ram>
1162 Filters the flavors by a minimum RAM, in MiB.
1163 --limit <limit>
1165 Maximum number of flavors to display. If limit is bigger than
1166 'CONF.api.max_limit' option of Nova API, limit
1167 'CONF.api.max_limit' will be used instead.
1168 --sort-key <sort-key>
1170 Flavors list sort key.
1171 --sort-dir <sort-dir>
1173 Flavors list sort direction.
1174 nova flavor-show
1176 usage: nova flavor-show <flavor>
1177 Show details about the given flavor.
1179 Positional arguments:
1181 <flavor>
1183 Name or ID of flavor.
1184 nova flavor-update
1186 usage: nova flavor-update <flavor> <description>
1187 Update the description of an existing flavor. (Supported by API ver‐
1189 sions '2.55' - '2.latest') [hint: use '--os-compute-api-version' flag
1190 to show help message for proper version]
1191 New in version 10.0.0.
1193 Positional arguments
1196 <flavor>
1198 Name or ID of the flavor to update.
1199 <description>
1201 A free form description of the flavor. Limited to 65535 charac‐
1202 ters in length. Only printable characters are allowed.
1203 nova force-delete
1205 usage: nova force-delete <server>
1206 Force delete a server.
1208 Positional arguments:
1210 <server>
1212 Name or ID of server.
1213 nova get-mks-console
1215 usage: nova get-mks-console <server>
1216 Get an MKS console to a server. (Supported by API versions '2.8' -
1218 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1219 message for proper version]
1220 New in version 3.0.0.
1222 Positional arguments:
1225 <server>
1227 Name or ID of server.
1228 nova get-password
1230 usage: nova get-password <server> [<private-key>]
1231 Get the admin password for a server. This operation calls the metadata
1233 service to query metadata information and does not read password infor‐
1234 mation from the server itself.
1235 Positional arguments:
1237 <server>
1239 Name or ID of server.
1240 <private-key>
1242 Private key (used locally to decrypt password) (Optional). When
1243 specified, the command displays the clear (decrypted) VM pass‐
1244 word. When not specified, the ciphered VM password is displayed.
1245 nova get-rdp-console
1247 usage: nova get-rdp-console <server> <console-type>
1248 Get a rdp console to a server.
1250 Positional arguments:
1252 <server>
1254 Name or ID of server.
1255 <console-type>
1257 Type of rdp console ("rdp-html5").
1258 nova get-serial-console
1260 usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>
1261 Get a serial console to a server.
1263 Positional arguments:
1265 <server>
1267 Name or ID of server.
1268 Optional arguments:
1270 --console-type CONSOLE_TYPE
1272 Type of serial console, default="serial".
1273 nova get-spice-console
1275 usage: nova get-spice-console <server> <console-type>
1276 Get a spice console to a server.
1278 Positional arguments:
1280 <server>
1282 Name or ID of server.
1283 <console-type>
1285 Type of spice console ("spice-html5").
1286 nova get-vnc-console
1288 usage: nova get-vnc-console <server> <console-type>
1289 Get a vnc console to a server.
1291 Positional arguments:
1293 <server>
1295 Name or ID of server.
1296 <console-type>
1298 Type of vnc console ("novnc" or "xvpvnc").
1299 nova host-evacuate
1301 usage: nova host-evacuate [--target_host <target_host>] [--force] [--strict]
1302 <host>
1303 Evacuate all instances from failed host.
1305 Positional arguments:
1307 <host> The hypervisor hostname (or pattern) to search for.
1309 WARNING:
1311 Use a fully qualified domain name if you only want to evacu‐
1312 ate from a specific host.
1313 Optional arguments:
1315 --target_host <target_host>
1317 Name of target host. If no host is specified the scheduler will
1318 select a target.
1319 --force
1321 Force an evacuation by not verifying the provided destination
1322 host by the scheduler. (Supported by API versions '2.29' -
1323 '2.67')
1324 WARNING:
1326 This could result in failures to actually evacuate the server
1327 to the specified host. It is recommended to either not spec‐
1328 ify a host so that the scheduler will pick one, or specify a
1329 host without --force.
1330 --strict
1332 Evacuate host with exact hypervisor hostname match
1333 nova host-evacuate-live
1335 usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
1336 [--max-servers <max_servers>] [--force]
1337 [--strict]
1338 <host>
1339 Live migrate all instances off the specified host to other available
1341 hosts.
1342 Positional arguments:
1344 <host> Name of host. The hypervisor hostname (or pattern) to search
1346 for.
1347 WARNING:
1349 Use a fully qualified domain name if you only want to live
1350 migrate from a specific host.
1351 Optional arguments:
1353 --target-host <target_host>
1355 Name of target host. If no host is specified, the scheduler will
1356 choose one.
1357 --block-migrate
1359 Enable block migration. (Default=auto) (Supported by API ver‐
1360 sions '2.25' - '2.latest')
1361 --max-servers <max_servers>
1363 Maximum number of servers to live migrate simultaneously
1364 --force
1366 Force a live-migration by not verifying the provided destination
1367 host by the scheduler. (Supported by API versions '2.30' -
1368 '2.67')
1369 WARNING:
1371 This could result in failures to actually live migrate the
1372 servers to the specified host. It is recommended to either
1373 not specify a host so that the scheduler will pick one, or
1374 specify a host without --force.
1375 --strict
1377 live Evacuate host with exact hypervisor hostname match
1378 nova host-meta
1380 usage: nova host-meta [--strict] <host> <action> <key=value> [<key=value> ...]
1381 Set or Delete metadata on all instances of a host.
1383 Positional arguments:
1385 <host> The hypervisor hostname (or pattern) to search for.
1387 WARNING:
1389 Use a fully qualified domain name if you only want to update
1390 metadata for servers on a specific host.
1391 <action>
1393 Actions: 'set' or 'delete'
1394 <key=value>
1396 Metadata to set or delete (only key is necessary on delete)
1397 Optional arguments:
1399 --strict
1401 Set host-meta to the hypervisor with exact hostname match
1402 nova host-servers-migrate
1404 usage: nova host-servers-migrate [--strict] <host>
1405 Cold migrate all instances off the specified host to other available
1407 hosts.
1408 Positional arguments:
1410 <host> Name of host. The hypervisor hostname (or pattern) to search
1412 for.
1413 WARNING:
1415 Use a fully qualified domain name if you only want to cold
1416 migrate from a specific host.
1417 Optional arguments:
1419 --strict
1421 Migrate host with exact hypervisor hostname match
1422 nova hypervisor-list
1424 usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
1425 [--limit <limit>]
1426 List hypervisors. (Supported by API versions '2.0' - '2.latest') [hint:
1428 use '--os-compute-api-version' flag to show help message for proper
1429 version]
1430 Optional arguments:
1432 --matching <hostname>
1434 List hypervisors matching the given <hostname>. If matching is
1435 used limit and marker options will be ignored.
1436 --marker <marker>
1438 The last hypervisor of the previous page; displays list of hy‐
1439 pervisors after "marker". (Supported by API versions '2.33' -
1440 '2.latest')
1441 --limit <limit>
1443 Maximum number of hypervisors to display. If limit is bigger
1444 than 'CONF.api.max_limit' option of Nova API, limit
1445 'CONF.api.max_limit' will be used instead. (Supported by API
1446 versions '2.33' - '2.latest')
1447 nova hypervisor-servers
1449 usage: nova hypervisor-servers <hostname>
1450 List servers belonging to specific hypervisors.
1452 Positional arguments:
1454 <hostname>
1456 The hypervisor hostname (or pattern) to search for.
1457 nova hypervisor-show
1459 usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
1460 Display the details of the specified hypervisor.
1462 Positional arguments:
1464 <hypervisor>
1466 Name or ID of the hypervisor. Starting with microversion 2.53
1467 the ID must be a UUID.
1468 Optional arguments:
1470 --wrap <integer>
1472 Wrap the output to a specified length. Default is 40 or 0 to
1473 disable
1474 nova hypervisor-stats
1476 usage: nova hypervisor-stats
1477 Get hypervisor statistics over all compute nodes.
1479 nova hypervisor-uptime
1481 usage: nova hypervisor-uptime <hypervisor>
1482 Display the uptime of the specified hypervisor.
1484 Positional arguments:
1486 <hypervisor>
1488 Name or ID of the hypervisor. Starting with microversion 2.53
1489 the ID must be a UUID.
1490 nova image-create
1492 usage: nova image-create [--metadata <key=value>] [--show] [--poll]
1493 <server> <name>
1494 Create a new image by taking a snapshot of a running server.
1496 Positional arguments:
1498 <server>
1500 Name or ID of server.
1501 <name> Name of snapshot.
1503 Optional arguments:
1505 --metadata <key=value>
1507 Record arbitrary key/value metadata to /meta_data.json on the
1508 metadata server. Can be specified multiple times.
1509 --show Print image info.
1511 --poll Report the snapshot progress and poll until image creation is
1513 complete.
1514 nova instance-action
1516 usage: nova instance-action <server> <request_id>
1517 Show an action.
1519 Positional arguments:
1521 <server>
1523 Name or UUID of the server to show actions for. Only UUID can be
1524 used to show actions for a deleted server. (Supported by API
1525 versions '2.21' - '2.latest')
1526 <request_id>
1528 Request ID of the action to get.
1529 nova instance-action-list
1531 usage: nova instance-action-list [--marker <marker>] [--limit <limit>]
1532 [--changes-since <changes_since>]
1533 [--changes-before <changes_before>]
1534 <server>
1535 List actions on a server.
1537 Positional arguments:
1539 <server>
1541 Name or UUID of the server to list actions for. Only UUID can be
1542 used to list actions on a deleted server. (Supported by API ver‐
1543 sions '2.21' - '2.latest')
1544 Optional arguments:
1546 --marker <marker>
1548 The last instance action of the previous page; displays list of
1549 actions after "marker". (Supported by API versions '2.58' -
1550 '2.latest')
1551 --limit <limit>
1553 Maximum number of instance actions to display. Note that there
1554 is a configurable max limit on the server, and the limit that is
1555 used will be the minimum of what is requested here and what is
1556 configured in the server. (Supported by API versions '2.58' -
1557 '2.latest')
1558 --changes-since <changes_since>
1560 List only instance actions changed later or equal to a certain
1561 point of time. The provided time should be an ISO 8061 formatted
1562 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1563 '2.58' - '2.latest')
1564 --changes-before <changes_before>
1566 List only instance actions changed earlier or equal to a certain
1567 point of time. The provided time should be an ISO 8061 formatted
1568 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1569 '2.66' - '2.latest')
1570 nova instance-usage-audit-log
1572 usage: nova instance-usage-audit-log [--before <before>]
1573 List/Get server usage audits.
1575 Optional arguments:
1577 --before <before>
1579 Filters the response by the date and time before which to list
1580 usage audits. The date and time stamp format is as follows:
1581 CCYY-MM-DD hh:mm:ss.NNNNNN ex 2015-08-27 09:49:58 or 2015-08-27
1582 09:49:58.123456.
1583 nova interface-attach
1585 usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
1586 [--fixed-ip <fixed_ip>] [--tag <tag>]
1587 <server>
1588 Attach a network interface to a server.
1590 Positional arguments:
1592 <server>
1594 Name or ID of server.
1595 Optional arguments:
1597 --port-id <port_id>
1599 Port ID.
1600 --net-id <net_id>
1602 Network ID
1603 --fixed-ip <fixed_ip>
1605 Requested fixed IP.
1606 --tag <tag>
1608 Tag for the attached interface. (Supported by API versions
1609 '2.49' - '2.latest')
1610 nova interface-detach
1612 usage: nova interface-detach <server> <port_id>
1613 Detach a network interface from a server.
1615 Positional arguments:
1617 <server>
1619 Name or ID of server.
1620 <port_id>
1622 Port ID.
1623 nova interface-list
1625 usage: nova interface-list <server>
1626 List interfaces attached to a server.
1628 Positional arguments:
1630 <server>
1632 Name or ID of server.
1633 nova keypair-add
1635 usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
1636 [--user <user-id>]
1637 <name>
1638 Create a new key pair for use with servers.
1640 Positional arguments:
1642 <name> Name of key.
1644 Optional arguments:
1646 --pub-key <pub-key>
1648 Path to a public ssh key.
1649 --key-type <key-type>
1651 Keypair type. Can be ssh or x509. (Supported by API versions
1652 '2.2' - '2.latest')
1653 --user <user-id>
1655 ID of user to whom to add key-pair (Admin only). (Supported by
1656 API versions '2.10' - '2.latest')
1657 nova keypair-delete
1659 usage: nova keypair-delete [--user <user-id>] <name>
1660 Delete keypair given by its name. (Supported by API versions '2.0' -
1662 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1663 message for proper version]
1664 Positional arguments:
1666 <name> Keypair name to delete.
1668 Optional arguments:
1670 --user <user-id>
1672 ID of key-pair owner (Admin only).
1673 nova keypair-list
1675 usage: nova keypair-list [--user <user-id>] [--marker <marker>]
1676 [--limit <limit>]
1677 Print a list of keypairs for a user (Supported by API versions '2.0' -
1679 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1680 message for proper version]
1681 Optional arguments:
1683 --user <user-id>
1685 List key-pairs of specified user ID (Admin only).
1686 --marker <marker>
1688 The last keypair of the previous page; displays list of keypairs
1689 after "marker".
1690 --limit <limit>
1692 Maximum number of keypairs to display. If limit is bigger than
1693 'CONF.api.max_limit' option of Nova API, limit
1694 'CONF.api.max_limit' will be used instead.
1695 nova keypair-show
1697 usage: nova keypair-show [--user <user-id>] <keypair>
1698 Show details about the given keypair. (Supported by API versions '2.0'
1700 - '2.latest') [hint: use '--os-compute-api-version' flag to show help
1701 message for proper version]
1702 Positional arguments:
1704 <keypair>
1706 Name of keypair.
1707 Optional arguments:
1709 --user <user-id>
1711 ID of key-pair owner (Admin only).
1712 nova limits
1714 usage: nova limits [--tenant [<tenant>]] [--reserved]
1715 Print rate and absolute limits.
1717 Optional arguments:
1719 --tenant [<tenant>]
1721 Display information from single tenant (Admin only).
1722 --reserved
1724 Include reservations count.
1725 nova list
1727 usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>]
1728 [--ip6 <ip6-regexp>] [--name <name-regexp>]
1729 [--status <status>] [--flavor <flavor>] [--image <image>]
1730 [--host <hostname>] [--all-tenants [<0|1>]]
1731 [--tenant [<tenant>]] [--user [<user>]] [--deleted]
1732 [--fields <fields>] [--minimal]
1733 [--sort <key>[:<direction>]] [--marker <marker>]
1734 [--limit <limit>] [--availability-zone <availability_zone>]
1735 [--key-name <key_name>] [--[no-]config-drive]
1736 [--progress <progress>] [--vm-state <vm_state>]
1737 [--task-state <task_state>] [--power-state <power_state>]
1738 [--changes-since <changes_since>]
1739 [--changes-before <changes_before>]
1740 [--tags <tags>] [--tags-any <tags-any>]
1741 [--not-tags <not-tags>] [--not-tags-any <not-tags-any>]
1742 [--locked]
1743 List servers.
1745 Note that from microversion 2.69, during partial infrastructure fail‐
1747 ures in the deployment, the output of this command may return partial
1748 results for the servers present in the failure domain.
1749 Optional arguments:
1751 --reservation-id <reservation-id>
1753 Only return servers that match reservation-id.
1754 --ip <ip-regexp>
1756 Search with regular expression match by IP address.
1757 --ip6 <ip6-regexp>
1759 Search with regular expression match by IPv6 address.
1760 --name <name-regexp>
1762 Search with regular expression match by name.
1763 --status <status>
1765 Search by server status.
1766 --flavor <flavor>
1768 Search by flavor name or ID.
1769 --image <image>
1771 Search by image name or ID.
1772 --host <hostname>
1774 Search servers by hostname to which they are assigned (Admin
1775 only).
1776 --all-tenants [<0|1>]
1778 Display information from all tenants (Admin only).
1779 --tenant [<tenant>]
1781 Display information from single tenant (Admin only).
1782 --user [<user>]
1784 Display information from single user (Admin only until microver‐
1785 sion 2.82).
1786 --deleted
1788 Only display deleted servers (Admin only).
1789 --fields <fields>
1791 Comma-separated list of fields to display. Use the show command
1792 to see which fields are available.
1793 --minimal
1795 Get only UUID and name.
1796 --sort <key>[:<direction>]
1798 Comma-separated list of sort keys and directions in the form of
1799 <key>[:<asc|desc>]. The direction defaults to descending if not
1800 specified.
1801 --marker <marker>
1803 The last server UUID of the previous page; displays list of
1804 servers after "marker".
1805 --limit <limit>
1807 Maximum number of servers to display. If limit == -1, all
1808 servers will be displayed. If limit is bigger than
1809 'CONF.api.max_limit' option of Nova API, limit
1810 'CONF.api.max_limit' will be used instead.
1811 --availability-zone <availability_zone>
1813 Display servers based on their availability zone (Admin only un‐
1814 til microversion 2.82).
1815 --key-name <key_name>
1817 Display servers based on their keypair name (Admin only until
1818 microversion 2.82).
1819 --config-drive
1821 Display servers that have a config drive attached. It is mutu‐
1822 ally exclusive with '--no-config-drive'. (Admin only until mi‐
1823 croversion 2.82).
1824 --no-config-drive
1826 Display servers that do not have a config drive attached. It is
1827 mutually exclusive with '--config-drive'. (Admin only until mi‐
1828 croversion 2.82).
1829 --progress <progress>
1831 Display servers based on their progress value (Admin only until
1832 microversion 2.82).
1833 --vm-state <vm_state>
1835 Display servers based on their vm_state value (Admin only until
1836 microversion 2.82).
1837 --task-state <task_state>
1839 Display servers based on their task_state value (Admin only un‐
1840 til microversion 2.82).
1841 --power-state <power_state>
1843 Display servers based on their power_state value (Admin only un‐
1844 til microversion 2.82).
1845 --changes-since <changes_since>
1847 List only servers changed later or equal to a certain point of
1848 time. The provided time should be an ISO 8061 formatted time.
1849 e.g. 2016-03-04T06:27:59Z .
1850 --changes-before <changes_before>
1852 List only servers changed earlier or equal to a certain point of
1853 time. The provided time should be an ISO 8061 formatted time.
1854 e.g. 2016-03-05T06:27:59Z . (Supported by API versions '2.66' -
1855 '2.latest')
1856 --tags <tags>
1858 The given tags must all be present for a server to be included
1859 in the list result. Boolean expression in this case is 't1 AND
1860 t2'. Tags must be separated by commas: --tags <tag1,tag2> (Sup‐
1861 ported by API versions '2.26' - '2.latest')
1862 --tags-any <tags-any>
1864 If one of the given tags is present the server will be included
1865 in the list result. Boolean expression in this case is 't1 OR
1866 t2'. Tags must be separated by commas: --tags-any <tag1,tag2>
1867 (Supported by API versions '2.26' - '2.latest')
1868 --not-tags <not-tags>
1870 Only the servers that do not have any of the given tags will be
1871 included in the list results. Boolean expression in this case is
1872 'NOT(t1 AND t2)'. Tags must be separated by commas: --not-tags
1873 <tag1,tag2> (Supported by API versions '2.26' - '2.latest')
1874 --not-tags-any <not-tags-any>
1876 Only the servers that do not have at least one of the given tags
1877 will be included in the list result. Boolean expression in this
1878 case is 'NOT(t1 OR t2)'. Tags must be separated by commas:
1879 --not-tags-any <tag1,tag2> (Supported by API versions '2.26' -
1880 '2.latest')
1881 --locked <locked>
1883 Display servers based on their locked value. A value must be
1884 specified; eg. 'true' will list only locked servers and 'false'
1885 will list only unlocked servers. (Supported by API versions
1886 '2.73' - '2.latest')
1887 nova list-secgroup
1889 usage: nova list-secgroup <server>
1890 List Security Group(s) of a server.
1892 Positional arguments:
1894 <server>
1896 Name or ID of server.
1897 nova live-migration
1899 usage: nova live-migration [--block-migrate] [--force] <server> [<host>]
1900 Migrate running server to a new machine.
1902 Positional arguments:
1904 <server>
1906 Name or ID of server.
1907 <host> Destination host name. If no host is specified, the scheduler
1909 will choose one.
1910 Optional arguments:
1912 --block-migrate
1914 True in case of block_migration. (Default=auto:live_migration)
1915 (Supported by API versions '2.25' - '2.latest')
1916 --force
1918 Force a live-migration by not verifying the provided destination
1919 host by the scheduler. (Supported by API versions '2.30' -
1920 '2.67')
1921 WARNING:
1923 This could result in failures to actually live migrate the
1924 server to the specified host. It is recommended to either not
1925 specify a host so that the scheduler will pick one, or spec‐
1926 ify a host without --force.
1927 nova live-migration-abort
1929 usage: nova live-migration-abort <server> <migration>
1930 Abort an on-going live migration. (Supported by API versions '2.24' -
1932 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1933 message for proper version]
1934 For microversions from 2.24 to 2.64 the migration status must be run‐
1936 ning; for microversion 2.65 and greater, the migration status can also
1937 be queued and preparing.
1938 New in version 3.3.0.
1940 Positional arguments:
1943 <server>
1945 Name or ID of server.
1946 <migration>
1948 ID of migration.
1949 nova live-migration-force-complete
1951 usage: nova live-migration-force-complete <server> <migration>
1952 Force on-going live migration to complete. (Supported by API versions
1954 '2.22' - '2.latest') [hint: use '--os-compute-api-version' flag to show
1955 help message for proper version]
1956 New in version 3.3.0.
1958 Positional arguments:
1961 <server>
1963 Name or ID of server.
1964 <migration>
1966 ID of migration.
1967 nova lock
1969 usage: nova lock [--reason <reason>] <server>
1970 Lock a server. A normal (non-admin) user will not be able to execute
1972 actions on a locked server.
1973 Positional arguments:
1975 <server>
1977 Name or ID of server.
1978 Optional arguments:
1980 --reason <reason>
1982 Reason for locking the server. (Supported by API versions '2.73'
1983 - '2.latest')
1984 nova meta
1986 usage: nova meta <server> <action> <key=value> [<key=value> ...]
1987 Set or delete metadata on a server.
1989 Positional arguments:
1991 <server>
1993 Name or ID of server.
1994 <action>
1996 Actions: 'set' or 'delete'.
1997 <key=value>
1999 Metadata to set or delete (only key is necessary on delete).
2000 nova migrate
2002 usage: nova migrate [--host <host>] [--poll] <server>
2003 Migrate a server. The new host will be selected by the scheduler.
2005 Positional arguments:
2007 <server>
2009 Name or ID of server.
2010 Optional arguments:
2012 --host <host>
2014 Destination host name. (Supported by API versions '2.56' -
2015 '2.latest')
2016 --poll Report the server migration progress until it completes.
2018 nova migration-list
2020 usage: nova migration-list [--instance-uuid <instance_uuid>]
2021 [--host <host>]
2022 [--status <status>]
2023 [--migration-type <migration_type>]
2024 [--source-compute <source_compute>]
2025 [--marker <marker>]
2026 [--limit <limit>]
2027 [--changes-since <changes_since>]
2028 [--changes-before <changes_before>]
2029 [--project-id <project_id>]
2030 [--user-id <user_id>]
2031 Print a list of migrations.
2033 Examples
2035 To see the list of evacuation operations from a compute service host:
2037 nova migration-list --migration-type evacuation --source-compute host.foo.bar
2039 Optional arguments:
2041 --instance-uuid <instance_uuid>
2043 Fetch migrations for the given instance.
2044 --host <host>
2046 Fetch migrations for the given source or destination host.
2047 --status <status>
2049 Fetch migrations for the given status.
2050 --migration-type <migration_type>
2052 Filter migrations by type. Valid values are:
2053 • evacuation
2055 • live-migration
2057 • migration
2059 NOTE:
2061 This is a cold migration.
2062 • resize
2064 --source-compute <source_compute>
2066 Filter migrations by source compute host name.
2067 --marker <marker>
2069 The last migration of the previous page; displays list of migra‐
2070 tions after "marker". Note that the marker is the migration
2071 UUID. (Supported by API versions '2.59' - '2.latest')
2072 --limit <limit>
2074 Maximum number of migrations to display. Note that there is a
2075 configurable max limit on the server, and the limit that is used
2076 will be the minimum of what is requested here and what is con‐
2077 figured in the server. (Supported by API versions '2.59' -
2078 '2.latest')
2079 --changes-since <changes_since>
2081 List only migrations changed later or equal to a certain point
2082 of time. The provided time should be an ISO 8061 formatted time.
2083 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.59' -
2084 '2.latest')
2085 --changes-before <changes_before>
2087 List only migrations changed earlier or equal to a certain point
2088 of time. The provided time should be an ISO 8061 formatted time.
2089 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.66' -
2090 '2.latest')
2091 --project-id <project_id>
2093 Filter the migrations by the given project ID. (Supported by
2094 API versions '2.80' - '2.latest')
2095 --user-id <user_id>
2097 Filter the migrations by the given user ID. (Supported by API
2098 versions '2.80' - '2.latest')
2099 nova pause
2101 usage: nova pause <server>
2102 Pause a server.
2104 Positional arguments:
2106 <server>
2108 Name or ID of server.
2109 nova quota-class-show
2111 usage: nova quota-class-show <class>
2112 List the quotas for a quota class.
2114 Positional arguments:
2116 <class>
2118 Name of quota class to list the quotas for.
2119 nova quota-class-update
2121 usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
2122 [--ram <ram>]
2123 [--metadata-items <metadata-items>]
2124 [--key-pairs <key-pairs>]
2125 [--server-groups <server-groups>]
2126 [--server-group-members <server-group-members>]
2127 <class>
2128 Update the quotas for a quota class. (Supported by API versions '2.0' -
2130 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2131 message for proper version]
2132 Positional arguments:
2134 <class>
2136 Name of quota class to set the quotas for.
2137 Optional arguments:
2139 --instances <instances>
2141 New value for the "instances" quota.
2142 --cores <cores>
2144 New value for the "cores" quota.
2145 --ram <ram>
2147 New value for the "ram" quota.
2148 --metadata-items <metadata-items>
2150 New value for the "metadata-items" quota.
2151 --key-pairs <key-pairs>
2153 New value for the "key-pairs" quota.
2154 --server-groups <server-groups>
2156 New value for the "server-groups" quota.
2157 --server-group-members <server-group-members>
2159 New value for the "server-group-members" quota.
2160 nova quota-defaults
2162 usage: nova quota-defaults [--tenant <tenant-id>]
2163 List the default quotas for a tenant.
2165 Optional arguments:
2167 --tenant <tenant-id>
2169 ID of tenant to list the default quotas for.
2170 nova quota-delete
2172 usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
2173 Delete quota for a tenant/user so their quota will Revert back to de‐
2175 fault.
2176 Optional arguments:
2178 --tenant <tenant-id>
2180 ID of tenant to delete quota for.
2181 --user <user-id>
2183 ID of user to delete quota for.
2184 nova quota-show
2186 usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]
2187 List the quotas for a tenant/user.
2189 Optional arguments:
2191 --tenant <tenant-id>
2193 ID of tenant to list the quotas for.
2194 --user <user-id>
2196 ID of user to list the quotas for.
2197 --detail
2199 Show detailed info (limit, reserved, in-use).
2200 nova quota-update
2202 usage: nova quota-update [--user <user-id>] [--instances <instances>]
2203 [--cores <cores>] [--ram <ram>]
2204 [--metadata-items <metadata-items>]
2205 [--key-pairs <key-pairs>]
2206 [--server-groups <server-groups>]
2207 [--server-group-members <server-group-members>]
2208 [--force]
2209 <tenant-id>
2210 Update the quotas for a tenant/user. (Supported by API versions '2.0' -
2212 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2213 message for proper version]
2214 Positional arguments:
2216 <tenant-id>
2218 ID of tenant to set the quotas for.
2219 Optional arguments:
2221 --user <user-id>
2223 ID of user to set the quotas for.
2224 --instances <instances>
2226 New value for the "instances" quota.
2227 --cores <cores>
2229 New value for the "cores" quota.
2230 --ram <ram>
2232 New value for the "ram" quota.
2233 --metadata-items <metadata-items>
2235 New value for the "metadata-items" quota.
2236 --key-pairs <key-pairs>
2238 New value for the "key-pairs" quota.
2239 --server-groups <server-groups>
2241 New value for the "server-groups" quota.
2242 --server-group-members <server-group-members>
2244 New value for the "server-group-members" quota.
2245 --force
2247 Whether force update the quota even if the already used and re‐
2248 served exceeds the new quota.
2249 nova reboot
2251 usage: nova reboot [--hard] [--poll] <server> [<server> ...]
2252 Reboot a server.
2254 Positional arguments:
2256 <server>
2258 Name or ID of server(s).
2259 Optional arguments:
2261 --hard Perform a hard reboot (instead of a soft one). Note: Ironic does
2263 not currently support soft reboot; consequently, bare metal
2264 nodes will always do a hard reboot, regardless of the use of
2265 this option.
2266 --poll Poll until reboot is complete.
2268 nova rebuild
2270 usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
2271 [--minimal] [--preserve-ephemeral] [--name <name>]
2272 [--description <description>] [--meta <key=value>]
2273 [--key-name <key-name>] [--key-unset]
2274 [--user-data <user-data>] [--user-data-unset]
2275 [--trusted-image-certificate-id <trusted-image-certificate-id>]
2276 [--trusted-image-certificates-unset]
2277 <server> <image>
2278 Shutdown, re-image, and re-boot a server.
2280 Positional arguments:
2282 <server>
2284 Name or ID of server.
2285 <image>
2287 Name or ID of new image.
2288 Optional arguments:
2290 --rebuild-password <rebuild-password>
2292 Set the provided admin password on the rebuilt server.
2293 --poll Report the server rebuild progress until it completes.
2295 --minimal
2297 Skips flavor/image lookups when showing servers.
2298 --preserve-ephemeral
2300 Preserve the default ephemeral storage partition on rebuild.
2301 --name <name>
2303 Name for the new server.
2304 --description <description>
2306 New description for the server. (Supported by API versions
2307 '2.19' - '2.latest')
2308 --meta <key=value>
2310 Record arbitrary key/value metadata to /meta_data.json on the
2311 metadata server. Can be specified multiple times.
2312 --key-name <key-name>
2314 Keypair name to set in the server. Cannot be specified with the
2315 '--key-unset' option. (Supported by API versions '2.54' -
2316 '2.latest')
2317 --key-unset
2319 Unset keypair in the server. Cannot be specified with the
2320 '--key-name' option. (Supported by API versions '2.54' -
2321 '2.latest')
2322 --user-data <user-data>
2324 User data file to pass to be exposed by the metadata server.
2325 (Supported by API versions '2.57' - '2.latest')
2326 --user-data-unset
2328 Unset user_data in the server. Cannot be specified with the
2329 '--user-data' option. (Supported by API versions '2.57' -
2330 '2.latest')
2331 --trusted-image-certificate-id <trusted-image-certificate-id>
2333 Trusted image certificate IDs used to validate certificates dur‐
2334 ing the image signature verification process. Defaults to
2335 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
2336 ple times to pass multiple trusted image certificate IDs. (Sup‐
2337 ported by API versions '2.63' - '2.latest')
2338 --trusted-image-certificates-unset
2340 Unset trusted_image_certificates in the server. Cannot be speci‐
2341 fied with the --trusted-image-certificate-id option. (Supported
2342 by API versions '2.63' - '2.latest')
2343 nova refresh-network
2345 usage: nova refresh-network <server>
2346 Refresh server network information.
2348 Positional arguments:
2350 <server>
2352 Name or ID of a server for which the network cache should be re‐
2353 freshed from neutron (Admin only).
2354 nova remove-secgroup
2356 usage: nova remove-secgroup <server> <secgroup>
2357 Remove a Security Group from a server.
2359 Positional arguments:
2361 <server>
2363 Name or ID of server.
2364 <secgroup>
2366 Name of Security Group.
2367 nova rescue
2369 usage: nova rescue [--password <password>] [--image <image>] <server>
2370 Reboots a server into rescue mode, which starts the machine from either
2372 the initial image or a specified image, attaching the current boot disk
2373 as secondary.
2374 Positional arguments:
2376 <server>
2378 Name or ID of server.
2379 Optional arguments:
2381 --password <password>
2383 The admin password to be set in the rescue environment.
2384 --image <image>
2386 The image to rescue with.
2387 nova reset-network
2389 usage: nova reset-network <server>
2390 Reset network of a server.
2392 Positional arguments:
2394 <server>
2396 Name or ID of server.
2397 nova reset-state
2399 usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]
2400 Reset the state of a server.
2402 Positional arguments:
2404 <server>
2406 Name or ID of server(s).
2407 Optional arguments:
2409 --all-tenants
2411 Reset state server(s) in another tenant by name (Admin only).
2412 --active
2414 Request the server be reset to "active" state instead of "error"
2415 state (the default).
2416 nova resize
2418 usage: nova resize [--poll] <server> <flavor>
2419 Resize a server.
2421 Positional arguments:
2423 <server>
2425 Name or ID of server.
2426 <flavor>
2428 Name or ID of new flavor.
2429 Optional arguments:
2431 --poll Report the server resize progress until it completes.
2433 nova resize-confirm
2435 usage: nova resize-confirm <server>
2436 Confirm a previous resize.
2438 Positional arguments:
2440 <server>
2442 Name or ID of server.
2443 nova resize-revert
2445 usage: nova resize-revert <server>
2446 Revert a previous resize (and return to the previous VM).
2448 Positional arguments:
2450 <server>
2452 Name or ID of server.
2453 nova restore
2455 usage: nova restore <server>
2456 Restore a soft-deleted server.
2458 Positional arguments:
2460 <server>
2462 Name or ID of server.
2463 nova resume
2465 usage: nova resume <server>
2466 Resume a server.
2468 Positional arguments:
2470 <server>
2472 Name or ID of server.
2473 nova server-group-create
2475 usage: nova server-group-create [--rules <key=value>] <name> <policy>
2476 Create a new server group with the specified details.
2478 Positional arguments:
2480 <name> Server group name.
2482 <policy>
2484 Policy for the server groups.
2485 Optional arguments:
2487 --rule Policy rules for the server groups. (Supported by API versions
2489 '2.64' - '2.latest'）. Currently, only the max_server_per_host
2490 rule is supported for the anti-affinity policy. The
2491 max_server_per_host rule allows specifying how many members of
2492 the anti-affinity group can reside on the same compute host. If
2493 not specified, only one member from the same anti-affinity group
2494 can reside on a given host.
2495 nova server-group-delete
2497 usage: nova server-group-delete <id> [<id> ...]
2498 Delete specific server group(s).
2500 Positional arguments:
2502 <id> Unique ID(s) of the server group to delete.
2504 nova server-group-get
2506 usage: nova server-group-get <id>
2507 Get a specific server group.
2509 Positional arguments:
2511 <id> Unique ID of the server group to get.
2513 nova server-group-list
2515 usage: nova server-group-list [--limit <limit>] [--offset <offset>]
2516 [--all-projects]
2517 Print a list of all server groups.
2519 Optional arguments:
2521 --limit <limit>
2523 Maximum number of server groups to display. If limit is bigger
2524 than 'CONF.api.max_limit' option of Nova API, limit
2525 'CONF.api.max_limit' will be used instead.
2526 --offset <offset>
2528 The offset of groups list to display; use with limit to return a
2529 slice of server groups.
2530 --all-projects
2532 Display server groups from all projects (Admin only).
2533 nova server-migration-list
2535 usage: nova server-migration-list <server>
2536 Get the migrations list of specified server. (Supported by API versions
2538 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2539 help message for proper version]
2540 New in version 3.3.0.
2542 Positional arguments:
2545 <server>
2547 Name or ID of server.
2548 nova server-migration-show
2550 usage: nova server-migration-show <server> <migration>
2551 Get the migration of specified server. (Supported by API versions
2553 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2554 help message for proper version]
2555 New in version 3.3.0.
2557 Positional arguments:
2560 <server>
2562 Name or ID of server.
2563 <migration>
2565 ID of migration.
2566 nova server-tag-add
2568 usage: nova server-tag-add <server> <tag> [<tag> ...]
2569 Add one or more tags to a server. (Supported by API versions '2.26' -
2571 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2572 message for proper version]
2573 New in version 4.1.0.
2575 Positional arguments:
2578 <server>
2580 Name or ID of server.
2581 <tag> Tag(s) to add.
2583 nova server-tag-delete
2585 usage: nova server-tag-delete <server> <tag> [<tag> ...]
2586 Delete one or more tags from a server. (Supported by API versions
2588 '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2589 help message for proper version]
2590 New in version 4.1.0.
2592 Positional arguments:
2595 <server>
2597 Name or ID of server.
2598 <tag> Tag(s) to delete.
2600 nova server-tag-delete-all
2602 usage: nova server-tag-delete-all <server>
2603 Delete all tags from a server. (Supported by API versions '2.26' -
2605 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2606 message for proper version]
2607 New in version 4.1.0.
2609 Positional arguments:
2612 <server>
2614 Name or ID of server.
2615 nova server-tag-list
2617 usage: nova server-tag-list <server>
2618 Get list of tags from a server. (Supported by API versions '2.26' -
2620 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2621 message for proper version]
2622 New in version 4.1.0.
2624 Positional arguments:
2627 <server>
2629 Name or ID of server.
2630 nova server-tag-set
2632 usage: nova server-tag-set <server> <tags> [<tags> ...]
2633 Set list of tags to a server. (Supported by API versions '2.26' -
2635 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2636 message for proper version]
2637 New in version 4.1.0.
2639 Positional arguments:
2642 <server>
2644 Name or ID of server.
2645 <tags> Tag(s) to set.
2647 nova server-topology
2649 usage: nova server-topology <server>
2650 Retrieve server NUMA topology information. Host specific fields are
2652 only visible to users with the administrative role. (Supported by API
2653 versions '2.78' - '2.latest')
2654 New in version 15.1.0.
2656 Positional arguments:
2659 <server>
2661 Name or ID of server.
2662 nova service-delete
2664 usage: nova service-delete <id>
2665 Delete the service.
2667 IMPORTANT:
2669 If deleting a nova-compute service, be sure to stop the actual
2670 nova-compute process on the physical host before deleting the ser‐
2671 vice with this command. Failing to do so can lead to the running
2672 service re-creating orphaned compute_nodes table records in the
2673 database.
2674 Positional arguments:
2676 <id> ID of service as a UUID. (Supported by API versions '2.53' -
2678 '2.latest')
2679 nova service-disable
2681 usage: nova service-disable [--reason <reason>] <id>
2682 Disable the service.
2684 Positional arguments:
2686 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2688 '2.latest')
2689 Optional arguments:
2691 --reason <reason>
2693 Reason for disabling the service.
2694 nova service-enable
2696 usage: nova service-enable <id>
2697 Enable the service.
2699 Positional arguments:
2701 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2703 '2.latest')
2704 nova service-force-down
2706 usage: nova service-force-down [--unset] <id>
2707 Force service to down. (Supported by API versions '2.11' - '2.latest')
2709 [hint: use '--os-compute-api-version' flag to show help message for
2710 proper version]
2711 New in version 2.27.0.
2713 Positional arguments:
2716 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2718 '2.latest')
2719 Optional arguments:
2721 --unset
2723 Unset the forced_down state of the service.
2724 nova service-list
2726 usage: nova service-list [--host <hostname>] [--binary <binary>]
2727 Show a list of all running services. Filter by host & binary.
2729 Note that from microversion 2.69, during partial infrastructure fail‐
2731 ures in the deployment, the output of this command may return partial
2732 results for the services present in the failure domain.
2733 Optional arguments:
2735 --host <hostname>
2737 Name of host.
2738 --binary <binary>
2740 Service binary.
2741 nova set-password
2743 usage: nova set-password <server>
2744 Change the admin password for a server.
2746 Positional arguments:
2748 <server>
2750 Name or ID of server.
2751 nova shelve
2753 usage: nova shelve <server>
2754 Shelve a server.
2756 Positional arguments:
2758 <server>
2760 Name or ID of server.
2761 nova shelve-offload
2763 usage: nova shelve-offload <server>
2764 Remove a shelved server from the compute node.
2766 Positional arguments:
2768 <server>
2770 Name or ID of server.
2771 nova show
2773 usage: nova show [--minimal] [--wrap <integer>] <server>
2774 Show details about the given server.
2776 Note that from microversion 2.69, during partial infrastructure fail‐
2778 ures in the deployment, the output of this command may return partial
2779 results for the server if it exists in the failure domain.
2780 Positional arguments:
2782 <server>
2784 Name or ID of server.
2785 Optional arguments:
2787 --minimal
2789 Skips flavor/image lookups when showing servers.
2790 --wrap <integer>
2792 Wrap the output to a specified length, or 0 to disable.
2793 nova ssh
2795 usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE]
2796 [--network <network>] [--ipv6] [--login <login>] [-i IDENTITY]
2797 [--extra-opts EXTRA]
2798 <server>
2799 SSH into a server.
2801 Positional arguments:
2803 <server>
2805 Name or ID of server.
2806 Optional arguments:
2808 --port PORT
2810 Optional flag to indicate which port to use for ssh. (De‐
2811 fault=22)
2812 --address-type ADDRESS_TYPE
2814 Optional flag to indicate which IP type to use. Possible values
2815 includes fixed and floating (the Default).
2816 --network <network>
2818 Network to use for the ssh.
2819 --ipv6 Optional flag to indicate whether to use an IPv6 address at‐
2821 tached to a server. (Defaults to IPv4 address)
2822 --login <login>
2824 Login to use.
2825 -i IDENTITY, --identity IDENTITY
2827 Private key file, same as the -i option to the ssh command.
2828 --extra-opts EXTRA
2830 Extra options to pass to ssh. see: man ssh.
2831 nova start
2833 usage: nova start [--all-tenants] <server> [<server> ...]
2834 Start the server(s).
2836 Positional arguments:
2838 <server>
2840 Name or ID of server(s).
2841 Optional arguments:
2843 --all-tenants
2845 Start server(s) in another tenant by name (Admin only).
2846 nova stop
2848 usage: nova stop [--all-tenants] <server> [<server> ...]
2849 Stop the server(s).
2851 Positional arguments:
2853 <server>
2855 Name or ID of server(s).
2856 Optional arguments:
2858 --all-tenants
2860 Stop server(s) in another tenant by name (Admin only).
2861 nova suspend
2863 usage: nova suspend <server>
2864 Suspend a server.
2866 Positional arguments:
2868 <server>
2870 Name or ID of server.
2871 nova trigger-crash-dump
2873 usage: nova trigger-crash-dump <server>
2874 Trigger crash dump in an instance. (Supported by API versions '2.17' -
2876 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2877 message for proper version]
2878 New in version 3.3.0.
2880 Positional arguments:
2883 <server>
2885 Name or ID of server.
2886 nova unlock
2888 usage: nova unlock <server>
2889 Unlock a server.
2891 Positional arguments:
2893 <server>
2895 Name or ID of server.
2896 nova unpause
2898 usage: nova unpause <server>
2899 Unpause a server.
2901 Positional arguments:
2903 <server>
2905 Name or ID of server.
2906 nova unrescue
2908 usage: nova unrescue <server>
2909 Restart the server from normal boot disk again.
2911 Positional arguments:
2913 <server>
2915 Name or ID of server.
2916 nova unshelve
2918 usage: nova unshelve [--availability-zone <availability_zone>] <server>
2919 Unshelve a server.
2921 Positional arguments:
2923 <server>
2925 Name or ID of server.
2926 Optional arguments:
2928 --availability-zone <availability_zone>
2930 Name of the availability zone in which to unshelve a
2931 SHELVED_OFFLOADED server. (Supported by API versions '2.77' -
2932 '2.latest')
2933 nova update
2935 usage: nova update [--name <name>] [--description <description>] <server>
2936 Update the name or the description for a server.
2938 Positional arguments:
2940 <server>
2942 Name (old name) or ID of server.
2943 Optional arguments:
2945 --name <name>
2947 New name for the server.
2948 --description <description>
2950 New description for the server. If it equals to empty string
2951 (i.g. ""), the server description will be removed. (Supported by
2952 API versions '2.19' - '2.latest')
2953 nova usage
2955 usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
2956 Show usage data for a single tenant.
2958 Optional arguments:
2960 --start <start>
2962 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2963 --end <end>
2965 Usage range end date, ex 2012-01-20. (default: tomorrow)
2966 --tenant <tenant-id>
2968 UUID of tenant to get usage for.
2969 nova usage-list
2971 usage: nova usage-list [--start <start>] [--end <end>]
2972 List usage data for all tenants.
2974 Optional arguments:
2976 --start <start>
2978 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2979 --end <end>
2981 Usage range end date, ex 2012-01-20. (default: tomorrow)
2982 nova version-list
2984 usage: nova version-list
2985 List all API versions.
2987 nova volume-attach
2989 usage: nova volume-attach [--delete-on-termination] [--tag <tag>]
2990 <server> <volume> [<device>]
2991 Attach a volume to a server.
2993 Positional arguments:
2995 <server>
2997 Name or ID of server.
2998 <volume>
3000 ID of the volume to attach.
3001 <device>
3003 Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if
3004 supported). Libvirt driver will use default device name.
3005 Optional arguments:
3007 --tag <tag>
3009 Tag for the attached volume. (Supported by API versions '2.49' -
3010 '2.latest')
3011 --delete-on-termination
3013 Specify if the attached volume should be deleted when the server
3014 is destroyed. By default the attached volume is not deleted when
3015 the server is destroyed. (Supported by API versions '2.79' -
3016 '2.latest')
3017 nova volume-attachments
3019 usage: nova volume-attachments <server>
3020 List all the volumes attached to a server.
3022 Positional arguments:
3024 <server>
3026 Name or ID of server.
3027 nova volume-detach
3029 usage: nova volume-detach <server> <volume>
3030 Detach a volume from a server.
3032 Positional arguments:
3034 <server>
3036 Name or ID of server.
3037 <volume>
3039 ID of the volume to detach.
3040 nova volume-update
3042 usage: nova volume-update [--[no-]delete-on-termination]
3043 <server> <src_volume> <dest_volume>
3044 Update the attachment on the server. Migrates the data from an attached
3046 volume to the specified available volume and swaps out the active at‐
3047 tachment to the new volume.
3048 Positional arguments:
3050 <server>
3052 Name or ID of server.
3053 <src_volume>
3055 ID of the source (original) volume.
3056 <dest_volume>
3058 ID of the destination volume.
3059 Optional arguments:
3061 --delete-on-termination
3063 Specify that the volume should be deleted when the server is de‐
3064 stroyed. It is mutually exclusive with '--no-delete-on-termina‐
3065 tion'. (Supported by API versions '2.85' - '2.latest')
3066 --no-delete-on-termination
3068 Specify that the attached volume should not be deleted when the
3069 server is destroyed. It is mutually exclusive with
3070 '--delete-on-termination'. (Supported by API versions '2.85' -
3071 '2.latest')
3072 nova bash-completion
3074 usage: nova bash-completion
3075 Prints all of the commands and options to stdout so that the
3077 nova.bash_completion script doesn't have to hard code them.
3078
3080 OpenStack Contributors
3081
3083 OpenStack Contributors
308417.4.0 Jul 23, 2021 NOVA(1)