4205 lines
80 KiB
ReStructuredText
4205 lines
80 KiB
ReStructuredText
.. ## WARNING #####################################
|
|
.. This file is tool-generated. Do not edit manually.
|
|
.. ##################################################
|
|
|
|
==========================================
|
|
Compute service (nova) command-line client
|
|
==========================================
|
|
|
|
The nova client is the command-line interface (CLI) for
|
|
the Compute service (nova) API and its extensions.
|
|
|
|
This chapter documents :command:`nova` version ``6.0.0``.
|
|
|
|
For help on a specific :command:`nova` command, enter:
|
|
|
|
.. code-block:: console
|
|
|
|
$ nova help COMMAND
|
|
|
|
.. _nova_command_usage:
|
|
|
|
nova usage
|
|
~~~~~~~~~~
|
|
|
|
.. code-block:: console
|
|
|
|
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>]
|
|
[--bypass-url <bypass-url>] [--insecure]
|
|
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
|
|
[--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>]
|
|
[--os-auth-url OS_AUTH_URL] [--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:**
|
|
|
|
``absolute-limits``
|
|
**DEPRECATED**, use limits instead.
|
|
|
|
``add-fixed-ip``
|
|
Add new IP address on a network to server.
|
|
|
|
``add-floating-ip``
|
|
**DEPRECATED**, use floating-ip-associate instead.
|
|
|
|
``add-secgroup``
|
|
Add a Security Group to a server.
|
|
|
|
``agent-create``
|
|
Create new agent build.
|
|
|
|
``agent-delete``
|
|
Delete existing agent build.
|
|
|
|
``agent-list``
|
|
List all builds.
|
|
|
|
``agent-modify``
|
|
Modify existing agent build.
|
|
|
|
``aggregate-add-host``
|
|
Add the host to the specified aggregate.
|
|
|
|
``aggregate-create``
|
|
Create a new aggregate with the specified
|
|
details.
|
|
|
|
``aggregate-delete``
|
|
Delete the aggregate.
|
|
|
|
``aggregate-details``
|
|
**DEPRECATED**, use aggregate-show instead.
|
|
|
|
``aggregate-list``
|
|
Print a list of all aggregates.
|
|
|
|
``aggregate-remove-host``
|
|
Remove the specified host from the specified
|
|
aggregate.
|
|
|
|
``aggregate-set-metadata``
|
|
Update the metadata associated with the
|
|
aggregate.
|
|
|
|
``aggregate-show``
|
|
Show details of the specified aggregate.
|
|
|
|
``aggregate-update``
|
|
Update the aggregate's name and optionally
|
|
availability zone.
|
|
|
|
``availability-zone-list``
|
|
List all the availability zones.
|
|
|
|
``backup``
|
|
Backup a server by creating a 'backup' type
|
|
snapshot.
|
|
|
|
``boot``
|
|
Boot a new server.
|
|
|
|
``clear-password``
|
|
Clear the admin password for a server from the
|
|
metadata server. This action does not actually
|
|
change the instance server password.
|
|
|
|
``cloudpipe-configure``
|
|
Update the VPN IP/port of a cloudpipe
|
|
instance.
|
|
|
|
``cloudpipe-create``
|
|
Create a cloudpipe instance for the given
|
|
project.
|
|
|
|
``cloudpipe-list``
|
|
Print a list of all cloudpipe instances.
|
|
|
|
``console-log``
|
|
Get console log output of a server.
|
|
|
|
``credentials``
|
|
Show user credentials returned from auth.
|
|
|
|
``delete``
|
|
Immediately shut down and delete specified
|
|
server(s).
|
|
|
|
``diagnostics``
|
|
Retrieve server diagnostics.
|
|
|
|
``dns-create``
|
|
**DEPRECATED**: Create a DNS entry for domain,
|
|
name, and IP.
|
|
|
|
``dns-create-private-domain``
|
|
**DEPRECATED**: Create the specified DNS domain.
|
|
|
|
``dns-create-public-domain``
|
|
**DEPRECATED**: Create the specified DNS domain.
|
|
|
|
``dns-delete``
|
|
**DEPRECATED**: Delete the specified DNS entry.
|
|
|
|
``dns-delete-domain``
|
|
**DEPRECATED**: Delete the specified DNS domain.
|
|
|
|
``dns-domains``
|
|
**DEPRECATED**: Print a list of available dns
|
|
domains.
|
|
|
|
``dns-list``
|
|
**DEPRECATED**: List current DNS entries for
|
|
domain and IP or domain and name.
|
|
|
|
``endpoints``
|
|
Discover endpoints that get returned from the
|
|
authenticate services.
|
|
|
|
``evacuate``
|
|
Evacuate server from failed host.
|
|
|
|
``fixed-ip-get``
|
|
**DEPRECATED**: Retrieve info on a fixed IP.
|
|
|
|
``fixed-ip-reserve``
|
|
**DEPRECATED**: Reserve a fixed IP.
|
|
|
|
``fixed-ip-unreserve``
|
|
**DEPRECATED**: Unreserve a fixed IP.
|
|
|
|
``flavor-access-add``
|
|
Add flavor access for the given tenant.
|
|
|
|
``flavor-access-list``
|
|
Print access information about the given
|
|
flavor.
|
|
|
|
``flavor-access-remove``
|
|
Remove flavor access for the given tenant.
|
|
|
|
``flavor-create``
|
|
Create a new flavor.
|
|
|
|
``flavor-delete``
|
|
Delete a specific flavor
|
|
|
|
``flavor-key``
|
|
Set or unset extra_spec for a flavor.
|
|
|
|
``flavor-list``
|
|
Print a list of available 'flavors' (sizes of
|
|
servers).
|
|
|
|
``flavor-show``
|
|
Show details about the given flavor.
|
|
|
|
``floating-ip-associate``
|
|
Associate a floating IP address to a server.
|
|
|
|
``floating-ip-bulk-create``
|
|
**DEPRECATED**: Bulk create floating IPs by range
|
|
(nova-network only).
|
|
|
|
``floating-ip-bulk-delete``
|
|
**DEPRECATED**: Bulk delete floating IPs by range
|
|
(nova-network only).
|
|
|
|
``floating-ip-bulk-list``
|
|
**DEPRECATED**: List all floating IPs (nova-network only).
|
|
|
|
``floating-ip-create``
|
|
**DEPRECATED**: Allocate a floating IP for the
|
|
current tenant.
|
|
|
|
``floating-ip-delete``
|
|
**DEPRECATED**: De-allocate a floating IP.
|
|
|
|
``floating-ip-disassociate``
|
|
Disassociate a floating IP address from a
|
|
server.
|
|
|
|
``floating-ip-list``
|
|
**DEPRECATED**: List floating IPs.
|
|
|
|
``floating-ip-pool-list``
|
|
**DEPRECATED**: List all floating IP pools.
|
|
|
|
``get-mks-console``
|
|
Get an MKS console to a server. (Supported by
|
|
API versions '2.8' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`' flag to show help
|
|
message for proper version]
|
|
|
|
``get-password``
|
|
Get the admin password for a server. This
|
|
operation calls the metadata service to query
|
|
metadata information and does not read
|
|
password information from the server itself.
|
|
|
|
``get-rdp-console``
|
|
Get a rdp console to a server.
|
|
|
|
``get-serial-console``
|
|
Get a serial console to a server.
|
|
|
|
``get-spice-console``
|
|
Get a spice console to a server.
|
|
|
|
``get-vnc-console``
|
|
Get a vnc console to a server.
|
|
|
|
``host-action``
|
|
Perform a power action on a host.
|
|
|
|
``host-describe``
|
|
Describe a specific host.
|
|
|
|
``host-list``
|
|
List all hosts by service.
|
|
|
|
``host-update``
|
|
Update host settings.
|
|
|
|
``hypervisor-list``
|
|
List hypervisors. (Supported by API versions
|
|
'2.0' - '2.latest') [hint: use ':option:`--os-compute-`
|
|
api-version' flag to show help message for
|
|
proper version]
|
|
|
|
``hypervisor-servers``
|
|
List servers belonging to specific
|
|
hypervisors.
|
|
|
|
``hypervisor-show``
|
|
Display the details of the specified
|
|
hypervisor.
|
|
|
|
``hypervisor-stats``
|
|
Get hypervisor statistics over all compute
|
|
nodes.
|
|
|
|
``hypervisor-uptime``
|
|
Display the uptime of the specified
|
|
hypervisor.
|
|
|
|
``image-create``
|
|
Create a new image by taking a snapshot of a
|
|
running server.
|
|
|
|
``image-delete``
|
|
**DEPRECATED**: Delete specified image(s).
|
|
|
|
``image-list``
|
|
**DEPRECATED**: Print a list of available images
|
|
to boot from.
|
|
|
|
``image-meta``
|
|
**DEPRECATED**: Set or delete metadata on an
|
|
image.
|
|
|
|
``image-show``
|
|
**DEPRECATED**: Show details about the given
|
|
image.
|
|
|
|
``interface-attach``
|
|
Attach a network interface to a server.
|
|
|
|
``interface-detach``
|
|
Detach a network interface from a server.
|
|
|
|
``interface-list``
|
|
List interfaces attached to a server.
|
|
|
|
``keypair-add``
|
|
Create a new key pair for use with servers.
|
|
|
|
``keypair-delete``
|
|
Delete keypair given by its name. (Supported
|
|
by API versions '2.0' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`' flag to show help
|
|
message for proper version]
|
|
|
|
``keypair-list``
|
|
Print a list of keypairs for a user (Supported
|
|
by API versions '2.0' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`' flag to show help
|
|
message for proper version]
|
|
|
|
``keypair-show``
|
|
Show details about the given keypair.
|
|
(Supported by API versions '2.0' - '2.latest')
|
|
[hint: use ':option:`--os-compute-api-version`' flag to
|
|
show help message for proper version]
|
|
|
|
``limits``
|
|
Print rate and absolute limits.
|
|
|
|
``list``
|
|
List active servers.
|
|
|
|
``list-secgroup``
|
|
List Security Group(s) of a server.
|
|
|
|
``live-migration``
|
|
Migrate running server to a new machine.
|
|
|
|
``live-migration-abort``
|
|
Abort an on-going live migration. (Supported
|
|
by API versions '2.24' - '2.latest') [hint:
|
|
use ':option:`--os-compute-api-version`' flag to show
|
|
help message for proper version]
|
|
|
|
``live-migration-force-complete``
|
|
Force on-going live migration to complete.
|
|
(Supported
|
|
by
|
|
API
|
|
versions
|
|
'2.22'
|
|
-'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-`
|
|
version' flag to show help message for proper
|
|
version]
|
|
|
|
``lock``
|
|
Lock a server. A normal (non-admin) user will
|
|
not be able to execute actions on a locked
|
|
server.
|
|
|
|
``meta``
|
|
Set or delete metadata on a server.
|
|
|
|
``migrate``
|
|
Migrate a server. The new host will be
|
|
selected by the scheduler.
|
|
|
|
``network-associate-host``
|
|
**DEPRECATED**: Associate host with network.
|
|
|
|
``network-associate-project``
|
|
**DEPRECATED**: Associate project with network.
|
|
|
|
``network-create``
|
|
**DEPRECATED**: Create a network.
|
|
|
|
``network-delete``
|
|
**DEPRECATED**: Delete network by label or id.
|
|
|
|
``network-disassociate``
|
|
**DEPRECATED**: Disassociate host and/or project
|
|
from the given network.
|
|
|
|
``network-list``
|
|
**DEPRECATED**: Print a list of available
|
|
networks.
|
|
|
|
``network-show``
|
|
**DEPRECATED**: Show details about the given
|
|
network.
|
|
|
|
``pause``
|
|
Pause a server.
|
|
|
|
``quota-class-show``
|
|
List the quotas for a quota class.
|
|
|
|
``quota-class-update``
|
|
Update the quotas for a quota class.
|
|
(Supported by API versions '2.0' - '2.latest')
|
|
[hint: use ':option:`--os-compute-api-version`' flag to
|
|
show help message for proper version]
|
|
|
|
``quota-defaults``
|
|
List the default quotas for a tenant.
|
|
|
|
``quota-delete``
|
|
Delete quota for a tenant/user so their quota
|
|
will Revert back to default.
|
|
|
|
``quota-show``
|
|
List the quotas for a tenant/user.
|
|
|
|
``quota-update``
|
|
Update the quotas for a tenant/user.
|
|
(Supported by API versions '2.0' - '2.latest')
|
|
[hint: use ':option:`--os-compute-api-version`' flag to
|
|
show help message for proper version]
|
|
|
|
``rate-limits``
|
|
**DEPRECATED**, use limits instead.
|
|
|
|
``reboot``
|
|
Reboot a server.
|
|
|
|
``rebuild``
|
|
Shutdown, re-image, and re-boot a server.
|
|
|
|
``refresh-network``
|
|
Refresh server network information.
|
|
|
|
``remove-fixed-ip``
|
|
Remove an IP address from a server.
|
|
|
|
``remove-floating-ip``
|
|
**DEPRECATED**, use floating-ip-disassociate
|
|
instead.
|
|
|
|
``remove-secgroup``
|
|
Remove a Security Group from a server.
|
|
|
|
``rename``
|
|
**DEPRECATED**, use update instead.
|
|
|
|
``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``
|
|
Reset network of a server.
|
|
|
|
``reset-state``
|
|
Reset the state of a server.
|
|
|
|
``resize``
|
|
Resize a server.
|
|
|
|
``resize-confirm``
|
|
Confirm a previous resize.
|
|
|
|
``resize-revert``
|
|
Revert a previous resize (and return to the
|
|
previous VM).
|
|
|
|
``resume``
|
|
Resume a server.
|
|
|
|
``root-password``
|
|
**DEPRECATED**, use set-password instead.
|
|
|
|
``scrub``
|
|
**DEPRECATED**: Delete networks and security
|
|
groups associated with a project.
|
|
|
|
``secgroup-add-default-rule``
|
|
**DEPRECATED**: Add a rule to the set of rules
|
|
that will be added to the 'default' security
|
|
group for new tenants (nova-network only).
|
|
|
|
``secgroup-add-group-rule``
|
|
**DEPRECATED**: Add a source group rule to a
|
|
security group.
|
|
|
|
``secgroup-add-rule``
|
|
**DEPRECATED**: Add a rule to a security group.
|
|
|
|
``secgroup-create``
|
|
**DEPRECATED**: Create a security group.
|
|
|
|
``secgroup-delete``
|
|
**DEPRECATED**: Delete a security group.
|
|
|
|
``secgroup-delete-default-rule``
|
|
**DEPRECATED**: Delete a rule from the set of
|
|
rules that will be added to the 'default'
|
|
security group for new tenants (nova-network
|
|
only).
|
|
|
|
``secgroup-delete-group-rule``
|
|
**DEPRECATED**: Delete a source group rule from a
|
|
security group.
|
|
|
|
``secgroup-delete-rule``
|
|
**DEPRECATED**: Delete a rule from a security
|
|
group.
|
|
|
|
``secgroup-list``
|
|
**DEPRECATED**: List security groups for the
|
|
current tenant.
|
|
|
|
``secgroup-list-default-rules``
|
|
**DEPRECATED**: List rules that will be added to
|
|
the 'default' security group for new tenants.
|
|
|
|
``secgroup-list-rules``
|
|
**DEPRECATED**: List rules for a security group.
|
|
|
|
``secgroup-update``
|
|
**DEPRECATED**: Update a security group.
|
|
|
|
``server-group-create``
|
|
Create a new server group with the specified
|
|
details.
|
|
|
|
``server-group-delete``
|
|
Delete specific server group(s).
|
|
|
|
``server-group-get``
|
|
Get a specific server group.
|
|
|
|
``server-group-list``
|
|
Print a list of all server groups.
|
|
|
|
``server-migration-list``
|
|
Get the migrations list of specified server.
|
|
(Supported
|
|
by
|
|
API
|
|
versions
|
|
'2.23'
|
|
-'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-`
|
|
version' flag to show help message for proper
|
|
version]
|
|
|
|
``server-migration-show``
|
|
Get the migration of specified server.
|
|
(Supported
|
|
by
|
|
API
|
|
versions
|
|
'2.23'
|
|
-'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-`
|
|
version' flag to show help message for proper
|
|
version]
|
|
|
|
``server-tag-add``
|
|
Add single tag to a server. (Supported by API
|
|
versions '2.26' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`' flag to show help
|
|
message for proper version]
|
|
|
|
``server-tag-delete``
|
|
Delete single tag from a server. (Supported by
|
|
API versions '2.26' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`' flag to show help
|
|
message for proper version]
|
|
|
|
``server-tag-delete-all``
|
|
Delete all tags from a server. (Supported by
|
|
API versions '2.26' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`' flag to show help
|
|
message for proper version]
|
|
|
|
``server-tag-list``
|
|
Get list of tags from a server. (Supported by
|
|
API versions '2.26' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`' flag to show help
|
|
message for proper version]
|
|
|
|
``server-tag-set``
|
|
Set list of tags to a server. (Supported by
|
|
API versions '2.26' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`' flag to show help
|
|
message for proper version]
|
|
|
|
``service-delete``
|
|
Delete the service.
|
|
|
|
``service-disable``
|
|
Disable the service.
|
|
|
|
``service-enable``
|
|
Enable the service.
|
|
|
|
``service-force-down``
|
|
Force service to down. (Supported by API
|
|
versions '2.11' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`' flag to show help
|
|
message for proper version]
|
|
|
|
``service-list``
|
|
Show a list of all running services. Filter by
|
|
host & binary.
|
|
|
|
``set-password``
|
|
Change the admin password for a server.
|
|
|
|
``shelve``
|
|
Shelve a server.
|
|
|
|
``shelve-offload``
|
|
Remove a shelved server from the compute node.
|
|
|
|
``show``
|
|
Show details about the given server.
|
|
|
|
``ssh``
|
|
SSH into a server.
|
|
|
|
``start``
|
|
Start the server(s).
|
|
|
|
``stop``
|
|
Stop the server(s).
|
|
|
|
``suspend``
|
|
Suspend a server.
|
|
|
|
``trigger-crash-dump``
|
|
Trigger crash dump in an instance. (Supported
|
|
by API versions '2.17' - '2.latest') [hint:
|
|
use ':option:`--os-compute-api-version`' flag to show
|
|
help message for proper version]
|
|
|
|
``unlock``
|
|
Unlock a server.
|
|
|
|
``unpause``
|
|
Unpause a server.
|
|
|
|
``unrescue``
|
|
Restart the server from normal boot disk
|
|
again.
|
|
|
|
``unshelve``
|
|
Unshelve a server.
|
|
|
|
``update``
|
|
Update the name or the description for a
|
|
server.
|
|
|
|
``usage``
|
|
Show usage data for a single tenant.
|
|
|
|
``usage-list``
|
|
List usage data for all tenants.
|
|
|
|
``version-list``
|
|
List all API versions.
|
|
|
|
``virtual-interface-list``
|
|
Show virtual interface info about the given
|
|
server.
|
|
|
|
``volume-attach``
|
|
Attach a volume to a server.
|
|
|
|
``volume-attachments``
|
|
List all the volumes attached to a server.
|
|
|
|
``volume-detach``
|
|
Detach a volume from a server.
|
|
|
|
``volume-update``
|
|
Update volume attachment.
|
|
|
|
``x509-create-cert``
|
|
Create x509 cert for a user in tenant.
|
|
|
|
``x509-get-root-cert``
|
|
Fetch 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.
|
|
|
|
``help``
|
|
Display help about this program or one of its
|
|
subcommands.
|
|
|
|
``baremetal-interface-list``
|
|
**DEPRECATED**: List network interfaces associated
|
|
with a baremetal node.
|
|
|
|
``baremetal-node-list``
|
|
**DEPRECATED**: Print list of available baremetal
|
|
nodes.
|
|
|
|
``baremetal-node-show``
|
|
**DEPRECATED**: Show information about a baremetal
|
|
node.
|
|
|
|
``host-meta``
|
|
Set or Delete metadata on all instances of a
|
|
host.
|
|
|
|
``force-delete``
|
|
Force delete a server.
|
|
|
|
``restore``
|
|
Restore a soft-deleted server.
|
|
|
|
``cell-capacities``
|
|
Get cell capacities for all cells or a given
|
|
cell.
|
|
|
|
``cell-show``
|
|
Show details of a given cell.
|
|
|
|
``host-servers-migrate``
|
|
Cold migrate all instances off the specified
|
|
host to other available hosts.
|
|
|
|
``list-extensions``
|
|
List all the os-api extensions that are
|
|
available.
|
|
|
|
``host-evacuate-live``
|
|
Live migrate all instances of the specified
|
|
host to other available hosts.
|
|
|
|
``migration-list``
|
|
Print a list of migrations.
|
|
|
|
``instance-action``
|
|
Show an action.
|
|
|
|
``instance-action-list``
|
|
List actions on a server.
|
|
|
|
``net``
|
|
**DEPRECATED**, use tenant-network-show instead.
|
|
|
|
``net-create``
|
|
**DEPRECATED**, use tenant-network-create instead.
|
|
|
|
``net-delete``
|
|
**DEPRECATED**, use tenant-network-delete instead.
|
|
|
|
``net-list``
|
|
**DEPRECATED**, use tenant-network-list instead.
|
|
|
|
``tenant-network-create``
|
|
**DEPRECATED**: Create a tenant network.
|
|
|
|
``tenant-network-delete``
|
|
**DEPRECATED**: Delete a tenant network.
|
|
|
|
``tenant-network-list``
|
|
**DEPRECATED**: List tenant networks.
|
|
|
|
``tenant-network-show``
|
|
**DEPRECATED**: Show a tenant network.
|
|
|
|
``host-evacuate``
|
|
Evacuate all instances from failed host.
|
|
|
|
.. _nova_command_options:
|
|
|
|
nova optional arguments
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
``--version``
|
|
show program's version number and exit
|
|
|
|
``--debug``
|
|
Print debugging output.
|
|
|
|
``--os-cache``
|
|
Use the auth token cache. Defaults to False if
|
|
``env[OS_CACHE]`` is not set.
|
|
|
|
``--timings``
|
|
Print 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]``.
|
|
|
|
``--bypass-url <bypass-url>``
|
|
Use this API endpoint instead of the Service
|
|
Catalog. Defaults to
|
|
``env[NOVACLIENT_BYPASS_URL]``.
|
|
|
|
``--os-auth-type <name>, --os-auth-plugin <name>``
|
|
Authentication type to use
|
|
|
|
.. _nova_add-fixed-ip:
|
|
|
|
nova add-fixed-ip
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova add-fixed-ip <server> <network-id>
|
|
|
|
Add new IP address on a network to server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<network-id>``
|
|
Network ID.
|
|
|
|
.. _nova_add-secgroup:
|
|
|
|
nova add-secgroup
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova add-secgroup <server> <secgroup>
|
|
|
|
Add a Security Group to a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<secgroup>``
|
|
Name or ID of Security Group.
|
|
|
|
.. _nova_agent-create:
|
|
|
|
nova agent-create
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
|
|
<hypervisor>
|
|
|
|
Create 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:
|
|
|
|
nova agent-delete
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova agent-delete <id>
|
|
|
|
Delete existing agent build.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<id>``
|
|
ID of the agent-build.
|
|
|
|
.. _nova_agent-list:
|
|
|
|
nova agent-list
|
|
---------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova agent-list [--hypervisor <hypervisor>]
|
|
|
|
List all builds.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--hypervisor <hypervisor>``
|
|
Type of hypervisor.
|
|
|
|
.. _nova_agent-modify:
|
|
|
|
nova agent-modify
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova agent-modify <id> <version> <url> <md5hash>
|
|
|
|
Modify existing agent build.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<id>``
|
|
ID of the agent-build.
|
|
|
|
``<version>``
|
|
Version.
|
|
|
|
``<url>``
|
|
URL
|
|
|
|
``<md5hash>``
|
|
MD5 hash.
|
|
|
|
.. _nova_aggregate-add-host:
|
|
|
|
nova aggregate-add-host
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova aggregate-add-host <aggregate> <host>
|
|
|
|
Add the host to the specified aggregate.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<aggregate>``
|
|
Name or ID of aggregate.
|
|
|
|
``<host>``
|
|
The host to add to the aggregate.
|
|
|
|
.. _nova_aggregate-create:
|
|
|
|
nova aggregate-create
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova aggregate-create <name> [<availability-zone>]
|
|
|
|
Create 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:
|
|
|
|
nova aggregate-delete
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova aggregate-delete <aggregate>
|
|
|
|
Delete the aggregate.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<aggregate>``
|
|
Name or ID of aggregate to delete.
|
|
|
|
.. _nova_aggregate-list:
|
|
|
|
nova aggregate-list
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova aggregate-list
|
|
|
|
Print a list of all aggregates.
|
|
|
|
.. _nova_aggregate-remove-host:
|
|
|
|
nova aggregate-remove-host
|
|
--------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova aggregate-remove-host <aggregate> <host>
|
|
|
|
Remove 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:
|
|
|
|
nova aggregate-set-metadata
|
|
---------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
|
|
|
|
Update 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.
|
|
|
|
.. _nova_aggregate-show:
|
|
|
|
nova aggregate-show
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova aggregate-show <aggregate>
|
|
|
|
Show details of the specified aggregate.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<aggregate>``
|
|
Name or ID of aggregate.
|
|
|
|
.. _nova_aggregate-update:
|
|
|
|
nova aggregate-update
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova aggregate-update [--name NAME]
|
|
[--availability-zone <availability-zone>]
|
|
<aggregate>
|
|
|
|
Update the aggregate's name and optionally availability zone.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<aggregate>``
|
|
Name or ID of aggregate to update.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--name NAME``
|
|
Name of aggregate.
|
|
|
|
``--availability-zone <availability-zone>``
|
|
The availability zone of the aggregate.
|
|
|
|
.. _nova_availability-zone-list:
|
|
|
|
nova availability-zone-list
|
|
---------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova availability-zone-list
|
|
|
|
List all the availability zones.
|
|
|
|
.. _nova_backup:
|
|
|
|
nova backup
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova backup <server> <name> <backup-type> <rotation>
|
|
|
|
Backup 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
|
|
---------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: 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>]
|
|
[--file <dst-path=src-path>] [--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>]
|
|
<name>
|
|
|
|
Boot a new server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<name>``
|
|
Name for the new server.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--flavor <flavor>``
|
|
Name or ID of flavor (see 'nova flavor-list').
|
|
|
|
``--image <image>``
|
|
Name or ID of image (see 'glance image-list').
|
|
|
|
``--image-with <key=value>``
|
|
Image metadata property (see 'glance image-show').
|
|
|
|
``--boot-volume <volume_id>``
|
|
Volume ID to boot from.
|
|
|
|
``--snapshot <snapshot_id>``
|
|
Snapshot ID to boot from (will create a
|
|
volume).
|
|
|
|
``--min-count <number>``
|
|
Boot at least <number> servers (limited by
|
|
quota).
|
|
|
|
``--max-count <number>``
|
|
Boot up to <number> servers (limited by
|
|
quota).
|
|
|
|
``--meta <key=value>``
|
|
Record arbitrary key/value metadata to
|
|
/meta_data.json on the metadata server. Can be
|
|
specified multiple times.
|
|
|
|
``--file <dst-path=src-path>``
|
|
Store arbitrary files from <src-path> locally
|
|
to <dst-path> on the new server. Limited by
|
|
the injected_files quota value.
|
|
|
|
``--key-name <key-name>``
|
|
Key name of keypair that should be created
|
|
earlier with the command keypair-add.
|
|
|
|
``--user-data <user-data>``
|
|
user data file to pass 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(GB)>:<delete-on-terminate>.
|
|
|
|
``--block-device``
|
|
key1=value1[,key2=value2...]
|
|
Block device mapping with the keys: id=UUID
|
|
(image_id, snapshot_id or volume_id only if
|
|
using source image, snapshot or volume)
|
|
source=source type (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 omitted,
|
|
hypervisor driver chooses a suitable default,
|
|
honoured only if device type is supplied)
|
|
type=device type (e.g. disk, cdrom, ...;
|
|
defaults to 'disk') device=name of the device
|
|
(e.g. vda, xda, ...; tag=device metadata tag
|
|
(optional) if omitted, hypervisor driver
|
|
chooses suitable device depending on selected
|
|
bus; note the libvirt driver always uses
|
|
default device names), size=size of the block
|
|
device in MB(for swap) and in GB(for other
|
|
formats) (if omitted, 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 is equal
|
|
to 0, for others need to be specified) and
|
|
shutdown=shutdown behaviour (either preserve
|
|
or remove, for local destination set to
|
|
remove). (Supported by API versions '2.32' -'2.latest')
|
|
|
|
``--swap <swap_size>``
|
|
Create and attach a local swap block device of
|
|
<swap_size> MB.
|
|
|
|
``--ephemeral``
|
|
size=<size>[,format=<format>]
|
|
Create and attach a local ephemeral block
|
|
device of <size> GB and format it to <format>.
|
|
|
|
``--hint <key=value>``
|
|
Send arbitrary key/value pairs to the
|
|
scheduler for custom use.
|
|
|
|
``--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 option
|
|
multiple times to create multiple nics unless
|
|
using the special 'auto' or 'none' values.
|
|
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 cannot be specified
|
|
with any other nic value and cannot be
|
|
specified multiple times. net-id: attach NIC
|
|
to network with a specific UUID. net-name:
|
|
attach NIC to network with this name (either
|
|
port-id or net-id or net-name must be
|
|
provided), v4-fixed-ip: IPv4 fixed address for
|
|
NIC (optional), v6-fixed-ip: IPv6 fixed
|
|
address for NIC (optional), port-id: attach
|
|
NIC to port with this UUID tag: interface
|
|
metadata tag (optional) (either port-id or
|
|
net-id must be provided). (Supported by API
|
|
versions '2.37' - '2.latest')
|
|
|
|
``--config-drive <value>``
|
|
Enable config drive.
|
|
|
|
``--poll``
|
|
Report the new server boot progress until it
|
|
completes.
|
|
|
|
``--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')
|
|
|
|
.. _nova_cell-capacities:
|
|
|
|
nova cell-capacities
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova cell-capacities [--cell <cell-name>]
|
|
|
|
Get cell capacities for all cells or a given cell.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--cell <cell-name>``
|
|
Name of the cell to get the capacities.
|
|
|
|
.. _nova_cell-show:
|
|
|
|
nova cell-show
|
|
--------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova cell-show <cell-name>
|
|
|
|
Show details of a given cell.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<cell-name>``
|
|
Name of the cell.
|
|
|
|
.. _nova_clear-password:
|
|
|
|
nova clear-password
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova clear-password <server>
|
|
|
|
Clear the admin password for a server from the metadata server. This action
|
|
does not actually change the instance server password.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_cloudpipe-configure:
|
|
|
|
nova cloudpipe-configure
|
|
------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova cloudpipe-configure <ip address> <port>
|
|
|
|
Update the VPN IP/port of a cloudpipe instance.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<ip address>``
|
|
New IP Address.
|
|
|
|
``<port>``
|
|
New Port.
|
|
|
|
.. _nova_cloudpipe-create:
|
|
|
|
nova cloudpipe-create
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova cloudpipe-create <project_id>
|
|
|
|
Create a cloudpipe instance for the given project.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<project_id>``
|
|
UUID of the project to create the cloudpipe for.
|
|
|
|
.. _nova_cloudpipe-list:
|
|
|
|
nova cloudpipe-list
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova cloudpipe-list
|
|
|
|
Print a list of all cloudpipe instances.
|
|
|
|
.. _nova_console-log:
|
|
|
|
nova console-log
|
|
----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova console-log [--length <length>] <server>
|
|
|
|
Get console log output of a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--length <length>``
|
|
Length in lines to tail.
|
|
|
|
.. _nova_credentials:
|
|
|
|
nova credentials
|
|
----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova credentials [--wrap <integer>]
|
|
|
|
Show user credentials returned from auth.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--wrap <integer>``
|
|
Wrap PKI tokens to a specified length, or 0 to disable.
|
|
|
|
.. _nova_delete:
|
|
|
|
nova delete
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova delete [--all-tenants] <server> [<server> ...]
|
|
|
|
Immediately shut down and delete specified server(s).
|
|
|
|
**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
|
|
----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova diagnostics <server>
|
|
|
|
Retrieve server diagnostics.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_endpoints:
|
|
|
|
nova endpoints
|
|
--------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova endpoints
|
|
|
|
Discover endpoints that get returned from the authenticate services.
|
|
|
|
.. _nova_evacuate:
|
|
|
|
nova evacuate
|
|
-------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova evacuate [--password <password>] [--force] <server> [<host>]
|
|
|
|
Evacuate server from failed host.
|
|
|
|
**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.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--password <password>``
|
|
Set the provided admin password on the evacuated
|
|
server. Not applicable if the server is on shared
|
|
storage.
|
|
|
|
``--force``
|
|
Force to not verify the scheduler if a host is
|
|
provided. (Supported by API versions '2.29' -'2.latest')
|
|
|
|
.. _nova_flavor-access-add:
|
|
|
|
nova flavor-access-add
|
|
----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova flavor-access-add <flavor> <tenant_id>
|
|
|
|
Add flavor access for the given tenant.
|
|
|
|
**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
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova flavor-access-list [--flavor <flavor>] [--tenant <tenant_id>]
|
|
|
|
Print access information about the given flavor.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--flavor <flavor>``
|
|
Filter results by flavor name or ID.
|
|
|
|
``--tenant <tenant_id>``
|
|
Filter results by tenant ID. (Deprecated; this option
|
|
is not supported, and will be removed in version
|
|
5.0.0.)
|
|
|
|
.. _nova_flavor-access-remove:
|
|
|
|
nova flavor-access-remove
|
|
-------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova flavor-access-remove <flavor> <tenant_id>
|
|
|
|
Remove flavor access for the given tenant.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<flavor>``
|
|
Flavor name or ID to remove access for the given tenant.
|
|
|
|
``<tenant_id>``
|
|
Tenant ID to remove flavor access for.
|
|
|
|
.. _nova_flavor-create:
|
|
|
|
nova flavor-create
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
|
|
[--rxtx-factor <factor>] [--is-public <is-public>]
|
|
<name> <id> <ram> <disk> <vcpus>
|
|
|
|
Create a new flavor.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<name>``
|
|
Unique name of the new flavor.
|
|
|
|
``<id>``
|
|
Unique ID of the new flavor. Specifying 'auto' will
|
|
generated a UUID for the ID.
|
|
|
|
``<ram>``
|
|
Memory size in MB.
|
|
|
|
``<disk>``
|
|
Disk size in GB.
|
|
|
|
``<vcpus>``
|
|
Number of vcpus
|
|
|
|
**Optional arguments:**
|
|
|
|
``--ephemeral <ephemeral>``
|
|
Ephemeral space size in GB (default 0).
|
|
|
|
``--swap <swap>``
|
|
Swap space size in MB (default 0).
|
|
|
|
``--rxtx-factor <factor>``
|
|
RX/TX factor (default 1).
|
|
|
|
``--is-public <is-public>``
|
|
Make flavor accessible to the public (default
|
|
true).
|
|
|
|
.. _nova_flavor-delete:
|
|
|
|
nova flavor-delete
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova flavor-delete <flavor>
|
|
|
|
Delete a specific flavor
|
|
|
|
**Positional arguments:**
|
|
|
|
``<flavor>``
|
|
Name or ID of the flavor to delete.
|
|
|
|
.. _nova_flavor-key:
|
|
|
|
nova flavor-key
|
|
---------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
|
|
|
|
Set or unset extra_spec for a flavor.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<flavor>``
|
|
Name or ID of flavor.
|
|
|
|
``<action>``
|
|
Actions: 'set' or 'unset'.
|
|
|
|
``<key=value>``
|
|
Extra_specs to set/unset (only key is necessary on unset).
|
|
|
|
.. _nova_flavor-list:
|
|
|
|
nova flavor-list
|
|
----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
|
|
[--limit <limit>]
|
|
|
|
Print a list of available 'flavors' (sizes of servers).
|
|
|
|
**Optional arguments:**
|
|
|
|
``--extra-specs``
|
|
Get extra-specs of each flavor.
|
|
|
|
``--all``
|
|
Display all flavors (Admin only).
|
|
|
|
``--marker <marker>``
|
|
The last flavor ID of the previous page; displays list of
|
|
flavors after "marker".
|
|
|
|
``--limit <limit>``
|
|
Maximum number of flavors to display. If limit == -1, all
|
|
flavors will be displayed. If limit is bigger than
|
|
'osapi_max_limit' option of Nova API, limit
|
|
'osapi_max_limit' will be used instead.
|
|
|
|
.. _nova_flavor-show:
|
|
|
|
nova flavor-show
|
|
----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova flavor-show <flavor>
|
|
|
|
Show details about the given flavor.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<flavor>``
|
|
Name or ID of flavor.
|
|
|
|
.. _nova_floating-ip-associate:
|
|
|
|
nova floating-ip-associate
|
|
--------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova floating-ip-associate [--fixed-address <fixed_address>]
|
|
<server> <address>
|
|
|
|
Associate a floating IP address to a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<address>``
|
|
IP Address.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--fixed-address <fixed_address>``
|
|
Fixed IP Address to associate with.
|
|
|
|
.. _nova_floating-ip-disassociate:
|
|
|
|
nova floating-ip-disassociate
|
|
-----------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova floating-ip-disassociate <server> <address>
|
|
|
|
Disassociate a floating IP address from a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<address>``
|
|
IP Address.
|
|
|
|
.. _nova_force-delete:
|
|
|
|
nova force-delete
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova force-delete <server>
|
|
|
|
Force delete a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_get-mks-console:
|
|
|
|
nova get-mks-console
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova get-mks-console <server>
|
|
|
|
Get an MKS console to a server. (Supported by API versions '2.8' - '2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for
|
|
proper
|
|
version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_get-password:
|
|
|
|
nova get-password
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova get-password <server> [<private-key>]
|
|
|
|
Get the admin password for a server. This operation calls the metadata service
|
|
to query metadata information and 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 password) (Optional).
|
|
When specified, the command displays the clear (decrypted) VM
|
|
password. When not specified, the ciphered VM password is
|
|
displayed.
|
|
|
|
.. _nova_get-rdp-console:
|
|
|
|
nova get-rdp-console
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova get-rdp-console <server> <console-type>
|
|
|
|
Get a 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:
|
|
|
|
nova get-serial-console
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>
|
|
|
|
Get 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:
|
|
|
|
nova get-spice-console
|
|
----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova get-spice-console <server> <console-type>
|
|
|
|
Get 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:
|
|
|
|
nova get-vnc-console
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova get-vnc-console <server> <console-type>
|
|
|
|
Get 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-action:
|
|
|
|
nova host-action
|
|
----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova host-action [--action <action>] <hostname>
|
|
|
|
Perform a power action on a host.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<hostname>``
|
|
Name of host.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--action <action>``
|
|
A power action: startup, reboot, or shutdown.
|
|
|
|
.. _nova_host-describe:
|
|
|
|
nova host-describe
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova host-describe <hostname>
|
|
|
|
Describe a specific host.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<hostname>``
|
|
Name of host.
|
|
|
|
.. _nova_host-evacuate:
|
|
|
|
nova host-evacuate
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova host-evacuate [--target_host <target_host>] [--force] <host>
|
|
|
|
Evacuate all instances from failed host.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<host>``
|
|
Name of host.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--target_host <target_host>``
|
|
Name of target host. If no host is specified
|
|
the scheduler will select a target.
|
|
|
|
``--force``
|
|
Force to not verify the scheduler if a host is
|
|
provided. (Supported by API versions '2.29' -'2.latest')
|
|
|
|
.. _nova_host-evacuate-live:
|
|
|
|
nova host-evacuate-live
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
|
|
[--max-servers <max_servers>] [--force]
|
|
<host>
|
|
|
|
Live migrate all instances of the specified host to other available hosts.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<host>``
|
|
Name of host.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--target-host <target_host>``
|
|
Name of target host.
|
|
|
|
``--block-migrate``
|
|
Enable 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``
|
|
Force to not verify the scheduler if a host is
|
|
provided. (Supported by API versions '2.30' -'2.latest')
|
|
|
|
.. _nova_host-list:
|
|
|
|
nova host-list
|
|
--------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova host-list [--zone <zone>]
|
|
|
|
List all hosts by service.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--zone <zone>``
|
|
Filters the list, returning only those hosts in the
|
|
availability zone <zone>.
|
|
|
|
.. _nova_host-meta:
|
|
|
|
nova host-meta
|
|
--------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova host-meta <host> <action> <key=value> [<key=value> ...]
|
|
|
|
Set or Delete metadata on all instances of a host.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<host>``
|
|
Name of host.
|
|
|
|
``<action>``
|
|
Actions: 'set' or 'delete'
|
|
|
|
``<key=value>``
|
|
Metadata to set or delete (only key is necessary on delete)
|
|
|
|
.. _nova_host-servers-migrate:
|
|
|
|
nova host-servers-migrate
|
|
-------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova host-servers-migrate <host>
|
|
|
|
Cold migrate all instances off the specified host to other available hosts.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<host>``
|
|
Name of host.
|
|
|
|
.. _nova_host-update:
|
|
|
|
nova host-update
|
|
----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova host-update [--status <enable|disable>]
|
|
[--maintenance <enable|disable>]
|
|
<hostname>
|
|
|
|
Update host settings.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<hostname>``
|
|
Name of host.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--status <enable|disable>``
|
|
Either enable or disable a host.
|
|
|
|
``--maintenance <enable|disable>``
|
|
Either put or resume host to/from maintenance.
|
|
|
|
.. _nova_hypervisor-list:
|
|
|
|
nova hypervisor-list
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
|
|
[--limit <limit>]
|
|
|
|
List hypervisors. (Supported by API versions '2.0' - '2.latest') [hint: use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for
|
|
proper
|
|
version]
|
|
|
|
**Optional arguments:**
|
|
|
|
``--matching <hostname>``
|
|
List hypervisors matching the given <hostname>. If
|
|
matching is used limit and marker options will be
|
|
ignored.
|
|
|
|
``--marker <marker>``
|
|
The last hypervisor of the previous page; displays
|
|
list of hypervisors after "marker".
|
|
|
|
``--limit <limit>``
|
|
Maximum number of hypervisors to display. If limit ==
|
|
-1, all hypervisors will be displayed. If limit is
|
|
bigger than 'osapi_max_limit' option of Nova API,
|
|
limit 'osapi_max_limit' will be used instead.
|
|
|
|
.. _nova_hypervisor-servers:
|
|
|
|
nova hypervisor-servers
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova hypervisor-servers <hostname>
|
|
|
|
List servers belonging to specific hypervisors.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<hostname>``
|
|
The hypervisor hostname (or pattern) to search for.
|
|
|
|
.. _nova_hypervisor-show:
|
|
|
|
nova hypervisor-show
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
|
|
|
|
Display the details of the specified hypervisor.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<hypervisor>``
|
|
Name or ID of the hypervisor to show the details of.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--wrap <integer>``
|
|
Wrap the output to a specified length. Default is 40 or 0
|
|
to disable
|
|
|
|
.. _nova_hypervisor-stats:
|
|
|
|
nova hypervisor-stats
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova hypervisor-stats
|
|
|
|
Get hypervisor statistics over all compute nodes.
|
|
|
|
.. _nova_hypervisor-uptime:
|
|
|
|
nova hypervisor-uptime
|
|
----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova hypervisor-uptime <hypervisor>
|
|
|
|
Display the uptime of the specified hypervisor.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<hypervisor>``
|
|
Name or ID of the hypervisor to show the uptime of.
|
|
|
|
.. _nova_image-create:
|
|
|
|
nova image-create
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova image-create [--metadata <key=value>] [--show] [--poll]
|
|
<server> <name>
|
|
|
|
Create a new image by taking a snapshot of a running server.
|
|
|
|
**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.
|
|
|
|
``--show``
|
|
Print image info.
|
|
|
|
``--poll``
|
|
Report the snapshot progress and poll until image
|
|
creation is complete.
|
|
|
|
.. _nova_instance-action:
|
|
|
|
nova instance-action
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova instance-action <server> <request_id>
|
|
|
|
Show an action.
|
|
|
|
**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:
|
|
|
|
nova instance-action-list
|
|
-------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova instance-action-list <server>
|
|
|
|
List actions on a server.
|
|
|
|
**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')
|
|
|
|
.. _nova_interface-attach:
|
|
|
|
nova interface-attach
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
|
|
[--fixed-ip <fixed_ip>]
|
|
<server>
|
|
|
|
Attach a network interface to a server.
|
|
|
|
**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.
|
|
|
|
.. _nova_interface-detach:
|
|
|
|
nova interface-detach
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova interface-detach <server> <port_id>
|
|
|
|
Detach a network interface from a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<port_id>``
|
|
Port ID.
|
|
|
|
.. _nova_interface-list:
|
|
|
|
nova interface-list
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova interface-list <server>
|
|
|
|
List interfaces attached to a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_keypair-add:
|
|
|
|
nova keypair-add
|
|
----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
|
|
[--user <user-id>]
|
|
<name>
|
|
|
|
Create a new key pair for use with servers.
|
|
|
|
**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:
|
|
|
|
nova keypair-delete
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova keypair-delete [--user <user-id>] <name>
|
|
|
|
Delete keypair given by its name. (Supported by API versions '2.0' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for proper version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<name>``
|
|
Keypair name to delete.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--user <user-id>``
|
|
ID of key-pair owner (Admin only).
|
|
|
|
.. _nova_keypair-list:
|
|
|
|
nova keypair-list
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova keypair-list [--user <user-id>] [--marker <marker>]
|
|
[--limit <limit>]
|
|
|
|
Print a list of keypairs for a user (Supported by API versions '2.0' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--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 == -1,
|
|
all keypairs will be displayed. If limit is bigger than
|
|
'osapi_max_limit' option of Nova API, limit
|
|
'osapi_max_limit' will be used instead.
|
|
|
|
.. _nova_keypair-show:
|
|
|
|
nova keypair-show
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova keypair-show [--user <user-id>] <keypair>
|
|
|
|
Show details about the given keypair. (Supported by API versions '2.0' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--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:
|
|
|
|
nova limits
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova limits [--tenant [<tenant>]] [--reserved]
|
|
|
|
Print rate and absolute limits.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--tenant [<tenant>]``
|
|
Display information from single tenant (Admin only).
|
|
|
|
``--reserved``
|
|
Include reservations count.
|
|
|
|
.. _nova_list:
|
|
|
|
nova list
|
|
---------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>]
|
|
[--ip6 <ip6-regexp>] [--name <name-regexp>]
|
|
[--instance-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>] [--changes-since <changes_since>]
|
|
[--tags <tags>] [--tags-any <tags-any>]
|
|
[--not-tags <not-tags>] [--not-tags-any <not-tags-any>]
|
|
|
|
List active servers.
|
|
|
|
**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.
|
|
|
|
``--instance-name <name-regexp>``
|
|
Search with regular expression match by server
|
|
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).
|
|
|
|
``--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.
|
|
|
|
``--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 'osapi_max_limit' option of
|
|
Nova API, limit 'osapi_max_limit' will be used
|
|
instead.
|
|
|
|
``--changes-since <changes_since>``
|
|
List only servers changed after a certain
|
|
point of time.The provided time should be an
|
|
ISO 8061 formatted time.ex
|
|
2016-03-04T06:27:59Z .
|
|
|
|
``--tags <tags>``
|
|
The given tags must all be present for a
|
|
server to be included in the list result.
|
|
Boolean expression in this case is 't1 AND
|
|
t2'. Tags must be separated by commas: :option:`--tags`
|
|
<tag1,tag2> (Supported by API versions '2.26'
|
|
- '2.latest')
|
|
|
|
``--tags-any <tags-any>``
|
|
If one of the given tags is present the server
|
|
will be included in the list result. Boolean
|
|
expression in this case is 't1 OR t2'. Tags
|
|
must be separated by commas: :option:`--tags-any`
|
|
<tag1,tag2> (Supported by API versions '2.26'
|
|
- '2.latest')
|
|
|
|
``--not-tags <not-tags>``
|
|
Only the servers that do not have any of the
|
|
given tags willbe included in the list
|
|
results. Boolean expression in this case is
|
|
'NOT(t1 AND t2)'. Tags must be separated by
|
|
commas: :option:`--not-tags` <tag1,tag2> (Supported by
|
|
API versions '2.26' - '2.latest')
|
|
|
|
``--not-tags-any <not-tags-any>``
|
|
Only the servers that do not have at least one
|
|
of the given tagswill be included in the list
|
|
result. Boolean expression in this case is
|
|
'NOT(t1 OR t2)'. Tags must be separated by
|
|
commas: :option:`--not-tags-any` <tag1,tag2> (Supported
|
|
by API versions '2.26' - '2.latest')
|
|
|
|
.. _nova_list-extensions:
|
|
|
|
nova list-extensions
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova list-extensions
|
|
|
|
List all the os-api extensions that are available.
|
|
|
|
.. _nova_list-secgroup:
|
|
|
|
nova list-secgroup
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova list-secgroup <server>
|
|
|
|
List Security Group(s) of a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_live-migration:
|
|
|
|
nova live-migration
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova live-migration [--block-migrate] [--force] <server> [<host>]
|
|
|
|
Migrate running server to a new machine.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<host>``
|
|
Destination host name.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--block-migrate``
|
|
True in case of block_migration.
|
|
(Default=auto:live_migration) (Supported by API versions
|
|
'2.25' - '2.latest')
|
|
|
|
``--force``
|
|
Force to not verify the scheduler if a host is provided.
|
|
(Supported by API versions '2.30' - '2.latest')
|
|
|
|
.. _nova_live-migration-abort:
|
|
|
|
nova live-migration-abort
|
|
-------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova live-migration-abort <server> <migration>
|
|
|
|
Abort an on-going live migration. (Supported by API versions '2.24' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for proper version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<migration>``
|
|
ID of migration.
|
|
|
|
.. _nova_live-migration-force-complete:
|
|
|
|
nova live-migration-force-complete
|
|
----------------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova live-migration-force-complete <server> <migration>
|
|
|
|
Force on-going live migration to complete. (Supported by API versions '2.22' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for proper version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<migration>``
|
|
ID of migration.
|
|
|
|
.. _nova_lock:
|
|
|
|
nova lock
|
|
---------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova lock <server>
|
|
|
|
Lock a server. A normal (non-admin) user will not be able to execute actions
|
|
on a locked server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_meta:
|
|
|
|
nova meta
|
|
---------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova meta <server> <action> <key=value> [<key=value> ...]
|
|
|
|
Set or delete 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:
|
|
|
|
nova migrate
|
|
------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova migrate [--poll] <server>
|
|
|
|
Migrate a server. The new host will be selected by the scheduler.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--poll``
|
|
Report the server migration progress until it completes.
|
|
|
|
.. _nova_migration-list:
|
|
|
|
nova migration-list
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova migration-list [--host <host>] [--status <status>]
|
|
[--cell_name <cell_name>]
|
|
|
|
Print a list of migrations.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--host <host>``
|
|
Fetch migrations for the given host.
|
|
|
|
``--status <status>``
|
|
Fetch migrations for the given status.
|
|
|
|
``--cell_name <cell_name>``
|
|
Fetch migrations for the given cell_name.
|
|
|
|
.. _nova_pause:
|
|
|
|
nova pause
|
|
----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova pause <server>
|
|
|
|
Pause a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_quota-class-show:
|
|
|
|
nova quota-class-show
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova quota-class-show <class>
|
|
|
|
List the quotas for a quota class.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<class>``
|
|
Name of quota class to list the quotas for.
|
|
|
|
.. _nova_quota-class-update:
|
|
|
|
nova quota-class-update
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
|
|
[--ram <ram>]
|
|
[--metadata-items <metadata-items>]
|
|
[--injected-files <injected-files>]
|
|
[--injected-file-content-bytes <injected-file-content-bytes>]
|
|
[--injected-file-path-bytes <injected-file-path-bytes>]
|
|
[--key-pairs <key-pairs>]
|
|
[--server-groups <server-groups>]
|
|
[--server-group-members <server-group-members>]
|
|
<class>
|
|
|
|
Update the quotas for a quota class. (Supported by API versions '2.0' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--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.
|
|
|
|
``--injected-files <injected-files>``
|
|
New value for the "injected-files" quota.
|
|
|
|
``--injected-file-content-bytes <injected-file-content-bytes>``
|
|
New value for the "injected-file-content-bytes" quota.
|
|
|
|
``--injected-file-path-bytes <injected-file-path-bytes>``
|
|
New value for the "injected-file-path-bytes"
|
|
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:
|
|
|
|
nova quota-defaults
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova quota-defaults [--tenant <tenant-id>]
|
|
|
|
List the default quotas for a tenant.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--tenant <tenant-id>``
|
|
ID of tenant to list the default quotas for.
|
|
|
|
.. _nova_quota-delete:
|
|
|
|
nova quota-delete
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
|
|
|
|
Delete quota for a tenant/user so their quota will Revert back to default.
|
|
|
|
**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:
|
|
|
|
nova quota-show
|
|
---------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]
|
|
|
|
List the quotas for a tenant/user.
|
|
|
|
**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:
|
|
|
|
nova quota-update
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova quota-update [--user <user-id>] [--instances <instances>]
|
|
[--cores <cores>] [--ram <ram>]
|
|
[--metadata-items <metadata-items>]
|
|
[--injected-files <injected-files>]
|
|
[--injected-file-content-bytes <injected-file-content-bytes>]
|
|
[--injected-file-path-bytes <injected-file-path-bytes>]
|
|
[--key-pairs <key-pairs>]
|
|
[--server-groups <server-groups>]
|
|
[--server-group-members <server-group-members>]
|
|
[--force]
|
|
<tenant-id>
|
|
|
|
Update the quotas for a tenant/user. (Supported by API versions '2.0' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--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.
|
|
|
|
``--injected-files <injected-files>``
|
|
New value for the "injected-files" quota.
|
|
|
|
``--injected-file-content-bytes <injected-file-content-bytes>``
|
|
New value for the "injected-file-content-bytes" quota.
|
|
|
|
``--injected-file-path-bytes <injected-file-path-bytes>``
|
|
New value for the "injected-file-path-bytes"
|
|
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:
|
|
|
|
nova reboot
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova reboot [--hard] [--poll] <server> [<server> ...]
|
|
|
|
Reboot a server.
|
|
|
|
**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:
|
|
|
|
nova rebuild
|
|
------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
|
|
[--minimal] [--preserve-ephemeral] [--name <name>]
|
|
[--description <description>] [--meta <key=value>]
|
|
[--file <dst-path=src-path>]
|
|
<server> <image>
|
|
|
|
Shutdown, re-image, and re-boot a server.
|
|
|
|
**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.
|
|
|
|
``--file <dst-path=src-path>``
|
|
Store arbitrary files from <src-path> locally
|
|
to <dst-path> on the new server. You may store
|
|
up to 5 files.
|
|
|
|
.. _nova_refresh-network:
|
|
|
|
nova refresh-network
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova refresh-network <server>
|
|
|
|
Refresh server network information.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of a server for which the network cache should be
|
|
refreshed from neutron (Admin only).
|
|
|
|
.. _nova_remove-fixed-ip:
|
|
|
|
nova remove-fixed-ip
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova remove-fixed-ip <server> <address>
|
|
|
|
Remove an IP address from a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<address>``
|
|
IP Address.
|
|
|
|
.. _nova_remove-secgroup:
|
|
|
|
nova remove-secgroup
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova remove-secgroup <server> <secgroup>
|
|
|
|
Remove a Security Group from a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<secgroup>``
|
|
Name of Security Group.
|
|
|
|
.. _nova_rescue:
|
|
|
|
nova rescue
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
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.
|
|
|
|
**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:
|
|
|
|
nova reset-network
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova reset-network <server>
|
|
|
|
Reset network of a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_reset-state:
|
|
|
|
nova reset-state
|
|
----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]
|
|
|
|
Reset the state of a server.
|
|
|
|
**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:
|
|
|
|
nova resize
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova resize [--poll] <server> <flavor>
|
|
|
|
Resize a server.
|
|
|
|
**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:
|
|
|
|
nova resize-confirm
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova resize-confirm <server>
|
|
|
|
Confirm a previous resize.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_resize-revert:
|
|
|
|
nova resize-revert
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova resize-revert <server>
|
|
|
|
Revert a previous resize (and return to the previous VM).
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_restore:
|
|
|
|
nova restore
|
|
------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova restore <server>
|
|
|
|
Restore a soft-deleted server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_resume:
|
|
|
|
nova resume
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova resume <server>
|
|
|
|
Resume a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_server-group-create:
|
|
|
|
nova server-group-create
|
|
------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-group-create <name> [<policy> [<policy> ...]]
|
|
|
|
Create a new server group with the specified details.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<name>``
|
|
Server group name.
|
|
|
|
``<policy>``
|
|
Policies for the server groups.
|
|
|
|
.. _nova_server-group-delete:
|
|
|
|
nova server-group-delete
|
|
------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-group-delete <id> [<id> ...]
|
|
|
|
Delete specific server group(s).
|
|
|
|
**Positional arguments:**
|
|
|
|
``<id>``
|
|
Unique ID(s) of the server group to delete.
|
|
|
|
.. _nova_server-group-get:
|
|
|
|
nova server-group-get
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-group-get <id>
|
|
|
|
Get a specific server group.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<id>``
|
|
Unique ID of the server group to get.
|
|
|
|
.. _nova_server-group-list:
|
|
|
|
nova server-group-list
|
|
----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-group-list [--all-projects]
|
|
|
|
Print a list of all server groups.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--all-projects``
|
|
Display server groups from all projects (Admin only).
|
|
|
|
.. _nova_server-migration-list:
|
|
|
|
nova server-migration-list
|
|
--------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-migration-list <server>
|
|
|
|
Get the migrations list of specified server. (Supported by API versions '2.23'
|
|
-
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for proper version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_server-migration-show:
|
|
|
|
nova server-migration-show
|
|
--------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-migration-show <server> <migration>
|
|
|
|
Get the migration of specified server. (Supported by API versions '2.23' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for proper version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<migration>``
|
|
ID of migration.
|
|
|
|
.. _nova_server-tag-add:
|
|
|
|
nova server-tag-add
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-tag-add <server> <tag>
|
|
|
|
Add single tag to a server. (Supported by API versions '2.26' - '2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for
|
|
proper
|
|
version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<tag>``
|
|
Tag to add.
|
|
|
|
.. _nova_server-tag-delete:
|
|
|
|
nova server-tag-delete
|
|
----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-tag-delete <server> <tag>
|
|
|
|
Delete single tag from a server. (Supported by API versions '2.26' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for proper version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<tag>``
|
|
Tag to delete.
|
|
|
|
.. _nova_server-tag-delete-all:
|
|
|
|
nova server-tag-delete-all
|
|
--------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-tag-delete-all <server>
|
|
|
|
Delete all tags from a server. (Supported by API versions '2.26' - '2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for
|
|
proper
|
|
version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_server-tag-list:
|
|
|
|
nova server-tag-list
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-tag-list <server>
|
|
|
|
Get list of tags from a server. (Supported by API versions '2.26' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for proper version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_server-tag-set:
|
|
|
|
nova server-tag-set
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova server-tag-set <server> <tags> [<tags> ...]
|
|
|
|
Set list of tags to a server. (Supported by API versions '2.26' - '2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for
|
|
proper
|
|
version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<tags>``
|
|
Tag(s) to set.
|
|
|
|
.. _nova_service-delete:
|
|
|
|
nova service-delete
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova service-delete <id>
|
|
|
|
Delete the service.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<id>``
|
|
ID of service.
|
|
|
|
.. _nova_service-disable:
|
|
|
|
nova service-disable
|
|
--------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova service-disable [--reason <reason>] <hostname> <binary>
|
|
|
|
Disable the service.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<hostname>``
|
|
Name of host.
|
|
|
|
``<binary>``
|
|
Service binary.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--reason <reason>``
|
|
Reason for disabling service.
|
|
|
|
.. _nova_service-enable:
|
|
|
|
nova service-enable
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova service-enable <hostname> <binary>
|
|
|
|
Enable the service.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<hostname>``
|
|
Name of host.
|
|
|
|
``<binary>``
|
|
Service binary.
|
|
|
|
.. _nova_service-force-down:
|
|
|
|
nova service-force-down
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova service-force-down [--unset] <hostname> <binary>
|
|
|
|
Force service to down. (Supported by API versions '2.11' - '2.latest') [hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for
|
|
proper
|
|
version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<hostname>``
|
|
Name of host.
|
|
|
|
``<binary>``
|
|
Service binary.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--unset``
|
|
Unset the force state down of service.
|
|
|
|
.. _nova_service-list:
|
|
|
|
nova service-list
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova service-list [--host <hostname>] [--binary <binary>]
|
|
|
|
Show a list of all running services. Filter by host & binary.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--host <hostname>``
|
|
Name of host.
|
|
|
|
``--binary <binary>``
|
|
Service binary.
|
|
|
|
.. _nova_set-password:
|
|
|
|
nova set-password
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova set-password <server>
|
|
|
|
Change the admin password for a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_shelve:
|
|
|
|
nova shelve
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova shelve <server>
|
|
|
|
Shelve a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_shelve-offload:
|
|
|
|
nova shelve-offload
|
|
-------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova shelve-offload <server>
|
|
|
|
Remove a shelved server from the compute node.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_show:
|
|
|
|
nova show
|
|
---------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova show [--minimal] <server>
|
|
|
|
Show details about the given server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--minimal``
|
|
Skips flavor/image lookups when showing servers.
|
|
|
|
.. _nova_ssh:
|
|
|
|
nova ssh
|
|
--------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE]
|
|
[--network <network>] [--ipv6] [--login <login>] [-i IDENTITY]
|
|
[--extra-opts EXTRA]
|
|
<server>
|
|
|
|
SSH into a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--port PORT``
|
|
Optional flag to indicate which port to use
|
|
for ssh. (Default=22)
|
|
|
|
``--address-type ADDRESS_TYPE``
|
|
Optional flag to indicate which IP type to
|
|
use. Possible values includes fixed and
|
|
floating (the Default).
|
|
|
|
``--network <network>``
|
|
Network to use for the ssh.
|
|
|
|
``--ipv6``
|
|
Optional flag to indicate whether to use an
|
|
IPv6 address attached to a server. (Defaults
|
|
to IPv4 address)
|
|
|
|
``--login <login>``
|
|
Login to use.
|
|
|
|
``-i IDENTITY, --identity IDENTITY``
|
|
Private key file, same as the -i option to the
|
|
ssh command.
|
|
|
|
``--extra-opts EXTRA``
|
|
Extra options to pass to ssh. see: man ssh.
|
|
|
|
.. _nova_start:
|
|
|
|
nova start
|
|
----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova start [--all-tenants] <server> [<server> ...]
|
|
|
|
Start the server(s).
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server(s).
|
|
|
|
**Optional arguments:**
|
|
|
|
``--all-tenants``
|
|
Start server(s) in another tenant by name (Admin only).
|
|
|
|
.. _nova_stop:
|
|
|
|
nova stop
|
|
---------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova stop [--all-tenants] <server> [<server> ...]
|
|
|
|
Stop the server(s).
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server(s).
|
|
|
|
**Optional arguments:**
|
|
|
|
``--all-tenants``
|
|
Stop server(s) in another tenant by name (Admin only).
|
|
|
|
.. _nova_suspend:
|
|
|
|
nova suspend
|
|
------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova suspend <server>
|
|
|
|
Suspend a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_trigger-crash-dump:
|
|
|
|
nova trigger-crash-dump
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova trigger-crash-dump <server>
|
|
|
|
Trigger crash dump in an instance. (Supported by API versions '2.17' -
|
|
'2.latest')
|
|
[hint:
|
|
use
|
|
':option:`--os-compute-api-version`'
|
|
flag
|
|
to
|
|
show
|
|
help
|
|
message
|
|
for proper version]
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_unlock:
|
|
|
|
nova unlock
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova unlock <server>
|
|
|
|
Unlock a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_unpause:
|
|
|
|
nova unpause
|
|
------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova unpause <server>
|
|
|
|
Unpause a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_unrescue:
|
|
|
|
nova unrescue
|
|
-------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova unrescue <server>
|
|
|
|
Restart the server from normal boot disk again.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_unshelve:
|
|
|
|
nova unshelve
|
|
-------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova unshelve <server>
|
|
|
|
Unshelve a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_update:
|
|
|
|
nova update
|
|
-----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova update [--name <name>] [--description <description>] <server>
|
|
|
|
Update the name or the description for a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name (old name) or ID of server.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--name <name>``
|
|
New name for the server.
|
|
|
|
``--description <description>``
|
|
New description for the server. If it equals to
|
|
empty string (i.g. ""), the server description
|
|
will be removed. (Supported by API versions
|
|
'2.19' - '2.latest')
|
|
|
|
.. _nova_usage:
|
|
|
|
nova usage
|
|
----------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
|
|
|
|
Show usage data for a single tenant.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--start <start>``
|
|
Usage range start date ex 2012-01-20. (default: 4
|
|
weeks ago)
|
|
|
|
``--end <end>``
|
|
Usage range end date, ex 2012-01-20. (default:
|
|
tomorrow)
|
|
|
|
``--tenant <tenant-id>``
|
|
UUID of tenant to get usage for.
|
|
|
|
.. _nova_usage-list:
|
|
|
|
nova usage-list
|
|
---------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova usage-list [--start <start>] [--end <end>]
|
|
|
|
List usage data for all tenants.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--start <start>``
|
|
Usage range start date ex 2012-01-20. (default: 4 weeks
|
|
ago)
|
|
|
|
``--end <end>``
|
|
Usage range end date, ex 2012-01-20. (default: tomorrow)
|
|
|
|
.. _nova_version-list:
|
|
|
|
nova version-list
|
|
-----------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova version-list
|
|
|
|
List all API versions.
|
|
|
|
.. _nova_virtual-interface-list:
|
|
|
|
nova virtual-interface-list
|
|
---------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova virtual-interface-list <server>
|
|
|
|
Show virtual interface info about the given server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
ID of server.
|
|
|
|
.. _nova_volume-attach:
|
|
|
|
nova volume-attach
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova volume-attach <server> <volume> [<device>]
|
|
|
|
Attach a volume to a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<volume>``
|
|
ID of the volume to attach.
|
|
|
|
``<device>``
|
|
Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if
|
|
supported). Libvirt driver will use default device name.
|
|
|
|
.. _nova_volume-attachments:
|
|
|
|
nova volume-attachments
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova volume-attachments <server>
|
|
|
|
List all the volumes attached to a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
.. _nova_volume-detach:
|
|
|
|
nova volume-detach
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova volume-detach <server> <volume>
|
|
|
|
Detach a volume from a server.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<volume>``
|
|
ID of the volume to detach.
|
|
|
|
.. _nova_volume-update:
|
|
|
|
nova volume-update
|
|
------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova volume-update <server> <attachment> <volume>
|
|
|
|
Update volume attachment.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<server>``
|
|
Name or ID of server.
|
|
|
|
``<attachment>``
|
|
Attachment ID of the volume.
|
|
|
|
``<volume>``
|
|
ID of the volume to attach.
|
|
|
|
.. _nova_x509-create-cert:
|
|
|
|
nova x509-create-cert
|
|
---------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova x509-create-cert [<private-key-filename>] [<x509-cert-filename>]
|
|
|
|
Create x509 cert for a user in tenant.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<private-key-filename>``
|
|
Filename for the private key. [Default: pk.pem]
|
|
|
|
``<x509-cert-filename>``
|
|
Filename for the X.509 certificate. [Default:
|
|
cert.pem]
|
|
|
|
.. _nova_x509-get-root-cert:
|
|
|
|
nova x509-get-root-cert
|
|
-----------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: nova x509-get-root-cert [<filename>]
|
|
|
|
Fetch the x509 root cert.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<filename>``
|
|
Filename to write the x509 root cert.
|
|
|