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-create
71 Create a new aggregate with the specified details.
72 aggregate-delete
74 Delete the aggregate.
75 aggregate-list
77 Print a list of all aggregates.
78 aggregate-remove-host
80 Remove the specified host from the specified aggregate.
81 aggregate-set-metadata
83 Update the metadata associated with the aggregate.
84 aggregate-show
86 Show details of the specified aggregate.
87 aggregate-update
89 Update the aggregate's name and optionally availability zone.
90 availability-zone-list
92 List all the availability zones.
93 backup Backup a server by creating a 'backup' type snapshot.
95 boot Boot a new server.
97 cell-capacities
99 Get cell capacities for all cells or a given cell.
100 cell-show
102 Show details of a given cell.
103 clear-password
105 Clear the admin password for a server from the metadata server.
106 This action does not actually change the instance server pass‐
107 word.
108 cloudpipe-configure
110 DEPRECATED Update the VPN IP/port of a cloudpipe instance.
111 cloudpipe-create
113 DEPRECATED Create a cloudpipe instance for the given project.
114 cloudpipe-list
116 DEPRECATED Print a list of all cloudpipe instances.
117 console-log
119 Get console log output of a server.
120 delete Immediately shut down and delete specified server(s).
122 diagnostics
124 Retrieve server diagnostics.
125 evacuate
127 Evacuate server from failed host.
128 flavor-access-add
130 Add flavor access for the given tenant.
131 flavor-access-list
133 Print access information about the given flavor.
134 flavor-access-remove
136 Remove flavor access for the given tenant.
137 flavor-create
139 Create a new flavor.
140 flavor-delete
142 Delete a specific flavor
143 flavor-key
145 Set or unset extra_spec for a flavor.
146 flavor-list
148 Print a list of available 'flavors' (sizes of servers).
149 flavor-show
151 Show details about the given flavor.
152 flavor-update
154 Update the description of an existing flavor. (Supported by API
155 versions '2.55' - '2.latest') [hint: use '--os-compute-api-ver‐
156 sion' flag to show help message for proper version]
157 floating-ip-associate
159 DEPRECATED Associate a floating IP address to a server.
160 floating-ip-disassociate
162 DEPRECATED Disassociate a floating IP address from a server.
163 force-delete
165 Force delete a server.
166 get-mks-console
168 Get an MKS console to a server. (Supported by API versions '2.8'
169 - '2.latest') [hint: use '--os-compute-api-version' flag to show
170 help message for proper version]
171 get-password
173 Get the admin password for a server. This operation calls the
174 metadata service to query metadata information and does not read
175 password information from the server itself.
176 get-rdp-console
178 Get a rdp console to a server.
179 get-serial-console
181 Get a serial console to a server.
182 get-spice-console
184 Get a spice console to a server.
185 get-vnc-console
187 Get a vnc console to a server.
188 host-action
190 DEPRECATED Perform a power action on a host.
191 host-describe
193 DEPRECATED Describe a specific host.
194 host-evacuate
196 Evacuate all instances from failed host.
197 host-evacuate-live
199 Live migrate all instances off the specified host to other
200 available hosts.
201 host-list
203 DEPRECATED List all hosts by service.
204 host-meta
206 Set or Delete metadata on all instances of a host.
207 host-servers-migrate
209 Cold migrate all instances off the specified host to other
210 available hosts.
211 host-update
213 DEPRECATED Update host settings.
214 hypervisor-list
216 List hypervisors. (Supported by API versions '2.0' - '2.latest')
217 [hint: use '--os-compute-api-version' flag to show help message
218 for proper version]
219 hypervisor-servers
221 List servers belonging to specific hypervisors.
222 hypervisor-show
224 Display the details of the specified hypervisor.
225 hypervisor-stats
227 Get hypervisor statistics over all compute nodes.
228 hypervisor-uptime
230 Display the uptime of the specified hypervisor.
231 image-create
233 Create a new image by taking a snapshot of a running server.
234 instance-action
236 Show an action.
237 instance-action-list
239 List actions on a server.
240 instance-usage-audit-log
242 List/Get server usage audits.
243 interface-attach
245 Attach a network interface to a server.
246 interface-detach
248 Detach a network interface from a server.
249 interface-list
251 List interfaces attached to a server.
252 keypair-add
254 Create a new key pair for use with servers.
255 keypair-delete
257 Delete keypair given by its name. (Supported by API versions
258 '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag
259 to show help message for proper version]
260 keypair-list
262 Print a list of keypairs for a user (Supported by API versions
263 '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag
264 to show help message for proper version]
265 keypair-show
267 Show details about the given keypair. (Supported by API ver‐
268 sions '2.0' - '2.latest') [hint: use '--os-compute-api-version'
269 flag to show help message for proper version]
270 limits Print rate and absolute limits.
272 list List servers.
274 list-extensions
276 List all the os-api extensions that are available.
277 list-secgroup
279 List Security Group(s) of a server.
280 live-migration
282 Migrate running server to a new machine.
283 live-migration-abort
285 Abort an on-going live migration. (Supported by API versions
286 '2.24' - '2.latest') [hint: use '--os-compute-api-version' flag
287 to show help message for proper version]
288 live-migration-force-complete
290 Force on-going live migration to complete. (Supported by API
291 versions '2.22' - '2.latest') [hint: use '--os-compute-api-ver‐
292 sion' flag to show help message for proper version]
293 lock Lock a server. A normal (non-admin) user will not be able to
295 execute actions on a locked server.
296 meta Set or delete metadata on a server.
298 migrate
300 Migrate a server. The new host will be selected by the sched‐
301 uler.
302 migration-list
304 Print a list of migrations.
305 pause Pause a server.
307 quota-class-show
309 List the quotas for a quota class.
310 quota-class-update
312 Update the quotas for a quota class. (Supported by API versions
313 '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag
314 to show help message for proper version]
315 quota-defaults
317 List the default quotas for a tenant.
318 quota-delete
320 Delete quota for a tenant/user so their quota will Revert back
321 to default.
322 quota-show
324 List the quotas for a tenant/user.
325 quota-update
327 Update the quotas for a tenant/user. (Supported by API versions
328 '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag
329 to show help message for proper version]
330 reboot Reboot a server.
332 rebuild
334 Shutdown, re-image, and re-boot a server.
335 refresh-network
337 Refresh server network information.
338 remove-fixed-ip
340 DEPRECATED Remove an IP address from a server.
341 remove-secgroup
343 Remove a Security Group from a server.
344 rescue Reboots a server into rescue mode, which starts the machine from
346 either the initial image or a specified image, attaching the
347 current boot disk as secondary.
348 reset-network
350 Reset network of a server.
351 reset-state
353 Reset the state of a server.
354 resize Resize a server.
356 resize-confirm
358 Confirm a previous resize.
359 resize-revert
361 Revert a previous resize (and return to the previous VM).
362 restore
364 Restore a soft-deleted server.
365 resume Resume a server.
367 server-group-create
369 Create a new server group with the specified details.
370 server-group-delete
372 Delete specific server group(s).
373 server-group-get
375 Get a specific server group.
376 server-group-list
378 Print a list of all server groups.
379 server-migration-list
381 Get the migrations list of specified server. (Supported by API
382 versions '2.23' - '2.latest') [hint: use '--os-compute-api-ver‐
383 sion' flag to show help message for proper version]
384 server-migration-show
386 Get the migration of specified server. (Supported by API ver‐
387 sions '2.23' - '2.latest') [hint: use '--os-compute-api-version'
388 flag to show help message for proper version]
389 server-tag-add
391 Add one or more tags to a server. (Supported by API versions
392 '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag
393 to show help message for proper version]
394 server-tag-delete
396 Delete one or more tags from a server. (Supported by API ver‐
397 sions '2.26' - '2.latest') [hint: use '--os-compute-api-version'
398 flag to show help message for proper version]
399 server-tag-delete-all
401 Delete all tags from a server. (Supported by API versions '2.26'
402 - '2.latest') [hint: use '--os-compute-api-version' flag to show
403 help message for proper version]
404 server-tag-list
406 Get list of tags from a server. (Supported by API versions
407 '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag
408 to show help message for proper version]
409 server-tag-set
411 Set list of tags to a server. (Supported by API versions '2.26'
412 - '2.latest') [hint: use '--os-compute-api-version' flag to show
413 help message for proper version]
414 server-topology
416 Retrieve NUMA topology of the given server.
417 service-delete
419 Delete the service.
420 service-disable
422 Disable the service.
423 service-enable
425 Enable the service.
426 service-force-down
428 Force service to down. (Supported by API versions '2.11' -
429 '2.latest') [hint: use '--os-compute-api-version' flag to show
430 help message for proper version]
431 service-list
433 Show a list of all running services. Filter by host & binary.
434 set-password
436 Change the admin password for a server.
437 shelve Shelve a server.
439 shelve-offload
441 Remove a shelved server from the compute node.
442 show Show details about the given server.
444 ssh SSH into a server.
446 start Start the server(s).
448 stop Stop the server(s).
450 suspend
452 Suspend a server.
453 trigger-crash-dump
455 Trigger crash dump in an instance. (Supported by API versions
456 '2.17' - '2.latest') [hint: use '--os-compute-api-version' flag
457 to show help message for proper version]
458 unlock Unlock a server.
460 unpause
462 Unpause a server.
463 unrescue
465 Restart the server from normal boot disk again.
466 unshelve
468 Unshelve a server.
469 update Update the name or the description for a server.
471 usage Show usage data for a single tenant.
473 usage-list
475 List usage data for all tenants.
476 version-list
478 List all API versions.
479 virtual-interface-list
481 DEPRECATED Show virtual interface info about the given server.
482 volume-attach
484 Attach a volume to a server.
485 volume-attachments
487 List all the volumes attached to a server.
488 volume-detach
490 Detach a volume from a server.
491 volume-update
493 Update the attachment on the server. Migrates the data from an
494 attached volume to the specified available volume and swaps out
495 the active attachment to the new volume.
496 x509-create-cert
498 DEPRECATED Create x509 cert for a user in tenant.
499 x509-get-root-cert
501 DEPRECATED Fetch the x509 root cert.
502 bash-completion
504 Prints all of the commands and options to stdout so that the
505 nova.bash_completion script doesn't have to hard code them.
506 help Display help about this program or one of its subcommands.
508
510 --version
511 show program's version number and exit
512 --debug
514 Print debugging output.
515 --os-cache
517 Use the auth token cache. Defaults to False if env[OS_CACHE] is
518 not set.
519 --timings
521 Print call timing info.
522 --os-region-name <region-name>
524 Defaults to env[OS_REGION_NAME].
525 --service-type <service-type>
527 Defaults to compute for most actions.
528 --service-name <service-name>
530 Defaults to env[NOVA_SERVICE_NAME].
531 --os-endpoint-type <endpoint-type>
533 Defaults to env[NOVA_ENDPOINT_TYPE], env[OS_ENDPOINT_TYPE] or
534 publicURL.
535 --os-compute-api-version <compute-api-ver>
537 Accepts X, X.Y (where X is major and Y is minor part) or "X.lat‐
538 est", defaults to env[OS_COMPUTE_API_VERSION].
539 --os-endpoint-override <bypass-url>
541 Use this API endpoint instead of the Service Catalog. Defaults
542 to env[OS_ENDPOINT_OVERRIDE].
543 --profile HMAC_KEY
545 HMAC key to use for encrypting context data for performance pro‐
546 filing of operation. This key should be the value of the HMAC
547 key configured for the OSprofiler middleware in nova; it is
548 specified in the Nova configuration file at
549 "/etc/nova/nova.conf". Without the key, profiling will not be
550 triggered even if OSprofiler is enabled on the server side.
551 --os-auth-type <name>, --os-auth-plugin <name>
553 Authentication type to use
554 nova add-secgroup
556 usage: nova add-secgroup <server> <secgroup>
557 Add a Security Group to a server.
559 Positional arguments:
561 <server>
563 Name or ID of server.
564 <secgroup>
566 Name or ID of Security Group.
567 nova agent-create
569 usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
570 <hypervisor>
571 Create new agent build.
573 Positional arguments:
575 <os> Type of OS.
577 <architecture>
579 Type of architecture.
580 <version>
582 Version.
583 <url> URL.
585 <md5hash>
587 MD5 hash.
588 <hypervisor>
590 Type of hypervisor.
591 nova agent-delete
593 usage: nova agent-delete <id>
594 Delete existing agent build.
596 Positional arguments:
598 <id> ID of the agent-build.
600 nova agent-list
602 usage: nova agent-list [--hypervisor <hypervisor>]
603 List all builds.
605 Optional arguments:
607 --hypervisor <hypervisor>
609 Type of hypervisor.
610 nova agent-modify
612 usage: nova agent-modify <id> <version> <url> <md5hash>
613 Modify existing agent build.
615 Positional arguments:
617 <id> ID of the agent-build.
619 <version>
621 Version.
622 <url> URL
624 <md5hash>
626 MD5 hash.
627 nova aggregate-add-host
629 usage: nova aggregate-add-host <aggregate> <host>
630 Add the host to the specified aggregate.
632 Positional arguments:
634 <aggregate>
636 Name or ID of aggregate.
637 <host> The host to add to the aggregate.
639 nova aggregate-create
641 usage: nova aggregate-create <name> [<availability-zone>]
642 Create a new aggregate with the specified details.
644 Positional arguments:
646 <name> Name of aggregate.
648 <availability-zone>
650 The availability zone of the aggregate (optional).
651 nova aggregate-delete
653 usage: nova aggregate-delete <aggregate>
654 Delete the aggregate.
656 Positional arguments:
658 <aggregate>
660 Name or ID of aggregate to delete.
661 nova aggregate-list
663 usage: nova aggregate-list
664 Print a list of all aggregates.
666 nova aggregate-remove-host
668 usage: nova aggregate-remove-host <aggregate> <host>
669 Remove the specified host from the specified aggregate.
671 Positional arguments:
673 <aggregate>
675 Name or ID of aggregate.
676 <host> The host to remove from the aggregate.
678 nova aggregate-set-metadata
680 usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
681 Update the metadata associated with the aggregate.
683 Positional arguments:
685 <aggregate>
687 Name or ID of aggregate to update.
688 <key=value>
690 Metadata to add/update to aggregate. Specify only the key to
691 delete a metadata item.
692 nova aggregate-show
694 usage: nova aggregate-show <aggregate>
695 Show details of the specified aggregate.
697 Positional arguments:
699 <aggregate>
701 Name or ID of aggregate.
702 nova aggregate-update
704 usage: nova aggregate-update [--name NAME]
705 [--availability-zone <availability-zone>]
706 <aggregate>
707 Update the aggregate's name and optionally availability zone.
709 Positional arguments:
711 <aggregate>
713 Name or ID of aggregate to update.
714 Optional arguments:
716 --name NAME
718 New name for aggregate.
719 --availability-zone <availability-zone>
721 New availability zone for aggregate.
722 nova availability-zone-list
724 usage: nova availability-zone-list
725 List all the availability zones.
727 nova backup
729 usage: nova backup <server> <name> <backup-type> <rotation>
730 Backup a server by creating a 'backup' type snapshot.
732 Positional arguments:
734 <server>
736 Name or ID of server.
737 <name> Name of the backup image.
739 <backup-type>
741 The backup type, like "daily" or "weekly".
742 <rotation>
744 Int parameter representing how many backups to keep around.
745 nova boot
747 usage: nova boot [--flavor <flavor>] [--image <image>]
748 [--image-with <key=value>] [--boot-volume <volume_id>]
749 [--snapshot <snapshot_id>] [--min-count <number>]
750 [--max-count <number>] [--meta <key=value>]
751 [--key-name <key-name>] [--user-data <user-data>]
752 [--availability-zone <availability-zone>]
753 [--security-groups <security-groups>]
754 [--block-device-mapping <dev-name=mapping>]
755 [--block-device key1=value1[,key2=value2...]]
756 [--swap <swap_size>]
757 [--ephemeral size=<size>[,format=<format>]]
758 [--hint <key=value>]
759 [--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>]
760 [--config-drive <value>] [--poll] [--admin-pass <value>]
761 [--access-ip-v4 <value>] [--access-ip-v6 <value>]
762 [--description <description>] [--tags <tags>]
763 [--return-reservation-id]
764 [--trusted-image-certificate-id <trusted-image-certificate-id>]
765 [--host <host>]
766 [--hypervisor-hostname <hypervisor-hostname>]
767 <name>
768 Boot a new server.
770 In order to create a server with pre-existing ports that contain a
772 resource_request value, such as for guaranteed minimum bandwidth qual‐
773 ity of service support, microversion 2.72 is required.
774 Positional arguments:
776 <name> Name for the new server.
778 Optional arguments:
780 --flavor <flavor>
782 Name or ID of flavor (see 'nova flavor-list').
783 --image <image>
785 Name or ID of image (see 'glance image-list').
786 --image-with <key=value>
788 Image metadata property (see 'glance image-show').
789 --boot-volume <volume_id>
791 Volume ID to boot from.
792 --snapshot <snapshot_id>
794 Snapshot ID to boot from (will create a volume).
795 --min-count <number>
797 Boot at least <number> servers (limited by quota).
798 --max-count <number>
800 Boot up to <number> servers (limited by quota).
801 --meta <key=value>
803 Record arbitrary key/value metadata to /meta_data.json on the
804 metadata server. Can be specified multiple times.
805 --key-name <key-name>
807 Key name of keypair that should be created earlier with the com‐
808 mand keypair-add.
809 --user-data <user-data>
811 user data file to pass to be exposed by the metadata server.
812 --availability-zone <availability-zone>
814 The availability zone for server placement.
815 --security-groups <security-groups>
817 Comma separated list of security group names.
818 --block-device-mapping <dev-name=mapping>
820 Block device mapping in the format
821 <dev-name>=<id>:<type>:<size(GiB)>:<delete-on-terminate>.
822 --block-device
824 key1=value1[,key2=value2...] Block device mapping with the
825 keys: id=UUID (image_id, snapshot_id or volume_id only if using
826 source image, snapshot or volume) source=source type (image,
827 snapshot, volume or blank), dest=destination type of the block
828 device (volume or local), bus=device's bus (e.g. uml, lxc, vir‐
829 tio, ...; if omitted, hypervisor driver chooses a suitable
830 default, honoured only if device type is supplied) type=device
831 type (e.g. disk, cdrom, ...; defaults to 'disk') device=name of
832 the device (e.g. vda, xda, ...; if omitted, hypervisor driver
833 chooses suitable device depending on selected bus; note the lib‐
834 virt driver always uses default device names), size=size of the
835 block device in MiB(for swap) and in GiB(for other formats) (if
836 omitted, hypervisor driver calculates size), format=device will
837 be formatted (e.g. swap, ntfs, ...; optional), bootindex=integer
838 used for ordering the boot disks (for image backed instances it
839 is equal to 0, for others need to be specified), shutdown=shut‐
840 down behaviour (either preserve or remove, for local destination
841 set to remove), tag=device metadata tag (optional; supported by
842 API versions '2.42' - '2.latest'), and volume_type=type of vol‐
843 ume to create (either ID or name) when source is blank, image or
844 snapshot and dest is volume (optional; supported by API versions
845 '2.67' - '2.latest').
846 --swap <swap_size>
848 Create and attach a local swap block device of <swap_size> MiB.
849 --ephemeral
851 size=<size>[,format=<format>] Create and attach a local
852 ephemeral block device of <size> GiB and format it to <format>.
853 --hint <key=value>
855 Send arbitrary key/value pairs to the scheduler for custom use.
856 --nic <auto,none,net-id=net-uuid,net-name=net‐
858 work-name,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag>
859 Create a NIC on the server. Specify option multiple times to
860 create multiple nics unless using the special 'auto' or 'none'
861 values. auto: automatically allocate network resources if none
862 are available. This cannot be specified with any other nic value
863 and cannot be specified multiple times. none: do not attach a
864 NIC at all. This cannot be specified with any other nic value
865 and cannot be specified multiple times. net-id: attach NIC to
866 network with a specific UUID. net-name: attach NIC to network
867 with this name (either port-id or net-id or net-name must be
868 provided), v4-fixed-ip: IPv4 fixed address for NIC (optional),
869 v6-fixed-ip: IPv6 fixed address for NIC (optional), port-id:
870 attach NIC to port with this UUID tag: interface metadata tag
871 (optional) (either port-id or net-id must be provided). (Sup‐
872 ported by API versions '2.42' - '2.latest')
873 --config-drive <value>
875 Enable config drive.
876 --poll Report the new server boot progress until it completes.
878 --admin-pass <value>
880 Admin password for the instance.
881 --access-ip-v4 <value>
883 Alternative access IPv4 of the instance.
884 --access-ip-v6 <value>
886 Alternative access IPv6 of the instance.
887 --description <description>
889 Description for the server. (Supported by API versions '2.19' -
890 '2.latest')
891 --tags <tags>
893 Tags for the server.Tags must be separated by commas: --tags
894 <tag1,tag2> (Supported by API versions '2.52' - '2.latest')
895 --return-reservation-id
897 Return a reservation id bound to created servers.
898 --trusted-image-certificate-id <trusted-image-certificate-id>
900 Trusted image certificate IDs used to validate certificates dur‐
901 ing the image signature verification process. Defaults to
902 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
903 ple times to pass multiple trusted image certificate IDs. (Sup‐
904 ported by API versions '2.63' - '2.latest')
905 --host <host>
907 Requested host to create servers. Admin only by default. (Sup‐
908 ported by API versions '2.74' - '2.latest')
909 --hypervisor-hostname <hypervisor-hostname>
911 Requested hypervisor hostname to create servers. Admin only by
912 default. (Supported by API versions '2.74' - '2.latest')
913 nova cell-capacities
915 usage: nova cell-capacities [--cell <cell-name>]
916 Get cell capacities for all cells or a given cell.
918 Optional arguments:
920 --cell <cell-name>
922 Name of the cell to get the capacities.
923 nova cell-show
925 usage: nova cell-show <cell-name>
926 Show details of a given cell.
928 Positional arguments:
930 <cell-name>
932 Name of the cell.
933 nova clear-password
935 usage: nova clear-password <server>
936 Clear the admin password for a server from the metadata server. This
938 action does not actually change the instance server password.
939 Positional arguments:
941 <server>
943 Name or ID of server.
944 nova console-log
946 usage: nova console-log [--length <length>] <server>
947 Get console log output of a server.
949 Locale encoding issues
951 If you encounter an error such as:
953 UnicodeEncodeError: 'ascii' codec can't encode characters in position
955 The solution to these problems is different depending on which locale
957 your computer is running in.
958 For instance, if you have a German Linux machine, you can fix the prob‐
960 lem by exporting the locale to de_DE.utf-8:
961 export LC_ALL=de_DE.utf-8
963 export LANG=de_DE.utf-8
964 If you are on a US machine, en_US.utf-8 is the encoding of choice. On
966 some newer Linux systems, you could also try C.UTF-8 as the locale:
967 export LC_ALL=C.UTF-8
969 export LANG=C.UTF-8
970 Positional arguments:
972 <server>
974 Name or ID of server.
975 Optional arguments:
977 --length <length>
979 Length in lines to tail.
980 nova delete
982 usage: nova delete [--all-tenants] <server> [<server> ...]
983 Immediately shut down and delete specified server(s).
985 Positional arguments:
987 <server>
989 Name or ID of server(s).
990 Optional arguments:
992 --all-tenants
994 Delete server(s) in another tenant by name (Admin only).
995 nova diagnostics
997 usage: nova diagnostics <server>
998 Retrieve server diagnostics.
1000 Positional arguments:
1002 <server>
1004 Name or ID of server.
1005 nova evacuate
1007 usage: nova evacuate [--password <password>] [--on-shared-storage] [--force] <server> [<host>]
1008 Evacuate server from failed host.
1010 Positional arguments:
1012 <server>
1014 Name or ID of server.
1015 <host> Name or ID of the target host. If no host is specified, the
1017 scheduler will choose one.
1018 Optional arguments:
1020 --password <password>
1022 Set the provided admin password on the evacuated server. Not
1023 applicable if the server is on shared storage.
1024 --on-shared-storage
1026 Specifies whether server files are located on shared storage.
1027 (Supported by API versions '2.0' - '2.13')
1028 --force
1030 Force an evacuation by not verifying the provided destination
1031 host by the scheduler. (Supported by API versions '2.29' -
1032 '2.67')
1033 WARNING:
1035 This could result in failures to actually evacuate the server
1036 to the specified host. It is recommended to either not spec‐
1037 ify a host so that the scheduler will pick one, or specify a
1038 host without --force.
1039 nova flavor-access-add
1041 usage: nova flavor-access-add <flavor> <tenant_id>
1042 Add flavor access for the given tenant.
1044 Positional arguments:
1046 <flavor>
1048 Flavor name or ID to add access for the given tenant.
1049 <tenant_id>
1051 Tenant ID to add flavor access for.
1052 nova flavor-access-list
1054 usage: nova flavor-access-list [--flavor <flavor>]
1055 Print access information about the given flavor.
1057 Optional arguments:
1059 --flavor <flavor>
1061 Filter results by flavor name or ID.
1062 nova flavor-access-remove
1064 usage: nova flavor-access-remove <flavor> <tenant_id>
1065 Remove flavor access for the given tenant.
1067 Positional arguments:
1069 <flavor>
1071 Flavor name or ID to remove access for the given tenant.
1072 <tenant_id>
1074 Tenant ID to remove flavor access for.
1075 nova flavor-create
1077 usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
1078 [--rxtx-factor <factor>] [--is-public <is-public>]
1079 [--description <description>]
1080 <name> <id> <ram> <disk> <vcpus>
1081 Create a new flavor.
1083 Positional arguments:
1085 <name> Unique name of the new flavor.
1087 <id> Unique ID of the new flavor. Specifying 'auto' will generated a
1089 UUID for the ID.
1090 <ram> Memory size in MiB.
1092 <disk> Disk size in GiB.
1094 <vcpus>
1096 Number of vcpus
1097 Optional arguments:
1099 --ephemeral <ephemeral>
1101 Ephemeral space size in GiB (default 0).
1102 --swap <swap>
1104 Swap space size in MiB (default 0).
1105 --rxtx-factor <factor>
1107 RX/TX factor (default 1).
1108 --is-public <is-public>
1110 Make flavor accessible to the public (default true).
1111 --description <description>
1113 A free form description of the flavor. Limited to 65535 charac‐
1114 ters in length. Only printable characters are allowed. (Sup‐
1115 ported by API versions '2.55' - '2.latest')
1116 nova flavor-delete
1118 usage: nova flavor-delete <flavor>
1119 Delete a specific flavor
1121 Positional arguments:
1123 <flavor>
1125 Name or ID of the flavor to delete.
1126 nova flavor-key
1128 usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
1129 Set or unset extra_spec for a flavor.
1131 Positional arguments:
1133 <flavor>
1135 Name or ID of flavor.
1136 <action>
1138 Actions: 'set' or 'unset'.
1139 <key=value>
1141 Extra_specs to set/unset (only key is necessary on unset).
1142 nova flavor-list
1144 usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
1145 [--min-disk <min-disk>] [--min-ram <min-ram>]
1146 [--limit <limit>] [--sort-key <sort-key>]
1147 [--sort-dir <sort-dir>]
1148 Print a list of available 'flavors' (sizes of servers).
1150 Optional arguments:
1152 --extra-specs
1154 Get extra-specs of each flavor.
1155 --all Display all flavors (Admin only).
1157 --marker <marker>
1159 The last flavor ID of the previous page; displays list of fla‐
1160 vors after "marker".
1161 --min-disk <min-disk>
1163 Filters the flavors by a minimum disk space, in GiB.
1164 --min-ram <min-ram>
1166 Filters the flavors by a minimum RAM, in MiB.
1167 --limit <limit>
1169 Maximum number of flavors to display. If limit is bigger than
1170 'CONF.api.max_limit' option of Nova API, limit
1171 'CONF.api.max_limit' will be used instead.
1172 --sort-key <sort-key>
1174 Flavors list sort key.
1175 --sort-dir <sort-dir>
1177 Flavors list sort direction.
1178 nova flavor-show
1180 usage: nova flavor-show <flavor>
1181 Show details about the given flavor.
1183 Positional arguments:
1185 <flavor>
1187 Name or ID of flavor.
1188 nova flavor-update
1190 usage: nova flavor-update <flavor> <description>
1191 Update the description of an existing flavor. (Supported by API ver‐
1193 sions '2.55' - '2.latest') [hint: use '--os-compute-api-version' flag
1194 to show help message for proper version]
1195 New in version 10.0.0.
1197 Positional arguments
1200 <flavor>
1202 Name or ID of the flavor to update.
1203 <description>
1205 A free form description of the flavor. Limited to 65535 charac‐
1206 ters in length. Only printable characters are allowed.
1207 nova force-delete
1209 usage: nova force-delete <server>
1210 Force delete a server.
1212 Positional arguments:
1214 <server>
1216 Name or ID of server.
1217 nova get-mks-console
1219 usage: nova get-mks-console <server>
1220 Get an MKS console to a server. (Supported by API versions '2.8' -
1222 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1223 message for proper version]
1224 New in version 3.0.0.
1226 Positional arguments:
1229 <server>
1231 Name or ID of server.
1232 nova get-password
1234 usage: nova get-password <server> [<private-key>]
1235 Get the admin password for a server. This operation calls the metadata
1237 service to query metadata information and does not read password infor‐
1238 mation from the server itself.
1239 Positional arguments:
1241 <server>
1243 Name or ID of server.
1244 <private-key>
1246 Private key (used locally to decrypt password) (Optional). When
1247 specified, the command displays the clear (decrypted) VM pass‐
1248 word. When not specified, the ciphered VM password is displayed.
1249 nova get-rdp-console
1251 usage: nova get-rdp-console <server> <console-type>
1252 Get a rdp console to a server.
1254 Positional arguments:
1256 <server>
1258 Name or ID of server.
1259 <console-type>
1261 Type of rdp console ("rdp-html5").
1262 nova get-serial-console
1264 usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>
1265 Get a serial console to a server.
1267 Positional arguments:
1269 <server>
1271 Name or ID of server.
1272 Optional arguments:
1274 --console-type CONSOLE_TYPE
1276 Type of serial console, default="serial".
1277 nova get-spice-console
1279 usage: nova get-spice-console <server> <console-type>
1280 Get a spice console to a server.
1282 Positional arguments:
1284 <server>
1286 Name or ID of server.
1287 <console-type>
1289 Type of spice console ("spice-html5").
1290 nova get-vnc-console
1292 usage: nova get-vnc-console <server> <console-type>
1293 Get a vnc console to a server.
1295 Positional arguments:
1297 <server>
1299 Name or ID of server.
1300 <console-type>
1302 Type of vnc console ("novnc" or "xvpvnc").
1303 nova host-evacuate
1305 usage: nova host-evacuate [--target_host <target_host>] [--force] [--strict]
1306 <host>
1307 Evacuate all instances from failed host.
1309 Positional arguments:
1311 <host> The hypervisor hostname (or pattern) to search for.
1313 WARNING:
1315 Use a fully qualified domain name if you only want to evacu‐
1316 ate from a specific host.
1317 Optional arguments:
1319 --target_host <target_host>
1321 Name of target host. If no host is specified the scheduler will
1322 select a target.
1323 --force
1325 Force an evacuation by not verifying the provided destination
1326 host by the scheduler. (Supported by API versions '2.29' -
1327 '2.67')
1328 WARNING:
1330 This could result in failures to actually evacuate the server
1331 to the specified host. It is recommended to either not spec‐
1332 ify a host so that the scheduler will pick one, or specify a
1333 host without --force.
1334 --strict
1336 Evacuate host with exact hypervisor hostname match
1337 nova host-evacuate-live
1339 usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
1340 [--max-servers <max_servers>] [--force]
1341 [--strict]
1342 <host>
1343 Live migrate all instances off the specified host to other available
1345 hosts.
1346 Positional arguments:
1348 <host> Name of host. The hypervisor hostname (or pattern) to search
1350 for.
1351 WARNING:
1353 Use a fully qualified domain name if you only want to live
1354 migrate from a specific host.
1355 Optional arguments:
1357 --target-host <target_host>
1359 Name of target host. If no host is specified, the scheduler will
1360 choose one.
1361 --block-migrate
1363 Enable block migration. (Default=auto) (Supported by API ver‐
1364 sions '2.25' - '2.latest')
1365 --max-servers <max_servers>
1367 Maximum number of servers to live migrate simultaneously
1368 --force
1370 Force a live-migration by not verifying the provided destination
1371 host by the scheduler. (Supported by API versions '2.30' -
1372 '2.67')
1373 WARNING:
1375 This could result in failures to actually live migrate the
1376 servers to the specified host. It is recommended to either
1377 not specify a host so that the scheduler will pick one, or
1378 specify a host without --force.
1379 --strict
1381 live Evacuate host with exact hypervisor hostname match
1382 nova host-meta
1384 usage: nova host-meta [--strict] <host> <action> <key=value> [<key=value> ...]
1385 Set or Delete metadata on all instances of a host.
1387 Positional arguments:
1389 <host> The hypervisor hostname (or pattern) to search for.
1391 WARNING:
1393 Use a fully qualified domain name if you only want to update
1394 metadata for servers on a specific host.
1395 <action>
1397 Actions: 'set' or 'delete'
1398 <key=value>
1400 Metadata to set or delete (only key is necessary on delete)
1401 Optional arguments:
1403 --strict
1405 Set host-meta to the hypervisor with exact hostname match
1406 nova host-servers-migrate
1408 usage: nova host-servers-migrate [--strict] <host>
1409 Cold migrate all instances off the specified host to other available
1411 hosts.
1412 Positional arguments:
1414 <host> Name of host. The hypervisor hostname (or pattern) to search
1416 for.
1417 WARNING:
1419 Use a fully qualified domain name if you only want to cold
1420 migrate from a specific host.
1421 Optional arguments:
1423 --strict
1425 Migrate host with exact hypervisor hostname match
1426 nova hypervisor-list
1428 usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
1429 [--limit <limit>]
1430 List hypervisors. (Supported by API versions '2.0' - '2.latest') [hint:
1432 use '--os-compute-api-version' flag to show help message for proper
1433 version]
1434 Optional arguments:
1436 --matching <hostname>
1438 List hypervisors matching the given <hostname>. If matching is
1439 used limit and marker options will be ignored.
1440 --marker <marker>
1442 The last hypervisor of the previous page; displays list of
1443 hypervisors after "marker".
1444 --limit <limit>
1446 Maximum number of hypervisors to display. If limit is bigger
1447 than 'CONF.api.max_limit' option of Nova API, limit
1448 'CONF.api.max_limit' will be used instead.
1449 nova hypervisor-servers
1451 usage: nova hypervisor-servers <hostname>
1452 List servers belonging to specific hypervisors.
1454 Positional arguments:
1456 <hostname>
1458 The hypervisor hostname (or pattern) to search for.
1459 nova hypervisor-show
1461 usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
1462 Display the details of the specified hypervisor.
1464 Positional arguments:
1466 <hypervisor>
1468 Name or ID of the hypervisor. Starting with microversion 2.53
1469 the ID must be a UUID.
1470 Optional arguments:
1472 --wrap <integer>
1474 Wrap the output to a specified length. Default is 40 or 0 to
1475 disable
1476 nova hypervisor-stats
1478 usage: nova hypervisor-stats
1479 Get hypervisor statistics over all compute nodes.
1481 nova hypervisor-uptime
1483 usage: nova hypervisor-uptime <hypervisor>
1484 Display the uptime of the specified hypervisor.
1486 Positional arguments:
1488 <hypervisor>
1490 Name or ID of the hypervisor. Starting with microversion 2.53
1491 the ID must be a UUID.
1492 nova image-create
1494 usage: nova image-create [--metadata <key=value>] [--show] [--poll]
1495 <server> <name>
1496 Create a new image by taking a snapshot of a running server.
1498 Positional arguments:
1500 <server>
1502 Name or ID of server.
1503 <name> Name of snapshot.
1505 Optional arguments:
1507 --metadata <key=value>
1509 Record arbitrary key/value metadata to /meta_data.json on the
1510 metadata server. Can be specified multiple times.
1511 --show Print image info.
1513 --poll Report the snapshot progress and poll until image creation is
1515 complete.
1516 nova instance-action
1518 usage: nova instance-action <server> <request_id>
1519 Show an action.
1521 Positional arguments:
1523 <server>
1525 Name or UUID of the server to show actions for. Only UUID can be
1526 used to show actions for a deleted server. (Supported by API
1527 versions '2.21' - '2.latest')
1528 <request_id>
1530 Request ID of the action to get.
1531 nova instance-action-list
1533 usage: nova instance-action-list [--marker <marker>] [--limit <limit>]
1534 [--changes-since <changes_since>]
1535 [--changes-before <changes_before>]
1536 <server>
1537 List actions on a server.
1539 Positional arguments:
1541 <server>
1543 Name or UUID of the server to list actions for. Only UUID can be
1544 used to list actions on a deleted server. (Supported by API ver‐
1545 sions '2.21' - '2.latest')
1546 Optional arguments:
1548 --marker <marker>
1550 The last instance action of the previous page; displays list of
1551 actions after "marker". (Supported by API versions '2.58' -
1552 '2.latest')
1553 --limit <limit>
1555 Maximum number of instance actions to display. Note that there
1556 is a configurable max limit on the server, and the limit that is
1557 used will be the minimum of what is requested here and what is
1558 configured in the server. (Supported by API versions '2.58' -
1559 '2.latest')
1560 --changes-since <changes_since>
1562 List only instance actions changed later or equal to a certain
1563 point of time. The provided time should be an ISO 8061 formatted
1564 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1565 '2.58' - '2.latest')
1566 --changes-before <changes_before>
1568 List only instance actions changed earlier or equal to a certain
1569 point of time. The provided time should be an ISO 8061 formatted
1570 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1571 '2.66' - '2.latest')
1572 nova instance-usage-audit-log
1574 usage: nova instance-usage-audit-log [--before <before>]
1575 List/Get server usage audits.
1577 Optional arguments:
1579 --before <before>
1581 Filters the response by the date and time before which to list
1582 usage audits. The date and time stamp format is as follows:
1583 CCYY-MM-DD hh:mm:ss.NNNNNN ex 2015-08-27 09:49:58 or 2015-08-27
1584 09:49:58.123456.
1585 nova interface-attach
1587 usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
1588 [--fixed-ip <fixed_ip>] [--tag <tag>]
1589 <server>
1590 Attach a network interface to a server.
1592 Positional arguments:
1594 <server>
1596 Name or ID of server.
1597 Optional arguments:
1599 --port-id <port_id>
1601 Port ID.
1602 --net-id <net_id>
1604 Network ID
1605 --fixed-ip <fixed_ip>
1607 Requested fixed IP.
1608 --tag <tag>
1610 Tag for the attached interface. (Supported by API versions
1611 '2.49' - '2.latest')
1612 nova interface-detach
1614 usage: nova interface-detach <server> <port_id>
1615 Detach a network interface from a server.
1617 Positional arguments:
1619 <server>
1621 Name or ID of server.
1622 <port_id>
1624 Port ID.
1625 nova interface-list
1627 usage: nova interface-list <server>
1628 List interfaces attached to a server.
1630 Positional arguments:
1632 <server>
1634 Name or ID of server.
1635 nova keypair-add
1637 usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
1638 [--user <user-id>]
1639 <name>
1640 Create a new key pair for use with servers.
1642 Positional arguments:
1644 <name> Name of key.
1646 Optional arguments:
1648 --pub-key <pub-key>
1650 Path to a public ssh key.
1651 --key-type <key-type>
1653 Keypair type. Can be ssh or x509. (Supported by API versions
1654 '2.2' - '2.latest')
1655 --user <user-id>
1657 ID of user to whom to add key-pair (Admin only). (Supported by
1658 API versions '2.10' - '2.latest')
1659 nova keypair-delete
1661 usage: nova keypair-delete [--user <user-id>] <name>
1662 Delete keypair given by its name. (Supported by API versions '2.0' -
1664 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1665 message for proper version]
1666 Positional arguments:
1668 <name> Keypair name to delete.
1670 Optional arguments:
1672 --user <user-id>
1674 ID of key-pair owner (Admin only).
1675 nova keypair-list
1677 usage: nova keypair-list [--user <user-id>] [--marker <marker>]
1678 [--limit <limit>]
1679 Print a list of keypairs for a user (Supported by API versions '2.0' -
1681 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1682 message for proper version]
1683 Optional arguments:
1685 --user <user-id>
1687 List key-pairs of specified user ID (Admin only).
1688 --marker <marker>
1690 The last keypair of the previous page; displays list of keypairs
1691 after "marker".
1692 --limit <limit>
1694 Maximum number of keypairs to display. If limit is bigger than
1695 'CONF.api.max_limit' option of Nova API, limit
1696 'CONF.api.max_limit' will be used instead.
1697 nova keypair-show
1699 usage: nova keypair-show [--user <user-id>] <keypair>
1700 Show details about the given keypair. (Supported by API versions '2.0'
1702 - '2.latest') [hint: use '--os-compute-api-version' flag to show help
1703 message for proper version]
1704 Positional arguments:
1706 <keypair>
1708 Name of keypair.
1709 Optional arguments:
1711 --user <user-id>
1713 ID of key-pair owner (Admin only).
1714 nova limits
1716 usage: nova limits [--tenant [<tenant>]] [--reserved]
1717 Print rate and absolute limits.
1719 Optional arguments:
1721 --tenant [<tenant>]
1723 Display information from single tenant (Admin only).
1724 --reserved
1726 Include reservations count.
1727 nova list
1729 usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>]
1730 [--ip6 <ip6-regexp>] [--name <name-regexp>]
1731 [--status <status>] [--flavor <flavor>] [--image <image>]
1732 [--host <hostname>] [--all-tenants [<0|1>]]
1733 [--tenant [<tenant>]] [--user [<user>]] [--deleted]
1734 [--fields <fields>] [--minimal]
1735 [--sort <key>[:<direction>]] [--marker <marker>]
1736 [--limit <limit>] [--changes-since <changes_since>]
1737 [--changes-before <changes_before>]
1738 [--tags <tags>] [--tags-any <tags-any>]
1739 [--not-tags <not-tags>] [--not-tags-any <not-tags-any>]
1740 [--locked]
1741 List servers.
1743 Note that from microversion 2.69, during partial infrastructure fail‐
1745 ures in the deployment, the output of this command may return partial
1746 results for the servers present in the failure domain.
1747 Optional arguments:
1749 --reservation-id <reservation-id>
1751 Only return servers that match reservation-id.
1752 --ip <ip-regexp>
1754 Search with regular expression match by IP address.
1755 --ip6 <ip6-regexp>
1757 Search with regular expression match by IPv6 address.
1758 --name <name-regexp>
1760 Search with regular expression match by name.
1761 --status <status>
1763 Search by server status.
1764 --flavor <flavor>
1766 Search by flavor name or ID.
1767 --image <image>
1769 Search by image name or ID.
1770 --host <hostname>
1772 Search servers by hostname to which they are assigned (Admin
1773 only).
1774 --all-tenants [<0|1>]
1776 Display information from all tenants (Admin only).
1777 --tenant [<tenant>]
1779 Display information from single tenant (Admin only).
1780 --user [<user>]
1782 Display information from single user (Admin only).
1783 --deleted
1785 Only display deleted servers (Admin only).
1786 --fields <fields>
1788 Comma-separated list of fields to display. Use the show command
1789 to see which fields are available.
1790 --minimal
1792 Get only UUID and name.
1793 --sort <key>[:<direction>]
1795 Comma-separated list of sort keys and directions in the form of
1796 <key>[:<asc|desc>]. The direction defaults to descending if not
1797 specified.
1798 --marker <marker>
1800 The last server UUID of the previous page; displays list of
1801 servers after "marker".
1802 --limit <limit>
1804 Maximum number of servers to display. If limit == -1, all
1805 servers will be displayed. If limit is bigger than
1806 'CONF.api.max_limit' option of Nova API, limit
1807 'CONF.api.max_limit' will be used instead.
1808 --changes-since <changes_since>
1810 List only servers changed later or equal to a certain point of
1811 time. The provided time should be an ISO 8061 formatted time.
1812 e.g. 2016-03-04T06:27:59Z .
1813 --changes-before <changes_before>
1815 List only servers changed earlier or equal to a certain point of
1816 time. The provided time should be an ISO 8061 formatted time.
1817 e.g. 2016-03-05T06:27:59Z . (Supported by API versions '2.66' -
1818 '2.latest')
1819 --tags <tags>
1821 The given tags must all be present for a server to be included
1822 in the list result. Boolean expression in this case is 't1 AND
1823 t2'. Tags must be separated by commas: --tags <tag1,tag2> (Sup‐
1824 ported by API versions '2.26' - '2.latest')
1825 --tags-any <tags-any>
1827 If one of the given tags is present the server will be included
1828 in the list result. Boolean expression in this case is 't1 OR
1829 t2'. Tags must be separated by commas: --tags-any <tag1,tag2>
1830 (Supported by API versions '2.26' - '2.latest')
1831 --not-tags <not-tags>
1833 Only the servers that do not have any of the given tags will be
1834 included in the list results. Boolean expression in this case is
1835 'NOT(t1 AND t2)'. Tags must be separated by commas: --not-tags
1836 <tag1,tag2> (Supported by API versions '2.26' - '2.latest')
1837 --not-tags-any <not-tags-any>
1839 Only the servers that do not have at least one of the given tags
1840 will be included in the list result. Boolean expression in this
1841 case is 'NOT(t1 OR t2)'. Tags must be separated by commas:
1842 --not-tags-any <tag1,tag2> (Supported by API versions '2.26' -
1843 '2.latest')
1844 --locked <locked>
1846 Display servers based on their locked value. A value must be
1847 specified; eg. 'true' will list only locked servers and 'false'
1848 will list only unlocked servers. (Supported by API versions
1849 '2.73' - '2.latest')
1850 nova list-extensions
1852 usage: nova list-extensions
1853 List all the os-api extensions that are available.
1855 nova list-secgroup
1857 usage: nova list-secgroup <server>
1858 List Security Group(s) of a server.
1860 Positional arguments:
1862 <server>
1864 Name or ID of server.
1865 nova live-migration
1867 usage: nova live-migration [--block-migrate] [--force] <server> [<host>]
1868 Migrate running server to a new machine.
1870 Positional arguments:
1872 <server>
1874 Name or ID of server.
1875 <host> Destination host name. If no host is specified, the scheduler
1877 will choose one.
1878 Optional arguments:
1880 --block-migrate
1882 True in case of block_migration. (Default=auto:live_migration)
1883 (Supported by API versions '2.25' - '2.latest')
1884 --force
1886 Force a live-migration by not verifying the provided destination
1887 host by the scheduler. (Supported by API versions '2.30' -
1888 '2.67')
1889 WARNING:
1891 This could result in failures to actually live migrate the
1892 server to the specified host. It is recommended to either not
1893 specify a host so that the scheduler will pick one, or spec‐
1894 ify a host without --force.
1895 nova live-migration-abort
1897 usage: nova live-migration-abort <server> <migration>
1898 Abort an on-going live migration. (Supported by API versions '2.24' -
1900 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1901 message for proper version]
1902 For microversions from 2.24 to 2.64 the migration status must be run‐
1904 ning; for microversion 2.65 and greater, the migration status can also
1905 be queued and preparing.
1906 New in version 3.3.0.
1908 Positional arguments:
1911 <server>
1913 Name or ID of server.
1914 <migration>
1916 ID of migration.
1917 nova live-migration-force-complete
1919 usage: nova live-migration-force-complete <server> <migration>
1920 Force on-going live migration to complete. (Supported by API versions
1922 '2.22' - '2.latest') [hint: use '--os-compute-api-version' flag to show
1923 help message for proper version]
1924 New in version 3.3.0.
1926 Positional arguments:
1929 <server>
1931 Name or ID of server.
1932 <migration>
1934 ID of migration.
1935 nova lock
1937 usage: nova lock [--reason <reason>] <server>
1938 Lock a server. A normal (non-admin) user will not be able to execute
1940 actions on a locked server.
1941 Positional arguments:
1943 <server>
1945 Name or ID of server.
1946 Optional arguments:
1948 --reason <reason>
1950 Reason for locking the server. (Supported by API versions '2.73'
1951 - '2.latest')
1952 nova meta
1954 usage: nova meta <server> <action> <key=value> [<key=value> ...]
1955 Set or delete metadata on a server.
1957 Positional arguments:
1959 <server>
1961 Name or ID of server.
1962 <action>
1964 Actions: 'set' or 'delete'.
1965 <key=value>
1967 Metadata to set or delete (only key is necessary on delete).
1968 nova migrate
1970 usage: nova migrate [--host <host>] [--poll] <server>
1971 Migrate a server. The new host will be selected by the scheduler.
1973 Positional arguments:
1975 <server>
1977 Name or ID of server.
1978 Optional arguments:
1980 --host <host>
1982 Destination host name. (Supported by API versions '2.56' -
1983 '2.latest')
1984 --poll Report the server migration progress until it completes.
1986 nova migration-list
1988 usage: nova migration-list [--instance-uuid <instance_uuid>]
1989 [--host <host>]
1990 [--status <status>]
1991 [--migration-type <migration_type>]
1992 [--source-compute <source_compute>]
1993 [--marker <marker>]
1994 [--limit <limit>]
1995 [--changes-since <changes_since>]
1996 [--changes-before <changes_before>]
1997 Print a list of migrations.
1999 Examples
2001 To see the list of evacuation operations from a compute service host:
2003 nova migration-list --migration-type evacuation --source-compute host.foo.bar
2005 Optional arguments:
2007 --instance-uuid <instance_uuid>
2009 Fetch migrations for the given instance.
2010 --host <host>
2012 Fetch migrations for the given source or destination host.
2013 --status <status>
2015 Fetch migrations for the given status.
2016 --migration-type <migration_type>
2018 Filter migrations by type. Valid values are:
2019 · evacuation
2021 · live-migration
2023 · migration
2025 · resize
2027 --source-compute <source_compute>
2029 Filter migrations by source compute host name.
2030 --marker <marker>
2032 The last migration of the previous page; displays list of migra‐
2033 tions after "marker". Note that the marker is the migration
2034 UUID. (Supported by API versions '2.59' - '2.latest')
2035 --limit <limit>
2037 Maximum number of migrations to display. Note that there is a
2038 configurable max limit on the server, and the limit that is used
2039 will be the minimum of what is requested here and what is con‐
2040 figured in the server. (Supported by API versions '2.59' -
2041 '2.latest')
2042 --changes-since <changes_since>
2044 List only migrations changed later or equal to a certain point
2045 of time. The provided time should be an ISO 8061 formatted time.
2046 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.59' -
2047 '2.latest')
2048 --changes-before <changes_before>
2050 List only migrations changed earlier or equal to a certain point
2051 of time. The provided time should be an ISO 8061 formatted time.
2052 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.66' -
2053 '2.latest')
2054 nova pause
2056 usage: nova pause <server>
2057 Pause a server.
2059 Positional arguments:
2061 <server>
2063 Name or ID of server.
2064 nova quota-class-show
2066 usage: nova quota-class-show <class>
2067 List the quotas for a quota class.
2069 Positional arguments:
2071 <class>
2073 Name of quota class to list the quotas for.
2074 nova quota-class-update
2076 usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
2077 [--ram <ram>]
2078 [--metadata-items <metadata-items>]
2079 [--key-pairs <key-pairs>]
2080 [--server-groups <server-groups>]
2081 [--server-group-members <server-group-members>]
2082 <class>
2083 Update the quotas for a quota class. (Supported by API versions '2.0' -
2085 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2086 message for proper version]
2087 Positional arguments:
2089 <class>
2091 Name of quota class to set the quotas for.
2092 Optional arguments:
2094 --instances <instances>
2096 New value for the "instances" quota.
2097 --cores <cores>
2099 New value for the "cores" quota.
2100 --ram <ram>
2102 New value for the "ram" quota.
2103 --metadata-items <metadata-items>
2105 New value for the "metadata-items" quota.
2106 --key-pairs <key-pairs>
2108 New value for the "key-pairs" quota.
2109 --server-groups <server-groups>
2111 New value for the "server-groups" quota.
2112 --server-group-members <server-group-members>
2114 New value for the "server-group-members" quota.
2115 nova quota-defaults
2117 usage: nova quota-defaults [--tenant <tenant-id>]
2118 List the default quotas for a tenant.
2120 Optional arguments:
2122 --tenant <tenant-id>
2124 ID of tenant to list the default quotas for.
2125 nova quota-delete
2127 usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
2128 Delete quota for a tenant/user so their quota will Revert back to
2130 default.
2131 Optional arguments:
2133 --tenant <tenant-id>
2135 ID of tenant to delete quota for.
2136 --user <user-id>
2138 ID of user to delete quota for.
2139 nova quota-show
2141 usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]
2142 List the quotas for a tenant/user.
2144 Optional arguments:
2146 --tenant <tenant-id>
2148 ID of tenant to list the quotas for.
2149 --user <user-id>
2151 ID of user to list the quotas for.
2152 --detail
2154 Show detailed info (limit, reserved, in-use).
2155 nova quota-update
2157 usage: nova quota-update [--user <user-id>] [--instances <instances>]
2158 [--cores <cores>] [--ram <ram>]
2159 [--metadata-items <metadata-items>]
2160 [--key-pairs <key-pairs>]
2161 [--server-groups <server-groups>]
2162 [--server-group-members <server-group-members>]
2163 [--force]
2164 <tenant-id>
2165 Update the quotas for a tenant/user. (Supported by API versions '2.0' -
2167 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2168 message for proper version]
2169 Positional arguments:
2171 <tenant-id>
2173 ID of tenant to set the quotas for.
2174 Optional arguments:
2176 --user <user-id>
2178 ID of user to set the quotas for.
2179 --instances <instances>
2181 New value for the "instances" quota.
2182 --cores <cores>
2184 New value for the "cores" quota.
2185 --ram <ram>
2187 New value for the "ram" quota.
2188 --metadata-items <metadata-items>
2190 New value for the "metadata-items" quota.
2191 --key-pairs <key-pairs>
2193 New value for the "key-pairs" quota.
2194 --server-groups <server-groups>
2196 New value for the "server-groups" quota.
2197 --server-group-members <server-group-members>
2199 New value for the "server-group-members" quota.
2200 --force
2202 Whether force update the quota even if the already used and
2203 reserved exceeds the new quota.
2204 nova reboot
2206 usage: nova reboot [--hard] [--poll] <server> [<server> ...]
2207 Reboot a server.
2209 Positional arguments:
2211 <server>
2213 Name or ID of server(s).
2214 Optional arguments:
2216 --hard Perform a hard reboot (instead of a soft one). Note: Ironic does
2218 not currently support soft reboot; consequently, bare metal
2219 nodes will always do a hard reboot, regardless of the use of
2220 this option.
2221 --poll Poll until reboot is complete.
2223 nova rebuild
2225 usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
2226 [--minimal] [--preserve-ephemeral] [--name <name>]
2227 [--description <description>] [--meta <key=value>]
2228 [--key-name <key-name>] [--key-unset]
2229 [--user-data <user-data>] [--user-data-unset]
2230 [--trusted-image-certificate-id <trusted-image-certificate-id>]
2231 [--trusted-image-certificates-unset]
2232 <server> <image>
2233 Shutdown, re-image, and re-boot a server.
2235 Positional arguments:
2237 <server>
2239 Name or ID of server.
2240 <image>
2242 Name or ID of new image.
2243 Optional arguments:
2245 --rebuild-password <rebuild-password>
2247 Set the provided admin password on the rebuilt server.
2248 --poll Report the server rebuild progress until it completes.
2250 --minimal
2252 Skips flavor/image lookups when showing servers.
2253 --preserve-ephemeral
2255 Preserve the default ephemeral storage partition on rebuild.
2256 --name <name>
2258 Name for the new server.
2259 --description <description>
2261 New description for the server. (Supported by API versions
2262 '2.19' - '2.latest')
2263 --meta <key=value>
2265 Record arbitrary key/value metadata to /meta_data.json on the
2266 metadata server. Can be specified multiple times.
2267 --key-name <key-name>
2269 Keypair name to set in the server. Cannot be specified with the
2270 '--key-unset' option. (Supported by API versions '2.54' -
2271 '2.latest')
2272 --key-unset
2274 Unset keypair in the server. Cannot be specified with the
2275 '--key-name' option. (Supported by API versions '2.54' -
2276 '2.latest')
2277 --user-data <user-data>
2279 User data file to pass to be exposed by the metadata server.
2280 (Supported by API versions '2.57' - '2.latest')
2281 --user-data-unset
2283 Unset user_data in the server. Cannot be specified with the
2284 '--user-data' option. (Supported by API versions '2.57' -
2285 '2.latest')
2286 --trusted-image-certificate-id <trusted-image-certificate-id>
2288 Trusted image certificate IDs used to validate certificates dur‐
2289 ing the image signature verification process. Defaults to
2290 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
2291 ple times to pass multiple trusted image certificate IDs. (Sup‐
2292 ported by API versions '2.63' - '2.latest')
2293 --trusted-image-certificates-unset
2295 Unset trusted_image_certificates in the server. Cannot be speci‐
2296 fied with the --trusted-image-certificate-id option. (Supported
2297 by API versions '2.63' - '2.latest')
2298 nova refresh-network
2300 usage: nova refresh-network <server>
2301 Refresh server network information.
2303 Positional arguments:
2305 <server>
2307 Name or ID of a server for which the network cache should be
2308 refreshed from neutron (Admin only).
2309 nova remove-secgroup
2311 usage: nova remove-secgroup <server> <secgroup>
2312 Remove a Security Group from a server.
2314 Positional arguments:
2316 <server>
2318 Name or ID of server.
2319 <secgroup>
2321 Name of Security Group.
2322 nova rescue
2324 usage: nova rescue [--password <password>] [--image <image>] <server>
2325 Reboots a server into rescue mode, which starts the machine from either
2327 the initial image or a specified image, attaching the current boot disk
2328 as secondary.
2329 Positional arguments:
2331 <server>
2333 Name or ID of server.
2334 Optional arguments:
2336 --password <password>
2338 The admin password to be set in the rescue environment.
2339 --image <image>
2341 The image to rescue with.
2342 nova reset-network
2344 usage: nova reset-network <server>
2345 Reset network of a server.
2347 Positional arguments:
2349 <server>
2351 Name or ID of server.
2352 nova reset-state
2354 usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]
2355 Reset the state of a server.
2357 Positional arguments:
2359 <server>
2361 Name or ID of server(s).
2362 Optional arguments:
2364 --all-tenants
2366 Reset state server(s) in another tenant by name (Admin only).
2367 --active
2369 Request the server be reset to "active" state instead of "error"
2370 state (the default).
2371 nova resize
2373 usage: nova resize [--poll] <server> <flavor>
2374 Resize a server.
2376 Positional arguments:
2378 <server>
2380 Name or ID of server.
2381 <flavor>
2383 Name or ID of new flavor.
2384 Optional arguments:
2386 --poll Report the server resize progress until it completes.
2388 nova resize-confirm
2390 usage: nova resize-confirm <server>
2391 Confirm a previous resize.
2393 Positional arguments:
2395 <server>
2397 Name or ID of server.
2398 nova resize-revert
2400 usage: nova resize-revert <server>
2401 Revert a previous resize (and return to the previous VM).
2403 Positional arguments:
2405 <server>
2407 Name or ID of server.
2408 nova restore
2410 usage: nova restore <server>
2411 Restore a soft-deleted server.
2413 Positional arguments:
2415 <server>
2417 Name or ID of server.
2418 nova resume
2420 usage: nova resume <server>
2421 Resume a server.
2423 Positional arguments:
2425 <server>
2427 Name or ID of server.
2428 nova server-group-create
2430 usage: nova server-group-create [--rules <key=value>] <name> <policy>
2431 Create a new server group with the specified details.
2433 Positional arguments:
2435 <name> Server group name.
2437 <policy>
2439 Policy for the server groups.
2440 Optional arguments:
2442 --rule Policy rules for the server groups. (Supported by API versions
2444 '2.64' - '2.latest'）. Currently, only the max_server_per_host
2445 rule is supported for the anti-affinity policy. The
2446 max_server_per_host rule allows specifying how many members of
2447 the anti-affinity group can reside on the same compute host. If
2448 not specified, only one member from the same anti-affinity group
2449 can reside on a given host.
2450 nova server-group-delete
2452 usage: nova server-group-delete <id> [<id> ...]
2453 Delete specific server group(s).
2455 Positional arguments:
2457 <id> Unique ID(s) of the server group to delete.
2459 nova server-group-get
2461 usage: nova server-group-get <id>
2462 Get a specific server group.
2464 Positional arguments:
2466 <id> Unique ID of the server group to get.
2468 nova server-group-list
2470 usage: nova server-group-list [--limit <limit>] [--offset <offset>]
2471 [--all-projects]
2472 Print a list of all server groups.
2474 Optional arguments:
2476 --limit <limit>
2478 Maximum number of server groups to display. If limit is bigger
2479 than 'CONF.api.max_limit' option of Nova API, limit
2480 'CONF.api.max_limit' will be used instead.
2481 --offset <offset>
2483 The offset of groups list to display; use with limit to return a
2484 slice of server groups.
2485 --all-projects
2487 Display server groups from all projects (Admin only).
2488 nova server-migration-list
2490 usage: nova server-migration-list <server>
2491 Get the migrations list of specified server. (Supported by API versions
2493 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2494 help message for proper version]
2495 New in version 3.3.0.
2497 Positional arguments:
2500 <server>
2502 Name or ID of server.
2503 nova server-migration-show
2505 usage: nova server-migration-show <server> <migration>
2506 Get the migration of specified server. (Supported by API versions
2508 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2509 help message for proper version]
2510 New in version 3.3.0.
2512 Positional arguments:
2515 <server>
2517 Name or ID of server.
2518 <migration>
2520 ID of migration.
2521 nova server-tag-add
2523 usage: nova server-tag-add <server> <tag> [<tag> ...]
2524 Add one or more tags to a server. (Supported by API versions '2.26' -
2526 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2527 message for proper version]
2528 New in version 4.1.0.
2530 Positional arguments:
2533 <server>
2535 Name or ID of server.
2536 <tag> Tag(s) to add.
2538 nova server-tag-delete
2540 usage: nova server-tag-delete <server> <tag> [<tag> ...]
2541 Delete one or more tags from a server. (Supported by API versions
2543 '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2544 help message for proper version]
2545 New in version 4.1.0.
2547 Positional arguments:
2550 <server>
2552 Name or ID of server.
2553 <tag> Tag(s) to delete.
2555 nova server-tag-delete-all
2557 usage: nova server-tag-delete-all <server>
2558 Delete all tags from a server. (Supported by API versions '2.26' -
2560 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2561 message for proper version]
2562 New in version 4.1.0.
2564 Positional arguments:
2567 <server>
2569 Name or ID of server.
2570 nova server-tag-list
2572 usage: nova server-tag-list <server>
2573 Get list of tags from a server. (Supported by API versions '2.26' -
2575 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2576 message for proper version]
2577 New in version 4.1.0.
2579 Positional arguments:
2582 <server>
2584 Name or ID of server.
2585 nova server-tag-set
2587 usage: nova server-tag-set <server> <tags> [<tags> ...]
2588 Set list of tags to a server. (Supported by API versions '2.26' -
2590 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2591 message for proper version]
2592 New in version 4.1.0.
2594 Positional arguments:
2597 <server>
2599 Name or ID of server.
2600 <tags> Tag(s) to set.
2602 nova server-topology
2604 usage: nova server-topology <server>
2605 Retrieve server NUMA topology information. Host specific fields are
2607 only visible to users with the administrative role. (Supported by API
2608 versions '2.78' - '2.latest')
2609 New in version 16.0.0.
2611 Positional arguments:
2614 <server>
2616 Name or ID of server.
2617 nova service-delete
2619 usage: nova service-delete <id>
2620 Delete the service.
2622 IMPORTANT:
2624 If deleting a nova-compute service, be sure to stop the actual
2625 nova-compute process on the physical host before deleting the ser‐
2626 vice with this command. Failing to do so can lead to the running
2627 service re-creating orphaned compute_nodes table records in the
2628 database.
2629 Positional arguments:
2631 <id> ID of service as a UUID. (Supported by API versions '2.53' -
2633 '2.latest')
2634 nova service-disable
2636 usage: nova service-disable [--reason <reason>] <id>
2637 Disable the service.
2639 Positional arguments:
2641 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2643 '2.latest')
2644 Optional arguments:
2646 --reason <reason>
2648 Reason for disabling the service.
2649 nova service-enable
2651 usage: nova service-enable <id>
2652 Enable the service.
2654 Positional arguments:
2656 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2658 '2.latest')
2659 nova service-force-down
2661 usage: nova service-force-down [--unset] <id>
2662 Force service to down. (Supported by API versions '2.11' - '2.latest')
2664 [hint: use '--os-compute-api-version' flag to show help message for
2665 proper version]
2666 New in version 2.27.0.
2668 Positional arguments:
2671 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2673 '2.latest')
2674 Optional arguments:
2676 --unset
2678 Unset the forced_down state of the service.
2679 nova service-list
2681 usage: nova service-list [--host <hostname>] [--binary <binary>]
2682 Show a list of all running services. Filter by host & binary.
2684 Note that from microversion 2.69, during partial infrastructure fail‐
2686 ures in the deployment, the output of this command may return partial
2687 results for the services present in the failure domain.
2688 Optional arguments:
2690 --host <hostname>
2692 Name of host.
2693 --binary <binary>
2695 Service binary.
2696 nova set-password
2698 usage: nova set-password <server>
2699 Change the admin password for a server.
2701 Positional arguments:
2703 <server>
2705 Name or ID of server.
2706 nova shelve
2708 usage: nova shelve <server>
2709 Shelve a server.
2711 Positional arguments:
2713 <server>
2715 Name or ID of server.
2716 nova shelve-offload
2718 usage: nova shelve-offload <server>
2719 Remove a shelved server from the compute node.
2721 Positional arguments:
2723 <server>
2725 Name or ID of server.
2726 nova show
2728 usage: nova show [--minimal] [--wrap <integer>] <server>
2729 Show details about the given server.
2731 Note that from microversion 2.69, during partial infrastructure fail‐
2733 ures in the deployment, the output of this command may return partial
2734 results for the server if it exists in the failure domain.
2735 Positional arguments:
2737 <server>
2739 Name or ID of server.
2740 Optional arguments:
2742 --minimal
2744 Skips flavor/image lookups when showing servers.
2745 --wrap <integer>
2747 Wrap the output to a specified length, or 0 to disable.
2748 nova ssh
2750 usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE]
2751 [--network <network>] [--ipv6] [--login <login>] [-i IDENTITY]
2752 [--extra-opts EXTRA]
2753 <server>
2754 SSH into a server.
2756 Positional arguments:
2758 <server>
2760 Name or ID of server.
2761 Optional arguments:
2763 --port PORT
2765 Optional flag to indicate which port to use for ssh.
2766 (Default=22)
2767 --address-type ADDRESS_TYPE
2769 Optional flag to indicate which IP type to use. Possible values
2770 includes fixed and floating (the Default).
2771 --network <network>
2773 Network to use for the ssh.
2774 --ipv6 Optional flag to indicate whether to use an IPv6 address
2776 attached to a server. (Defaults to IPv4 address)
2777 --login <login>
2779 Login to use.
2780 -i IDENTITY, --identity IDENTITY
2782 Private key file, same as the -i option to the ssh command.
2783 --extra-opts EXTRA
2785 Extra options to pass to ssh. see: man ssh.
2786 nova start
2788 usage: nova start [--all-tenants] <server> [<server> ...]
2789 Start the server(s).
2791 Positional arguments:
2793 <server>
2795 Name or ID of server(s).
2796 Optional arguments:
2798 --all-tenants
2800 Start server(s) in another tenant by name (Admin only).
2801 nova stop
2803 usage: nova stop [--all-tenants] <server> [<server> ...]
2804 Stop the server(s).
2806 Positional arguments:
2808 <server>
2810 Name or ID of server(s).
2811 Optional arguments:
2813 --all-tenants
2815 Stop server(s) in another tenant by name (Admin only).
2816 nova suspend
2818 usage: nova suspend <server>
2819 Suspend a server.
2821 Positional arguments:
2823 <server>
2825 Name or ID of server.
2826 nova trigger-crash-dump
2828 usage: nova trigger-crash-dump <server>
2829 Trigger crash dump in an instance. (Supported by API versions '2.17' -
2831 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2832 message for proper version]
2833 New in version 3.3.0.
2835 Positional arguments:
2838 <server>
2840 Name or ID of server.
2841 nova unlock
2843 usage: nova unlock <server>
2844 Unlock a server.
2846 Positional arguments:
2848 <server>
2850 Name or ID of server.
2851 nova unpause
2853 usage: nova unpause <server>
2854 Unpause a server.
2856 Positional arguments:
2858 <server>
2860 Name or ID of server.
2861 nova unrescue
2863 usage: nova unrescue <server>
2864 Restart the server from normal boot disk again.
2866 Positional arguments:
2868 <server>
2870 Name or ID of server.
2871 nova unshelve
2873 usage: nova unshelve [--availability-zone <availability_zone>] <server>
2874 Unshelve a server.
2876 Positional arguments:
2878 <server>
2880 Name or ID of server.
2881 Optional arguments:
2883 --availability-zone <availability_zone>
2885 Name of the availability zone in which to unshelve a
2886 SHELVED_OFFLOADED server. (Supported by API versions '2.77' -
2887 '2.latest')
2888 nova update
2890 usage: nova update [--name <name>] [--description <description>] <server>
2891 Update the name or the description for a server.
2893 Positional arguments:
2895 <server>
2897 Name (old name) or ID of server.
2898 Optional arguments:
2900 --name <name>
2902 New name for the server.
2903 --description <description>
2905 New description for the server. If it equals to empty string
2906 (i.g. ""), the server description will be removed. (Supported by
2907 API versions '2.19' - '2.latest')
2908 nova usage
2910 usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
2911 Show usage data for a single tenant.
2913 Optional arguments:
2915 --start <start>
2917 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2918 --end <end>
2920 Usage range end date, ex 2012-01-20. (default: tomorrow)
2921 --tenant <tenant-id>
2923 UUID of tenant to get usage for.
2924 nova usage-list
2926 usage: nova usage-list [--start <start>] [--end <end>]
2927 List usage data for all tenants.
2929 Optional arguments:
2931 --start <start>
2933 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2934 --end <end>
2936 Usage range end date, ex 2012-01-20. (default: tomorrow)
2937 nova version-list
2939 usage: nova version-list
2940 List all API versions.
2942 nova volume-attach
2944 usage: nova volume-attach [--delete-on-termination] [--tag <tag>]
2945 <server> <volume> [<device>]
2946 Attach a volume to a server.
2948 Positional arguments:
2950 <server>
2952 Name or ID of server.
2953 <volume>
2955 ID of the volume to attach.
2956 <device>
2958 Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if
2959 supported). Libvirt driver will use default device name.
2960 Optional arguments:
2962 --tag <tag>
2964 Tag for the attached volume. (Supported by API versions '2.49' -
2965 '2.latest')
2966 --delete-on-termination
2968 Specify if the attached volume sholud be deleted when the server
2969 is destroyed. By default the attached volume is not deleted when
2970 the server is destroyed. (Supported by API versions '2.79' -
2971 '2.latest')
2972 nova volume-attachments
2974 usage: nova volume-attachments <server>
2975 List all the volumes attached to a server.
2977 Positional arguments:
2979 <server>
2981 Name or ID of server.
2982 nova volume-detach
2984 usage: nova volume-detach <server> <volume>
2985 Detach a volume from a server.
2987 Positional arguments:
2989 <server>
2991 Name or ID of server.
2992 <volume>
2994 ID of the volume to detach.
2995 nova volume-update
2997 usage: nova volume-update <server> <src_volid> <dest_volid>
2998 Update the attachment on the server. Migrates the data from an attached
3000 volume to the specified available volume and swaps out the active
3001 attachment to the new volume.
3002 Positional arguments:
3004 <server>
3006 Name or ID of server.
3007 <src_volid>
3009 ID of the source (original) volume.
3010 <dest_volid>
3012 ID of the destination volume.
3013 nova bash-completion
3015 usage: nova bash-completion
3016 Prints all of the commands and options to stdout so that the
3018 nova.bash_completion script doesn't have to hard code them.
3019
3021 OpenStack Contributors
3022
3024 OpenStack Contributors
3025 Jan 30, 2020 NOVA(1)