NOVA(1)

📦

version 18.12.0 · 6 versions

💅 NOVA(1) 💅

okok so this is the manual page for nova, brought to you by python-novaclient (that's the fancy package name, iykyk) — and bestie, we're about to get into it ✨

🌸 NAME 🌸

nova — the OpenStack Nova command line client 👑

The nova client is the command-line interface (CLI) for the Compute service (nova) API and its extensions. Basically it's your little remote control for the whole compute situation 🎮

Need help on a specific nova command? Just ask, she answers:

$ nova help COMMAND

⚠️ Deprecated since version 17.8.0: the nova CLI has been deprecated in favour of the unified openstack CLI. For information on using the openstack CLI, see OpenStackClient. Not me delivering bad news in the first paragraph 😭 but like, forewarned is forearmed, fr fr.

🦋 NOVA USAGE 🦋

Here's the whole entire shape of her, verbatim, no notes:

usage: nova [--version] [--debug] [--os-cache] [--timings]
            [--os-region-name <region-name>] [--service-type <service-type>]
            [--service-name <service-name>]
            [--os-endpoint-type <endpoint-type>]
            [--os-compute-api-version <compute-api-ver>]
            [--os-endpoint-override <bypass-url>] [--profile HMAC_KEY]
            [--insecure] [--os-cacert <ca-certificate>]
            [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
            [--collect-timing] [--os-auth-type <name>]
            [--os-auth-url OS_AUTH_URL] [--os-system-scope OS_SYSTEM_SCOPE]
            [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME]
            [--os-project-id OS_PROJECT_ID]
            [--os-project-name OS_PROJECT_NAME]
            [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
            [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
            [--os-trust-id OS_TRUST_ID]
            [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
            [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
            [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
            [--os-user-domain-id OS_USER_DOMAIN_ID]
            [--os-user-domain-name OS_USER_DOMAIN_NAME]
            [--os-password OS_PASSWORD]
            <subcommand> ...

🎀 Subcommands 🎀

okay this is the whole squad, all 102 of them, no skipping, no "and the rest" — we do not do that here 💅

add-fixed-ip — DEPRECATED — adds a new IP address on a network to a server.
add-secgroup — adds a Security Group to a server. protecting her 🛡️
agent-create — creates a new agent build.
agent-delete — deletes an existing agent build. bye 👋
agent-list — lists all the builds.
agent-modify — modifies an existing agent build. glow-up ✨
aggregate-add-host — adds the host to the specified aggregate.
aggregate-cache-images — requests that images be pre-cached on hosts within an aggregate. (Supported by API versions '2.81' - '2.latest')
aggregate-create — creates a new aggregate with the specified details.
aggregate-delete — deletes the aggregate. gone, reduced to atoms 💀
aggregate-list — prints a list of all aggregates.
aggregate-remove-host — removes the specified host from the specified aggregate.
aggregate-set-metadata — updates the metadata associated with the aggregate.
aggregate-show — shows details of the specified aggregate.
aggregate-update — updates the aggregate's name and optionally the availability zone.
availability-zone-list — lists all the availability zones.
backup — backs up a server by creating a 'backup' type snapshot.
boot — boots a new server. main character entrance 🚀
clear-password — clears the admin password for a server from the metadata server. Heads up: this action does not actually change the instance server password. read it again, yes, it's giving "did nothing but slay" 🙈
cloudpipe-configure — DEPRECATED — updates the VPN IP/port of a cloudpipe instance.
cloudpipe-create — DEPRECATED — creates a cloudpipe instance for the given project.
cloudpipe-list — DEPRECATED — prints a list of all cloudpipe instances.
console-log — gets the console log output of a server.
delete — immediately shuts down and deletes the specified server(s). no warning, no grace period, just vibes and consequences 😭
diagnostics — retrieves server diagnostics.
evacuate — evacuates a server from a failed host. get her outta there 🏃‍♀️
flavor-access-add — adds flavor access for the given tenant.
flavor-access-list — prints access information about the given flavor.
flavor-access-remove — removes flavor access for the given tenant.
flavor-create — creates a new flavor.
flavor-delete — deletes a specific flavor
flavor-key — sets or unsets extra_spec for a flavor.
flavor-list — prints a list of available 'flavors' (sizes of servers).
flavor-show — shows details about the given flavor.
flavor-update — updates the description of an existing flavor. (Supported by API versions '2.55' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
floating-ip-associate — DEPRECATED — associates a floating IP address to a server.
floating-ip-disassociate — DEPRECATED — disassociates a floating IP address from a server.
force-delete — force deletes a server. it's giving no chill 🔥
get-mks-console — gets an MKS console to a server. (Supported by API versions '2.8' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
get-password — gets the admin password for a server. Important: this operation calls the metadata service to query metadata information and does not read password information from the server itself. love a transparent queen 🫶
get-rdp-console — gets a rdp console to a server.
get-serial-console — gets a serial console to a server.
get-spice-console — gets a spice console to a server.
get-vnc-console — gets a vnc console to a server.
host-action — DEPRECATED — performs a power action on a host.
host-describe — DEPRECATED — describes a specific host.
host-evacuate — evacuates all instances from a failed host.
host-evacuate-live — live migrates all instances off the specified host to other available hosts.
host-list — DEPRECATED — lists all hosts by service.
host-meta — sets or deletes metadata on all instances of a host.
host-servers-migrate — cold migrates all instances off the specified host to other available hosts.
host-update — DEPRECATED — updates host settings.
hypervisor-list — lists hypervisors. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
hypervisor-servers — lists servers belonging to specific hypervisors.
hypervisor-show — displays the details of the specified hypervisor.
hypervisor-stats — gets hypervisor statistics over all compute nodes.
hypervisor-uptime — displays the uptime of the specified hypervisor.
image-create — creates a new image by taking a snapshot of a running server. 📸
instance-action — shows an action.
instance-action-list — lists actions on a server.
instance-usage-audit-log — lists/gets server usage audits.
interface-attach — attaches a network interface to a server.
interface-detach — detaches a network interface from a server.
interface-list — lists interfaces attached to a server.
keypair-add — creates a new key pair for use with servers. 🔑
keypair-delete — deletes the keypair given by its name. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
keypair-list — prints a list of keypairs for a user (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
keypair-show — shows details about the given keypair. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
limits — prints rate and absolute limits.
list — lists servers. yes that's it, that's the whole description, and honestly? iconic minimalism 👑
list-secgroup — lists Security Group(s) of a server.
live-migration — migrates a running server to a new machine.
live-migration-abort — aborts an on-going live migration. (Supported by API versions '2.24' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
live-migration-force-complete — forces an on-going live migration to complete. (Supported by API versions '2.22' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
lock — locks a server. a normal (non-admin) user will not be able to execute actions on a locked server. it's giving "you're on time-out" 🔒
meta — sets or deletes metadata on a server.
migrate — migrates a server. the new host will be selected by the scheduler. she's not picking, the scheduler is 💅
migration-list — prints a list of migrations.
pause — pauses a server. ⏸️
quota-class-show — lists the quotas for a quota class.
quota-class-update — updates the quotas for a quota class. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
quota-defaults — lists the default quotas for a tenant.
quota-delete — deletes quota for a tenant/user so their quota will revert back to default.
quota-show — lists the quotas for a tenant/user.
quota-update — updates the quotas for a tenant/user. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
reboot — reboots a server. 🔄
rebuild — shuts down, re-images, and re-boots a server. full reset, new me energy ✨
refresh-network — refreshes server network information.
remove-fixed-ip — DEPRECATED — removes an IP address from a server.
remove-secgroup — removes a Security Group from a server.
rescue — reboots a server into rescue mode, which starts the machine from either the initial image or a specified image, attaching the current boot disk as secondary. 🚑
reset-network — resets the network of a server.
reset-state — resets the state of a server.
resize — resizes a server.
resize-confirm — confirms a previous resize.
resize-revert — reverts a previous resize (and returns to the previous VM).
restore — restores a soft-deleted server. she's back 🫶
resume — resumes a server. ▶️
server-group-create — creates a new server group with the specified details.
server-group-delete — deletes specific server group(s).
server-group-get — gets a specific server group.
server-group-list — prints a list of all server groups.
server-migration-list — grabs the migrations list for a server you pick. (Supported by API versions '2.23' - '2.latest') [hint: use --os-compute-api-version flag to show help message for proper version]
server-migration-show — shows you one specific migration for a server. (Supported by API versions '2.23' - '2.latest') [hint: use --os-compute-api-version flag to show help message for proper version]
server-tag-add — slaps one or more tags onto a server, no cap. (Supported by API versions '2.26' - '2.latest') [hint: use --os-compute-api-version flag to show help message for proper version]
server-tag-delete — yeets one or more tags off a server. (Supported by API versions '2.26' - '2.latest') [hint: use --os-compute-api-version flag to show help message for proper version]
server-tag-delete-all — nukes every tag on a server, like a full clean slate era. (Supported by API versions '2.26' - '2.latest') [hint: use --os-compute-api-version flag to show help message for proper version]
server-tag-list — shows you all the tags chillin' on a server. (Supported by API versions '2.26' - '2.latest') [hint: use --os-compute-api-version flag to show help message for proper version]
server-tag-set — replaces the whole tag list on a server with the one you give it. (Supported by API versions '2.26' - '2.latest') [hint: use --os-compute-api-version flag to show help message for proper version]
server-topology — pulls the NUMA topology of whatever server you name. (Supported by API versions '2.78' - '2.latest')
service-delete — deletes the service. that's it, that's the tweet 💀
service-disable — disables the service.
service-enable — enables the service (the glow-up arc ✨).
service-force-down — forces the service into the down state. (Supported by API versions '2.11' - '2.latest') [hint: use --os-compute-api-version flag to show help message for proper version]
service-list — shows every running service in a list. You can filter by host & binary, bestie.
set-password — changes the admin password for a server 🔑
shelve — shelves a server.
shelve-offload — takes a shelved server off the compute node entirely.
show — shows you the details of a server, the whole lore.
ssh — SSH'ing straight into a server, iconic.
start — starts the server(s).
stop — stops the server(s).
suspend — suspends a server.
trigger-crash-dump — triggers a crash dump inside an instance. (Supported by API versions '2.17' - '2.latest') [hint: use --os-compute-api-version flag to show help message for proper version]
unlock — unlocks a server.
unpause — unpauses a server.
unrescue — restarts the server from its normal boot disk again.
unshelve — unshelves a server.
update — updates a server's name or its description.
usage — shows usage data for a single tenant.
usage-list — lists usage data for all the tenants.
version-list — lists every API version.
virtual-interface-list — DEPRECATED shows virtual interface info about the given server.
volume-attach — attaches a volume to a server.
volume-attachments — lists all the volumes currently attached to a server.
volume-detach — detaches a volume from a server.
volume-update — updates the attachment on the server. Migrates the data from an attached volume to the specified available volume and swaps out the active attachment to the new volume. Since microversion 2.85, support for updating the delete_on_termination delete flag, which allows changing the behavior of volume deletion on instance deletion. 🫶
x509-create-cert — DEPRECATED creates an x509 cert for a user in a tenant.
x509-get-root-cert — DEPRECATED fetches the x509 root cert.
bash-completion — prints all of the commands and options to stdout so that the nova.bash_completion script doesn't have to hard code them. lowkey genius.
help — shows help about this program, or about one of its subcommands.

✨ NOVA OPTIONAL ARGUMENTS ✨

These are the big global ones, the ones that apply everywhere, the main characters of the flag world 👑

--version — shows the program's version number and exits.
--debug — prints debugging output, for when you need to see everything.
--os-cache — uses the auth token cache. Defaults to False if env[OS_CACHE] is not set.
--timings — prints call timing info.
--os-region-name <region-name> — defaults to env[OS_REGION_NAME].
--service-type <service-type> — defaults to compute for most actions.
--service-name <service-name> — defaults to env[NOVA_SERVICE_NAME].
--os-endpoint-type <endpoint-type> — defaults to env[NOVA_ENDPOINT_TYPE], env[OS_ENDPOINT_TYPE] or publicURL.
--os-compute-api-version <compute-api-ver> — accepts X, X.Y (where X is major and Y is minor part) or "X.latest", defaults to env[OS_COMPUTE_API_VERSION].
--os-endpoint-override <bypass-url> — uses this API endpoint instead of the Service Catalog. Defaults to env[OS_ENDPOINT_OVERRIDE].
--profile HMAC_KEY — the HMAC key to use for encrypting context data for performance profiling of an operation. This key should be the value of the HMAC key configured for the OSprofiler middleware in nova; it is specified in the Nova configuration file at "/etc/nova/nova.conf". Without the key, profiling will not be triggered even if OSprofiler is enabled on the server side. so like, remember the key or nothing happens 💅
--os-auth-type <name>, --os-auth-plugin <name> — authentication type to use.

🌸 nova add-secgroup 🌸

usage: nova add-secgroup <server> <secgroup>

Adds a Security Group to a server.

Positional arguments:

<server> — name or ID of server.
<secgroup> — name or ID of Security Group.

🦋 nova agent-create 🦋

usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
                         <hypervisor>

Creates a new agent build.

Positional arguments:

<os> — type of OS.
<architecture> — type of architecture.
<version> — version.
<url> — URL.
<md5hash> — MD5 hash.
<hypervisor> — type of hypervisor.

🎀 nova agent-delete 🎀

usage: nova agent-delete <id>

Deletes an existing agent build.

Positional arguments:

<id> — ID of the agent-build.

⭐ nova agent-list ⭐

usage: nova agent-list [--hypervisor <hypervisor>]

Lists all builds. every single one.

Optional arguments:

--hypervisor <hypervisor> — type of hypervisor.

💜 nova agent-modify 💜

usage: nova agent-modify <id> <version> <url> <md5hash>

Modifies an existing agent build.

Positional arguments:

<id> — ID of the agent-build.
<version> — version.
<url> — URL
<md5hash> — MD5 hash.

🌈 nova aggregate-add-host 🌈

usage: nova aggregate-add-host <aggregate> <host>

Adds the host to the specified aggregate.

Positional arguments:

<aggregate> — name or ID of aggregate.
<host> — the host to add to the aggregate.

🍓 nova aggregate-cache-images 🍓

usage: nova aggregate-cache-images <aggregate> <image> [<image> ..]

Requests image(s) be pre-cached on hosts within the aggregate. (Supported by API versions '2.81' - '2.latest')

New in version 16.0.0.

Positional arguments:

<aggregate> — name or ID of aggregate.
<image> — name or ID of image(s) to cache.

🧚 nova aggregate-create 🧚

usage: nova aggregate-create <name> [<availability-zone>]

Creates a new aggregate with the specified details.

Positional arguments:

<name> — name of aggregate.
<availability-zone> — the availability zone of the aggregate (optional).

💖 nova aggregate-delete 💖

usage: nova aggregate-delete <aggregate>

Deletes the aggregate. bye bestie 👋

Positional arguments:

<aggregate> — name or ID of aggregate to delete.

✨ nova aggregate-list ✨

usage: nova aggregate-list

Prints a list of all aggregates.

🔥 nova aggregate-remove-host 🔥

usage: nova aggregate-remove-host <aggregate> <host>

Removes the specified host from the specified aggregate.

Positional arguments:

<aggregate> — name or ID of aggregate.
<host> — the host to remove from the aggregate.

🦋 nova aggregate-set-metadata 🦋

usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]

Updates the metadata associated with the aggregate.

Positional arguments:

<aggregate> — name or ID of aggregate to update.
<key=value> — metadata to add/update to aggregate. Specify only the key to delete a metadata item. (yes, key alone = delete, that's the trick 💅)

👑 nova aggregate-show 👑

usage: nova aggregate-show <aggregate>

Shows details of the specified aggregate.

Positional arguments:

<aggregate> — name or ID of aggregate.

🎀 nova aggregate-update 🎀

usage: nova aggregate-update [--name NAME]
                             [--availability-zone <availability-zone>]
                             <aggregate>

Updates the aggregate's name and optionally availability zone.

Positional arguments:

<aggregate> — name or ID of aggregate to update.

Optional arguments:

--name NAME — new name for aggregate.
--availability-zone <availability-zone> — new availability zone for aggregate.

🌸 nova availability-zone-list 🌸

usage: nova availability-zone-list

Lists all the availability zones.

💜 nova backup 💜

usage: nova backup <server> <name> <backup-type> <rotation>

Backs up a server by creating a 'backup' type snapshot.

Positional arguments:

<server> — name or ID of server.
<name> — name of the backup image.
<backup-type> — the backup type, like "daily" or "weekly".
<rotation> — int parameter representing how many backups to keep around.

🦋 nova boot 🦋

nova boot [--flavor <flavor>] [--image <image>]
             [--image-with <key=value>] [--boot-volume <volume_id>]
             [--snapshot <snapshot_id>] [--min-count <number>]
             [--max-count <number>] [--meta <key=value>]
             [--key-name <key-name>] [--user-data <user-data>]
             [--availability-zone <availability-zone>]
             [--security-groups <security-groups>]
             [--block-device-mapping <dev-name=mapping>]
             [--block-device key1=value1[,key2=value2...]]
             [--swap <swap_size>]
             [--ephemeral size=<size>[,format=<format>]]
             [--hint <key=value>]
             [--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>]
             [--config-drive <value>] [--poll] [--admin-pass <value>]
             [--access-ip-v4 <value>] [--access-ip-v6 <value>]
             [--description <description>] [--tags <tags>]
             [--return-reservation-id]
             [--trusted-image-certificate-id <trusted-image-certificate-id>]
             [--host <host>]
             [--hypervisor-hostname <hypervisor-hostname>]
             [--hostname <hostname>]
             <name>

Boot a new server. ✨ That's it, that's the whole vibe — brand new server, freshly booted, yours.

Little heads-up though, bestie: if you wanna create a server with pre-existing ports that have a resource_request value — think guaranteed minimum bandwidth quality of service support — you need microversion 2.72. No cap. 🫶

Positional arguments:

<name> — the name for your new server. Name it something cute, or don't, we don't judge. 💜

Optional arguments:

--flavor <flavor> — name or ID of the flavor (peep nova flavor-list for the menu 🍓).
--image <image> — name or ID of the image (see glance image-list). This is the glow-up your server boots from ✨.
--image-with <key=value> — image metadata property (check glance image-show).
--boot-volume <volume_id> — volume ID to boot from. Boot straight off a volume, main character energy.
--snapshot <snapshot_id> — snapshot ID to boot from — heads up, this will create a volume. 😭 Not free, bestie.
--min-count <number> — boot at least <number> servers (limited by quota, so don't get too ambitious).
--max-count <number> — boot up to <number> servers (also limited by quota, okurrr).
--meta <key=value> — record arbitrary key/value metadata to /meta_data.json on the metadata server. Can be specified multiple times — stack 'em up 🎀.
--key-name <key-name> — key name of a keypair that you should've created earlier with the command keypair-add.
--user-data <user-data> — user data file to pass along, to be exposed by the metadata server.
--availability-zone <availability-zone> — the availability zone for server placement 📍.
--security-groups <security-groups> — comma separated list of security group names.
--block-device-mapping <dev-name=mapping> — block device mapping, in the format <dev-name>=<id>:<type>:<size(GiB)>:<delete-on-terminate>.
--block-device key1=value1[,key2=value2...] — block device mapping with these keys, and yes there are a lot of them, buckle up 🎢:
- id=UUID (this can be image_id, snapshot_id or volume_id — only if using source image, snapshot or volume)
- source=source type (that's image, snapshot, volume or blank)
- dest=destination type of the block device (volume or local)
- bus=device's bus (e.g. uml, lxc, virtio, ...; if you leave it out, the hypervisor driver chooses a suitable default — and it's only honoured if device type is supplied)
- type=device type (e.g. disk, cdrom, ...; defaults to 'disk')
- device=name of the device (e.g. vda, xda, ...; if omitted, the hypervisor driver chooses a suitable device depending on the selected bus — note the libvirt driver always uses default device names)
- size=size of the block device in MiB (for swap) and in GiB (for other formats) — if omitted, the hypervisor driver calculates size
- format=device will be formatted (e.g. swap, ntfs, ...; optional)
- bootindex=integer used for ordering the boot disks (for image backed instances it's equal to 0, for others it needs to be specified)
- shutdown=shutdown behaviour (either preserve or remove — for local destination set to remove)
- tag=device metadata tag (optional; supported by API versions '2.42' - '2.latest')
- and volume_type=type of volume to create (either ID or name) when source is blank, image or snapshot and dest is volume (optional; supported by API versions '2.67' - '2.latest').
--swap <swap_size> — create and attach a local swap block device of <swap_size> MiB.
--ephemeral size=<size>[,format=<format>] — create and attach a local ephemeral block device of <size> GiB and format it to <format>.
--hint <key=value> — send arbitrary key/value pairs to the scheduler for custom use. Scheduler gossip, iykyk 💅.
--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> — create a NIC on the server. Specify this option multiple times to create multiple nics — unless you're using the special 'auto' or 'none' values. Here's the breakdown, bestie:
- auto: automatically allocate network resources if none are available. This cannot be specified with any other nic value and cannot be specified multiple times.
- none: do not attach a NIC at all. This also cannot be specified with any other nic value and cannot be specified multiple times.
- net-id: attach NIC to the network with a specific UUID.
- net-name: attach NIC to the network with this name (either port-id or net-id or net-name must be provided).
- v4-fixed-ip: IPv4 fixed address for the NIC (optional).
- v6-fixed-ip: IPv6 fixed address for the NIC (optional).
- port-id: attach NIC to the port with this UUID.
- tag: interface metadata tag (optional) (either port-id or net-id must be provided).

(Supported by API versions '2.42' - '2.latest')

--config-drive <value> — enable config drive. The value must be a boolean value.
--poll — report the new server boot progress until it completes 👀. Perfect for the impatient girlies.
--admin-pass <value> — admin password for the instance.
--access-ip-v4 <value> — alternative access IPv4 of the instance.
--access-ip-v6 <value> — alternative access IPv6 of the instance.
--description <description> — description for the server. (Supported by API versions '2.19' - '2.latest')
--tags <tags> — tags for the server. Tags must be separated by commas: --tags <tag1,tag2> (Supported by API versions '2.52' - '2.latest')
--return-reservation-id — return a reservation id bound to created servers.
--trusted-image-certificate-id <trusted-image-certificate-id> — trusted image certificate IDs used to validate certificates during the image signature verification process 🔐. Defaults to env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multiple times to pass multiple trusted image certificate IDs. (Supported by API versions '2.63' - '2.latest')
--host <host> — requested host to create servers. Admin only by default. (Supported by API versions '2.74' - '2.latest')
--hypervisor-hostname <hypervisor-hostname> — requested hypervisor hostname to create servers. Admin only by default. (Supported by API versions '2.74' - '2.latest')
--hostname <hostname> — hostname for the instance. This sets the hostname stored in the metadata server — but lowkey important: a utility such as cloud-init running on the guest is required to propagate these changes to the guest. (Supported by API versions '2.90' - '2.latest')

🌸 nova clear-password 🌸

nova clear-password <server>

Clear the admin password for a server from the metadata server. And no, bestie, this doesn't actually change the instance server password — it just clears it from the metadata server. Important distinction 💅.

Positional arguments:

<server> — name or ID of server.

🎀 nova console-log 🎀

nova console-log [--length <length>] <server>

Get console log output of a server. Bring receipts 📜.

💀 Locale encoding issues 💀

If you encounter an error such as:

UnicodeEncodeError: 'ascii' codec can't encode characters in position

...the solution is different depending on which locale your computer is running in. Annoying, I know 😭.

So for instance, if you have a German Linux machine, you can fix the problem by exporting the locale to de_DE.utf-8:

export LC_ALL=de_DE.utf-8
export LANG=de_DE.utf-8

If you're on a US machine, en_US.utf-8 is the encoding of choice. And on some newer Linux systems, you could also try C.UTF-8 as the locale:

export LC_ALL=C.UTF-8
export LANG=C.UTF-8

Positional arguments:

<server> — name or ID of server.

Optional arguments:

--length <length> — length in lines to tail.

🔥 nova delete 🔥

nova delete [--all-tenants] <server> [<server> ...]

Immediately shut down and delete specified server(s). Like, gone gone. No undo button, no "wait actually" — periodt 💀.

Positional arguments:

<server> — name or ID of server(s).

Optional arguments:

--all-tenants — delete server(s) in another tenant by name (Admin only).

🦋 nova diagnostics 🦋

nova diagnostics <server>

Retrieve server diagnostics. Health check for your server, slay 🩺.

Positional arguments:

<server> — name or ID of server.

🌈 nova evacuate 🌈

nova evacuate [--password <password>] [--on-shared-storage] [--force] <server> [<host>]

Evacuate server from failed host 🚨. Rescue mission energy.

Positional arguments:

<server> — name or ID of server.
<host> — name or ID of the target host. If no host is specified, the scheduler will choose one for you (letting the scheduler pick is honestly the move).

Optional arguments:

--password <password> — set the provided admin password on the evacuated server. Not applicable if the server is on shared storage.
--on-shared-storage — specifies whether server files are located on shared storage. (Supported by API versions '2.0' - '2.13')
--force — force an evacuation by not verifying the provided destination host by the scheduler. (Supported by API versions '2.29' - '2.67')

WARNING: This could result in failures to actually evacuate the server to the specified host. It is recommended to either not specify a host so that the scheduler will pick one, or specify a host without --force. Fr fr, don't do it 🫶.

💜 nova flavor-access-add 💜

nova flavor-access-add <flavor> <tenant_id>

Add flavor access for the given tenant. Sharing is caring 🎁.

Positional arguments:

<flavor> — flavor name or ID to add access for the given tenant.
<tenant_id> — tenant ID to add flavor access for.

⭐ nova flavor-access-list ⭐

nova flavor-access-list [--flavor <flavor>]

Print access information about the given flavor 👑.

--flavor <flavor> — narrows the results down by flavor name or ID ✨

🎀 `nova flavor-access-remove`

usage: nova flavor-access-remove <flavor> <tenant_id>

Bye-bye flavor access for that one tenant 👋 literally revoking it.

Positional arguments:

<flavor> — the flavor name or ID whose access you're removing for the tenant.
<tenant_id> — the tenant ID you're pulling the flavor access from.

🧚 `nova flavor-create`

usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
                          [--rxtx-factor <factor>] [--is-public <is-public>]
                          [--description <description>]
                          <name> <id> <ram> <disk> <vcpus>

Bestie, you're literally building a whole new flavor from scratch. Main character behavior 💅

Positional arguments:

<name> — the unique name of your brand-new flavor.
<id> — the unique ID of the new flavor. If you put 'auto' here it'll generate a UUID for the ID for you, slay.
<ram> — memory size, in MiB.
<disk> — disk size, in GiB.
<vcpus> — number of vcpus.

Optional arguments:

--ephemeral <ephemeral> — ephemeral space size in GiB (default 0).
--swap <swap> — swap space size in MiB (default 0).
--rxtx-factor <factor> — the RX/TX factor (default 1).
--is-public <is-public> — makes the flavor accessible to the public (default true).
--description <description> — a free form description of the flavor. Limited to 65535 characters in length, and only printable characters are allowed. (Supported by API versions '2.55' - '2.latest')

🦋 `nova flavor-delete`

usage: nova flavor-delete <flavor>

Deletes one specific flavor. Gone, periodt 💀

Positional arguments:

<flavor> — the name or ID of the flavor to delete.

🌸 `nova flavor-key`

usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]

Sets or unsets the extra_spec for a flavor — iykyk, it's the flavor's little extras drawer 🎀

Positional arguments:

<flavor> — name or ID of the flavor.
<action> — the action: 'set' or 'unset'.
<key=value> — the extra_specs to set/unset (only the key is necessary on unset).

🌈 `nova flavor-list`

usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
                        [--min-disk <min-disk>] [--min-ram <min-ram>]
                        [--limit <limit>] [--sort-key <sort-key>]
                        [--sort-dir <sort-dir>]

Prints a list of the available 'flavors' (aka sizes of servers). Your whole menu of vibes, lowkey 📋

Optional arguments:

--extra-specs — also grabs the extra-specs of each flavor.
--all — displays all flavors (Admin only). Yeah, admin gate 🙈
--marker <marker> — the last flavor ID of the previous page; shows you the list of flavors after "marker".
--min-disk <min-disk> — filters the flavors by a minimum disk space, in GiB.
--min-ram <min-ram> — filters the flavors by a minimum RAM, in MiB.
--limit <limit> — maximum number of flavors to display. If limit is bigger than the 'CONF.api.max_limit' option of Nova API, that 'CONF.api.max_limit' limit gets used instead. The cap stays capping 🧢
--sort-key <sort-key> — the flavors list sort key.
--sort-dir <sort-dir> — the flavors list sort direction.

⭐ `nova flavor-show`

usage: nova flavor-show <flavor>

Shows you all the deets about the flavor you picked. It's giving full profile reveal ✨

Positional arguments:

<flavor> — name or ID of the flavor.

💜 `nova flavor-update`

usage: nova flavor-update <flavor> <description>

Updates the description on an existing flavor. (Supported by API versions '2.55' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

New in version 10.0.0.

Positional arguments

<flavor> — name or ID of the flavor to update.
<description> — a free form description of the flavor. Limited to 65535 characters in length, and only printable characters are allowed.

🔥 `nova force-delete`

usage: nova force-delete <server>

Force deletes a server. No gentle goodbyes, just yeet 💀

Positional arguments:

<server> — name or ID of server.

🫶 `nova get-mks-console`

usage: nova get-mks-console <server>

Gets you an MKS console to a server. (Supported by API versions '2.8' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

New in version 3.0.0.

Positional arguments:

<server> — name or ID of server.

🍓 `nova get-password`

usage: nova get-password <server> [<private-key>]

Gets the admin password for a server. Heads up bestie, this operation calls the metadata service to query metadata info — it does not read password information from the server itself 👀

Positional arguments:

<server> — name or ID of server.
<private-key> — private key (used locally to decrypt the password) (Optional). When you specify it, the command displays the clear (decrypted) VM password. When you don't, the ciphered VM password is what you get.

🎀 `nova get-rdp-console`

usage: nova get-rdp-console <server> <console-type>

Gets you an rdp console to a server.

Positional arguments:

<server> — name or ID of server.
<console-type> — type of rdp console ("rdp-html5").

🧚 `nova get-serial-console`

usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>

Gets you a serial console to a server.

Positional arguments:

<server> — name or ID of server.

Optional arguments:

--console-type CONSOLE_TYPE — type of serial console, default="serial".

🦋 `nova get-spice-console`

usage: nova get-spice-console <server> <console-type>

Gets you a spice console to a server.

Positional arguments:

<server> — name or ID of server.
<console-type> — type of spice console ("spice-html5").

🌸 `nova get-vnc-console`

usage: nova get-vnc-console <server> <console-type>

Gets you a vnc console to a server.

Positional arguments:

<server> — name or ID of server.
<console-type> — type of vnc console ("novnc" or "xvpvnc").

👑 `nova host-evacuate`

usage: nova host-evacuate [--target_host <target_host>] [--force] [--strict]
                          <host>

Evacuates all the instances off a failed host. Everybody out, immediately 🏃‍♀️💨

Positional arguments:

<host> — the hypervisor hostname (or pattern) to search for.

⚠️ WARNING: use a fully qualified domain name if you only want to evacuate from a specific host.

Optional arguments:

--target_host <target_host> — name of the target host. If no host is specified, the scheduler will select a target.
--force — forces an evacuation by not verifying the provided destination host by the scheduler. (Supported by API versions '2.29' - '2.67')

⚠️ WARNING: this could result in failures to actually evacuate the server to the specified host. It is recommended to either not specify a host so that the scheduler will pick one, or specify a host without --force.

--strict — evacuates the host with an exact hypervisor hostname match.

💅 `nova host-evacuate-live`

usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
                               [--max-servers <max_servers>] [--force]
                               [--strict]
                               <host>

Live migrates all the instances off the specified host onto other available hosts. No downtime energy ✨

Positional arguments:

<host> — name of host. The hypervisor hostname (or pattern) to search for.

⚠️ WARNING: use a fully qualified domain name if you only want to live migrate from a specific host.

Optional arguments:

--target-host <target_host> — name of target host. If no host is specified, the scheduler will choose one.
--block-migrate — enables block migration. (Default=auto) (Supported by API versions '2.25' - '2.latest')
--max-servers <max_servers> — maximum number of servers to live migrate simultaneously.
--force — forces a live-migration by not verifying the provided destination host by the scheduler. (Supported by API versions '2.30' - '2.67')

⚠️ WARNING: this could result in failures to actually live migrate the servers to the specified host. It is recommended to either not specify a host so that the scheduler will pick one, or specify a host without --force.

--strict — live evacuates the host with an exact hypervisor hostname match.

🎀 `nova host-meta`

usage: nova host-meta [--strict] <host> <action> <key=value> [<key=value> ...]

Sets or deletes metadata on all the instances of a host. Every single one, bestie 🫶

Positional arguments:

<host> — the hypervisor hostname (or pattern) to search for.

⚠️ WARNING: use a fully qualified domain name if you only want to update metadata for servers on a specific host.

<action> — the actions: 'set' or 'delete'.
<key=value> — the metadata to set or delete (only the key is necessary on delete).

Optional arguments:

--strict — sets host-meta to the hypervisor with an exact hostname match.

🌈 `nova host-servers-migrate`

usage: nova host-servers-migrate [--strict] <host>

Cold migrates all the instances off the specified host onto other available hosts. Chill migration, no live drama 🧊

Positional arguments:

<host> — name of host. The hypervisor hostname (or pattern) to search for.

⚠️ WARNING: use a fully qualified domain name if you only want to cold migrate from a specific host.

Optional arguments:

--strict — migrates the host with an exact hypervisor hostname match.

⭐ `nova hypervisor-list`

usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
                            [--limit <limit>]

Lists hypervisors. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Optional arguments:

--matching <hostname> — lists hypervisors matching the given <hostname>. If matching is used, the limit and marker options will be ignored.
--marker <marker> — the last hypervisor of the previous page; shows the list of hypervisors after "marker". (Supported by API versions '2.33' - '2.latest')
--limit <limit> — maximum number of hypervisors to display. If limit is bigger than the 'CONF.api.max_limit' option of Nova API, that 'CONF.api.max_limit' limit gets used instead. (Supported by API versions '2.33' - '2.latest')

🦋 `nova hypervisor-servers`

usage: nova hypervisor-servers <hostname>

Lists the servers that belong to specific hypervisors. Who lives where, basically 🏠

Positional arguments:

<hostname> — the hypervisor hostname (or pattern) to search for.

🌸 `nova hypervisor-show` 🌸

usage: nova hypervisor-show [--wrap <integer>] <hypervisor>

Okay so this one shows you all the deets of one specific hypervisor. Like the full profile page, bestie 💅

Positional arguments:

<hypervisor> — Name or ID of the hypervisor. Heads up tho: starting with microversion 2.53 the ID must be a UUID. no cap, they tightened that up ✨

Optional arguments:

--wrap <integer> — Wrap the output to a specified length. Default is 40, or 0 to disable. (So if the output is giving long unbroken lines, you know what to do 🎀)

🦋 `nova hypervisor-stats` 🦋

usage: nova hypervisor-stats

Gets hypervisor statistics across all the compute nodes. Global vibes only, no positional args needed. Slay, zero effort 🫶

⭐ `nova hypervisor-uptime` ⭐

usage: nova hypervisor-uptime <hypervisor>

Displays the uptime of the specified hypervisor. Like "how long has this thing been awake" energy 😭

Positional arguments:

<hypervisor> — Name or ID of the hypervisor. Starting with microversion 2.53 the ID must be a UUID. Same rule, every time 💅

🎀 `nova image-create` 🎀

usage: nova image-create [--metadata <key=value>] [--show] [--poll]
                         <server> <name>

Creates a brand new image by taking a snapshot of a running server. It's giving "photoshoot but for your instance" 📸

Positional arguments:

<server> — Name or ID of server.
<name> — Name of snapshot.

Optional arguments:

--metadata <key=value> — Record arbitrary key/value metadata to /meta_data.json on the metadata server. Can be specified multiple times. (Yes, stack 'em up 🍓)
--show — Print image info.
--poll — Report the snapshot progress and poll until image creation is complete. (Impatient bestie mode: it'll keep you posted until it's done ✨)

💜 `nova instance-action` 💜

usage: nova instance-action <server> <request_id>

Shows one single action. Just the one. Curated. 👑

Positional arguments:

<server> — Name or UUID of the server to show actions for. Only UUID can be used to show actions for a deleted server. (Supported by API versions '2.21' - '2.latest')
<request_id> — Request ID of the action to get.

🌈 `nova instance-action-list` 🌈

usage: nova instance-action-list [--marker <marker>] [--limit <limit>]
                                 [--changes-since <changes_since>]
                                 [--changes-before <changes_before>]
                                 <server>

Lists all the actions on a server. The whole lore drop, fr fr 📜

Positional arguments:

<server> — Name or UUID of the server to list actions for. Only UUID can be used to list actions on a deleted server. (Supported by API versions '2.21' - '2.latest')

Optional arguments:

--marker <marker> — The last instance action of the previous page; displays list of actions after "marker". (Supported by API versions '2.58' - '2.latest')
--limit <limit> — Maximum number of instance actions to display. Note that there is a configurable max limit on the server, and the limit that is used will be the minimum of what is requested here and what is configured in the server. (Supported by API versions '2.58' - '2.latest') — so you can ask for a million but the server's lowkey gonna cap you 🙈
--changes-since <changes_since> — List only instance actions changed later or equal to a certain point of time. The provided time should be an ISO 8061 formatted time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions '2.58' - '2.latest')
--changes-before <changes_before> — List only instance actions changed earlier or equal to a certain point of time. The provided time should be an ISO 8061 formatted time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions '2.66' - '2.latest')

🧚 `nova instance-usage-audit-log` 🧚

usage: nova instance-usage-audit-log [--before <before>]

List/Get server usage audits. Receipts, basically 🧾

Optional arguments:

--before <before> — Filters the response by the date and time before which to list usage audits. The date and time stamp format is as follows: CCYY-MM-DD hh:mm:ss.NNNNNN ex 2015-08-27 09:49:58 or 2015-08-27 09:49:58.123456. Get the format exactly right or it's not gonna slay 😤

🔥 `nova interface-attach` 🔥

usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
                             [--fixed-ip <fixed_ip>] [--tag <tag>]
                             <server>

Attaches a network interface to a server. Plug it in, plug it in 🔌

Positional arguments:

<server> — Name or ID of server.

Optional arguments:

--port-id <port_id> — Port ID.
--net-id <net_id> — Network ID
--fixed-ip <fixed_ip> — Requested fixed IP.
--tag <tag> — Tag for the attached interface. (Supported by API versions '2.49' - '2.latest')

💀 `nova interface-detach` 💀

usage: nova interface-detach <server> <port_id>

Detaches a network interface from a server. Unplug. Bye bestie 👋

Positional arguments:

<server> — Name or ID of server.
<port_id> — Port ID.

🌸 `nova interface-list` 🌸

usage: nova interface-list <server>

Lists the interfaces attached to a server. Roll call 🎀

Positional arguments:

<server> — Name or ID of server.

👑 `nova keypair-add` 👑

usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
                        [--user <user-id>]
                        <name>

Creates a new key pair for use with servers. Keys = access, and access is main character energy 🔑

Positional arguments:

<name> — Name of key.

Optional arguments:

--pub-key <pub-key> — Path to a public ssh key.
--key-type <key-type> — Keypair type. Can be ssh or x509. (Supported by API versions '2.2' - '2.latest')
--user <user-id> — ID of user to whom to add key-pair (Admin only). (Supported by API versions '2.10' - '2.latest')

🦋 `nova keypair-delete` 🦋

usage: nova keypair-delete [--user <user-id>] <name>

Deletes the keypair given by its name. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Gone. Deleted. Not me being dramatic, that's literally what it does 💀

Positional arguments:

<name> — Keypair name to delete.

Optional arguments:

--user <user-id> — ID of key-pair owner (Admin only).

✨ `nova keypair-list` ✨

usage: nova keypair-list [--user <user-id>] [--marker <marker>]
                         [--limit <limit>]

Prints a list of keypairs for a user (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Optional arguments:

--user <user-id> — List key-pairs of specified user ID (Admin only).
--marker <marker> — The last keypair of the previous page; displays list of keypairs after "marker".
--limit <limit> — Maximum number of keypairs to display. If limit is bigger than 'CONF.api.max_limit' option of Nova API, limit 'CONF.api.max_limit' will be used instead. (Yep, the server wins that argument 🫠)

🍓 `nova keypair-show` 🍓

usage: nova keypair-show [--user <user-id>] <keypair>

Shows details about the given keypair. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments:

<keypair> — Name of keypair.

Optional arguments:

--user <user-id> — ID of key-pair owner (Admin only).

💅 `nova limits` 💅

usage: nova limits [--tenant [<tenant>]] [--reserved]

Prints rate and absolute limits. The "know your ceiling" command 🚧

Optional arguments:

--tenant [<tenant>] — Display information from single tenant (Admin only).
--reserved — Include reservations count.

🌈 `nova list` 🌈

usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>]
                 [--ip6 <ip6-regexp>] [--name <name-regexp>]
                 [--status <status>] [--flavor <flavor>] [--image <image>]
                 [--host <hostname>] [--all-tenants [<0|1>]]
                 [--tenant [<tenant>]] [--user [<user>]] [--deleted]
                 [--fields <fields>] [--minimal]
                 [--sort <key>[:<direction>]] [--marker <marker>]
                 [--limit <limit>] [--availability-zone <availability_zone>]
                 [--key-name <key_name>] [--[no-]config-drive]
                 [--progress <progress>] [--vm-state <vm_state>]
                 [--task-state <task_state>] [--power-state <power_state>]
                 [--changes-since <changes_since>]
                 [--changes-before <changes_before>]
                 [--tags <tags>] [--tags-any <tags-any>]
                 [--not-tags <not-tags>] [--not-tags-any <not-tags-any>]
                 [--locked]

Lists servers. The big one. The main event. The whole group chat roster 📋✨

Ngl, important note: from microversion 2.69, during partial infrastructure failures in the deployment, the output of this command may return partial results for the servers present in the failure domain. So if the list looks sus and short, that might be why 😭

Optional arguments:

--reservation-id <reservation-id> — Only return servers that match reservation-id.
--ip <ip-regexp> — Search with regular expression match by IP address.
--ip6 <ip6-regexp> — Search with regular expression match by IPv6 address.
--name <name-regexp> — Search with regular expression match by name.
--status <status> — Search by server status.
--flavor <flavor> — Search by flavor name or ID.
--image <image> — Search by image name or ID.
--host <hostname> — Search servers by hostname to which they are assigned (Admin only).
--all-tenants [<0|1>] — Display information from all tenants (Admin only).
--tenant [<tenant>] — Display information from single tenant (Admin only).
--user [<user>] — Display information from single user (Admin only until microversion 2.82).
--deleted — Only display deleted servers (Admin only).
--fields <fields> — Comma-separated list of fields to display. Use the show command to see which fields are available.
--minimal — Get only UUID and name. Bare minimum, honestly kinda iconic 🎀
--sort <key>[:<direction>] — Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. The direction defaults to descending if not specified.
--marker <marker> — The last server UUID of the previous page; displays list of servers after "marker".
--limit <limit> — Maximum number of servers to display. If limit == -1, all servers will be displayed. If limit is bigger than 'CONF.api.max_limit' option of Nova API, limit 'CONF.api.max_limit' will be used instead.
--availability-zone <availability_zone> — Display servers based on their availability zone (Admin only until microversion 2.82).
--key-name <key_name> — Display servers based on their keypair name (Admin only until microversion 2.82).
--config-drive — Display servers that have a config drive attached. It is mutually exclusive with '--no-config-drive'. (Admin only until microversion 2.82).
--no-config-drive — shows you only the servers with no config drive attached. It's mutually exclusive with --config-drive, so pick a lane bestie, you can't have both 💅 (Admin only until microversion 2.82).
--progress <progress> — filters servers by their progress value. (Admin only until microversion 2.82).
--vm-state <vm_state> — filters servers by their vm_state value. (Admin only until microversion 2.82).
--task-state <task_state> — filters servers by their task_state value. (Admin only until microversion 2.82).
--power-state <power_state> — filters servers by their power_state value. (Admin only until microversion 2.82).
--changes-since <changes_since> — lists only servers that changed later than or equal to a certain point in time. That time has to be an ISO 8061 formatted time, e.g. 2016-03-04T06:27:59Z ✨
--changes-before <changes_before> — the flip side: only servers that changed earlier than or equal to a given point in time. Also an ISO 8061 formatted time, e.g. 2016-03-05T06:27:59Z. (Supported by API versions 2.66 - 2.latest)
--tags <tags> — every single tag you hand over must be present for a server to make the list. The boolean energy here is literally t1 AND t2. Separate your tags with commas: --tags <tag1,tag2>. (Supported by API versions 2.26 - 2.latest)
--tags-any <tags-any> — if just one of the given tags is present, that server gets included. Boolean expression: t1 OR t2. Commas between tags: --tags-any <tag1,tag2>. (Supported by API versions 2.26 - 2.latest)
--not-tags <not-tags> — only the servers that have none of the given tags show up. Boolean expression: NOT(t1 AND t2). Commas, again: --not-tags <tag1,tag2>. (Supported by API versions 2.26 - 2.latest)
--not-tags-any <not-tags-any> — only servers that don't have at least one of the given tags make the cut. Boolean expression: NOT(t1 OR t2). You know the drill, commas: --not-tags-any <tag1,tag2>. (Supported by API versions 2.26 - 2.latest)
--locked <locked> — filters servers by their locked value. You must give it a value, no vibes-only mode: eg. true lists only locked servers and false lists only unlocked ones. (Supported by API versions 2.73 - 2.latest)

💖 `nova list-secgroup` 💖

usage: nova list-secgroup <server>

Lists the Security Group(s) of a server. like, who's in the group chat 🫶

Positional arguments

<server> — Name or ID of server.

🦋 `nova live-migration` 🦋

usage: nova live-migration [--block-migrate] [--force] <server> [<host>]

Scoots a running server over to a new machine. no downtime era ✨

Positional arguments

<server> — Name or ID of server.
<host> — Destination host name. If you don't specify a host, the scheduler will choose one for you (it's giving delegating, and honestly? iconic).

Optional arguments

--block-migrate — True in case of block_migration. (Default=auto:live_migration) (Supported by API versions 2.25 - 2.latest)
--force — forces the live-migration by not verifying the provided destination host with the scheduler. (Supported by API versions 2.30 - 2.67)

⚠️ WARNING: this could result in failures to actually live migrate the server to the specified host. It is recommended to either not specify a host so that the scheduler will pick one, or specify a host without --force. like, the safe route exists for a reason bestie 😭

🌸 `nova live-migration-abort` 🌸

usage: nova live-migration-abort <server> <migration>

Aborts an on-going live migration. (Supported by API versions 2.24 - 2.latest) [hint: use --os-compute-api-version flag to show help message for proper version]

For microversions from 2.24 to 2.64 the migration status must be running; for microversion 2.65 and greater, the migration status can also be queued and preparing.

New in version 3.3.0.

Positional arguments

<server> — Name or ID of server.
<migration> — ID of migration.

🎀 `nova live-migration-force-complete` 🎀

usage: nova live-migration-force-complete <server> <migration>

Forces an on-going live migration to complete. (Supported by API versions 2.22 - 2.latest) [hint: use --os-compute-api-version flag to show help message for proper version]

New in version 3.3.0.

Positional arguments

<server> — Name or ID of server.
<migration> — ID of migration.

💜 `nova lock` 💜

usage: nova lock [--reason <reason>] <server>

Locks a server. A normal (non-admin) user will not be able to execute actions on a locked server. it's giving "you're on read-only" energy 🙈

Positional arguments

<server> — Name or ID of server.

Optional arguments

--reason <reason> — Reason for locking the server. (Supported by API versions 2.73 - 2.latest)

🍓 `nova meta` 🍓

usage: nova meta <server> <action> <key=value> [<key=value> ...]

Sets or deletes metadata on a server.

Positional arguments

<server> — Name or ID of server.
<action> — Actions: set or delete.
<key=value> — Metadata to set or delete (only key is necessary on delete).

☁️ `nova migrate` ☁️

usage: nova migrate [--host <host>] [--poll] <server>

Migrates a server. The new host will be selected by the scheduler.

Positional arguments

<server> — Name or ID of server.

Optional arguments

--host <host> — Destination host name. (Supported by API versions 2.56 - 2.latest)
--poll — reports the server migration progress until it completes. sit there and watch it cook 🔥

🌈 `nova migration-list` 🌈

usage: nova migration-list [--instance-uuid <instance_uuid>]
                           [--host <host>]
                           [--status <status>]
                           [--migration-type <migration_type>]
                           [--source-compute <source_compute>]
                           [--marker <marker>]
                           [--limit <limit>]
                           [--changes-since <changes_since>]
                           [--changes-before <changes_before>]
                           [--project-id <project_id>]
                           [--user-id <user_id>]

Prints a list of migrations. the receipts of where everything's been 👑

Examples

To see the list of evacuation operations from a compute service host:

nova migration-list --migration-type evacuation --source-compute host.foo.bar

Optional arguments

--instance-uuid <instance_uuid> — fetches migrations for the given instance.
--host <host> — fetches migrations for the given source or destination host.
--status <status> — fetches migrations for the given status.
--migration-type <migration_type> — filters migrations by type. Valid values are:
- evacuation
- live-migration
- migration

NOTE: this is a cold migration.

resize

--source-compute <source_compute> — filters migrations by source compute host name.
--marker <marker> — the last migration of the previous page; displays the list of migrations after `marker`. Note that the marker is the migration UUID. (Supported by API versions 2.59 - 2.latest)
--limit <limit> — maximum number of migrations to display. Note that there is a configurable max limit on the server, and the limit that's used will be the minimum of what you request here and what's configured in the server. (Supported by API versions 2.59 - 2.latest)
--changes-since <changes_since> — lists only migrations changed later than or equal to a certain point in time. The provided time should be an ISO 8061 formatted time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions 2.59 - 2.latest)
--changes-before <changes_before> — lists only migrations changed earlier than or equal to a certain point in time. The provided time should be an ISO 8061 formatted time. e.g. 2016-03-04T06:27:59Z. (Supported by API versions 2.66 - 2.latest)
--project-id <project_id> — filters the migrations by the given project ID. (Supported by API versions 2.80 - 2.latest)
--user-id <user_id> — filters the migrations by the given user ID. (Supported by API versions 2.80 - 2.latest)

🧚 `nova pause` 🧚

usage: nova pause <server>

Pauses a server. it's not gone, it's just resting ✨

Positional arguments

<server> — Name or ID of server.

👑 `nova quota-class-show` 👑

usage: nova quota-class-show <class>

Lists the quotas for a quota class.

Positional arguments

<class> — Name of quota class to list the quotas for.

💀 `nova quota-class-update` 💀

usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
                               [--ram <ram>]
                               [--metadata-items <metadata-items>]
                               [--key-pairs <key-pairs>]
                               [--server-groups <server-groups>]
                               [--server-group-members <server-group-members>]
                               <class>

Updates the quotas for a quota class. (Supported by API versions 2.0 - 2.latest) [hint: use --os-compute-api-version flag to show help message for proper version]

Positional arguments

<class> — Name of quota class to set the quotas for.

Optional arguments

--instances <instances> — new value for the "instances" quota.
--cores <cores> — new value for the "cores" quota.
--ram <ram> — new value for the "ram" quota.
--metadata-items <metadata-items> — new value for the "metadata-items" quota.
--key-pairs <key-pairs> — new value for the "key-pairs" quota.
--server-groups <server-groups> — new value for the "server-groups" quota.
--server-group-members <server-group-members> — new value for the "server-group-members" quota.

⭐ `nova quota-defaults` ⭐

usage: nova quota-defaults [--tenant <tenant-id>]

Lists the default quotas for a tenant. the factory settings, basically 🎀

Optional arguments

--tenant <tenant-id> — ID of tenant to list the default quotas for.

🫶 `nova quota-delete` 🫶

usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]

Deletes quota for a tenant/user so their quota will revert back to default. yes, it's a reset, and yes, that capital R "Revert" is canon 😌

Optional arguments

--tenant <tenant-id> — ID of tenant to delete quota for. 🗑️
--user <user-id> — ID of user to delete quota for. 🗑️

💖 `nova quota-show`

usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]

Lists the quotas for a tenant/user — like a lil receipt for your limits, bestie. 🧾✨

🎀 Optional arguments

--tenant <tenant-id> — ID of tenant to list the quotas for.
--user <user-id> — ID of user to list the quotas for.
--detail — Show detailed info (limit, reserved, in-use). 💅

🌸 `nova quota-update`

usage: nova quota-update [--user <user-id>] [--instances <instances>]
                         [--cores <cores>] [--ram <ram>]
                         [--metadata-items <metadata-items>]
                         [--key-pairs <key-pairs>]
                         [--server-groups <server-groups>]
                         [--server-group-members <server-group-members>]
                         [--force]
                         <tenant-id>

Updates the quotas for a tenant/user. Supported by API versions '2.0' - '2.latest' — and fr fr, if you need the version-specific help, the hint is right here:

[hint: use '--os-compute-api-version' flag to show help message for proper version]

📌 Positional arguments

<tenant-id> — ID of tenant to set the quotas for.

🎀 Optional arguments

--user <user-id> — ID of user to set the quotas for.
--instances <instances> — New value for the "instances" quota.
--cores <cores> — New value for the "cores" quota.
--ram <ram> — New value for the "ram" quota.
--metadata-items <metadata-items> — New value for the "metadata-items" quota.
--key-pairs <key-pairs> — New value for the "key-pairs" quota.
--server-groups <server-groups> — New value for the "server-groups" quota.
--server-group-members <server-group-members> — New value for the "server-group-members" quota.
--force — Whether force update the quota even if the already used and reserved exceeds the new quota. 😤

🔁 `nova reboot`

usage: nova reboot [--hard] [--poll] <server> [<server> ...]

Reboots a server. Like hitting restart on your fave game, but make it cloud. 🎮✨

📌 Positional arguments

<server> — Name or ID of server(s).

🎀 Optional arguments

--hard — Perform a hard reboot (instead of a soft one). Note: Ironic does not currently support soft reboot; consequently, bare metal nodes will always do a hard reboot, regardless of the use of this option. 💀
--poll — Poll until reboot is complete. ⏳

🦋 `nova rebuild`

usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
                    [--minimal] [--preserve-ephemeral] [--name <name>]
                    [--description <description>] [--meta <key=value>]
                    [--key-name <key-name>] [--key-unset]
                    [--user-data <user-data>] [--user-data-unset]
                    [--trusted-image-certificate-id <trusted-image-certificate-id>]
                    [--trusted-image-certificates-unset]
                    [--hostname <hostname>]
                    <server> <image>

Shutdown, re-image, and re-boot a server — the full glow-up pipeline, no cap. 💅🔥

📌 Positional arguments

<server> — Name or ID of server.
<image> — Name or ID of new image.

🎀 Optional arguments

--rebuild-password <rebuild-password> — Set the provided admin password on the rebuilt server. 🔐
--poll — Report the server rebuild progress until it completes. ⏳
--minimal — Skips flavor/image lookups when showing servers. 🧚
--preserve-ephemeral — Preserve the default ephemeral storage partition on rebuild. 💾
--name <name> — Name for the new server. ✨
--description <description> — New description for the server. (Supported by API versions '2.19' - '2.latest')
--meta <key=value> — Record arbitrary key/value metadata to /meta_data.json on the metadata server. Can be specified multiple times. 🏷️
--key-name <key-name> — Keypair name to set in the server. Cannot be specified with the '--key-unset' option. (Supported by API versions '2.54' - '2.latest')
--key-unset — Unset keypair in the server. Cannot be specified with the '--key-name' option. (Supported by API versions '2.54' - '2.latest')
--user-data <user-data> — User data file to pass to be exposed by the metadata server. (Supported by API versions '2.57' - '2.latest')
--user-data-unset — Unset user_data in the server. Cannot be specified with the '--user-data' option. (Supported by API versions '2.57' - '2.latest')
--trusted-image-certificate-id <trusted-image-certificate-id> — Trusted image certificate IDs used to validate certificates during the image signature verification process. Defaults to env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multiple times to pass multiple trusted image certificate IDs. (Supported by API versions '2.63' - '2.latest')
--trusted-image-certificates-unset — Unset trusted_image_certificates in the server. Cannot be specified with the --trusted-image-certificate-id option. (Supported by API versions '2.63' - '2.latest')
--hostname <hostname> — New hostname for the instance. This only updates the hostname stored in the metadata server: a utility running on the guest is required to propagate these changes to the guest. (Supported by API versions '2.90' - '2.latest')

🌈 `nova refresh-network`

usage: nova refresh-network <server>

Refresh server network information. It’s giving “clear the cache and try again.” 🧼✨

📌 Positional arguments

<server> — Name or ID of a server for which the network cache should be refreshed from neutron (Admin only).

🎀 `nova remove-secgroup`

usage: nova remove-secgroup <server> <secgroup>

Remove a Security Group from a server. Bye-bye, secgroup bestie. 👋💜

📌 Positional arguments

<server> — Name or ID of server.
<secgroup> — Name of Security Group.

🧚 `nova rescue`

usage: nova rescue [--password <password>] [--image <image>] <server>

Reboots a server into rescue mode, which starts the machine from either the initial image or a specified image, attaching the current boot disk as secondary. It’s the Unix equivalent of a rescue mission, lowkey iconic. 🚑✨

📌 Positional arguments

<server> — Name or ID of server.

🎀 Optional arguments

--password <password> — The admin password to be set in the rescue environment. 🔐
--image <image> — The image to rescue with. 🖼️

🌀 `nova reset-network`

usage: nova reset-network <server>

Reset network of a server. Networking said “new phone, who dis?” 📱💀

📌 Positional arguments

<server> — Name or ID of server.

⭐ `nova reset-state`

usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]

Reset the state of a server. Sometimes your server is just in its feelings and needs a vibe reset. 😭✨

📌 Positional arguments

<server> — Name or ID of server(s).

🎀 Optional arguments

--all-tenants — Reset state server(s) in another tenant by name (Admin only). 👑
--active — Request the server be reset to "active" state instead of "error" state (the default). 💖

🦋 `nova resize`

usage: nova resize [--poll] <server> <flavor>

Resize a server. It’s the “new year, new me” of compute. 💅✨

📌 Positional arguments

<server> — Name or ID of server.
<flavor> — Name or ID of new flavor.

🎀 Optional arguments

--poll — Report the server resize progress until it completes. ⏳

✅ `nova resize-confirm`

usage: nova resize-confirm <server>

Confirm a previous resize. Lock it in, bestie. 🔒💖

📌 Positional arguments

<server> — Name or ID of server.

↩️ `nova resize-revert`

usage: nova resize-revert <server>

Revert a previous resize (and return to the previous VM). Ctrl+Z energy, but make it cloud. 😭🫶

📌 Positional arguments

<server> — Name or ID of server.

🌸 `nova restore`

usage: nova restore <server>

Restore a soft-deleted server. Not me bringing you back from the deleted folder. 🙈💜

📌 Positional arguments

<server> — Name or ID of server.

▶️ `nova resume`

usage: nova resume <server>

Resume a server. Wake up, sleepy icon. ⏰✨

📌 Positional arguments

<server> — Name or ID of server.

👑 `nova server-group-create`

usage: nova server-group-create [--rules <key=value>] <name> <policy>

Create a new server group with the specified details. Squad goals, but for compute. 🫶✨

📌 Positional arguments

<name> — Server group name.
<policy> — Policy for the server groups.

🎀 Optional arguments

--rule — Policy rules for the server groups. (Supported by API versions '2.64' - '2.latest'）. Currently, only the max_server_per_host rule is supported for the anti-affinity policy. The max_server_per_host rule allows specifying how many members of the anti-affinity group can reside on the same compute host. If not specified, only one member from the same anti-affinity group can reside on a given host. 💅

🗑️ `nova server-group-delete`

usage: nova server-group-delete <id> [<id> ...]

Delete specific server group(s). It’s giving cleanup era. 🧹✨

📌 Positional arguments

<id> — Unique ID(s) of the server group to delete.

🔍 `nova server-group-get`

usage: nova server-group-get <id>

Get a specific server group. Stalk the group, but consensually. 👀💖

📌 Positional arguments

<id> — Unique ID of the server group to get.

📋 `nova server-group-list`

usage: nova server-group-list [--limit <limit>] [--offset <offset>]
                              [--all-projects]

Print a list of all server groups. A whole lineup of squads. 🌈✨

🎀 Optional arguments

--limit <limit> — Maximum number of server groups to display. If limit is bigger than 'CONF.api.max_limit' option of Nova API, limit 'CONF.api.max_limit' will be used instead. 🛑
--offset <offset> — The offset of groups list to display; use with limit to return a slice of server groups. 🍰
--all-projects — Display server groups from all projects (Admin only). 👑

🚚 `nova server-migration-list`

usage: nova server-migration-list <server>

Get the migrations list of specified server. Supported by API versions '2.23' - '2.latest' — and yes, the hint applies here too:

[hint: use '--os-compute-api-version' flag to show help message for proper version]

New in version 3.3.0. 🆕

📌 Positional arguments

<server> — Name or ID of server.

🛰️ `nova server-migration-show`

usage: nova server-migration-show <server> <migration>

Get the migration of specified server. Supported by API versions '2.23' - '2.latest' — same hint, same energy:

[hint: use '--os-compute-api-version' flag to show help message for proper version]

New in version 3.3.0. 🆕

📌 Positional arguments

<server> — Name or ID of server.
<migration> — ID of migration.

🏷️ `nova server-tag-add`

usage: nova server-tag-add <server> <tag> [<tag> ...]

Add one or more tags to a server — yes, plural, it’s giving sticker-pack energy. (Supported by API versions '2.26' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]