6dd9a49851
Change-Id: I88e799d0834781625fd5aac2f4bd1acf92e56f06
7256 lines
205 KiB
XML
7256 lines
205 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="novaclient_commands">
|
|
|
|
<!-- This file is automatically generated, do not edit -->
|
|
|
|
<?dbhtml stop-chunking?>
|
|
|
|
<title>Compute command-line client</title>
|
|
|
|
<para>The <command>nova</command> client is the command-line
|
|
interface (CLI) for the OpenStack Compute API and its extensions.
|
|
|
|
This chapter documents <command>nova</command> version
|
|
<literal>2.20.0</literal>.
|
|
</para>
|
|
|
|
<para>For help on a specific <command>nova</command>
|
|
command, enter:
|
|
</para>
|
|
<screen><prompt>$</prompt> <userinput><command>nova</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
|
|
<section xml:id="novaclient_command_usage">
|
|
<title>nova usage</title>
|
|
<screen><computeroutput>usage: nova [--version] [--debug] [--os-cache] [--timings]
|
|
[--timeout <seconds>] [--os-auth-token OS_AUTH_TOKEN]
|
|
[--os-username <auth-user-name>] [--os-user-id <auth-user-id>]
|
|
[--os-password <auth-password>]
|
|
[--os-tenant-name <auth-tenant-name>]
|
|
[--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
|
|
[--os-region-name <region-name>] [--os-auth-system <auth-system>]
|
|
[--service-type <service-type>] [--service-name <service-name>]
|
|
[--volume-service-name <volume-service-name>]
|
|
[--endpoint-type <endpoint-type>]
|
|
[--os-compute-api-version <compute-api-ver>]
|
|
[--os-cacert <ca-certificate>] [--insecure]
|
|
[--bypass-url <bypass-url>]
|
|
<subcommand> ...</computeroutput></screen>
|
|
<variablelist wordsize="10">
|
|
<title>Subcommands</title>
|
|
<varlistentry>
|
|
<term><command>absolute-limits</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of absolute limits for a user
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>add-fixed-ip</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add new IP address on a network to server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>add-floating-ip</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED</emphasis>, use floating-ip-associate instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>add-secgroup</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a Security Group to a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>agent-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create new agent build.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>agent-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete existing agent build.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>agent-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all builds.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>agent-modify</command></term>
|
|
<listitem>
|
|
<para>
|
|
Modify existing agent build.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>aggregate-add-host</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add the host to the specified aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>aggregate-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new aggregate with the specified
|
|
details.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>aggregate-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete the aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>aggregate-details</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details of the specified aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>aggregate-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of all aggregates.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>aggregate-remove-host</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove the specified host from the specified
|
|
aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>aggregate-set-metadata</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update the metadata associated with the
|
|
aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>aggregate-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update the aggregate's name and optionally
|
|
availability zone.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>availability-zone-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all the availability zones.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>backup</command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup a server by creating a 'backup' type
|
|
snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>boot</command></term>
|
|
<listitem>
|
|
<para>
|
|
Boot a new server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>clear-password</command></term>
|
|
<listitem>
|
|
<para>
|
|
Clear password for a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cloudpipe-configure</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update the VPN IP/port of a cloudpipe
|
|
instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cloudpipe-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a cloudpipe instance for the given
|
|
project.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cloudpipe-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of all cloudpipe instances.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>console-log</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get console log output of a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>credentials</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show user credentials returned from auth.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Immediately shut down and delete specified
|
|
server(s).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>diagnostics</command></term>
|
|
<listitem>
|
|
<para>
|
|
Retrieve server diagnostics.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dns-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a DNS entry for domain, name and ip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dns-create-private-domain</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create the specified DNS domain.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dns-create-public-domain</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create the specified DNS domain.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dns-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete the specified DNS entry.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dns-delete-domain</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete the specified DNS domain.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dns-domains</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of available dns domains.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>dns-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List current DNS entries for domain and ip or
|
|
domain and name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>endpoints</command></term>
|
|
<listitem>
|
|
<para>
|
|
Discover endpoints that get returned from the
|
|
authenticate services.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>evacuate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Evacuate server from failed host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>fixed-ip-get</command></term>
|
|
<listitem>
|
|
<para>
|
|
Retrieve info on a fixed ip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>fixed-ip-reserve</command></term>
|
|
<listitem>
|
|
<para>
|
|
Reserve a fixed IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>fixed-ip-unreserve</command></term>
|
|
<listitem>
|
|
<para>
|
|
Unreserve a fixed IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>flavor-access-add</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add flavor access for the given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>flavor-access-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print access information about the given
|
|
flavor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>flavor-access-remove</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove flavor access for the given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>flavor-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>flavor-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a specific flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>flavor-key</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set or unset extra_spec for a flavor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>flavor-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of available 'flavors' (sizes of
|
|
servers).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>flavor-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given flavor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floating-ip-associate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Associate a floating IP address to a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floating-ip-bulk-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Bulk create floating ips by range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floating-ip-bulk-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Bulk delete floating ips by range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floating-ip-bulk-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all floating ips.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floating-ip-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allocate a floating IP for the current tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floating-ip-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
De-allocate a floating IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floating-ip-disassociate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disassociate a floating IP address from a
|
|
server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floating-ip-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List floating ips.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>floating-ip-pool-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all floating ip pools.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>get-password</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get password for a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>get-rdp-console</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get a rdp console to a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>get-serial-console</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get a serial console to a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>get-spice-console</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get a spice console to a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>get-vnc-console</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get a vnc console to a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>host-action</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a power action on a host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>host-describe</command></term>
|
|
<listitem>
|
|
<para>
|
|
Describe a specific host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>host-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all hosts by service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>host-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update host settings.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>hypervisor-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List hypervisors.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>hypervisor-servers</command></term>
|
|
<listitem>
|
|
<para>
|
|
List servers belonging to specific
|
|
hypervisors.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>hypervisor-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display the details of the specified
|
|
hypervisor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>hypervisor-stats</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get hypervisor statistics over all compute
|
|
nodes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>hypervisor-uptime</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display the uptime of the specified
|
|
hypervisor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>image-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new image by taking a snapshot of a
|
|
running server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>image-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete specified image(s).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>image-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of available images to boot from.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>image-meta</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set or Delete metadata on an image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>image-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>interface-attach</command></term>
|
|
<listitem>
|
|
<para>
|
|
Attach a network interface to a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>interface-detach</command></term>
|
|
<listitem>
|
|
<para>
|
|
Detach a network interface from a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>interface-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List interfaces attached to a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>keypair-add</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new key pair for use with servers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>keypair-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete keypair given by its name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>keypair-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of keypairs for a user
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>keypair-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given keypair.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List active servers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>list-secgroup</command></term>
|
|
<listitem>
|
|
<para>
|
|
List Security Group(s) of a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>live-migration</command></term>
|
|
<listitem>
|
|
<para>
|
|
Migrate running server to a new machine.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>lock</command></term>
|
|
<listitem>
|
|
<para>
|
|
Lock a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meta</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set or Delete metadata on a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>migrate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Migrate a server. The new host will be
|
|
selected by the scheduler.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>network-associate-host</command></term>
|
|
<listitem>
|
|
<para>
|
|
Associate host with network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>network-associate-project</command></term>
|
|
<listitem>
|
|
<para>
|
|
Associate project with network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>network-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>network-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete network by label or id.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>network-disassociate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disassociate host and/or project from the
|
|
given network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>network-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of available networks.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>network-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given network.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>pause</command></term>
|
|
<listitem>
|
|
<para>
|
|
Pause a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-class-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the quotas for a quota class.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-class-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update the quotas for a quota class.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-defaults</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the default quotas for a tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete quota for a tenant/user so their quota
|
|
will Revert back to default.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the quotas for a tenant/user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>quota-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update the quotas for a tenant/user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rate-limits</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of rate limits for a user
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>reboot</command></term>
|
|
<listitem>
|
|
<para>
|
|
Reboot a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rebuild</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shutdown, re-image, and re-boot a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>refresh-network</command></term>
|
|
<listitem>
|
|
<para>
|
|
Refresh server network information.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>remove-fixed-ip</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove an IP address from a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>remove-floating-ip</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED</emphasis>, use floating-ip-disassociate
|
|
instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>remove-secgroup</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a Security Group from a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rename</command></term>
|
|
<listitem>
|
|
<para>
|
|
Rename a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>rescue</command></term>
|
|
<listitem>
|
|
<para>
|
|
Reboots a server into rescue mode, which
|
|
starts the machine from the initial image,
|
|
attaching the current boot disk as secondary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>reset-network</command></term>
|
|
<listitem>
|
|
<para>
|
|
Reset network of a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>reset-state</command></term>
|
|
<listitem>
|
|
<para>
|
|
Reset the state of a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resize</command></term>
|
|
<listitem>
|
|
<para>
|
|
Resize a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resize-confirm</command></term>
|
|
<listitem>
|
|
<para>
|
|
Confirm a previous resize.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resize-revert</command></term>
|
|
<listitem>
|
|
<para>
|
|
Revert a previous resize (and return to the
|
|
previous VM).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resume</command></term>
|
|
<listitem>
|
|
<para>
|
|
Resume a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>root-password</command></term>
|
|
<listitem>
|
|
<para>
|
|
Change the root password for a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>scrub</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete data associated with the project.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-add-default-rule</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a rule to the default security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-add-group-rule</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a source group rule to a security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-add-rule</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a rule to a security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-delete-default-rule</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a rule from the default security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-delete-group-rule</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a source group rule from a security
|
|
group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-delete-rule</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a rule from a security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List security groups for the current tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-list-default-rules</command></term>
|
|
<listitem>
|
|
<para>
|
|
List rules for the default security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-list-rules</command></term>
|
|
<listitem>
|
|
<para>
|
|
List rules for a security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>secgroup-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update a security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>server-group-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new server group with the specified
|
|
details.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>server-group-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete specific server group(s).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>server-group-get</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get a specific server group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>server-group-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of all server groups.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete the service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable the service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable the service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>service-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show a list of all running services. Filter by
|
|
host & binary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>shelve</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shelve a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>shelve-offload</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a shelved server from the compute node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about the given server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>ssh</command></term>
|
|
<listitem>
|
|
<para>
|
|
SSH into a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>start</command></term>
|
|
<listitem>
|
|
<para>
|
|
Start a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>stop</command></term>
|
|
<listitem>
|
|
<para>
|
|
Stop a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>suspend</command></term>
|
|
<listitem>
|
|
<para>
|
|
Suspend a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>unlock</command></term>
|
|
<listitem>
|
|
<para>
|
|
Unlock a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>unpause</command></term>
|
|
<listitem>
|
|
<para>
|
|
Unpause a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>unrescue</command></term>
|
|
<listitem>
|
|
<para>
|
|
Restart the server from normal boot disk
|
|
again.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>unshelve</command></term>
|
|
<listitem>
|
|
<para>
|
|
Unshelve a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>usage</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show usage data for a single tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>usage-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List usage data for all tenants.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>version-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all API versions.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-attach</command></term>
|
|
<listitem>
|
|
<para>
|
|
Attach a volume to a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a new volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove volume(s).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-detach</command></term>
|
|
<listitem>
|
|
<para>
|
|
Detach a volume from a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all the volumes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about a volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-snapshot-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a new snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-snapshot-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-snapshot-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all the snapshots.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-snapshot-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details about a snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-type-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-type-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a specific volume type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-type-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of available 'volume types'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>volume-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update volume attachment.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>x509-create-cert</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create x509 cert for a user in tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>x509-get-root-cert</command></term>
|
|
<listitem>
|
|
<para>
|
|
Fetch the x509 root cert.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>bash-completion</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prints all of the commands and options to
|
|
stdout so that the nova.bash_completion script
|
|
doesn't have to hard code them.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>help</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display help about this program or one of its
|
|
subcommands.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>force-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Force delete a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>restore</command></term>
|
|
<listitem>
|
|
<para>
|
|
Restore a soft-deleted server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show a network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete a network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>net-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List networks
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baremetal-interface-add</command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a network interface to a baremetal node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baremetal-interface-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List network interfaces associated with a
|
|
baremetal node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baremetal-interface-remove</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a network interface from a baremetal
|
|
node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baremetal-node-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a baremetal node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baremetal-node-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Remove a baremetal node and any associated
|
|
interfaces.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baremetal-node-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print list of available baremetal nodes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>baremetal-node-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show information about a baremetal node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>host-evacuate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Evacuate all instances from failed host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>instance-action</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show an action.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>instance-action-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List actions on a server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>migration-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print a list of migrations.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>host-servers-migrate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Migrate all instances of the specified host to
|
|
other available hosts.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cell-capacities</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get cell capacities for all cells or a given
|
|
cell.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>cell-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show details of a given cell.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>host-meta</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set or Delete metadata on all instances of a
|
|
host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>list-extensions</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all the os-api extensions that are
|
|
available.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_command_optional">
|
|
<title>nova optional arguments</title>
|
|
<variablelist wordsize="10">
|
|
<varlistentry>
|
|
<term><command>--version</command></term>
|
|
<listitem>
|
|
<para>
|
|
show program's version number and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--debug</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print debugging output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cache</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use the auth token cache. Defaults to False if
|
|
<code>env[OS_CACHE]</code> is not set.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--timings</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print call timing info
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--timeout <seconds></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set HTTP call timeout (in seconds)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-token OS_AUTH_TOKEN</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_TOKEN]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-username <auth-user-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USERNAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-id <auth-user-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USER_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-password <auth-password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PASSWORD]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-name <auth-tenant-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-id <auth-tenant-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-url <auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_URL]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-region-name <region-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_REGION_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-system <auth-system></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_SYSTEM]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-type <service-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to compute for most actions
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-name <service-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[NOVA_SERVICE_NAME]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-service-name <volume-service-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[NOVA_VOLUME_SERVICE_NAME]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--endpoint-type <endpoint-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[NOVA_ENDPOINT_TYPE]</code> or
|
|
publicURL.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-compute-api-version <compute-api-ver></command></term>
|
|
<listitem>
|
|
<para>
|
|
Accepts 1.1 or 3, defaults to
|
|
<code>env[OS_COMPUTE_API_VERSION]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cacert <ca-certificate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify a CA bundle file to use in verifying a
|
|
TLS (https) server certificate. Defaults to
|
|
<code>env[OS_CACERT]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--insecure</command></term>
|
|
<listitem>
|
|
<para>
|
|
Explicitly allow novaclient to perform
|
|
"insecure" SSL (https) requests. The server's
|
|
certificate will not be verified against any
|
|
certificate authorities. This option should be
|
|
used with caution.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bypass-url <bypass-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use this API endpoint instead of the Service
|
|
Catalog. Defaults to
|
|
<code>env[NOVACLIENT_BYPASS_URL]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_absolute-limits">
|
|
<title>nova absolute-limits</title>
|
|
<screen><computeroutput>usage: nova absolute-limits [--tenant [<tenant>]] [--reserved]</computeroutput></screen>
|
|
<para>
|
|
Print a list of absolute limits for a user
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--tenant [<tenant>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display information from single tenant (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--reserved</command></term>
|
|
<listitem>
|
|
<para>
|
|
Include reservations count.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_add-fixed-ip">
|
|
<title>nova add-fixed-ip</title>
|
|
<screen><computeroutput>usage: nova add-fixed-ip <server> <network-id></computeroutput></screen>
|
|
<para>
|
|
Add new IP address on a network to server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><network-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_add-secgroup">
|
|
<title>nova add-secgroup</title>
|
|
<screen><computeroutput>usage: nova add-secgroup <server> <secgroup></computeroutput></screen>
|
|
<para>
|
|
Add a Security Group to a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><secgroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of Security Group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_agent-create">
|
|
<title>nova agent-create</title>
|
|
<screen><computeroutput>usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
|
|
<hypervisor></computeroutput></screen>
|
|
<para>
|
|
Create new agent build.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><os></command></term>
|
|
<listitem>
|
|
<para>
|
|
type of os.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><architecture></command></term>
|
|
<listitem>
|
|
<para>
|
|
type of architecture
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><version></command></term>
|
|
<listitem>
|
|
<para>
|
|
version
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><url></command></term>
|
|
<listitem>
|
|
<para>
|
|
url
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><md5hash></command></term>
|
|
<listitem>
|
|
<para>
|
|
md5 hash
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><hypervisor></command></term>
|
|
<listitem>
|
|
<para>
|
|
type of hypervisor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_agent-delete">
|
|
<title>nova agent-delete</title>
|
|
<screen><computeroutput>usage: nova agent-delete <id></computeroutput></screen>
|
|
<para>
|
|
Delete existing agent build.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
id of the agent-build
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_agent-list">
|
|
<title>nova agent-list</title>
|
|
<screen><computeroutput>usage: nova agent-list [--hypervisor <hypervisor>]</computeroutput></screen>
|
|
<para>
|
|
List all builds.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--hypervisor <hypervisor></command></term>
|
|
<listitem>
|
|
<para>
|
|
type of hypervisor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_agent-modify">
|
|
<title>nova agent-modify</title>
|
|
<screen><computeroutput>usage: nova agent-modify <id> <version> <url> <md5hash></computeroutput></screen>
|
|
<para>
|
|
Modify existing agent build.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
id of the agent-build
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><version></command></term>
|
|
<listitem>
|
|
<para>
|
|
version
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><url></command></term>
|
|
<listitem>
|
|
<para>
|
|
url
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><md5hash></command></term>
|
|
<listitem>
|
|
<para>
|
|
md5hash
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-add-host">
|
|
<title>nova aggregate-add-host</title>
|
|
<screen><computeroutput>usage: nova aggregate-add-host <aggregate> <host></computeroutput></screen>
|
|
<para>
|
|
Add the host to the specified aggregate.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
The host to add to the aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-create">
|
|
<title>nova aggregate-create</title>
|
|
<screen><computeroutput>usage: nova aggregate-create <name> [<availability-zone>]</computeroutput></screen>
|
|
<para>
|
|
Create a new aggregate with the specified details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
The availability zone of the aggregate (optional).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-delete">
|
|
<title>nova aggregate-delete</title>
|
|
<screen><computeroutput>usage: nova aggregate-delete <aggregate></computeroutput></screen>
|
|
<para>
|
|
Delete the aggregate.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of aggregate to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-details">
|
|
<title>nova aggregate-details</title>
|
|
<screen><computeroutput>usage: nova aggregate-details <aggregate></computeroutput></screen>
|
|
<para>
|
|
Show details of the specified aggregate.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-list">
|
|
<title>nova aggregate-list</title>
|
|
<screen><computeroutput>usage: nova aggregate-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of all aggregates.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-remove-host">
|
|
<title>nova aggregate-remove-host</title>
|
|
<screen><computeroutput>usage: nova aggregate-remove-host <aggregate> <host></computeroutput></screen>
|
|
<para>
|
|
Remove the specified host from the specified aggregate.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
The host to remove from the aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-set-metadata">
|
|
<title>nova aggregate-set-metadata</title>
|
|
<screen><computeroutput>usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Update the metadata associated with the aggregate.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of aggregate to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata to add/update to aggregate. Specify only the key to
|
|
delete a metadata item.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-update">
|
|
<title>nova aggregate-update</title>
|
|
<screen><computeroutput>usage: nova aggregate-update <aggregate> <name> [<availability-zone>]</computeroutput></screen>
|
|
<para>
|
|
Update the aggregate's name and optionally availability zone.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of aggregate to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
The availability zone of the aggregate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_availability-zone-list">
|
|
<title>nova availability-zone-list</title>
|
|
<screen><computeroutput>usage: nova availability-zone-list</computeroutput></screen>
|
|
<para>
|
|
List all the availability zones.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_backup">
|
|
<title>nova backup</title>
|
|
<screen><computeroutput>usage: nova backup <server> <name> <backup-type> <rotation></computeroutput></screen>
|
|
<para>
|
|
Backup a server by creating a 'backup' type snapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the backup image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><backup-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
The backup type, like "daily" or "weekly".
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><rotation></command></term>
|
|
<listitem>
|
|
<para>
|
|
Int parameter representing how many backups to keep around.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_baremetal-interface-add">
|
|
<title>nova baremetal-interface-add</title>
|
|
<screen><computeroutput>usage: nova baremetal-interface-add [--datapath_id <datapath_id>]
|
|
[--port_no <port_no>]
|
|
<node> <address></computeroutput></screen>
|
|
<para>
|
|
Add a network interface to a baremetal node.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><node></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><address></command></term>
|
|
<listitem>
|
|
<para>
|
|
MAC address of interface
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--datapath_id <datapath_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
OpenFlow Datapath ID of interface
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--port_no <port_no></command></term>
|
|
<listitem>
|
|
<para>
|
|
OpenFlow port number of interface
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_baremetal-interface-list">
|
|
<title>nova baremetal-interface-list</title>
|
|
<screen><computeroutput>usage: nova baremetal-interface-list <node></computeroutput></screen>
|
|
<para>
|
|
List network interfaces associated with a baremetal node.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><node></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_baremetal-interface-remove">
|
|
<title>nova baremetal-interface-remove</title>
|
|
<screen><computeroutput>usage: nova baremetal-interface-remove <node> <address></computeroutput></screen>
|
|
<para>
|
|
Remove a network interface from a baremetal node.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><node></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><address></command></term>
|
|
<listitem>
|
|
<para>
|
|
MAC address of interface
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_baremetal-node-create">
|
|
<title>nova baremetal-node-create</title>
|
|
<screen><computeroutput>usage: nova baremetal-node-create [--pm_address <pm_address>]
|
|
[--pm_user <pm_user>]
|
|
[--pm_password <pm_password>]
|
|
[--terminal_port <terminal_port>]
|
|
<service_host> <cpus> <memory_mb> <local_gb>
|
|
<prov_mac_address></computeroutput></screen>
|
|
<para>
|
|
Create a baremetal node.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service_host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of nova compute host which will control
|
|
this baremetal node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><cpus></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of CPUs in the node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><memory_mb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Megabytes of RAM in the node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><local_gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Gigabytes of local storage in the node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><prov_mac_address></command></term>
|
|
<listitem>
|
|
<para>
|
|
MAC address to provision the node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--pm_address <pm_address></command></term>
|
|
<listitem>
|
|
<para>
|
|
Power management IP for the node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--pm_user <pm_user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Username for the node's power management
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--pm_password <pm_password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Password for the node's power management
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--terminal_port <terminal_port></command></term>
|
|
<listitem>
|
|
<para>
|
|
ShellInABox port?
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_baremetal-node-delete">
|
|
<title>nova baremetal-node-delete</title>
|
|
<screen><computeroutput>usage: nova baremetal-node-delete <node></computeroutput></screen>
|
|
<para>
|
|
Remove a baremetal node and any associated interfaces.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><node></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the node to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_baremetal-node-list">
|
|
<title>nova baremetal-node-list</title>
|
|
<screen><computeroutput>usage: nova baremetal-node-list</computeroutput></screen>
|
|
<para>
|
|
Print list of available baremetal nodes.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_baremetal-node-show">
|
|
<title>nova baremetal-node-show</title>
|
|
<screen><computeroutput>usage: nova baremetal-node-show <node></computeroutput></screen>
|
|
<para>
|
|
Show information about a baremetal node.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><node></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of node
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_boot">
|
|
<title>nova boot</title>
|
|
<screen><computeroutput>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 <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>]
|
|
[--config-drive <value>] [--poll]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Boot a new server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name for the new server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--flavor <flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of flavor (see 'nova flavor-list').
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of image (see 'nova image-list').
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image-with <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image metadata property (see 'nova image-
|
|
show').
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--boot-volume <volume_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume ID to boot from.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshot <snapshot_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot ID to boot from (will create a
|
|
volume).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-count <number></command></term>
|
|
<listitem>
|
|
<para>
|
|
Boot at least <number> servers (limited by
|
|
quota).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--max-count <number></command></term>
|
|
<listitem>
|
|
<para>
|
|
Boot up to <number> servers (limited by
|
|
quota).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--meta <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Record arbitrary key/value metadata to
|
|
/meta.js on the new server. Can be specified
|
|
multiple times.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <dst-path=src-path></command></term>
|
|
<listitem>
|
|
<para>
|
|
Store arbitrary files from <src-path> locally
|
|
to <dst-path> on the new server. You may store
|
|
up to 5 files.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key-name <key-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Key name of keypair that should be created
|
|
earlier with the command keypair-add
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-data <user-data></command></term>
|
|
<listitem>
|
|
<para>
|
|
user data file to pass to be exposed by the
|
|
metadata server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
The availability zone for server placement.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-groups <security-groups></command></term>
|
|
<listitem>
|
|
<para>
|
|
Comma separated list of security group names.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--block-device-mapping <dev-name=mapping></command></term>
|
|
<listitem>
|
|
<para>
|
|
Block device mapping in the format <dev-
|
|
name>=<id>:<type>:<size(GB)>:<delete-on-
|
|
terminate>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--block-device</command></term>
|
|
<listitem>
|
|
<para>
|
|
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, ...; if omitted, hypervisor
|
|
driver chooses suitable device depending on
|
|
selected bus), size=size of the block device
|
|
in GB (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).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--swap <swap_size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create and attach a local swap block device of
|
|
<swap_size> MB.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ephemeral</command></term>
|
|
<listitem>
|
|
<para>
|
|
size=<size>[,format=<format>]
|
|
Create and attach a local ephemeral block
|
|
device of <size> GB and format it to <format>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--hint <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Send arbitrary key/value pairs to the
|
|
scheduler for custom use.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a NIC on the server. Specify option
|
|
multiple times to create multiple NICs. net-
|
|
id: attach NIC to network with this UUID
|
|
(either port-id or net-id 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 (either port-id or net-id
|
|
must be provided).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--config-drive <value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable config drive
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--poll</command></term>
|
|
<listitem>
|
|
<para>
|
|
Report the new server boot progress until it
|
|
completes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_cell-capacities">
|
|
<title>nova cell-capacities</title>
|
|
<screen><computeroutput>usage: nova cell-capacities [--cell <cell-name>]</computeroutput></screen>
|
|
<para>
|
|
Get cell capacities for all cells or a given cell.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--cell <cell-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the cell to get the capacities.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_cell-show">
|
|
<title>nova cell-show</title>
|
|
<screen><computeroutput>usage: nova cell-show <cell-name></computeroutput></screen>
|
|
<para>
|
|
Show details of a given cell.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><cell-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the cell.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_clear-password">
|
|
<title>nova clear-password</title>
|
|
<screen><computeroutput>usage: nova clear-password <server></computeroutput></screen>
|
|
<para>
|
|
Clear password for a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_cloudpipe-configure">
|
|
<title>nova cloudpipe-configure</title>
|
|
<screen><computeroutput>usage: nova cloudpipe-configure <ip address> <port></computeroutput></screen>
|
|
<para>
|
|
Update the VPN IP/port of a cloudpipe instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip address></command></term>
|
|
<listitem>
|
|
<para>
|
|
New IP Address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><port></command></term>
|
|
<listitem>
|
|
<para>
|
|
New Port.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_cloudpipe-create">
|
|
<title>nova cloudpipe-create</title>
|
|
<screen><computeroutput>usage: nova cloudpipe-create <project_id></computeroutput></screen>
|
|
<para>
|
|
Create a cloudpipe instance for the given project.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID of the project to create the cloudpipe for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_cloudpipe-list">
|
|
<title>nova cloudpipe-list</title>
|
|
<screen><computeroutput>usage: nova cloudpipe-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of all cloudpipe instances.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_console-log">
|
|
<title>nova console-log</title>
|
|
<screen><computeroutput>usage: nova console-log [--length <length>] <server></computeroutput></screen>
|
|
<para>
|
|
Get console log output of a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--length <length></command></term>
|
|
<listitem>
|
|
<para>
|
|
Length in lines to tail.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_credentials">
|
|
<title>nova credentials</title>
|
|
<screen><computeroutput>usage: nova credentials [--wrap <integer>]</computeroutput></screen>
|
|
<para>
|
|
Show user credentials returned from auth.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--wrap <integer></command></term>
|
|
<listitem>
|
|
<para>
|
|
wrap PKI tokens to a specified length, or 0 to disable
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_delete">
|
|
<title>nova delete</title>
|
|
<screen><computeroutput>usage: nova delete <server> [<server> ...]</computeroutput></screen>
|
|
<para>
|
|
Immediately shut down and delete specified server(s).
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server(s).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_diagnostics">
|
|
<title>nova diagnostics</title>
|
|
<screen><computeroutput>usage: nova diagnostics <server></computeroutput></screen>
|
|
<para>
|
|
Retrieve server diagnostics.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_dns-create">
|
|
<title>nova dns-create</title>
|
|
<screen><computeroutput>usage: nova dns-create [--type <type>] <ip> <name> <domain></computeroutput></screen>
|
|
<para>
|
|
Create a DNS entry for domain, name and ip.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip></command></term>
|
|
<listitem>
|
|
<para>
|
|
ip address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--type <type></command></term>
|
|
<listitem>
|
|
<para>
|
|
dns type (e.g. "A")
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_dns-create-private-domain">
|
|
<title>nova dns-create-private-domain</title>
|
|
<screen><computeroutput>usage: nova dns-create-private-domain
|
|
[--availability-zone <availability-zone>]
|
|
<domain></computeroutput></screen>
|
|
<para>
|
|
Create the specified DNS domain.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Limit access to this domain to servers in the
|
|
specified availability zone.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_dns-create-public-domain">
|
|
<title>nova dns-create-public-domain</title>
|
|
<screen><computeroutput>usage: nova dns-create-public-domain [--project <project>] <domain></computeroutput></screen>
|
|
<para>
|
|
Create the specified DNS domain.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Limit access to this domain to users of the specified
|
|
project.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_dns-delete">
|
|
<title>nova dns-delete</title>
|
|
<screen><computeroutput>usage: nova dns-delete <domain> <name></computeroutput></screen>
|
|
<para>
|
|
Delete the specified DNS entry.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_dns-delete-domain">
|
|
<title>nova dns-delete-domain</title>
|
|
<screen><computeroutput>usage: nova dns-delete-domain <domain></computeroutput></screen>
|
|
<para>
|
|
Delete the specified DNS domain.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_dns-domains">
|
|
<title>nova dns-domains</title>
|
|
<screen><computeroutput>usage: nova dns-domains</computeroutput></screen>
|
|
<para>
|
|
Print a list of available dns domains.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_dns-list">
|
|
<title>nova dns-list</title>
|
|
<screen><computeroutput>usage: nova dns-list [--ip <ip>] [--name <name>] <domain></computeroutput></screen>
|
|
<para>
|
|
List current DNS entries for domain and ip or domain and name.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
DNS domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--ip <ip></command></term>
|
|
<listitem>
|
|
<para>
|
|
ip address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name> DNS</command></term>
|
|
<listitem>
|
|
<para>
|
|
name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_endpoints">
|
|
<title>nova endpoints</title>
|
|
<screen><computeroutput>usage: nova endpoints</computeroutput></screen>
|
|
<para>
|
|
Discover endpoints that get returned from the authenticate services.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_evacuate">
|
|
<title>nova evacuate</title>
|
|
<screen><computeroutput>usage: nova evacuate [--password <password>] [--on-shared-storage]
|
|
<server> [<host>]</computeroutput></screen>
|
|
<para>
|
|
Evacuate server from failed host.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the target host. If no host is
|
|
specified, the scheduler will choose one.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--password <password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set the provided password on the evacuated server.
|
|
Not applicable with on-shared-storage flag
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--on-shared-storage</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies whether server files are located on shared
|
|
storage
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_fixed-ip-get">
|
|
<title>nova fixed-ip-get</title>
|
|
<screen><computeroutput>usage: nova fixed-ip-get <fixed_ip></computeroutput></screen>
|
|
<para>
|
|
Retrieve info on a fixed ip.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><fixed_ip></command></term>
|
|
<listitem>
|
|
<para>
|
|
Fixed IP Address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_fixed-ip-reserve">
|
|
<title>nova fixed-ip-reserve</title>
|
|
<screen><computeroutput>usage: nova fixed-ip-reserve <fixed_ip></computeroutput></screen>
|
|
<para>
|
|
Reserve a fixed IP.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><fixed_ip></command></term>
|
|
<listitem>
|
|
<para>
|
|
Fixed IP Address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_fixed-ip-unreserve">
|
|
<title>nova fixed-ip-unreserve</title>
|
|
<screen><computeroutput>usage: nova fixed-ip-unreserve <fixed_ip></computeroutput></screen>
|
|
<para>
|
|
Unreserve a fixed IP.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><fixed_ip></command></term>
|
|
<listitem>
|
|
<para>
|
|
Fixed IP Address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-access-add">
|
|
<title>nova flavor-access-add</title>
|
|
<screen><computeroutput>usage: nova flavor-access-add <flavor> <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Add flavor access for the given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor name or ID to add access for the given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant ID to add flavor access for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-access-list">
|
|
<title>nova flavor-access-list</title>
|
|
<screen><computeroutput>usage: nova flavor-access-list [--flavor <flavor>] [--tenant <tenant_id>]</computeroutput></screen>
|
|
<para>
|
|
Print access information about the given flavor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--flavor <flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter results by flavor name or ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant <tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter results by tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-access-remove">
|
|
<title>nova flavor-access-remove</title>
|
|
<screen><computeroutput>usage: nova flavor-access-remove <flavor> <tenant_id></computeroutput></screen>
|
|
<para>
|
|
Remove flavor access for the given tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor name or ID to remove access for the given tenant.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><tenant_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant ID to remove flavor access for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-create">
|
|
<title>nova flavor-create</title>
|
|
<screen><computeroutput>usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
|
|
[--rxtx-factor <factor>] [--is-public <is-public>]
|
|
<name> <id> <ram> <disk> <vcpus></computeroutput></screen>
|
|
<para>
|
|
Create a new flavor
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the new flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Unique ID (integer or UUID) for the new flavor. If
|
|
specifying 'auto', a UUID will be generated as id
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><ram></command></term>
|
|
<listitem>
|
|
<para>
|
|
Memory size in MB
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><disk></command></term>
|
|
<listitem>
|
|
<para>
|
|
Disk size in GB
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><vcpus></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of vcpus
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--ephemeral <ephemeral></command></term>
|
|
<listitem>
|
|
<para>
|
|
Ephemeral space size in GB (default 0)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--swap <swap></command></term>
|
|
<listitem>
|
|
<para>
|
|
Swap space size in MB (default 0)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--rxtx-factor <factor></command></term>
|
|
<listitem>
|
|
<para>
|
|
RX/TX factor (default 1)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--is-public <is-public></command></term>
|
|
<listitem>
|
|
<para>
|
|
Make flavor accessible to the public (default true)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-delete">
|
|
<title>nova flavor-delete</title>
|
|
<screen><computeroutput>usage: nova flavor-delete <flavor></computeroutput></screen>
|
|
<para>
|
|
Delete a specific flavor
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the flavor to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-key">
|
|
<title>nova flavor-key</title>
|
|
<screen><computeroutput>usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Set or unset extra_spec for a flavor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
Actions: 'set' or 'unset'
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Extra_specs to set/unset (only key is necessary on unset)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-list">
|
|
<title>nova flavor-list</title>
|
|
<screen><computeroutput>usage: nova flavor-list [--extra-specs] [--all]</computeroutput></screen>
|
|
<para>
|
|
Print a list of available 'flavors' (sizes of servers).
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--extra-specs</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get extra-specs of each flavor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display all flavors (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-show">
|
|
<title>nova flavor-show</title>
|
|
<screen><computeroutput>usage: nova flavor-show <flavor></computeroutput></screen>
|
|
<para>
|
|
Show details about the given flavor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_floating-ip-associate">
|
|
<title>nova floating-ip-associate</title>
|
|
<screen><computeroutput>usage: nova floating-ip-associate [--fixed-address <fixed_address>]
|
|
<server> <address></computeroutput></screen>
|
|
<para>
|
|
Associate a floating IP address to a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP Address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--fixed-address <fixed_address></command></term>
|
|
<listitem>
|
|
<para>
|
|
Fixed IP Address to associate with.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_floating-ip-bulk-create">
|
|
<title>nova floating-ip-bulk-create</title>
|
|
<screen><computeroutput>usage: nova floating-ip-bulk-create [--pool <pool>] [--interface <interface>]
|
|
<range></computeroutput></screen>
|
|
<para>
|
|
Bulk create floating ips by range.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><range></command></term>
|
|
<listitem>
|
|
<para>
|
|
Address range to create
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--pool <pool></command></term>
|
|
<listitem>
|
|
<para>
|
|
Pool for new Floating IPs
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--interface <interface></command></term>
|
|
<listitem>
|
|
<para>
|
|
Interface for new Floating IPs
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_floating-ip-bulk-delete">
|
|
<title>nova floating-ip-bulk-delete</title>
|
|
<screen><computeroutput>usage: nova floating-ip-bulk-delete <range></computeroutput></screen>
|
|
<para>
|
|
Bulk delete floating ips by range.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><range></command></term>
|
|
<listitem>
|
|
<para>
|
|
Address range to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_floating-ip-bulk-list">
|
|
<title>nova floating-ip-bulk-list</title>
|
|
<screen><computeroutput>usage: nova floating-ip-bulk-list [--host <host>]</computeroutput></screen>
|
|
<para>
|
|
List all floating ips.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter by host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_floating-ip-create">
|
|
<title>nova floating-ip-create</title>
|
|
<screen><computeroutput>usage: nova floating-ip-create [<floating-ip-pool>]</computeroutput></screen>
|
|
<para>
|
|
Allocate a floating IP for the current tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><floating-ip-pool></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of Floating IP Pool. (Optional)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_floating-ip-delete">
|
|
<title>nova floating-ip-delete</title>
|
|
<screen><computeroutput>usage: nova floating-ip-delete <address></computeroutput></screen>
|
|
<para>
|
|
De-allocate a floating IP.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP of Floating Ip.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_floating-ip-disassociate">
|
|
<title>nova floating-ip-disassociate</title>
|
|
<screen><computeroutput>usage: nova floating-ip-disassociate <server> <address></computeroutput></screen>
|
|
<para>
|
|
Disassociate a floating IP address from a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP Address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_floating-ip-list">
|
|
<title>nova floating-ip-list</title>
|
|
<screen><computeroutput>usage: nova floating-ip-list [--all-tenants]</computeroutput></screen>
|
|
<para>
|
|
List floating ips.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display floatingips from all tenants (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_floating-ip-pool-list">
|
|
<title>nova floating-ip-pool-list</title>
|
|
<screen><computeroutput>usage: nova floating-ip-pool-list</computeroutput></screen>
|
|
<para>
|
|
List all floating ip pools.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_force-delete">
|
|
<title>nova force-delete</title>
|
|
<screen><computeroutput>usage: nova force-delete <server></computeroutput></screen>
|
|
<para>
|
|
Force delete a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_get-password">
|
|
<title>nova get-password</title>
|
|
<screen><computeroutput>usage: nova get-password <server> [<private-key>]</computeroutput></screen>
|
|
<para>
|
|
Get password for a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><private-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_get-rdp-console">
|
|
<title>nova get-rdp-console</title>
|
|
<screen><computeroutput>usage: nova get-rdp-console <server> <console-type></computeroutput></screen>
|
|
<para>
|
|
Get a rdp console to a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><console-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of rdp console ("rdp-html5").
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_get-serial-console">
|
|
<title>nova get-serial-console</title>
|
|
<screen><computeroutput>usage: nova get-serial-console [--console_type CONSOLE_TYPE] <server></computeroutput></screen>
|
|
<para>
|
|
Get a serial console to a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--console_type CONSOLE_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of serial console, default="serial".
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_get-spice-console">
|
|
<title>nova get-spice-console</title>
|
|
<screen><computeroutput>usage: nova get-spice-console <server> <console-type></computeroutput></screen>
|
|
<para>
|
|
Get a spice console to a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><console-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of spice console ("spice-html5").
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_get-vnc-console">
|
|
<title>nova get-vnc-console</title>
|
|
<screen><computeroutput>usage: nova get-vnc-console <server> <console-type></computeroutput></screen>
|
|
<para>
|
|
Get a vnc console to a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><console-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of vnc console ("novnc" or "xvpvnc").
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-action">
|
|
<title>nova host-action</title>
|
|
<screen><computeroutput>usage: nova host-action [--action <action>] <hostname></computeroutput></screen>
|
|
<para>
|
|
Perform a power action on a host.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--action <action> A</command></term>
|
|
<listitem>
|
|
<para>
|
|
power action: startup, reboot, or shutdown.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-describe">
|
|
<title>nova host-describe</title>
|
|
<screen><computeroutput>usage: nova host-describe <hostname></computeroutput></screen>
|
|
<para>
|
|
Describe a specific host.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-evacuate">
|
|
<title>nova host-evacuate</title>
|
|
<screen><computeroutput>usage: nova host-evacuate [--target_host <target_host>] [--on-shared-storage]
|
|
<host></computeroutput></screen>
|
|
<para>
|
|
Evacuate all instances from failed host.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--target_host <target_host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of target host. If no host is specified
|
|
the scheduler will select a target.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--on-shared-storage</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies whether all instances files are on
|
|
shared storage
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-list">
|
|
<title>nova host-list</title>
|
|
<screen><computeroutput>usage: nova host-list [--zone <zone>]</computeroutput></screen>
|
|
<para>
|
|
List all hosts by service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--zone <zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filters the list, returning only those hosts in the
|
|
availability zone <zone>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-meta">
|
|
<title>nova host-meta</title>
|
|
<screen><computeroutput>usage: nova host-meta <host> <action> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Set or Delete metadata on all instances of a host.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
Actions: 'set' or 'delete'
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata to set or delete (only key is necessary on delete)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-servers-migrate">
|
|
<title>nova host-servers-migrate</title>
|
|
<screen><computeroutput>usage: nova host-servers-migrate <host></computeroutput></screen>
|
|
<para>
|
|
Migrate all instances of the specified host to other available hosts.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-update">
|
|
<title>nova host-update</title>
|
|
<screen><computeroutput>usage: nova host-update [--status <enable|disable>]
|
|
[--maintenance <enable|disable>]
|
|
<hostname></computeroutput></screen>
|
|
<para>
|
|
Update host settings.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--status <enable|disable></command></term>
|
|
<listitem>
|
|
<para>
|
|
Either enable or disable a host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--maintenance <enable|disable></command></term>
|
|
<listitem>
|
|
<para>
|
|
Either put or resume host to/from maintenance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_hypervisor-list">
|
|
<title>nova hypervisor-list</title>
|
|
<screen><computeroutput>usage: nova hypervisor-list [--matching <hostname>]</computeroutput></screen>
|
|
<para>
|
|
List hypervisors.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--matching <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
List hypervisors matching the given <hostname>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_hypervisor-servers">
|
|
<title>nova hypervisor-servers</title>
|
|
<screen><computeroutput>usage: nova hypervisor-servers <hostname></computeroutput></screen>
|
|
<para>
|
|
List servers belonging to specific hypervisors.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
The hypervisor hostname (or pattern) to search for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_hypervisor-show">
|
|
<title>nova hypervisor-show</title>
|
|
<screen><computeroutput>usage: nova hypervisor-show <hypervisor></computeroutput></screen>
|
|
<para>
|
|
Display the details of the specified hypervisor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hypervisor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the hypervisor to show the details of.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_hypervisor-stats">
|
|
<title>nova hypervisor-stats</title>
|
|
<screen><computeroutput>usage: nova hypervisor-stats</computeroutput></screen>
|
|
<para>
|
|
Get hypervisor statistics over all compute nodes.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_hypervisor-uptime">
|
|
<title>nova hypervisor-uptime</title>
|
|
<screen><computeroutput>usage: nova hypervisor-uptime <hypervisor></computeroutput></screen>
|
|
<para>
|
|
Display the uptime of the specified hypervisor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hypervisor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the hypervisor to show the uptime of.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_image-create">
|
|
<title>nova image-create</title>
|
|
<screen><computeroutput>usage: nova image-create [--show] [--poll] <server> <name></computeroutput></screen>
|
|
<para>
|
|
Create a new image by taking a snapshot of a running server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print image info.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--poll</command></term>
|
|
<listitem>
|
|
<para>
|
|
Report the snapshot progress and poll until image creation is
|
|
complete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_image-delete">
|
|
<title>nova image-delete</title>
|
|
<screen><computeroutput>usage: nova image-delete <image> [<image> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete specified image(s).
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of image(s).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_image-list">
|
|
<title>nova image-list</title>
|
|
<screen><computeroutput>usage: nova image-list [--limit <limit>]</computeroutput></screen>
|
|
<para>
|
|
Print a list of available images to boot from.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of images to return per request.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_image-meta">
|
|
<title>nova image-meta</title>
|
|
<screen><computeroutput>usage: nova image-meta <image> <action> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Set or Delete metadata on an image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
Actions: 'set' or 'delete'
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata to add/update or delete (only key is necessary on
|
|
delete)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_image-show">
|
|
<title>nova image-show</title>
|
|
<screen><computeroutput>usage: nova image-show <image></computeroutput></screen>
|
|
<para>
|
|
Show details about the given image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_instance-action">
|
|
<title>nova instance-action</title>
|
|
<screen><computeroutput>usage: nova instance-action <server> <request_id></computeroutput></screen>
|
|
<para>
|
|
Show an action.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or UUID of the server to show an action for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><request_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Request ID of the action to get.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_instance-action-list">
|
|
<title>nova instance-action-list</title>
|
|
<screen><computeroutput>usage: nova instance-action-list <server></computeroutput></screen>
|
|
<para>
|
|
List actions on a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or UUID of the server to list actions for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_interface-attach">
|
|
<title>nova interface-attach</title>
|
|
<screen><computeroutput>usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
|
|
[--fixed-ip <fixed_ip>]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Attach a network interface to a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--port-id <port_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--net-id <net_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-ip <fixed_ip></command></term>
|
|
<listitem>
|
|
<para>
|
|
Requested fixed IP.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_interface-detach">
|
|
<title>nova interface-detach</title>
|
|
<screen><computeroutput>usage: nova interface-detach <server> <port_id></computeroutput></screen>
|
|
<para>
|
|
Detach a network interface from a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><port_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_interface-list">
|
|
<title>nova interface-list</title>
|
|
<screen><computeroutput>usage: nova interface-list <server></computeroutput></screen>
|
|
<para>
|
|
List interfaces attached to a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_keypair-add">
|
|
<title>nova keypair-add</title>
|
|
<screen><computeroutput>usage: nova keypair-add [--pub-key <pub-key>] <name></computeroutput></screen>
|
|
<para>
|
|
Create a new key pair for use with servers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--pub-key <pub-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path to a public ssh key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_keypair-delete">
|
|
<title>nova keypair-delete</title>
|
|
<screen><computeroutput>usage: nova keypair-delete <name></computeroutput></screen>
|
|
<para>
|
|
Delete keypair given by its name.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Keypair name to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_keypair-list">
|
|
<title>nova keypair-list</title>
|
|
<screen><computeroutput>usage: nova keypair-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of keypairs for a user
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_keypair-show">
|
|
<title>nova keypair-show</title>
|
|
<screen><computeroutput>usage: nova keypair-show <keypair></computeroutput></screen>
|
|
<para>
|
|
Show details about the given keypair.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><keypair></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of keypair
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_list">
|
|
<title>nova list</title>
|
|
<screen><computeroutput>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>]] [--deleted]
|
|
[--fields <fields>] [--minimal]</computeroutput></screen>
|
|
<para>
|
|
List active servers.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--reservation-id <reservation-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Only return servers that match reservation-id.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ip <ip-regexp></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search with regular expression match by IP
|
|
address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ip6 <ip6-regexp></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search with regular expression match by IPv6
|
|
address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name-regexp></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search with regular expression match by name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instance-name <name-regexp></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search with regular expression match by server
|
|
name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by server status
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--flavor <flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by flavor name or ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by image name or ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--host <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search servers by hostname to which they are
|
|
assigned (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display information from all tenants (Admin
|
|
only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant [<tenant>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display information from single tenant (Admin
|
|
only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--deleted</command></term>
|
|
<listitem>
|
|
<para>
|
|
Only display deleted servers (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fields <fields></command></term>
|
|
<listitem>
|
|
<para>
|
|
Comma-separated list of fields to display. Use
|
|
the show command to see which fields are
|
|
available.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--minimal</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get only uuid and name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_list-extensions">
|
|
<title>nova list-extensions</title>
|
|
<screen><computeroutput>usage: nova list-extensions</computeroutput></screen>
|
|
<para>
|
|
List all the os-api extensions that are available.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_list-secgroup">
|
|
<title>nova list-secgroup</title>
|
|
<screen><computeroutput>usage: nova list-secgroup <server></computeroutput></screen>
|
|
<para>
|
|
List Security Group(s) of a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_live-migration">
|
|
<title>nova live-migration</title>
|
|
<screen><computeroutput>usage: nova live-migration [--block-migrate] [--disk-over-commit]
|
|
<server> [<host>]</computeroutput></screen>
|
|
<para>
|
|
Migrate running server to a new machine.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
destination host name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--block-migrate</command></term>
|
|
<listitem>
|
|
<para>
|
|
True in case of block_migration.
|
|
(Default=False:live_migration)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-over-commit</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allow overcommit.(Default=False)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_lock">
|
|
<title>nova lock</title>
|
|
<screen><computeroutput>usage: nova lock <server></computeroutput></screen>
|
|
<para>
|
|
Lock a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_meta">
|
|
<title>nova meta</title>
|
|
<screen><computeroutput>usage: nova meta <server> <action> <key=value> [<key=value> ...]</computeroutput></screen>
|
|
<para>
|
|
Set or Delete metadata on a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><action></command></term>
|
|
<listitem>
|
|
<para>
|
|
Actions: 'set' or 'delete'
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata to set or delete (only key is necessary on delete)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_migrate">
|
|
<title>nova migrate</title>
|
|
<screen><computeroutput>usage: nova migrate [--poll] <server></computeroutput></screen>
|
|
<para>
|
|
Migrate a server. The new host will be selected by the scheduler.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--poll</command></term>
|
|
<listitem>
|
|
<para>
|
|
Report the server migration progress until it completes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_migration-list">
|
|
<title>nova migration-list</title>
|
|
<screen><computeroutput>usage: nova migration-list [--host <host>] [--status <status>]
|
|
[--cell_name <cell_name>]</computeroutput></screen>
|
|
<para>
|
|
Print a list of migrations.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Fetch migrations for the given host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Fetch migrations for the given status.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--cell_name <cell_name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Fetch migrations for the given cell_name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_net">
|
|
<title>nova net</title>
|
|
<screen><computeroutput>usage: nova net <network_id></computeroutput></screen>
|
|
<para>
|
|
Show a network
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_net-create">
|
|
<title>nova net-create</title>
|
|
<screen><computeroutput>usage: nova net-create <network_label> <cidr></computeroutput></screen>
|
|
<para>
|
|
Create a network
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network_label></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network label (ex. my_new_network)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><cidr></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP block to allocate from (ex. 172.16.0.0/24 or
|
|
2001:DB8::/64)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_net-delete">
|
|
<title>nova net-delete</title>
|
|
<screen><computeroutput>usage: nova net-delete <network_id></computeroutput></screen>
|
|
<para>
|
|
Delete a network
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_net-list">
|
|
<title>nova net-list</title>
|
|
<screen><computeroutput>usage: nova net-list</computeroutput></screen>
|
|
<para>
|
|
List networks
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_network-associate-host">
|
|
<title>nova network-associate-host</title>
|
|
<screen><computeroutput>usage: nova network-associate-host <network> <host></computeroutput></screen>
|
|
<para>
|
|
Associate host with network.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
uuid of network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_network-associate-project">
|
|
<title>nova network-associate-project</title>
|
|
<screen><computeroutput>usage: nova network-associate-project <network></computeroutput></screen>
|
|
<para>
|
|
Associate project with network.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
uuid of network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_network-create">
|
|
<title>nova network-create</title>
|
|
<screen><computeroutput>usage: nova network-create [--fixed-range-v4 <x.x.x.x/yy>]
|
|
[--fixed-range-v6 CIDR_V6] [--vlan <vlan id>]
|
|
[--vlan-start <vlan start>] [--vpn <vpn start>]
|
|
[--gateway GATEWAY] [--gateway-v6 GATEWAY_V6]
|
|
[--bridge <bridge>]
|
|
[--bridge-interface <bridge interface>]
|
|
[--multi-host <'T'|'F'>] [--dns1 <DNS Address>]
|
|
[--dns2 <DNS Address>] [--uuid <network uuid>]
|
|
[--fixed-cidr <x.x.x.x/yy>]
|
|
[--project-id <project id>] [--priority <number>]
|
|
[--mtu MTU] [--enable-dhcp <'T'|'F'>]
|
|
[--dhcp-server DHCP_SERVER]
|
|
[--share-address <'T'|'F'>]
|
|
[--allowed-start ALLOWED_START]
|
|
[--allowed-end ALLOWED_END]
|
|
<network_label></computeroutput></screen>
|
|
<para>
|
|
Create a network.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network_label></command></term>
|
|
<listitem>
|
|
<para>
|
|
Label for network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--fixed-range-v4 <x.x.x.x/yy></command></term>
|
|
<listitem>
|
|
<para>
|
|
IPv4 subnet (ex: 10.0.0.0/8)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-range-v6</command></term>
|
|
<listitem>
|
|
<para>
|
|
CIDR_V6 IPv6 subnet (ex: fe80::/64
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--vlan <vlan id></command></term>
|
|
<listitem>
|
|
<para>
|
|
The vlan ID to be assigned to the project.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--vlan-start <vlan start></command></term>
|
|
<listitem>
|
|
<para>
|
|
First vlan ID to be assigned to the project.
|
|
Subsequent vlan IDs will be assigned
|
|
incrementally.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--vpn <vpn start></command></term>
|
|
<listitem>
|
|
<para>
|
|
vpn start
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gateway GATEWAY</command></term>
|
|
<listitem>
|
|
<para>
|
|
gateway
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gateway-v6</command></term>
|
|
<listitem>
|
|
<para>
|
|
GATEWAY_V6 IPv6 gateway
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bridge <bridge></command></term>
|
|
<listitem>
|
|
<para>
|
|
VIFs on this network are connected to this
|
|
bridge.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bridge-interface <bridge interface></command></term>
|
|
<listitem>
|
|
<para>
|
|
The bridge is connected to this interface.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--multi-host <'T'|'F'></command></term>
|
|
<listitem>
|
|
<para>
|
|
Multi host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dns1 <DNS Address></command></term>
|
|
<listitem>
|
|
<para>
|
|
First DNS
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dns2 <DNS Address></command></term>
|
|
<listitem>
|
|
<para>
|
|
Second DNS
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--uuid <network uuid></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network UUID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-cidr <x.x.x.x/yy></command></term>
|
|
<listitem>
|
|
<para>
|
|
IPv4 subnet for fixed IPs (ex: 10.20.0.0/16)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-id <project id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--priority <number></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network interface priority
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--mtu MTU MTU</command></term>
|
|
<listitem>
|
|
<para>
|
|
for network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable-dhcp <'T'|'F'></command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable dhcp
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dhcp-server DHCP_SERVER</command></term>
|
|
<listitem>
|
|
<para>
|
|
Dhcp-server (defaults to gateway address)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--share-address <'T'|'F'></command></term>
|
|
<listitem>
|
|
<para>
|
|
Share address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--allowed-start ALLOWED_START</command></term>
|
|
<listitem>
|
|
<para>
|
|
Start of allowed addresses for instances
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--allowed-end ALLOWED_END</command></term>
|
|
<listitem>
|
|
<para>
|
|
End of allowed addresses for instances
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_network-delete">
|
|
<title>nova network-delete</title>
|
|
<screen><computeroutput>usage: nova network-delete <network></computeroutput></screen>
|
|
<para>
|
|
Delete network by label or id.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
uuid or label of network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_network-disassociate">
|
|
<title>nova network-disassociate</title>
|
|
<screen><computeroutput>usage: nova network-disassociate [--host-only [<0|1>]]
|
|
[--project-only [<0|1>]]
|
|
<network></computeroutput></screen>
|
|
<para>
|
|
Disassociate host and/or project from the given network.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
uuid of network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host-only [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-only [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_network-list">
|
|
<title>nova network-list</title>
|
|
<screen><computeroutput>usage: nova network-list [--fields <fields>]</computeroutput></screen>
|
|
<para>
|
|
Print a list of available networks.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--fields <fields></command></term>
|
|
<listitem>
|
|
<para>
|
|
Comma-separated list of fields to display. Use the show
|
|
command to see which fields are available.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_network-show">
|
|
<title>nova network-show</title>
|
|
<screen><computeroutput>usage: nova network-show <network></computeroutput></screen>
|
|
<para>
|
|
Show details about the given network.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
uuid or label of network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_pause">
|
|
<title>nova pause</title>
|
|
<screen><computeroutput>usage: nova pause <server></computeroutput></screen>
|
|
<para>
|
|
Pause a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_quota-class-show">
|
|
<title>nova quota-class-show</title>
|
|
<screen><computeroutput>usage: nova quota-class-show <class></computeroutput></screen>
|
|
<para>
|
|
List the quotas for a quota class.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><class></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of quota class to list the quotas for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_quota-class-update">
|
|
<title>nova quota-class-update</title>
|
|
<screen><computeroutput>usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
|
|
[--ram <ram>] [--floating-ips <floating-ips>]
|
|
[--fixed-ips <fixed-ips>]
|
|
[--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>]
|
|
[--security-groups <security-groups>]
|
|
[--security-group-rules <security-group-rules>]
|
|
[--server-groups <server-groups>]
|
|
[--server-group-members <server-group-members>]
|
|
<class></computeroutput></screen>
|
|
<para>
|
|
Update the quotas for a quota class.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><class></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of quota class to set the quotas for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--instances <instances></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "instances" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--cores <cores></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "cores" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ram <ram></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "ram" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--floating-ips <floating-ips></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "floating-ips" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-ips <fixed-ips></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "fixed-ips" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata-items <metadata-items></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "metadata-items" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-files <injected-files></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "injected-files" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-file-content-bytes <injected-file-content-bytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "injected-file-content-
|
|
bytes" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-file-path-bytes <injected-file-path-bytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "injected-file-path-bytes"
|
|
quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key-pairs <key-pairs></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "key-pairs" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-groups <security-groups></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "security-groups" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-group-rules <security-group-rules></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "security-group-rules"
|
|
quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--server-groups <server-groups></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "server-groups" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--server-group-members <server-group-members></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "server-group-members"
|
|
quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_quota-defaults">
|
|
<title>nova quota-defaults</title>
|
|
<screen><computeroutput>usage: nova quota-defaults [--tenant <tenant-id>]</computeroutput></screen>
|
|
<para>
|
|
List the default quotas for a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--tenant <tenant-id> ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
of tenant to list the default quotas for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_quota-delete">
|
|
<title>nova quota-delete</title>
|
|
<screen><computeroutput>usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]</computeroutput></screen>
|
|
<para>
|
|
Delete quota for a tenant/user so their quota will Revert back to default.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--tenant <tenant-id> ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
of tenant to delete quota for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user-id> ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
of user to delete quota for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_quota-show">
|
|
<title>nova quota-show</title>
|
|
<screen><computeroutput>usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>]</computeroutput></screen>
|
|
<para>
|
|
List the quotas for a tenant/user.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--tenant <tenant-id> ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
of tenant to list the quotas for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user-id> ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
of user to list the quotas for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_quota-update">
|
|
<title>nova quota-update</title>
|
|
<screen><computeroutput>usage: nova quota-update [--user <user-id>] [--instances <instances>]
|
|
[--cores <cores>] [--ram <ram>]
|
|
[--floating-ips <floating-ips>]
|
|
[--fixed-ips <fixed-ips>]
|
|
[--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>]
|
|
[--security-groups <security-groups>]
|
|
[--security-group-rules <security-group-rules>]
|
|
[--server-groups <server-groups>]
|
|
[--server-group-members <server-group-members>]
|
|
[--force]
|
|
<tenant-id></computeroutput></screen>
|
|
<para>
|
|
Update the quotas for a tenant/user.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><tenant-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of tenant to set the quotas for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--user <user-id> ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
of user to set the quotas for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instances <instances></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "instances" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--cores <cores></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "cores" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ram <ram></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "ram" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--floating-ips <floating-ips></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "floating-ips" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-ips <fixed-ips></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "fixed-ips" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata-items <metadata-items></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "metadata-items" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-files <injected-files></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "injected-files" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-file-content-bytes <injected-file-content-bytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "injected-file-content-
|
|
bytes" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-file-path-bytes <injected-file-path-bytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "injected-file-path-bytes"
|
|
quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key-pairs <key-pairs></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "key-pairs" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-groups <security-groups></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "security-groups" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-group-rules <security-group-rules></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "security-group-rules"
|
|
quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--server-groups <server-groups></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "server-groups" quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--server-group-members <server-group-members></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the "server-group-members"
|
|
quota.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--force</command></term>
|
|
<listitem>
|
|
<para>
|
|
Whether force update the quota even if the
|
|
already used and reserved exceeds the new
|
|
quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_rate-limits">
|
|
<title>nova rate-limits</title>
|
|
<screen><computeroutput>usage: nova rate-limits</computeroutput></screen>
|
|
<para>
|
|
Print a list of rate limits for a user
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_reboot">
|
|
<title>nova reboot</title>
|
|
<screen><computeroutput>usage: nova reboot [--hard] [--poll] <server></computeroutput></screen>
|
|
<para>
|
|
Reboot a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--hard</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a hard reboot (instead of a soft one).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--poll</command></term>
|
|
<listitem>
|
|
<para>
|
|
Poll until reboot is complete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_rebuild">
|
|
<title>nova rebuild</title>
|
|
<screen><computeroutput>usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
|
|
[--minimal] [--preserve-ephemeral] [--name <name>]
|
|
[--meta <key=value>] [--file <dst-path=src-path>]
|
|
<server> <image></computeroutput></screen>
|
|
<para>
|
|
Shutdown, re-image, and re-boot a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of new image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--rebuild-password <rebuild-password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set the provided password on the rebuild
|
|
server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--poll</command></term>
|
|
<listitem>
|
|
<para>
|
|
Report the server rebuild progress until it
|
|
completes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--minimal</command></term>
|
|
<listitem>
|
|
<para>
|
|
Skips flavor/image lookups when showing
|
|
servers
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--preserve-ephemeral</command></term>
|
|
<listitem>
|
|
<para>
|
|
Preserve the default ephemeral storage
|
|
partition on rebuild.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name for the new server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--meta <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Record arbitrary key/value metadata to
|
|
/meta.js on the new server. Can be specified
|
|
multiple times.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <dst-path=src-path></command></term>
|
|
<listitem>
|
|
<para>
|
|
Store arbitrary files from <src-path> locally
|
|
to <dst-path> on the new server. You may store
|
|
up to 5 files.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_refresh-network">
|
|
<title>nova refresh-network</title>
|
|
<screen><computeroutput>usage: nova refresh-network <server></computeroutput></screen>
|
|
<para>
|
|
Refresh server network information.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of a server for which the network cache should be
|
|
refreshed from neutron (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_remove-fixed-ip">
|
|
<title>nova remove-fixed-ip</title>
|
|
<screen><computeroutput>usage: nova remove-fixed-ip <server> <address></computeroutput></screen>
|
|
<para>
|
|
Remove an IP address from a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP Address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_remove-secgroup">
|
|
<title>nova remove-secgroup</title>
|
|
<screen><computeroutput>usage: nova remove-secgroup <server> <secgroup></computeroutput></screen>
|
|
<para>
|
|
Remove a Security Group from a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><secgroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of Security Group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_rename">
|
|
<title>nova rename</title>
|
|
<screen><computeroutput>usage: nova rename <server> <name></computeroutput></screen>
|
|
<para>
|
|
Rename a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name (old name) or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New name for the server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_rescue">
|
|
<title>nova rescue</title>
|
|
<screen><computeroutput>usage: nova rescue <server></computeroutput></screen>
|
|
<para>
|
|
Reboots a server into rescue mode, which starts the machine from the initial
|
|
image, attaching the current boot disk as secondary.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_reset-network">
|
|
<title>nova reset-network</title>
|
|
<screen><computeroutput>usage: nova reset-network <server></computeroutput></screen>
|
|
<para>
|
|
Reset network of a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_reset-state">
|
|
<title>nova reset-state</title>
|
|
<screen><computeroutput>usage: nova reset-state [--active] <server> [<server> ...]</computeroutput></screen>
|
|
<para>
|
|
Reset the state of a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server(s).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--active</command></term>
|
|
<listitem>
|
|
<para>
|
|
Request the server be reset to "active" state instead of "error"
|
|
state (the default).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_resize">
|
|
<title>nova resize</title>
|
|
<screen><computeroutput>usage: nova resize [--poll] <server> <flavor></computeroutput></screen>
|
|
<para>
|
|
Resize a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of new flavor.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--poll</command></term>
|
|
<listitem>
|
|
<para>
|
|
Report the server resize progress until it completes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_resize-confirm">
|
|
<title>nova resize-confirm</title>
|
|
<screen><computeroutput>usage: nova resize-confirm <server></computeroutput></screen>
|
|
<para>
|
|
Confirm a previous resize.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_resize-revert">
|
|
<title>nova resize-revert</title>
|
|
<screen><computeroutput>usage: nova resize-revert <server></computeroutput></screen>
|
|
<para>
|
|
Revert a previous resize (and return to the previous VM).
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_restore">
|
|
<title>nova restore</title>
|
|
<screen><computeroutput>usage: nova restore <server></computeroutput></screen>
|
|
<para>
|
|
Restore a soft-deleted server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_resume">
|
|
<title>nova resume</title>
|
|
<screen><computeroutput>usage: nova resume <server></computeroutput></screen>
|
|
<para>
|
|
Resume a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_root-password">
|
|
<title>nova root-password</title>
|
|
<screen><computeroutput>usage: nova root-password <server></computeroutput></screen>
|
|
<para>
|
|
Change the root password for a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_scrub">
|
|
<title>nova scrub</title>
|
|
<screen><computeroutput>usage: nova scrub <project_id></computeroutput></screen>
|
|
<para>
|
|
Delete data associated with the project.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
The ID of the project.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-add-default-rule">
|
|
<title>nova secgroup-add-default-rule</title>
|
|
<screen><computeroutput>usage: nova secgroup-add-default-rule <ip-proto> <from-port> <to-port> <cidr></computeroutput></screen>
|
|
<para>
|
|
Add a rule to the default security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-proto></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP protocol (icmp, tcp, udp).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><from-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at start of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><to-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at end of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><cidr></command></term>
|
|
<listitem>
|
|
<para>
|
|
CIDR for address range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-add-group-rule">
|
|
<title>nova secgroup-add-group-rule</title>
|
|
<screen><computeroutput>usage: nova secgroup-add-group-rule <secgroup> <source-group> <ip-proto>
|
|
<from-port> <to-port></computeroutput></screen>
|
|
<para>
|
|
Add a source group rule to a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><secgroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><source-group></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of source group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><ip-proto></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP protocol (icmp, tcp, udp).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><from-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at start of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><to-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at end of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-add-rule">
|
|
<title>nova secgroup-add-rule</title>
|
|
<screen><computeroutput>usage: nova secgroup-add-rule <secgroup> <ip-proto> <from-port> <to-port>
|
|
<cidr></computeroutput></screen>
|
|
<para>
|
|
Add a rule to a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><secgroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><ip-proto></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP protocol (icmp, tcp, udp).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><from-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at start of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><to-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at end of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><cidr></command></term>
|
|
<listitem>
|
|
<para>
|
|
CIDR for address range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-create">
|
|
<title>nova secgroup-create</title>
|
|
<screen><computeroutput>usage: nova secgroup-create <name> <description></computeroutput></screen>
|
|
<para>
|
|
Create a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-delete">
|
|
<title>nova secgroup-delete</title>
|
|
<screen><computeroutput>usage: nova secgroup-delete <secgroup></computeroutput></screen>
|
|
<para>
|
|
Delete a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><secgroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-delete-default-rule">
|
|
<title>nova secgroup-delete-default-rule</title>
|
|
<screen><computeroutput>usage: nova secgroup-delete-default-rule <ip-proto> <from-port> <to-port>
|
|
<cidr></computeroutput></screen>
|
|
<para>
|
|
Delete a rule from the default security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-proto></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP protocol (icmp, tcp, udp).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><from-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at start of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><to-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at end of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><cidr></command></term>
|
|
<listitem>
|
|
<para>
|
|
CIDR for address range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-delete-group-rule">
|
|
<title>nova secgroup-delete-group-rule</title>
|
|
<screen><computeroutput>usage: nova secgroup-delete-group-rule <secgroup> <source-group> <ip-proto>
|
|
<from-port> <to-port></computeroutput></screen>
|
|
<para>
|
|
Delete a source group rule from a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><secgroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><source-group></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of source group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><ip-proto></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP protocol (icmp, tcp, udp).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><from-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at start of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><to-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at end of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-delete-rule">
|
|
<title>nova secgroup-delete-rule</title>
|
|
<screen><computeroutput>usage: nova secgroup-delete-rule <secgroup> <ip-proto> <from-port> <to-port>
|
|
<cidr></computeroutput></screen>
|
|
<para>
|
|
Delete a rule from a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><secgroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><ip-proto></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP protocol (icmp, tcp, udp).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><from-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at start of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><to-port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Port at end of range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><cidr></command></term>
|
|
<listitem>
|
|
<para>
|
|
CIDR for address range.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-list">
|
|
<title>nova secgroup-list</title>
|
|
<screen><computeroutput>usage: nova secgroup-list [--all-tenants [<0|1>]]</computeroutput></screen>
|
|
<para>
|
|
List security groups for the current tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display information from all tenants (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-list-default-rules">
|
|
<title>nova secgroup-list-default-rules</title>
|
|
<screen><computeroutput>usage: nova secgroup-list-default-rules</computeroutput></screen>
|
|
<para>
|
|
List rules for the default security group.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-list-rules">
|
|
<title>nova secgroup-list-rules</title>
|
|
<screen><computeroutput>usage: nova secgroup-list-rules <secgroup></computeroutput></screen>
|
|
<para>
|
|
List rules for a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><secgroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_secgroup-update">
|
|
<title>nova secgroup-update</title>
|
|
<screen><computeroutput>usage: nova secgroup-update <secgroup> <name> <description></computeroutput></screen>
|
|
<para>
|
|
Update a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><secgroup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of security group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_server-group-create">
|
|
<title>nova server-group-create</title>
|
|
<screen><computeroutput>usage: nova server-group-create <name> [<policy> [<policy> ...]]</computeroutput></screen>
|
|
<para>
|
|
Create a new server group with the specified details.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server group name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><policy></command></term>
|
|
<listitem>
|
|
<para>
|
|
Policies for the server groups ("affinity" or "anti-affinity")
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_server-group-delete">
|
|
<title>nova server-group-delete</title>
|
|
<screen><computeroutput>usage: nova server-group-delete <id> [<id> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete specific server group(s).
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Unique ID(s) of the server group to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_server-group-get">
|
|
<title>nova server-group-get</title>
|
|
<screen><computeroutput>usage: nova server-group-get <id></computeroutput></screen>
|
|
<para>
|
|
Get a specific server group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Unique ID of the server group to get
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_server-group-list">
|
|
<title>nova server-group-list</title>
|
|
<screen><computeroutput>usage: nova server-group-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of all server groups.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_service-delete">
|
|
<title>nova service-delete</title>
|
|
<screen><computeroutput>usage: nova service-delete <id></computeroutput></screen>
|
|
<para>
|
|
Delete the service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Id of service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_service-disable">
|
|
<title>nova service-disable</title>
|
|
<screen><computeroutput>usage: nova service-disable [--reason <reason>] <hostname> <binary></computeroutput></screen>
|
|
<para>
|
|
Disable the service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><binary></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service binary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--reason <reason></command></term>
|
|
<listitem>
|
|
<para>
|
|
Reason for disabling service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_service-enable">
|
|
<title>nova service-enable</title>
|
|
<screen><computeroutput>usage: nova service-enable <hostname> <binary></computeroutput></screen>
|
|
<para>
|
|
Enable the service.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><binary></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service binary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_service-list">
|
|
<title>nova service-list</title>
|
|
<screen><computeroutput>usage: nova service-list [--host <hostname>] [--binary <binary>]</computeroutput></screen>
|
|
<para>
|
|
Show a list of all running services. Filter by host & binary.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--binary <binary></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service binary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_shelve">
|
|
<title>nova shelve</title>
|
|
<screen><computeroutput>usage: nova shelve <server></computeroutput></screen>
|
|
<para>
|
|
Shelve a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_shelve-offload">
|
|
<title>nova shelve-offload</title>
|
|
<screen><computeroutput>usage: nova shelve-offload <server></computeroutput></screen>
|
|
<para>
|
|
Remove a shelved server from the compute node.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_show">
|
|
<title>nova show</title>
|
|
<screen><computeroutput>usage: nova show [--minimal] <server></computeroutput></screen>
|
|
<para>
|
|
Show details about the given server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--minimal</command></term>
|
|
<listitem>
|
|
<para>
|
|
Skips flavor/image lookups when showing servers
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_ssh">
|
|
<title>nova ssh</title>
|
|
<screen><computeroutput>usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE]
|
|
[--network <network>] [--ipv6] [--login <login>] [-i IDENTITY]
|
|
[--extra-opts EXTRA]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
SSH into a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--port PORT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional flag to indicate which port to use
|
|
for ssh. (Default=22)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--address-type ADDRESS_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional flag to indicate which IP type to
|
|
use. Possible values includes fixed and
|
|
floating (the Default).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--network <network></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network to use for the ssh.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ipv6</command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional flag to indicate whether to use an
|
|
IPv6 address attached to a server. (Defaults
|
|
to IPv4 address)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--login <login></command></term>
|
|
<listitem>
|
|
<para>
|
|
Login to use.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-i IDENTITY, --identity IDENTITY</command></term>
|
|
<listitem>
|
|
<para>
|
|
Private key file, same as the -i option to the
|
|
ssh command.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--extra-opts EXTRA</command></term>
|
|
<listitem>
|
|
<para>
|
|
Extra options to pass to ssh. see: man ssh
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_start">
|
|
<title>nova start</title>
|
|
<screen><computeroutput>usage: nova start <server></computeroutput></screen>
|
|
<para>
|
|
Start a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_stop">
|
|
<title>nova stop</title>
|
|
<screen><computeroutput>usage: nova stop <server></computeroutput></screen>
|
|
<para>
|
|
Stop a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_suspend">
|
|
<title>nova suspend</title>
|
|
<screen><computeroutput>usage: nova suspend <server></computeroutput></screen>
|
|
<para>
|
|
Suspend a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_unlock">
|
|
<title>nova unlock</title>
|
|
<screen><computeroutput>usage: nova unlock <server></computeroutput></screen>
|
|
<para>
|
|
Unlock a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_unpause">
|
|
<title>nova unpause</title>
|
|
<screen><computeroutput>usage: nova unpause <server></computeroutput></screen>
|
|
<para>
|
|
Unpause a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_unrescue">
|
|
<title>nova unrescue</title>
|
|
<screen><computeroutput>usage: nova unrescue <server></computeroutput></screen>
|
|
<para>
|
|
Restart the server from normal boot disk again.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_unshelve">
|
|
<title>nova unshelve</title>
|
|
<screen><computeroutput>usage: nova unshelve <server></computeroutput></screen>
|
|
<para>
|
|
Unshelve a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_usage">
|
|
<title>nova usage</title>
|
|
<screen><computeroutput>usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]</computeroutput></screen>
|
|
<para>
|
|
Show usage data for a single tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--start <start></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range start date ex 2012-01-20 (default: 4 weeks
|
|
ago)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end <end></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range end date, ex 2012-01-20 (default:
|
|
tomorrow)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant <tenant-id> UUID</command></term>
|
|
<listitem>
|
|
<para>
|
|
or name of tenant to get usage for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_usage-list">
|
|
<title>nova usage-list</title>
|
|
<screen><computeroutput>usage: nova usage-list [--start <start>] [--end <end>]</computeroutput></screen>
|
|
<para>
|
|
List usage data for all tenants.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--start <start></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range start date ex 2012-01-20 (default: 4 weeks ago)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end <end></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range end date, ex 2012-01-20 (default: tomorrow)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_version-list">
|
|
<title>nova version-list</title>
|
|
<screen><computeroutput>usage: nova version-list</computeroutput></screen>
|
|
<para>
|
|
List all API versions.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-attach">
|
|
<title>nova volume-attach</title>
|
|
<screen><computeroutput>usage: nova volume-attach <server> <volume> [<device>]</computeroutput></screen>
|
|
<para>
|
|
Attach a volume to a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the volume to attach.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><device></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if
|
|
supported)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-create">
|
|
<title>nova volume-create</title>
|
|
<screen><computeroutput>usage: nova volume-create [--snapshot-id <snapshot-id>]
|
|
[--image-id <image-id>]
|
|
[--display-name <display-name>]
|
|
[--display-description <display-description>]
|
|
[--volume-type <volume-type>]
|
|
[--availability-zone <availability-zone>]
|
|
<size></computeroutput></screen>
|
|
<para>
|
|
Add a new volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Size of volume in GB
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--snapshot-id <snapshot-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional snapshot id to create the volume
|
|
from. (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image-id <image-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional image id to create the volume from.
|
|
(Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-name <display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional volume name. (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-description <display-description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional volume description. (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional volume type. (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional Availability Zone for volume.
|
|
(Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-delete">
|
|
<title>nova volume-delete</title>
|
|
<screen><computeroutput>usage: nova volume-delete <volume> [<volume> ...]</computeroutput></screen>
|
|
<para>
|
|
Remove volume(s).
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the volume(s) to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-detach">
|
|
<title>nova volume-detach</title>
|
|
<screen><computeroutput>usage: nova volume-detach <server> <volume></computeroutput></screen>
|
|
<para>
|
|
Detach a volume from a server.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the volume to detach.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-list">
|
|
<title>nova volume-list</title>
|
|
<screen><computeroutput>usage: nova volume-list [--all-tenants [<0|1>]]</computeroutput></screen>
|
|
<para>
|
|
List all the volumes.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--all-tenants [<0|1>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display information from all tenants (Admin only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-show">
|
|
<title>nova volume-show</title>
|
|
<screen><computeroutput>usage: nova volume-show <volume></computeroutput></screen>
|
|
<para>
|
|
Show details about a volume.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-snapshot-create">
|
|
<title>nova volume-snapshot-create</title>
|
|
<screen><computeroutput>usage: nova volume-snapshot-create [--force <True|False>]
|
|
[--display-name <display-name>]
|
|
[--display-description <display-description>]
|
|
<volume-id></computeroutput></screen>
|
|
<para>
|
|
Add a new snapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the volume to snapshot
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--force <True|False></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional flag to indicate whether to snapshot
|
|
a volume even if its attached to a server.
|
|
(Default=False)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-name <display-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional snapshot name. (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--display-description <display-description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional snapshot description. (Default=None)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-snapshot-delete">
|
|
<title>nova volume-snapshot-delete</title>
|
|
<screen><computeroutput>usage: nova volume-snapshot-delete <snapshot></computeroutput></screen>
|
|
<para>
|
|
Remove a snapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the snapshot to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-snapshot-list">
|
|
<title>nova volume-snapshot-list</title>
|
|
<screen><computeroutput>usage: nova volume-snapshot-list</computeroutput></screen>
|
|
<para>
|
|
List all the snapshots.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-snapshot-show">
|
|
<title>nova volume-snapshot-show</title>
|
|
<screen><computeroutput>usage: nova volume-snapshot-show <snapshot></computeroutput></screen>
|
|
<para>
|
|
Show details about a snapshot.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of the snapshot.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-type-create">
|
|
<title>nova volume-type-create</title>
|
|
<screen><computeroutput>usage: nova volume-type-create <name></computeroutput></screen>
|
|
<para>
|
|
Create a new volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the new volume type
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-type-delete">
|
|
<title>nova volume-type-delete</title>
|
|
<screen><computeroutput>usage: nova volume-type-delete <id></computeroutput></screen>
|
|
<para>
|
|
Delete a specific volume type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Unique ID of the volume type to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-type-list">
|
|
<title>nova volume-type-list</title>
|
|
<screen><computeroutput>usage: nova volume-type-list</computeroutput></screen>
|
|
<para>
|
|
Print a list of available 'volume types'.
|
|
</para>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-update">
|
|
<title>nova volume-update</title>
|
|
<screen><computeroutput>usage: nova volume-update <server> <attachment> <volume></computeroutput></screen>
|
|
<para>
|
|
Update volume attachment.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><attachment></command></term>
|
|
<listitem>
|
|
<para>
|
|
Attachment ID of the volume.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the volume to attach.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_x509-create-cert">
|
|
<title>nova x509-create-cert</title>
|
|
<screen><computeroutput>usage: nova x509-create-cert [<private-key-filename>] [<x509-cert-filename>]</computeroutput></screen>
|
|
<para>
|
|
Create x509 cert for a user in tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><private-key-filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filename for the private key [Default: pk.pem]
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><x509-cert-filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filename for the X.509 certificate [Default:
|
|
cert.pem]
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_x509-get-root-cert">
|
|
<title>nova x509-get-root-cert</title>
|
|
<screen><computeroutput>usage: nova x509-get-root-cert [<filename>]</computeroutput></screen>
|
|
<para>
|
|
Fetch the x509 root cert.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filename to write the x509 root cert.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</chapter>
|