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 service-delete
416 Delete the service.
417 service-disable
419 Disable the service.
420 service-enable
422 Enable the service.
423 service-force-down
425 Force service to down. (Supported by API versions '2.11' -
426 '2.latest') [hint: use '--os-compute-api-version' flag to show
427 help message for proper version]
428 service-list
430 Show a list of all running services. Filter by host & binary.
431 set-password
433 Change the admin password for a server.
434 shelve Shelve a server.
436 shelve-offload
438 Remove a shelved server from the compute node.
439 show Show details about the given server.
441 ssh SSH into a server.
443 start Start the server(s).
445 stop Stop the server(s).
447 suspend
449 Suspend a server.
450 trigger-crash-dump
452 Trigger crash dump in an instance. (Supported by API versions
453 '2.17' - '2.latest') [hint: use '--os-compute-api-version' flag
454 to show help message for proper version]
455 unlock Unlock a server.
457 unpause
459 Unpause a server.
460 unrescue
462 Restart the server from normal boot disk again.
463 unshelve
465 Unshelve a server.
466 update Update the name or the description for a server.
468 usage Show usage data for a single tenant.
470 usage-list
472 List usage data for all tenants.
473 version-list
475 List all API versions.
476 virtual-interface-list
478 DEPRECATED Show virtual interface info about the given server.
479 volume-attach
481 Attach a volume to a server.
482 volume-attachments
484 List all the volumes attached to a server.
485 volume-detach
487 Detach a volume from a server.
488 volume-update
490 Update the attachment on the server. Migrates the data from an
491 attached volume to the specified available volume and swaps out
492 the active attachment to the new volume.
493 x509-create-cert
495 DEPRECATED Create x509 cert for a user in tenant.
496 x509-get-root-cert
498 DEPRECATED Fetch the x509 root cert.
499 bash-completion
501 Prints all of the commands and options to stdout so that the
502 nova.bash_completion script doesn't have to hard code them.
503 help Display help about this program or one of its subcommands.
505
507 --version
508 show program's version number and exit
509 --debug
511 Print debugging output.
512 --os-cache
514 Use the auth token cache. Defaults to False if env[OS_CACHE] is
515 not set.
516 --timings
518 Print call timing info.
519 --os-region-name <region-name>
521 Defaults to env[OS_REGION_NAME].
522 --service-type <service-type>
524 Defaults to compute for most actions.
525 --service-name <service-name>
527 Defaults to env[NOVA_SERVICE_NAME].
528 --os-endpoint-type <endpoint-type>
530 Defaults to env[NOVA_ENDPOINT_TYPE], env[OS_ENDPOINT_TYPE] or
531 publicURL.
532 --os-compute-api-version <compute-api-ver>
534 Accepts X, X.Y (where X is major and Y is minor part) or "X.lat‐
535 est", defaults to env[OS_COMPUTE_API_VERSION].
536 --os-endpoint-override <bypass-url>
538 Use this API endpoint instead of the Service Catalog. Defaults
539 to env[OS_ENDPOINT_OVERRIDE].
540 --profile HMAC_KEY
542 HMAC key to use for encrypting context data for performance pro‐
543 filing of operation. This key should be the value of the HMAC
544 key configured for the OSprofiler middleware in nova; it is
545 specified in the Nova configuration file at
546 "/etc/nova/nova.conf". Without the key, profiling will not be
547 triggered even if OSprofiler is enabled on the server side.
548 --os-auth-type <name>, --os-auth-plugin <name>
550 Authentication type to use
551 nova add-secgroup
553 usage: nova add-secgroup <server> <secgroup>
554 Add a Security Group to a server.
556 Positional arguments:
558 <server>
560 Name or ID of server.
561 <secgroup>
563 Name or ID of Security Group.
564 nova agent-create
566 usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
567 <hypervisor>
568 Create new agent build.
570 Positional arguments:
572 <os> Type of OS.
574 <architecture>
576 Type of architecture.
577 <version>
579 Version.
580 <url> URL.
582 <md5hash>
584 MD5 hash.
585 <hypervisor>
587 Type of hypervisor.
588 nova agent-delete
590 usage: nova agent-delete <id>
591 Delete existing agent build.
593 Positional arguments:
595 <id> ID of the agent-build.
597 nova agent-list
599 usage: nova agent-list [--hypervisor <hypervisor>]
600 List all builds.
602 Optional arguments:
604 --hypervisor <hypervisor>
606 Type of hypervisor.
607 nova agent-modify
609 usage: nova agent-modify <id> <version> <url> <md5hash>
610 Modify existing agent build.
612 Positional arguments:
614 <id> ID of the agent-build.
616 <version>
618 Version.
619 <url> URL
621 <md5hash>
623 MD5 hash.
624 nova aggregate-add-host
626 usage: nova aggregate-add-host <aggregate> <host>
627 Add the host to the specified aggregate.
629 Positional arguments:
631 <aggregate>
633 Name or ID of aggregate.
634 <host> The host to add to the aggregate.
636 nova aggregate-create
638 usage: nova aggregate-create <name> [<availability-zone>]
639 Create a new aggregate with the specified details.
641 Positional arguments:
643 <name> Name of aggregate.
645 <availability-zone>
647 The availability zone of the aggregate (optional).
648 nova aggregate-delete
650 usage: nova aggregate-delete <aggregate>
651 Delete the aggregate.
653 Positional arguments:
655 <aggregate>
657 Name or ID of aggregate to delete.
658 nova aggregate-list
660 usage: nova aggregate-list
661 Print a list of all aggregates.
663 nova aggregate-remove-host
665 usage: nova aggregate-remove-host <aggregate> <host>
666 Remove the specified host from the specified aggregate.
668 Positional arguments:
670 <aggregate>
672 Name or ID of aggregate.
673 <host> The host to remove from the aggregate.
675 nova aggregate-set-metadata
677 usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
678 Update the metadata associated with the aggregate.
680 Positional arguments:
682 <aggregate>
684 Name or ID of aggregate to update.
685 <key=value>
687 Metadata to add/update to aggregate. Specify only the key to
688 delete a metadata item.
689 nova aggregate-show
691 usage: nova aggregate-show <aggregate>
692 Show details of the specified aggregate.
694 Positional arguments:
696 <aggregate>
698 Name or ID of aggregate.
699 nova aggregate-update
701 usage: nova aggregate-update [--name NAME]
702 [--availability-zone <availability-zone>]
703 <aggregate>
704 Update the aggregate's name and optionally availability zone.
706 Positional arguments:
708 <aggregate>
710 Name or ID of aggregate to update.
711 Optional arguments:
713 --name NAME
715 New name for aggregate.
716 --availability-zone <availability-zone>
718 New availability zone for aggregate.
719 nova availability-zone-list
721 usage: nova availability-zone-list
722 List all the availability zones.
724 nova backup
726 usage: nova backup <server> <name> <backup-type> <rotation>
727 Backup a server by creating a 'backup' type snapshot.
729 Positional arguments:
731 <server>
733 Name or ID of server.
734 <name> Name of the backup image.
736 <backup-type>
738 The backup type, like "daily" or "weekly".
739 <rotation>
741 Int parameter representing how many backups to keep around.
742 nova boot
744 usage: nova boot [--flavor <flavor>] [--image <image>]
745 [--image-with <key=value>] [--boot-volume <volume_id>]
746 [--snapshot <snapshot_id>] [--min-count <number>]
747 [--max-count <number>] [--meta <key=value>]
748 [--key-name <key-name>] [--user-data <user-data>]
749 [--availability-zone <availability-zone>]
750 [--security-groups <security-groups>]
751 [--block-device-mapping <dev-name=mapping>]
752 [--block-device key1=value1[,key2=value2...]]
753 [--swap <swap_size>]
754 [--ephemeral size=<size>[,format=<format>]]
755 [--hint <key=value>]
756 [--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>]
757 [--config-drive <value>] [--poll] [--admin-pass <value>]
758 [--access-ip-v4 <value>] [--access-ip-v6 <value>]
759 [--description <description>] [--tags <tags>]
760 [--return-reservation-id]
761 [--trusted-image-certificate-id <trusted-image-certificate-id>]
762 <name>
763 Boot a new server.
765 In order to create a server with pre-existing ports that contain a
767 resource_request value, such as for guaranteed minimum bandwidth qual‐
768 ity of service support, microversion 2.72 is required.
769 Positional arguments:
771 <name> Name for the new server.
773 Optional arguments:
775 --flavor <flavor>
777 Name or ID of flavor (see 'nova flavor-list').
778 --image <image>
780 Name or ID of image (see 'glance image-list').
781 --image-with <key=value>
783 Image metadata property (see 'glance image-show').
784 --boot-volume <volume_id>
786 Volume ID to boot from.
787 --snapshot <snapshot_id>
789 Snapshot ID to boot from (will create a volume).
790 --min-count <number>
792 Boot at least <number> servers (limited by quota).
793 --max-count <number>
795 Boot up to <number> servers (limited by quota).
796 --meta <key=value>
798 Record arbitrary key/value metadata to /meta_data.json on the
799 metadata server. Can be specified multiple times.
800 --key-name <key-name>
802 Key name of keypair that should be created earlier with the com‐
803 mand keypair-add.
804 --user-data <user-data>
806 user data file to pass to be exposed by the metadata server.
807 --availability-zone <availability-zone>
809 The availability zone for server placement.
810 --security-groups <security-groups>
812 Comma separated list of security group names.
813 --block-device-mapping <dev-name=mapping>
815 Block device mapping in the format
816 <dev-name>=<id>:<type>:<size(GiB)>:<delete-on-terminate>.
817 --block-device
819 key1=value1[,key2=value2...] Block device mapping with the
820 keys: id=UUID (image_id, snapshot_id or volume_id only if using
821 source image, snapshot or volume) source=source type (image,
822 snapshot, volume or blank), dest=destination type of the block
823 device (volume or local), bus=device's bus (e.g. uml, lxc, vir‐
824 tio, ...; if omitted, hypervisor driver chooses a suitable
825 default, honoured only if device type is supplied) type=device
826 type (e.g. disk, cdrom, ...; defaults to 'disk') device=name of
827 the device (e.g. vda, xda, ...; if omitted, hypervisor driver
828 chooses suitable device depending on selected bus; note the lib‐
829 virt driver always uses default device names), size=size of the
830 block device in MiB(for swap) and in GiB(for other formats) (if
831 omitted, hypervisor driver calculates size), format=device will
832 be formatted (e.g. swap, ntfs, ...; optional), bootindex=integer
833 used for ordering the boot disks (for image backed instances it
834 is equal to 0, for others need to be specified), shutdown=shut‐
835 down behaviour (either preserve or remove, for local destination
836 set to remove), tag=device metadata tag (optional; supported by
837 API versions '2.42' - '2.latest'), and volume_type=type of vol‐
838 ume to create (either ID or name) when source is blank, image or
839 snapshot and dest is volume (optional; supported by API versions
840 '2.67' - '2.latest').
841 --swap <swap_size>
843 Create and attach a local swap block device of <swap_size> MiB.
844 --ephemeral
846 size=<size>[,format=<format>] Create and attach a local
847 ephemeral block device of <size> GiB and format it to <format>.
848 --hint <key=value>
850 Send arbitrary key/value pairs to the scheduler for custom use.
851 --nic <auto,none,net-id=net-uuid,net-name=net‐
853 work-name,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag>
854 Create a NIC on the server. Specify option multiple times to
855 create multiple nics unless using the special 'auto' or 'none'
856 values. auto: automatically allocate network resources if none
857 are available. This cannot be specified with any other nic value
858 and cannot be specified multiple times. none: do not attach a
859 NIC at all. This cannot be specified with any other nic value
860 and cannot be specified multiple times. net-id: attach NIC to
861 network with a specific UUID. net-name: attach NIC to network
862 with this name (either port-id or net-id or net-name must be
863 provided), v4-fixed-ip: IPv4 fixed address for NIC (optional),
864 v6-fixed-ip: IPv6 fixed address for NIC (optional), port-id:
865 attach NIC to port with this UUID tag: interface metadata tag
866 (optional) (either port-id or net-id must be provided). (Sup‐
867 ported by API versions '2.42' - '2.latest')
868 --config-drive <value>
870 Enable config drive.
871 --poll Report the new server boot progress until it completes.
873 --admin-pass <value>
875 Admin password for the instance.
876 --access-ip-v4 <value>
878 Alternative access IPv4 of the instance.
879 --access-ip-v6 <value>
881 Alternative access IPv6 of the instance.
882 --description <description>
884 Description for the server. (Supported by API versions '2.19' -
885 '2.latest')
886 --tags <tags>
888 Tags for the server.Tags must be separated by commas: --tags
889 <tag1,tag2> (Supported by API versions '2.52' - '2.latest')
890 --return-reservation-id
892 Return a reservation id bound to created servers.
893 --trusted-image-certificate-id <trusted-image-certificate-id>
895 Trusted image certificate IDs used to validate certificates dur‐
896 ing the image signature verification process. Defaults to
897 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
898 ple times to pass multiple trusted image certificate IDs. (Sup‐
899 ported by API versions '2.63' - '2.latest')
900 nova cell-capacities
902 usage: nova cell-capacities [--cell <cell-name>]
903 Get cell capacities for all cells or a given cell.
905 Optional arguments:
907 --cell <cell-name>
909 Name of the cell to get the capacities.
910 nova cell-show
912 usage: nova cell-show <cell-name>
913 Show details of a given cell.
915 Positional arguments:
917 <cell-name>
919 Name of the cell.
920 nova clear-password
922 usage: nova clear-password <server>
923 Clear the admin password for a server from the metadata server. This
925 action does not actually change the instance server password.
926 Positional arguments:
928 <server>
930 Name or ID of server.
931 nova console-log
933 usage: nova console-log [--length <length>] <server>
934 Get console log output of a server.
936 Positional arguments:
938 <server>
940 Name or ID of server.
941 Optional arguments:
943 --length <length>
945 Length in lines to tail.
946 nova delete
948 usage: nova delete [--all-tenants] <server> [<server> ...]
949 Immediately shut down and delete specified server(s).
951 Positional arguments:
953 <server>
955 Name or ID of server(s).
956 Optional arguments:
958 --all-tenants
960 Delete server(s) in another tenant by name (Admin only).
961 nova diagnostics
963 usage: nova diagnostics <server>
964 Retrieve server diagnostics.
966 Positional arguments:
968 <server>
970 Name or ID of server.
971 nova evacuate
973 usage: nova evacuate [--password <password>] [--force] <server> [<host>]
974 Evacuate server from failed host.
976 Positional arguments:
978 <server>
980 Name or ID of server.
981 <host> Name or ID of the target host. If no host is specified, the
983 scheduler will choose one.
984 Optional arguments:
986 --password <password>
988 Set the provided admin password on the evacuated server. Not
989 applicable if the server is on shared storage.
990 --force
992 Force an evacuation by not verifying the provided destination
993 host by the scheduler. (Supported by API versions '2.29' -
994 '2.67')
995 WARNING:
997 This could result in failures to actually evacuate the server
998 to the specified host. It is recommended to either not spec‐
999 ify a host so that the scheduler will pick one, or specify a
1000 host without --force.
1001 nova flavor-access-add
1003 usage: nova flavor-access-add <flavor> <tenant_id>
1004 Add flavor access for the given tenant.
1006 Positional arguments:
1008 <flavor>
1010 Flavor name or ID to add access for the given tenant.
1011 <tenant_id>
1013 Tenant ID to add flavor access for.
1014 nova flavor-access-list
1016 usage: nova flavor-access-list [--flavor <flavor>]
1017 Print access information about the given flavor.
1019 Optional arguments:
1021 --flavor <flavor>
1023 Filter results by flavor name or ID.
1024 nova flavor-access-remove
1026 usage: nova flavor-access-remove <flavor> <tenant_id>
1027 Remove flavor access for the given tenant.
1029 Positional arguments:
1031 <flavor>
1033 Flavor name or ID to remove access for the given tenant.
1034 <tenant_id>
1036 Tenant ID to remove flavor access for.
1037 nova flavor-create
1039 usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
1040 [--rxtx-factor <factor>] [--is-public <is-public>]
1041 [--description <description>]
1042 <name> <id> <ram> <disk> <vcpus>
1043 Create a new flavor.
1045 Positional arguments:
1047 <name> Unique name of the new flavor.
1049 <id> Unique ID of the new flavor. Specifying 'auto' will generated a
1051 UUID for the ID.
1052 <ram> Memory size in MiB.
1054 <disk> Disk size in GiB.
1056 <vcpus>
1058 Number of vcpus
1059 Optional arguments:
1061 --ephemeral <ephemeral>
1063 Ephemeral space size in GiB (default 0).
1064 --swap <swap>
1066 Swap space size in MiB (default 0).
1067 --rxtx-factor <factor>
1069 RX/TX factor (default 1).
1070 --is-public <is-public>
1072 Make flavor accessible to the public (default true).
1073 --description <description>
1075 A free form description of the flavor. Limited to 65535 charac‐
1076 ters in length. Only printable characters are allowed. (Sup‐
1077 ported by API versions '2.55' - '2.latest')
1078 nova flavor-delete
1080 usage: nova flavor-delete <flavor>
1081 Delete a specific flavor
1083 Positional arguments:
1085 <flavor>
1087 Name or ID of the flavor to delete.
1088 nova flavor-key
1090 usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
1091 Set or unset extra_spec for a flavor.
1093 Positional arguments:
1095 <flavor>
1097 Name or ID of flavor.
1098 <action>
1100 Actions: 'set' or 'unset'.
1101 <key=value>
1103 Extra_specs to set/unset (only key is necessary on unset).
1104 nova flavor-list
1106 usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
1107 [--min-disk <min-disk>] [--min-ram <min-ram>]
1108 [--limit <limit>] [--sort-key <sort-key>]
1109 [--sort-dir <sort-dir>]
1110 Print a list of available 'flavors' (sizes of servers).
1112 Optional arguments:
1114 --extra-specs
1116 Get extra-specs of each flavor.
1117 --all Display all flavors (Admin only).
1119 --marker <marker>
1121 The last flavor ID of the previous page; displays list of fla‐
1122 vors after "marker".
1123 --min-disk <min-disk>
1125 Filters the flavors by a minimum disk space, in GiB.
1126 --min-ram <min-ram>
1128 Filters the flavors by a minimum RAM, in MiB.
1129 --limit <limit>
1131 Maximum number of flavors to display. If limit is bigger than
1132 'CONF.api.max_limit' option of Nova API, limit
1133 'CONF.api.max_limit' will be used instead.
1134 --sort-key <sort-key>
1136 Flavors list sort key.
1137 --sort-dir <sort-dir>
1139 Flavors list sort direction.
1140 nova flavor-show
1142 usage: nova flavor-show <flavor>
1143 Show details about the given flavor.
1145 Positional arguments:
1147 <flavor>
1149 Name or ID of flavor.
1150 nova flavor-update
1152 usage: nova flavor-update <flavor> <description>
1153 Update the description of an existing flavor. (Supported by API ver‐
1155 sions '2.55' - '2.latest') [hint: use '--os-compute-api-version' flag
1156 to show help message for proper version]
1157 New in version 10.0.0.
1159 Positional arguments
1162 <flavor>
1164 Name or ID of the flavor to update.
1165 <description>
1167 A free form description of the flavor. Limited to 65535 charac‐
1168 ters in length. Only printable characters are allowed.
1169 nova force-delete
1171 usage: nova force-delete <server>
1172 Force delete a server.
1174 Positional arguments:
1176 <server>
1178 Name or ID of server.
1179 nova get-mks-console
1181 usage: nova get-mks-console <server>
1182 Get an MKS console to a server. (Supported by API versions '2.8' -
1184 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1185 message for proper version]
1186 New in version 3.0.0.
1188 Positional arguments:
1191 <server>
1193 Name or ID of server.
1194 nova get-password
1196 usage: nova get-password <server> [<private-key>]
1197 Get the admin password for a server. This operation calls the metadata
1199 service to query metadata information and does not read password infor‐
1200 mation from the server itself.
1201 Positional arguments:
1203 <server>
1205 Name or ID of server.
1206 <private-key>
1208 Private key (used locally to decrypt password) (Optional). When
1209 specified, the command displays the clear (decrypted) VM pass‐
1210 word. When not specified, the ciphered VM password is displayed.
1211 nova get-rdp-console
1213 usage: nova get-rdp-console <server> <console-type>
1214 Get a rdp console to a server.
1216 Positional arguments:
1218 <server>
1220 Name or ID of server.
1221 <console-type>
1223 Type of rdp console ("rdp-html5").
1224 nova get-serial-console
1226 usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>
1227 Get a serial console to a server.
1229 Positional arguments:
1231 <server>
1233 Name or ID of server.
1234 Optional arguments:
1236 --console-type CONSOLE_TYPE
1238 Type of serial console, default="serial".
1239 nova get-spice-console
1241 usage: nova get-spice-console <server> <console-type>
1242 Get a spice console to a server.
1244 Positional arguments:
1246 <server>
1248 Name or ID of server.
1249 <console-type>
1251 Type of spice console ("spice-html5").
1252 nova get-vnc-console
1254 usage: nova get-vnc-console <server> <console-type>
1255 Get a vnc console to a server.
1257 Positional arguments:
1259 <server>
1261 Name or ID of server.
1262 <console-type>
1264 Type of vnc console ("novnc" or "xvpvnc").
1265 nova host-evacuate
1267 usage: nova host-evacuate [--target_host <target_host>] [--force] [--strict]
1268 <host>
1269 Evacuate all instances from failed host.
1271 Positional arguments:
1273 <host> The hypervisor hostname (or pattern) to search for.
1275 WARNING:
1277 Use a fully qualified domain name if you only want to evacu‐
1278 ate from a specific host.
1279 Optional arguments:
1281 --target_host <target_host>
1283 Name of target host. If no host is specified the scheduler will
1284 select a target.
1285 --force
1287 Force an evacuation by not verifying the provided destination
1288 host by the scheduler. (Supported by API versions '2.29' -
1289 '2.67')
1290 WARNING:
1292 This could result in failures to actually evacuate the server
1293 to the specified host. It is recommended to either not spec‐
1294 ify a host so that the scheduler will pick one, or specify a
1295 host without --force.
1296 --strict
1298 Evacuate host with exact hypervisor hostname match
1299 nova host-evacuate-live
1301 usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
1302 [--max-servers <max_servers>] [--force]
1303 [--strict]
1304 <host>
1305 Live migrate all instances off the specified host to other available
1307 hosts.
1308 Positional arguments:
1310 <host> Name of host. The hypervisor hostname (or pattern) to search
1312 for.
1313 WARNING:
1315 Use a fully qualified domain name if you only want to live
1316 migrate 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 choose one.
1323 --block-migrate
1325 Enable block migration. (Default=auto) (Supported by API ver‐
1326 sions '2.25' - '2.latest')
1327 --max-servers <max_servers>
1329 Maximum number of servers to live migrate simultaneously
1330 --force
1332 Force a live-migration by not verifying the provided destination
1333 host by the scheduler. (Supported by API versions '2.30' -
1334 '2.67')
1335 WARNING:
1337 This could result in failures to actually live migrate the
1338 servers to the specified host. It is recommended to either
1339 not specify a host so that the scheduler will pick one, or
1340 specify a host without --force.
1341 --strict
1343 live Evacuate host with exact hypervisor hostname match
1344 nova host-meta
1346 usage: nova host-meta [--strict] <host> <action> <key=value> [<key=value> ...]
1347 Set or Delete metadata on all instances of a host.
1349 Positional arguments:
1351 <host> The hypervisor hostname (or pattern) to search for.
1353 WARNING:
1355 Use a fully qualified domain name if you only want to update
1356 metadata for servers on a specific host.
1357 <action>
1359 Actions: 'set' or 'delete'
1360 <key=value>
1362 Metadata to set or delete (only key is necessary on delete)
1363 Optional arguments:
1365 --strict
1367 Set host-meta to the hypervisor with exact hostname match
1368 nova host-servers-migrate
1370 usage: nova host-servers-migrate [--strict] <host>
1371 Cold migrate all instances off the specified host to other available
1373 hosts.
1374 Positional arguments:
1376 <host> Name of host. The hypervisor hostname (or pattern) to search
1378 for.
1379 WARNING:
1381 Use a fully qualified domain name if you only want to cold
1382 migrate from a specific host.
1383 Optional arguments:
1385 --strict
1387 Migrate host with exact hypervisor hostname match
1388 nova hypervisor-list
1390 usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
1391 [--limit <limit>]
1392 List hypervisors. (Supported by API versions '2.0' - '2.latest') [hint:
1394 use '--os-compute-api-version' flag to show help message for proper
1395 version]
1396 Optional arguments:
1398 --matching <hostname>
1400 List hypervisors matching the given <hostname>. If matching is
1401 used limit and marker options will be ignored.
1402 --marker <marker>
1404 The last hypervisor of the previous page; displays list of
1405 hypervisors after "marker".
1406 --limit <limit>
1408 Maximum number of hypervisors to display. If limit is bigger
1409 than 'CONF.api.max_limit' option of Nova API, limit
1410 'CONF.api.max_limit' will be used instead.
1411 nova hypervisor-servers
1413 usage: nova hypervisor-servers <hostname>
1414 List servers belonging to specific hypervisors.
1416 Positional arguments:
1418 <hostname>
1420 The hypervisor hostname (or pattern) to search for.
1421 nova hypervisor-show
1423 usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
1424 Display the details of the specified hypervisor.
1426 Positional arguments:
1428 <hypervisor>
1430 Name or ID of the hypervisor. Starting with microversion 2.53
1431 the ID must be a UUID.
1432 Optional arguments:
1434 --wrap <integer>
1436 Wrap the output to a specified length. Default is 40 or 0 to
1437 disable
1438 nova hypervisor-stats
1440 usage: nova hypervisor-stats
1441 Get hypervisor statistics over all compute nodes.
1443 nova hypervisor-uptime
1445 usage: nova hypervisor-uptime <hypervisor>
1446 Display the uptime of the specified hypervisor.
1448 Positional arguments:
1450 <hypervisor>
1452 Name or ID of the hypervisor. Starting with microversion 2.53
1453 the ID must be a UUID.
1454 nova image-create
1456 usage: nova image-create [--metadata <key=value>] [--show] [--poll]
1457 <server> <name>
1458 Create a new image by taking a snapshot of a running server.
1460 Positional arguments:
1462 <server>
1464 Name or ID of server.
1465 <name> Name of snapshot.
1467 Optional arguments:
1469 --metadata <key=value>
1471 Record arbitrary key/value metadata to /meta_data.json on the
1472 metadata server. Can be specified multiple times.
1473 --show Print image info.
1475 --poll Report the snapshot progress and poll until image creation is
1477 complete.
1478 nova instance-action
1480 usage: nova instance-action <server> <request_id>
1481 Show an action.
1483 Positional arguments:
1485 <server>
1487 Name or UUID of the server to show actions for. Only UUID can be
1488 used to show actions for a deleted server. (Supported by API
1489 versions '2.21' - '2.latest')
1490 <request_id>
1492 Request ID of the action to get.
1493 nova instance-action-list
1495 usage: nova instance-action-list [--marker <marker>] [--limit <limit>]
1496 [--changes-since <changes_since>]
1497 [--changes-before <changes_before>]
1498 <server>
1499 List actions on a server.
1501 Positional arguments:
1503 <server>
1505 Name or UUID of the server to list actions for. Only UUID can be
1506 used to list actions on a deleted server. (Supported by API ver‐
1507 sions '2.21' - '2.latest')
1508 Optional arguments:
1510 --marker <marker>
1512 The last instance action of the previous page; displays list of
1513 actions after "marker". (Supported by API versions '2.58' -
1514 '2.latest')
1515 --limit <limit>
1517 Maximum number of instance actions to display. Note that there
1518 is a configurable max limit on the server, and the limit that is
1519 used will be the minimum of what is requested here and what is
1520 configured in the server. (Supported by API versions '2.58' -
1521 '2.latest')
1522 --changes-since <changes_since>
1524 List only instance actions changed later or equal to a certain
1525 point of time. The provided time should be an ISO 8061 formatted
1526 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1527 '2.58' - '2.latest')
1528 --changes-before <changes_before>
1530 List only instance actions changed earlier or equal to a certain
1531 point of time. The provided time should be an ISO 8061 formatted
1532 time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions
1533 '2.66' - '2.latest')
1534 nova instance-usage-audit-log
1536 usage: nova instance-usage-audit-log [--before <before>]
1537 List/Get server usage audits.
1539 Optional arguments:
1541 --before <before>
1543 Filters the response by the date and time before which to list
1544 usage audits. The date and time stamp format is as follows:
1545 CCYY-MM-DD hh:mm:ss.NNNNNN ex 2015-08-27 09:49:58 or 2015-08-27
1546 09:49:58.123456.
1547 nova interface-attach
1549 usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
1550 [--fixed-ip <fixed_ip>] [--tag <tag>]
1551 <server>
1552 Attach a network interface to a server.
1554 Positional arguments:
1556 <server>
1558 Name or ID of server.
1559 Optional arguments:
1561 --port-id <port_id>
1563 Port ID.
1564 --net-id <net_id>
1566 Network ID
1567 --fixed-ip <fixed_ip>
1569 Requested fixed IP.
1570 --tag <tag>
1572 Tag for the attached interface. (Supported by API versions
1573 '2.49' - '2.latest')
1574 nova interface-detach
1576 usage: nova interface-detach <server> <port_id>
1577 Detach a network interface from a server.
1579 Positional arguments:
1581 <server>
1583 Name or ID of server.
1584 <port_id>
1586 Port ID.
1587 nova interface-list
1589 usage: nova interface-list <server>
1590 List interfaces attached to a server.
1592 Positional arguments:
1594 <server>
1596 Name or ID of server.
1597 nova keypair-add
1599 usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
1600 [--user <user-id>]
1601 <name>
1602 Create a new key pair for use with servers.
1604 Positional arguments:
1606 <name> Name of key.
1608 Optional arguments:
1610 --pub-key <pub-key>
1612 Path to a public ssh key.
1613 --key-type <key-type>
1615 Keypair type. Can be ssh or x509. (Supported by API versions
1616 '2.2' - '2.latest')
1617 --user <user-id>
1619 ID of user to whom to add key-pair (Admin only). (Supported by
1620 API versions '2.10' - '2.latest')
1621 nova keypair-delete
1623 usage: nova keypair-delete [--user <user-id>] <name>
1624 Delete keypair given by its name. (Supported by API versions '2.0' -
1626 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1627 message for proper version]
1628 Positional arguments:
1630 <name> Keypair name to delete.
1632 Optional arguments:
1634 --user <user-id>
1636 ID of key-pair owner (Admin only).
1637 nova keypair-list
1639 usage: nova keypair-list [--user <user-id>] [--marker <marker>]
1640 [--limit <limit>]
1641 Print a list of keypairs for a user (Supported by API versions '2.0' -
1643 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1644 message for proper version]
1645 Optional arguments:
1647 --user <user-id>
1649 List key-pairs of specified user ID (Admin only).
1650 --marker <marker>
1652 The last keypair of the previous page; displays list of keypairs
1653 after "marker".
1654 --limit <limit>
1656 Maximum number of keypairs to display. If limit is bigger than
1657 'CONF.api.max_limit' option of Nova API, limit
1658 'CONF.api.max_limit' will be used instead.
1659 nova keypair-show
1661 usage: nova keypair-show [--user <user-id>] <keypair>
1662 Show details about the given keypair. (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 <keypair>
1670 Name of keypair.
1671 Optional arguments:
1673 --user <user-id>
1675 ID of key-pair owner (Admin only).
1676 nova limits
1678 usage: nova limits [--tenant [<tenant>]] [--reserved]
1679 Print rate and absolute limits.
1681 Optional arguments:
1683 --tenant [<tenant>]
1685 Display information from single tenant (Admin only).
1686 --reserved
1688 Include reservations count.
1689 nova list
1691 usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>]
1692 [--ip6 <ip6-regexp>] [--name <name-regexp>]
1693 [--instance-name <name-regexp>] [--status <status>]
1694 [--flavor <flavor>] [--image <image>] [--host <hostname>]
1695 [--all-tenants [<0|1>]] [--tenant [<tenant>]]
1696 [--user [<user>]] [--deleted] [--fields <fields>] [--minimal]
1697 [--sort <key>[:<direction>]] [--marker <marker>]
1698 [--limit <limit>] [--changes-since <changes_since>]
1699 [--changes-before <changes_before>]
1700 [--tags <tags>] [--tags-any <tags-any>]
1701 [--not-tags <not-tags>] [--not-tags-any <not-tags-any>]
1702 List servers.
1704 Note that from microversion 2.69, during partial infrastructure fail‐
1706 ures in the deployment, the output of this command may return partial
1707 results for the servers present in the failure domain.
1708 Optional arguments:
1710 --reservation-id <reservation-id>
1712 Only return servers that match reservation-id.
1713 --ip <ip-regexp>
1715 Search with regular expression match by IP address.
1716 --ip6 <ip6-regexp>
1718 Search with regular expression match by IPv6 address.
1719 --name <name-regexp>
1721 Search with regular expression match by name.
1722 --instance-name <name-regexp>
1724 Search with regular expression match by server name.
1725 --status <status>
1727 Search by server status.
1728 --flavor <flavor>
1730 Search by flavor name or ID.
1731 --image <image>
1733 Search by image name or ID.
1734 --host <hostname>
1736 Search servers by hostname to which they are assigned (Admin
1737 only).
1738 --all-tenants [<0|1>]
1740 Display information from all tenants (Admin only).
1741 --tenant [<tenant>]
1743 Display information from single tenant (Admin only).
1744 --user [<user>]
1746 Display information from single user (Admin only).
1747 --deleted
1749 Only display deleted servers (Admin only).
1750 --fields <fields>
1752 Comma-separated list of fields to display. Use the show command
1753 to see which fields are available.
1754 --minimal
1756 Get only UUID and name.
1757 --sort <key>[:<direction>]
1759 Comma-separated list of sort keys and directions in the form of
1760 <key>[:<asc|desc>]. The direction defaults to descending if not
1761 specified.
1762 --marker <marker>
1764 The last server UUID of the previous page; displays list of
1765 servers after "marker".
1766 --limit <limit>
1768 Maximum number of servers to display. If limit == -1, all
1769 servers will be displayed. If limit is bigger than
1770 'CONF.api.max_limit' option of Nova API, limit
1771 'CONF.api.max_limit' will be used instead.
1772 --changes-since <changes_since>
1774 List only servers changed later or equal to a certain point of
1775 time. The provided time should be an ISO 8061 formatted time.
1776 e.g. 2016-03-04T06:27:59Z .
1777 --changes-before <changes_before>
1779 List only servers changed earlier or equal to a certain point of
1780 time. The provided time should be an ISO 8061 formatted time.
1781 e.g. 2016-03-05T06:27:59Z . (Supported by API versions '2.66' -
1782 '2.latest')
1783 --tags <tags>
1785 The given tags must all be present for a server to be included
1786 in the list result. Boolean expression in this case is 't1 AND
1787 t2'. Tags must be separated by commas: --tags <tag1,tag2> (Sup‐
1788 ported by API versions '2.26' - '2.latest')
1789 --tags-any <tags-any>
1791 If one of the given tags is present the server will be included
1792 in the list result. Boolean expression in this case is 't1 OR
1793 t2'. Tags must be separated by commas: --tags-any <tag1,tag2>
1794 (Supported by API versions '2.26' - '2.latest')
1795 --not-tags <not-tags>
1797 Only the servers that do not have any of the given tags will be
1798 included in the list results. Boolean expression in this case is
1799 'NOT(t1 AND t2)'. Tags must be separated by commas: --not-tags
1800 <tag1,tag2> (Supported by API versions '2.26' - '2.latest')
1801 --not-tags-any <not-tags-any>
1803 Only the servers that do not have at least one of the given tags
1804 will be included in the list result. Boolean expression in this
1805 case is 'NOT(t1 OR t2)'. Tags must be separated by commas:
1806 --not-tags-any <tag1,tag2> (Supported by API versions '2.26' -
1807 '2.latest')
1808 nova list-extensions
1810 usage: nova list-extensions
1811 List all the os-api extensions that are available.
1813 nova list-secgroup
1815 usage: nova list-secgroup <server>
1816 List Security Group(s) of a server.
1818 Positional arguments:
1820 <server>
1822 Name or ID of server.
1823 nova live-migration
1825 usage: nova live-migration [--block-migrate] [--force] <server> [<host>]
1826 Migrate running server to a new machine.
1828 Positional arguments:
1830 <server>
1832 Name or ID of server.
1833 <host> Destination host name. If no host is specified, the scheduler
1835 will choose one.
1836 Optional arguments:
1838 --block-migrate
1840 True in case of block_migration. (Default=auto:live_migration)
1841 (Supported by API versions '2.25' - '2.latest')
1842 --force
1844 Force a live-migration by not verifying the provided destination
1845 host by the scheduler. (Supported by API versions '2.30' -
1846 '2.67')
1847 WARNING:
1849 This could result in failures to actually live migrate the
1850 server to the specified host. It is recommended to either not
1851 specify a host so that the scheduler will pick one, or spec‐
1852 ify a host without --force.
1853 nova live-migration-abort
1855 usage: nova live-migration-abort <server> <migration>
1856 Abort an on-going live migration. (Supported by API versions '2.24' -
1858 '2.latest') [hint: use '--os-compute-api-version' flag to show help
1859 message for proper version]
1860 For microversions from 2.24 to 2.64 the migration status must be run‐
1862 ning; for microversion 2.65 and greater, the migration status can also
1863 be queued and preparing.
1864 New in version 3.3.0.
1866 Positional arguments:
1869 <server>
1871 Name or ID of server.
1872 <migration>
1874 ID of migration.
1875 nova live-migration-force-complete
1877 usage: nova live-migration-force-complete <server> <migration>
1878 Force on-going live migration to complete. (Supported by API versions
1880 '2.22' - '2.latest') [hint: use '--os-compute-api-version' flag to show
1881 help message for proper version]
1882 New in version 3.3.0.
1884 Positional arguments:
1887 <server>
1889 Name or ID of server.
1890 <migration>
1892 ID of migration.
1893 nova lock
1895 usage: nova lock <server>
1896 Lock a server. A normal (non-admin) user will not be able to execute
1898 actions on a locked server.
1899 Positional arguments:
1901 <server>
1903 Name or ID of server.
1904 nova meta
1906 usage: nova meta <server> <action> <key=value> [<key=value> ...]
1907 Set or delete metadata on a server.
1909 Positional arguments:
1911 <server>
1913 Name or ID of server.
1914 <action>
1916 Actions: 'set' or 'delete'.
1917 <key=value>
1919 Metadata to set or delete (only key is necessary on delete).
1920 nova migrate
1922 usage: nova migrate [--host <host>] [--poll] <server>
1923 Migrate a server. The new host will be selected by the scheduler.
1925 Positional arguments:
1927 <server>
1929 Name or ID of server.
1930 Optional arguments:
1932 --host <host>
1934 Destination host name. (Supported by API versions '2.56' -
1935 '2.latest')
1936 --poll Report the server migration progress until it completes.
1938 nova migration-list
1940 usage: nova migration-list [--instance-uuid <instance_uuid>] [--host <host>]
1941 [--status <status>] [--marker <marker>]
1942 [--limit <limit>] [--changes-since <changes_since>]
1943 [--changes-before <changes_before>]
1944 Print a list of migrations.
1946 Optional arguments:
1948 --instance-uuid <instance_uuid>
1950 Fetch migrations for the given instance.
1951 --host <host>
1953 Fetch migrations for the given host.
1954 --status <status>
1956 Fetch migrations for the given status.
1957 --marker <marker>
1959 The last migration of the previous page; displays list of migra‐
1960 tions after "marker". Note that the marker is the migration
1961 UUID. (Supported by API versions '2.59' - '2.latest')
1962 --limit <limit>
1964 Maximum number of migrations to display. Note that there is a
1965 configurable max limit on the server, and the limit that is used
1966 will be the minimum of what is requested here and what is con‐
1967 figured in the server. (Supported by API versions '2.59' -
1968 '2.latest')
1969 --changes-since <changes_since>
1971 List only migrations changed later or equal to a certain point
1972 of time. The provided time should be an ISO 8061 formatted time.
1973 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.59' -
1974 '2.latest')
1975 --changes-before <changes_before>
1977 List only migrations changed earlier or equal to a certain point
1978 of time. The provided time should be an ISO 8061 formatted time.
1979 e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.66' -
1980 '2.latest')
1981 nova pause
1983 usage: nova pause <server>
1984 Pause a server.
1986 Positional arguments:
1988 <server>
1990 Name or ID of server.
1991 nova quota-class-show
1993 usage: nova quota-class-show <class>
1994 List the quotas for a quota class.
1996 Positional arguments:
1998 <class>
2000 Name of quota class to list the quotas for.
2001 nova quota-class-update
2003 usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
2004 [--ram <ram>]
2005 [--metadata-items <metadata-items>]
2006 [--key-pairs <key-pairs>]
2007 [--server-groups <server-groups>]
2008 [--server-group-members <server-group-members>]
2009 <class>
2010 Update the quotas for a quota class. (Supported by API versions '2.0' -
2012 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2013 message for proper version]
2014 Positional arguments:
2016 <class>
2018 Name of quota class to set the quotas for.
2019 Optional arguments:
2021 --instances <instances>
2023 New value for the "instances" quota.
2024 --cores <cores>
2026 New value for the "cores" quota.
2027 --ram <ram>
2029 New value for the "ram" quota.
2030 --metadata-items <metadata-items>
2032 New value for the "metadata-items" quota.
2033 --key-pairs <key-pairs>
2035 New value for the "key-pairs" quota.
2036 --server-groups <server-groups>
2038 New value for the "server-groups" quota.
2039 --server-group-members <server-group-members>
2041 New value for the "server-group-members" quota.
2042 nova quota-defaults
2044 usage: nova quota-defaults [--tenant <tenant-id>]
2045 List the default quotas for a tenant.
2047 Optional arguments:
2049 --tenant <tenant-id>
2051 ID of tenant to list the default quotas for.
2052 nova quota-delete
2054 usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
2055 Delete quota for a tenant/user so their quota will Revert back to
2057 default.
2058 Optional arguments:
2060 --tenant <tenant-id>
2062 ID of tenant to delete quota for.
2063 --user <user-id>
2065 ID of user to delete quota for.
2066 nova quota-show
2068 usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]
2069 List the quotas for a tenant/user.
2071 Optional arguments:
2073 --tenant <tenant-id>
2075 ID of tenant to list the quotas for.
2076 --user <user-id>
2078 ID of user to list the quotas for.
2079 --detail
2081 Show detailed info (limit, reserved, in-use).
2082 nova quota-update
2084 usage: nova quota-update [--user <user-id>] [--instances <instances>]
2085 [--cores <cores>] [--ram <ram>]
2086 [--metadata-items <metadata-items>]
2087 [--key-pairs <key-pairs>]
2088 [--server-groups <server-groups>]
2089 [--server-group-members <server-group-members>]
2090 [--force]
2091 <tenant-id>
2092 Update the quotas for a tenant/user. (Supported by API versions '2.0' -
2094 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2095 message for proper version]
2096 Positional arguments:
2098 <tenant-id>
2100 ID of tenant to set the quotas for.
2101 Optional arguments:
2103 --user <user-id>
2105 ID of user to set the quotas for.
2106 --instances <instances>
2108 New value for the "instances" quota.
2109 --cores <cores>
2111 New value for the "cores" quota.
2112 --ram <ram>
2114 New value for the "ram" quota.
2115 --metadata-items <metadata-items>
2117 New value for the "metadata-items" quota.
2118 --key-pairs <key-pairs>
2120 New value for the "key-pairs" quota.
2121 --server-groups <server-groups>
2123 New value for the "server-groups" quota.
2124 --server-group-members <server-group-members>
2126 New value for the "server-group-members" quota.
2127 --force
2129 Whether force update the quota even if the already used and
2130 reserved exceeds the new quota.
2131 nova reboot
2133 usage: nova reboot [--hard] [--poll] <server> [<server> ...]
2134 Reboot a server.
2136 Positional arguments:
2138 <server>
2140 Name or ID of server(s).
2141 Optional arguments:
2143 --hard Perform a hard reboot (instead of a soft one). Note: Ironic does
2145 not currently support soft reboot; consequently, bare metal
2146 nodes will always do a hard reboot, regardless of the use of
2147 this option.
2148 --poll Poll until reboot is complete.
2150 nova rebuild
2152 usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
2153 [--minimal] [--preserve-ephemeral] [--name <name>]
2154 [--description <description>] [--meta <key=value>]
2155 [--key-name <key-name>] [--key-unset]
2156 [--user-data <user-data>] [--user-data-unset]
2157 [--trusted-image-certificate-id <trusted-image-certificate-id>]
2158 [--trusted-image-certificates-unset]
2159 <server> <image>
2160 Shutdown, re-image, and re-boot a server.
2162 Positional arguments:
2164 <server>
2166 Name or ID of server.
2167 <image>
2169 Name or ID of new image.
2170 Optional arguments:
2172 --rebuild-password <rebuild-password>
2174 Set the provided admin password on the rebuilt server.
2175 --poll Report the server rebuild progress until it completes.
2177 --minimal
2179 Skips flavor/image lookups when showing servers.
2180 --preserve-ephemeral
2182 Preserve the default ephemeral storage partition on rebuild.
2183 --name <name>
2185 Name for the new server.
2186 --description <description>
2188 New description for the server. (Supported by API versions
2189 '2.19' - '2.latest')
2190 --meta <key=value>
2192 Record arbitrary key/value metadata to /meta_data.json on the
2193 metadata server. Can be specified multiple times.
2194 --key-name <key-name>
2196 Keypair name to set in the server. Cannot be specified with the
2197 '--key-unset' option. (Supported by API versions '2.54' -
2198 '2.latest')
2199 --key-unset
2201 Unset keypair in the server. Cannot be specified with the
2202 '--key-name' option. (Supported by API versions '2.54' -
2203 '2.latest')
2204 --user-data <user-data>
2206 User data file to pass to be exposed by the metadata server.
2207 (Supported by API versions '2.57' - '2.latest')
2208 --user-data-unset
2210 Unset user_data in the server. Cannot be specified with the
2211 '--user-data' option. (Supported by API versions '2.57' -
2212 '2.latest')
2213 --trusted-image-certificate-id <trusted-image-certificate-id>
2215 Trusted image certificate IDs used to validate certificates dur‐
2216 ing the image signature verification process. Defaults to
2217 env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multi‐
2218 ple times to pass multiple trusted image certificate IDs. (Sup‐
2219 ported by API versions '2.63' - '2.latest')
2220 --trusted-image-certificates-unset
2222 Unset trusted_image_certificates in the server. Cannot be speci‐
2223 fied with the --trusted-image-certificate-id option. (Supported
2224 by API versions '2.63' - '2.latest')
2225 nova refresh-network
2227 usage: nova refresh-network <server>
2228 Refresh server network information.
2230 Positional arguments:
2232 <server>
2234 Name or ID of a server for which the network cache should be
2235 refreshed from neutron (Admin only).
2236 nova remove-secgroup
2238 usage: nova remove-secgroup <server> <secgroup>
2239 Remove a Security Group from a server.
2241 Positional arguments:
2243 <server>
2245 Name or ID of server.
2246 <secgroup>
2248 Name of Security Group.
2249 nova rescue
2251 usage: nova rescue [--password <password>] [--image <image>] <server>
2252 Reboots a server into rescue mode, which starts the machine from either
2254 the initial image or a specified image, attaching the current boot disk
2255 as secondary.
2256 Positional arguments:
2258 <server>
2260 Name or ID of server.
2261 Optional arguments:
2263 --password <password>
2265 The admin password to be set in the rescue environment.
2266 --image <image>
2268 The image to rescue with.
2269 nova reset-network
2271 usage: nova reset-network <server>
2272 Reset network of a server.
2274 Positional arguments:
2276 <server>
2278 Name or ID of server.
2279 nova reset-state
2281 usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]
2282 Reset the state of a server.
2284 Positional arguments:
2286 <server>
2288 Name or ID of server(s).
2289 Optional arguments:
2291 --all-tenants
2293 Reset state server(s) in another tenant by name (Admin only).
2294 --active
2296 Request the server be reset to "active" state instead of "error"
2297 state (the default).
2298 nova resize
2300 usage: nova resize [--poll] <server> <flavor>
2301 Resize a server.
2303 Positional arguments:
2305 <server>
2307 Name or ID of server.
2308 <flavor>
2310 Name or ID of new flavor.
2311 Optional arguments:
2313 --poll Report the server resize progress until it completes.
2315 nova resize-confirm
2317 usage: nova resize-confirm <server>
2318 Confirm a previous resize.
2320 Positional arguments:
2322 <server>
2324 Name or ID of server.
2325 nova resize-revert
2327 usage: nova resize-revert <server>
2328 Revert a previous resize (and return to the previous VM).
2330 Positional arguments:
2332 <server>
2334 Name or ID of server.
2335 nova restore
2337 usage: nova restore <server>
2338 Restore a soft-deleted server.
2340 Positional arguments:
2342 <server>
2344 Name or ID of server.
2345 nova resume
2347 usage: nova resume <server>
2348 Resume a server.
2350 Positional arguments:
2352 <server>
2354 Name or ID of server.
2355 nova server-group-create
2357 usage: nova server-group-create [--rules <key=value>] <name> <policy>
2358 Create a new server group with the specified details.
2360 Positional arguments:
2362 <name> Server group name.
2364 <policy>
2366 Policy for the server groups.
2367 Optional arguments:
2369 --rule Policy rules for the server groups. (Supported by API versions
2371 '2.64' - '2.latest'）. Currently, only the max_server_per_host
2372 rule is supported for the anti-affinity policy. The
2373 max_server_per_host rule allows specifying how many members of
2374 the anti-affinity group can reside on the same compute host. If
2375 not specified, only one member from the same anti-affinity group
2376 can reside on a given host.
2377 nova server-group-delete
2379 usage: nova server-group-delete <id> [<id> ...]
2380 Delete specific server group(s).
2382 Positional arguments:
2384 <id> Unique ID(s) of the server group to delete.
2386 nova server-group-get
2388 usage: nova server-group-get <id>
2389 Get a specific server group.
2391 Positional arguments:
2393 <id> Unique ID of the server group to get.
2395 nova server-group-list
2397 usage: nova server-group-list [--limit <limit>] [--offset <offset>]
2398 [--all-projects]
2399 Print a list of all server groups.
2401 Optional arguments:
2403 --limit <limit>
2405 Maximum number of server groups to display. If limit is bigger
2406 than 'CONF.api.max_limit' option of Nova API, limit
2407 'CONF.api.max_limit' will be used instead.
2408 --offset <offset>
2410 The offset of groups list to display; use with limit to return a
2411 slice of server groups.
2412 --all-projects
2414 Display server groups from all projects (Admin only).
2415 nova server-migration-list
2417 usage: nova server-migration-list <server>
2418 Get the migrations list of specified server. (Supported by API versions
2420 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2421 help message for proper version]
2422 New in version 3.3.0.
2424 Positional arguments:
2427 <server>
2429 Name or ID of server.
2430 nova server-migration-show
2432 usage: nova server-migration-show <server> <migration>
2433 Get the migration of specified server. (Supported by API versions
2435 '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2436 help message for proper version]
2437 New in version 3.3.0.
2439 Positional arguments:
2442 <server>
2444 Name or ID of server.
2445 <migration>
2447 ID of migration.
2448 nova server-tag-add
2450 usage: nova server-tag-add <server> <tag> [<tag> ...]
2451 Add one or more tags to a server. (Supported by API versions '2.26' -
2453 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2454 message for proper version]
2455 New in version 4.1.0.
2457 Positional arguments:
2460 <server>
2462 Name or ID of server.
2463 <tag> Tag(s) to add.
2465 nova server-tag-delete
2467 usage: nova server-tag-delete <server> <tag> [<tag> ...]
2468 Delete one or more tags from a server. (Supported by API versions
2470 '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag to show
2471 help message for proper version]
2472 New in version 4.1.0.
2474 Positional arguments:
2477 <server>
2479 Name or ID of server.
2480 <tag> Tag(s) to delete.
2482 nova server-tag-delete-all
2484 usage: nova server-tag-delete-all <server>
2485 Delete all tags from a server. (Supported by API versions '2.26' -
2487 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2488 message for proper version]
2489 New in version 4.1.0.
2491 Positional arguments:
2494 <server>
2496 Name or ID of server.
2497 nova server-tag-list
2499 usage: nova server-tag-list <server>
2500 Get list of tags from a server. (Supported by API versions '2.26' -
2502 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2503 message for proper version]
2504 New in version 4.1.0.
2506 Positional arguments:
2509 <server>
2511 Name or ID of server.
2512 nova server-tag-set
2514 usage: nova server-tag-set <server> <tags> [<tags> ...]
2515 Set list of tags to a server. (Supported by API versions '2.26' -
2517 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2518 message for proper version]
2519 New in version 4.1.0.
2521 Positional arguments:
2524 <server>
2526 Name or ID of server.
2527 <tags> Tag(s) to set.
2529 nova service-delete
2531 usage: nova service-delete <id>
2532 Delete the service.
2534 IMPORTANT:
2536 If deleting a nova-compute service, be sure to stop the actual
2537 nova-compute process on the physical host before deleting the ser‐
2538 vice with this command. Failing to do so can lead to the running
2539 service re-creating orphaned compute_nodes table records in the
2540 database.
2541 Positional arguments:
2543 <id> ID of service as a UUID. (Supported by API versions '2.53' -
2545 '2.latest')
2546 nova service-disable
2548 usage: nova service-disable [--reason <reason>] <id>
2549 Disable the service.
2551 Positional arguments:
2553 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2555 '2.latest')
2556 Optional arguments:
2558 --reason <reason>
2560 Reason for disabling the service.
2561 nova service-enable
2563 usage: nova service-enable <id>
2564 Enable the service.
2566 Positional arguments:
2568 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2570 '2.latest')
2571 nova service-force-down
2573 usage: nova service-force-down [--unset] <id>
2574 Force service to down. (Supported by API versions '2.11' - '2.latest')
2576 [hint: use '--os-compute-api-version' flag to show help message for
2577 proper version]
2578 New in version 2.27.0.
2580 Positional arguments:
2583 <id> ID of the service as a UUID. (Supported by API versions '2.53' -
2585 '2.latest')
2586 Optional arguments:
2588 --unset
2590 Unset the forced_down state of the service.
2591 nova service-list
2593 usage: nova service-list [--host <hostname>] [--binary <binary>]
2594 Show a list of all running services. Filter by host & binary.
2596 Note that from microversion 2.69, during partial infrastructure fail‐
2598 ures in the deployment, the output of this command may return partial
2599 results for the services present in the failure domain.
2600 Optional arguments:
2602 --host <hostname>
2604 Name of host.
2605 --binary <binary>
2607 Service binary.
2608 nova set-password
2610 usage: nova set-password <server>
2611 Change the admin password for a server.
2613 Positional arguments:
2615 <server>
2617 Name or ID of server.
2618 nova shelve
2620 usage: nova shelve <server>
2621 Shelve a server.
2623 Positional arguments:
2625 <server>
2627 Name or ID of server.
2628 nova shelve-offload
2630 usage: nova shelve-offload <server>
2631 Remove a shelved server from the compute node.
2633 Positional arguments:
2635 <server>
2637 Name or ID of server.
2638 nova show
2640 usage: nova show [--minimal] [--wrap <integer>] <server>
2641 Show details about the given server.
2643 Note that from microversion 2.69, during partial infrastructure fail‐
2645 ures in the deployment, the output of this command may return partial
2646 results for the server if it exists in the failure domain.
2647 Positional arguments:
2649 <server>
2651 Name or ID of server.
2652 Optional arguments:
2654 --minimal
2656 Skips flavor/image lookups when showing servers.
2657 --wrap <integer>
2659 Wrap the output to a specified length, or 0 to disable.
2660 nova ssh
2662 usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE]
2663 [--network <network>] [--ipv6] [--login <login>] [-i IDENTITY]
2664 [--extra-opts EXTRA]
2665 <server>
2666 SSH into a server.
2668 Positional arguments:
2670 <server>
2672 Name or ID of server.
2673 Optional arguments:
2675 --port PORT
2677 Optional flag to indicate which port to use for ssh.
2678 (Default=22)
2679 --address-type ADDRESS_TYPE
2681 Optional flag to indicate which IP type to use. Possible values
2682 includes fixed and floating (the Default).
2683 --network <network>
2685 Network to use for the ssh.
2686 --ipv6 Optional flag to indicate whether to use an IPv6 address
2688 attached to a server. (Defaults to IPv4 address)
2689 --login <login>
2691 Login to use.
2692 -i IDENTITY, --identity IDENTITY
2694 Private key file, same as the -i option to the ssh command.
2695 --extra-opts EXTRA
2697 Extra options to pass to ssh. see: man ssh.
2698 nova start
2700 usage: nova start [--all-tenants] <server> [<server> ...]
2701 Start the server(s).
2703 Positional arguments:
2705 <server>
2707 Name or ID of server(s).
2708 Optional arguments:
2710 --all-tenants
2712 Start server(s) in another tenant by name (Admin only).
2713 nova stop
2715 usage: nova stop [--all-tenants] <server> [<server> ...]
2716 Stop the server(s).
2718 Positional arguments:
2720 <server>
2722 Name or ID of server(s).
2723 Optional arguments:
2725 --all-tenants
2727 Stop server(s) in another tenant by name (Admin only).
2728 nova suspend
2730 usage: nova suspend <server>
2731 Suspend a server.
2733 Positional arguments:
2735 <server>
2737 Name or ID of server.
2738 nova trigger-crash-dump
2740 usage: nova trigger-crash-dump <server>
2741 Trigger crash dump in an instance. (Supported by API versions '2.17' -
2743 '2.latest') [hint: use '--os-compute-api-version' flag to show help
2744 message for proper version]
2745 New in version 3.3.0.
2747 Positional arguments:
2750 <server>
2752 Name or ID of server.
2753 nova unlock
2755 usage: nova unlock <server>
2756 Unlock a server.
2758 Positional arguments:
2760 <server>
2762 Name or ID of server.
2763 nova unpause
2765 usage: nova unpause <server>
2766 Unpause a server.
2768 Positional arguments:
2770 <server>
2772 Name or ID of server.
2773 nova unrescue
2775 usage: nova unrescue <server>
2776 Restart the server from normal boot disk again.
2778 Positional arguments:
2780 <server>
2782 Name or ID of server.
2783 nova unshelve
2785 usage: nova unshelve <server>
2786 Unshelve a server.
2788 Positional arguments:
2790 <server>
2792 Name or ID of server.
2793 nova update
2795 usage: nova update [--name <name>] [--description <description>] <server>
2796 Update the name or the description for a server.
2798 Positional arguments:
2800 <server>
2802 Name (old name) or ID of server.
2803 Optional arguments:
2805 --name <name>
2807 New name for the server.
2808 --description <description>
2810 New description for the server. If it equals to empty string
2811 (i.g. ""), the server description will be removed. (Supported by
2812 API versions '2.19' - '2.latest')
2813 nova usage
2815 usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
2816 Show usage data for a single tenant.
2818 Optional arguments:
2820 --start <start>
2822 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2823 --end <end>
2825 Usage range end date, ex 2012-01-20. (default: tomorrow)
2826 --tenant <tenant-id>
2828 UUID of tenant to get usage for.
2829 nova usage-list
2831 usage: nova usage-list [--start <start>] [--end <end>]
2832 List usage data for all tenants.
2834 Optional arguments:
2836 --start <start>
2838 Usage range start date ex 2012-01-20. (default: 4 weeks ago)
2839 --end <end>
2841 Usage range end date, ex 2012-01-20. (default: tomorrow)
2842 nova version-list
2844 usage: nova version-list
2845 List all API versions.
2847 nova volume-attach
2849 usage: nova volume-attach [--tag <tag>] <server> <volume> [<device>]
2850 Attach a volume to a server.
2852 Positional arguments:
2854 <server>
2856 Name or ID of server.
2857 <volume>
2859 ID of the volume to attach.
2860 <device>
2862 Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if
2863 supported). Libvirt driver will use default device name.
2864 Optional arguments:
2866 --tag <tag>
2868 Tag for the attached volume. (Supported by API versions '2.49' -
2869 '2.latest')
2870 nova volume-attachments
2872 usage: nova volume-attachments <server>
2873 List all the volumes attached to a server.
2875 Positional arguments:
2877 <server>
2879 Name or ID of server.
2880 nova volume-detach
2882 usage: nova volume-detach <server> <volume>
2883 Detach a volume from a server.
2885 Positional arguments:
2887 <server>
2889 Name or ID of server.
2890 <volume>
2892 ID of the volume to detach.
2893 nova volume-update
2895 usage: nova volume-update <server> <src_volid> <dest_volid>
2896 Update the attachment on the server. Migrates the data from an attached
2898 volume to the specified available volume and swaps out the active
2899 attachment to the new volume.
2900 Positional arguments:
2902 <server>
2904 Name or ID of server.
2905 <src_volid>
2907 ID of the source (original) volume.
2908 <dest_volid>
2910 ID of the destination volume.
2911 nova bash-completion
2913 usage: nova bash-completion
2914 Prints all of the commands and options to stdout so that the
2916 nova.bash_completion script doesn't have to hard code them.
2917
2919 OpenStack Contributors
2920
2922 OpenStack Contributors
2923 Jul 26, 2019 NOVA(1)