openstack-manuals/doc/common/section_cli_nova_commands.xml
Andreas Jaeger f3bc4fdb51 Autogenerate python cli page
Use new tool to autogenerate cli pages.

Pages are created using current client git versions.

Note that swift output looks a bit different
since swift does not support "swift help subcommand".

Change-Id: I1b44e188ea460c9ece973cd52443f5533f93e8b4
2014-01-22 19:51:51 +01:00

2736 lines
99 KiB
XML

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