f3bc4fdb51
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
2736 lines
99 KiB
XML
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 <seconds>] [--os-auth-token OS_AUTH_TOKEN]
|
|
[--os-username <auth-user-name>] [--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>
|
|
</section>
|
|
<section xml:id="novaclient_command_pos">
|
|
<title>nova positional arguments</title>
|
|
<screen><computeroutput> <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 &
|
|
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 <seconds> Set HTTP call timeout (in seconds)
|
|
--os-auth-token OS_AUTH_TOKEN
|
|
Defaults to env[OS_AUTH_TOKEN]
|
|
--os-username <auth-user-name>
|
|
Defaults to env[OS_USERNAME].
|
|
--os-password <auth-password>
|
|
Defaults to env[OS_PASSWORD].
|
|
--os-tenant-name <auth-tenant-name>
|
|
Defaults to env[OS_TENANT_NAME].
|
|
--os-tenant-id <auth-tenant-id>
|
|
Defaults to env[OS_TENANT_ID].
|
|
--os-auth-url <auth-url>
|
|
Defaults to env[OS_AUTH_URL].
|
|
--os-region-name <region-name>
|
|
Defaults to env[OS_REGION_NAME].
|
|
--os-auth-system <auth-system>
|
|
Defaults to env[OS_AUTH_SYSTEM].
|
|
--service-type <service-type>
|
|
Defaults to compute for most actions
|
|
--service-name <service-name>
|
|
Defaults to env[NOVA_SERVICE_NAME]
|
|
--volume-service-name <volume-service-name>
|
|
Defaults to env[NOVA_VOLUME_SERVICE_NAME]
|
|
--endpoint-type <endpoint-type>
|
|
Defaults to env[NOVA_ENDPOINT_TYPE] or publicURL.
|
|
--os-compute-api-version <compute-api-ver>
|
|
Accepts 1.1 or 3, defaults to
|
|
env[OS_COMPUTE_API_VERSION].
|
|
--os-cacert <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 <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 [<tenant>]] [--reserved]
|
|
|
|
Print a list of absolute limits for a user
|
|
|
|
Optional arguments:
|
|
--tenant [<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 <server> <network-id>
|
|
|
|
Add new IP address on a network to server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<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 <server> <secgroup>
|
|
|
|
Add a Security Group to a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<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 <os> <architecture> <version> <url> <md5hash>
|
|
<hypervisor>
|
|
|
|
Create new agent build.
|
|
|
|
Positional arguments:
|
|
<os> type of os.
|
|
<architecture> type of architecture
|
|
<version> version
|
|
<url> url
|
|
<md5hash> md5 hash
|
|
<hypervisor> type of hypervisor.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_agent-delete">
|
|
<title>nova agent-delete command</title>
|
|
<screen><computeroutput>usage: nova agent-delete <id>
|
|
|
|
Delete existing agent build.
|
|
|
|
Positional arguments:
|
|
<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 <hypervisor>]
|
|
|
|
List all builds.
|
|
|
|
Optional arguments:
|
|
--hypervisor <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 <id> <version> <url> <md5hash>
|
|
|
|
Modify existing agent build.
|
|
|
|
Positional arguments:
|
|
<id> id of the agent-build
|
|
<version> version
|
|
<url> url
|
|
<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 <aggregate> <host>
|
|
|
|
Add the host to the specified aggregate.
|
|
|
|
Positional arguments:
|
|
<aggregate> Name or ID of aggregate.
|
|
<host> The host to add to the aggregate.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-create">
|
|
<title>nova aggregate-create command</title>
|
|
<screen><computeroutput>usage: nova aggregate-create <name> [<availability-zone>]
|
|
|
|
Create a new aggregate with the specified details.
|
|
|
|
Positional arguments:
|
|
<name> Name of aggregate.
|
|
<availability-zone> The availability zone of the aggregate (optional).
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-delete">
|
|
<title>nova aggregate-delete command</title>
|
|
<screen><computeroutput>usage: nova aggregate-delete <aggregate>
|
|
|
|
Delete the aggregate.
|
|
|
|
Positional arguments:
|
|
<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 <aggregate>
|
|
|
|
Show details of the specified aggregate.
|
|
|
|
Positional arguments:
|
|
<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 <aggregate> <host>
|
|
|
|
Remove the specified host from the specified aggregate.
|
|
|
|
Positional arguments:
|
|
<aggregate> Name or ID of aggregate.
|
|
<host> The host to remove from the aggregate.
|
|
|
|
</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 <aggregate> <key=value> [<key=value> ...]
|
|
|
|
Update the metadata associated with the aggregate.
|
|
|
|
Positional arguments:
|
|
<aggregate> Name or ID of aggregate to update.
|
|
<key=value> Metadata to add/update to aggregate
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_aggregate-update">
|
|
<title>nova aggregate-update command</title>
|
|
<screen><computeroutput>usage: nova aggregate-update <aggregate> <name> [<availability-zone>]
|
|
|
|
Update the aggregate's name and optionally availability zone.
|
|
|
|
Positional arguments:
|
|
<aggregate> Name or ID of aggregate to update.
|
|
<name> Name of aggregate.
|
|
<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 <server> <name> <backup-type> <rotation>
|
|
|
|
Backup a server by creating a 'backup' type snapshot.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<name> Name of the backup image.
|
|
<backup-type> The backup type, like "daily" or "weekly".
|
|
<rotation> Int parameter representing how many backups to keep around.
|
|
|
|
</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 <datapath_id>]
|
|
[--port_no <port_no>]
|
|
<node> <address>
|
|
|
|
Add a network interface to a baremetal node.
|
|
|
|
Positional arguments:
|
|
<node> ID of node
|
|
<address> MAC address of interface
|
|
|
|
Optional arguments:
|
|
--datapath_id <datapath_id>
|
|
OpenFlow Datapath ID of interface
|
|
--port_no <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 <node>
|
|
|
|
List network interfaces associated with a baremetal node.
|
|
|
|
Positional arguments:
|
|
<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 <node> <address>
|
|
|
|
Remove a network interface from a baremetal node.
|
|
|
|
Positional arguments:
|
|
<node> ID of node
|
|
<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 <pm_address>]
|
|
[--pm_user <pm_user>]
|
|
[--pm_password <pm_password>]
|
|
[--terminal_port <terminal_port>]
|
|
<service_host> <cpus> <memory_mb> <local_gb>
|
|
<prov_mac_address>
|
|
|
|
Create a baremetal node.
|
|
|
|
Positional arguments:
|
|
<service_host> Name of nova compute host which will control this
|
|
baremetal node
|
|
<cpus> Number of CPUs in the node
|
|
<memory_mb> Megabytes of RAM in the node
|
|
<local_gb> Gigabytes of local storage in the node
|
|
<prov_mac_address> MAC address to provision the node
|
|
|
|
Optional arguments:
|
|
--pm_address <pm_address>
|
|
Power management IP for the node
|
|
--pm_user <pm_user> Username for the node's power management
|
|
--pm_password <pm_password>
|
|
Password for the node's power management
|
|
--terminal_port <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 <node>
|
|
|
|
Remove a baremetal node and any associated interfaces.
|
|
|
|
Positional arguments:
|
|
<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 <node>
|
|
|
|
Show information about a baremetal node.
|
|
|
|
Positional arguments:
|
|
<node> ID of node
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_boot">
|
|
<title>nova boot command</title>
|
|
<screen><computeroutput>usage: nova boot [--flavor <flavor>] [--image <image>]
|
|
[--image-with <key=value>] [--boot-volume <volume_id>]
|
|
[--snapshot <snapshot_id>] [--num-instances <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,port-id=port-uuid>]
|
|
[--config-drive <value>] [--poll]
|
|
<name>
|
|
|
|
Boot a new server.
|
|
|
|
Positional arguments:
|
|
<name> Name for the new server
|
|
|
|
Optional arguments:
|
|
--flavor <flavor> Name or ID of flavor (see 'nova flavor-list').
|
|
--image <image> Name or ID of image (see 'nova image-list').
|
|
--image-with <key=value>
|
|
Image metadata property (see 'nova image-show').
|
|
--boot-volume <volume_id>
|
|
Volume ID to boot from.
|
|
--snapshot <snapshot_id>
|
|
Sapshot ID to boot from (will create a volume).
|
|
--num-instances <number>
|
|
boot multiple servers at a time (limited by quota).
|
|
--meta <key=value> Record arbitrary key/value metadata to /meta.js on the
|
|
new server. Can be specified multiple times.
|
|
--file <dst-path=src-path>
|
|
Store arbitrary files from <src-path> locally to <dst-
|
|
path> on the new server. You may store up to 5 files.
|
|
--key-name <key-name>
|
|
Key name of keypair that should be created earlier
|
|
with the command keypair-add
|
|
--user-data <user-data>
|
|
user data file to pass to be exposed by the metadata
|
|
server.
|
|
--availability-zone <availability-zone>
|
|
The availability zone for server placement.
|
|
--security-groups <security-groups>
|
|
Comma separated list of security group names.
|
|
--block-device-mapping <dev-name=mapping>
|
|
Block device mapping in the format <dev-
|
|
name>=<id>:<type>:<size(GB)>:<delete-on-terminate>.
|
|
--block-device key1=value1[,key2=value2...]
|
|
Block device mapping with the keys: id=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 <swap_size> Create and attach a local swap block device of
|
|
<swap_size> MB.
|
|
--ephemeral size=<size>[,format=<format>]
|
|
Create and attach a local ephemeral block device of
|
|
<size> GB and format it to <format>.
|
|
--hint <key=value> Send arbitrary key/value pairs to the scheduler for
|
|
custom use.
|
|
--nic <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 <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 <cell-name>]
|
|
|
|
Get cell capacities for all cells or a given cell.
|
|
|
|
Optional arguments:
|
|
--cell <cell-name> Name of the cell to get the capacities.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_cell-show">
|
|
<title>nova cell-show command</title>
|
|
<screen><computeroutput>usage: nova cell-show <cell-name>
|
|
|
|
Show details of a given cell.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Clear password for a server.
|
|
|
|
Positional arguments:
|
|
<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 <ip address> <port>
|
|
|
|
Update the VPN IP/port of a cloudpipe instance.
|
|
|
|
Positional arguments:
|
|
<ip address> New IP Address.
|
|
<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 <project_id>
|
|
|
|
Create a cloudpipe instance for the given project.
|
|
|
|
Positional arguments:
|
|
<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 <length>] <server>
|
|
|
|
Get console log output of a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
|
|
Optional arguments:
|
|
--length <length> Length in lines to tail.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_credentials">
|
|
<title>nova credentials command</title>
|
|
<screen><computeroutput>usage: nova credentials [--wrap <integer>]
|
|
|
|
Show user credentials returned from auth.
|
|
|
|
Optional arguments:
|
|
--wrap <integer> wrap PKI tokens to a specified length, or 0 to disable
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_delete">
|
|
<title>nova delete command</title>
|
|
<screen><computeroutput>usage: nova delete <server> [<server> ...]
|
|
|
|
Immediately shut down and delete specified server(s).
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Retrieve server diagnostics.
|
|
|
|
Positional arguments:
|
|
<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 <type>] <ip> <name> <domain>
|
|
|
|
Create a DNS entry for domain, name and ip.
|
|
|
|
Positional arguments:
|
|
<ip> ip address
|
|
<name> DNS name
|
|
<domain> DNS domain
|
|
|
|
Optional arguments:
|
|
--type <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 <availability-zone>]
|
|
<domain>
|
|
|
|
Create the specified DNS domain.
|
|
|
|
Positional arguments:
|
|
<domain> DNS domain
|
|
|
|
Optional arguments:
|
|
--availability-zone <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 <project>] <domain>
|
|
|
|
Create the specified DNS domain.
|
|
|
|
Positional arguments:
|
|
<domain> DNS domain
|
|
|
|
Optional arguments:
|
|
--project <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 <domain> <name>
|
|
|
|
Delete the specified DNS entry.
|
|
|
|
Positional arguments:
|
|
<domain> DNS domain
|
|
<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 <domain>
|
|
|
|
Delete the specified DNS domain.
|
|
|
|
Positional arguments:
|
|
<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 <ip>] [--name <name>] <domain>
|
|
|
|
List current DNS entries for domain and ip or domain and name.
|
|
|
|
Positional arguments:
|
|
<domain> DNS domain
|
|
|
|
Optional arguments:
|
|
--ip <ip> ip address
|
|
--name <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 <password>] [--on-shared-storage]
|
|
<server> <host>
|
|
|
|
Evacuate server from failed host to specified one.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<host> Name or ID of target host.
|
|
|
|
Optional arguments:
|
|
--password <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 <fixed_ip>
|
|
|
|
Retrieve info on a fixed ip.
|
|
|
|
Positional arguments:
|
|
<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 <fixed_ip>
|
|
|
|
Reserve a fixed IP.
|
|
|
|
Positional arguments:
|
|
<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 <fixed_ip>
|
|
|
|
Unreserve a fixed IP.
|
|
|
|
Positional arguments:
|
|
<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 <flavor> <tenant_id>
|
|
|
|
Add flavor access for the given tenant.
|
|
|
|
Positional arguments:
|
|
<flavor> Flavor name or ID to add access for the given tenant.
|
|
<tenant_id> Tenant ID to add flavor access for.
|
|
|
|
</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 <flavor>] [--tenant <tenant_id>]
|
|
|
|
Print access information about the given flavor.
|
|
|
|
Optional arguments:
|
|
--flavor <flavor> Filter results by flavor name or ID.
|
|
--tenant <tenant_id> Filter results by tenant ID.
|
|
|
|
</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 <flavor> <tenant_id>
|
|
|
|
Remove flavor access for the given tenant.
|
|
|
|
Positional arguments:
|
|
<flavor> Flavor name or ID to remove access for the given tenant.
|
|
<tenant_id> Tenant ID to remove flavor access for.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-create">
|
|
<title>nova flavor-create command</title>
|
|
<screen><computeroutput>usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
|
|
[--rxtx-factor <factor>] [--is-public <is-public>]
|
|
<name> <id> <ram> <disk> <vcpus>
|
|
|
|
Create a new flavor
|
|
|
|
Positional arguments:
|
|
<name> Name of the new flavor
|
|
<id> Unique ID (integer or UUID) for the new flavor. If
|
|
specifying 'auto', a UUID will be generated as id
|
|
<ram> Memory size in MB
|
|
<disk> Disk size in GB
|
|
<vcpus> Number of vcpus
|
|
|
|
Optional arguments:
|
|
--ephemeral <ephemeral>
|
|
Ephemeral space size in GB (default 0)
|
|
--swap <swap> Swap space size in MB (default 0)
|
|
--rxtx-factor <factor>
|
|
RX/TX factor (default 1)
|
|
--is-public <is-public>
|
|
Make flavor accessible to the public (default true)
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_flavor-delete">
|
|
<title>nova flavor-delete command</title>
|
|
<screen><computeroutput>usage: nova flavor-delete <flavor>
|
|
|
|
Delete a specific flavor
|
|
|
|
Positional arguments:
|
|
<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 <flavor> <action> <key=value> [<key=value> ...]
|
|
|
|
Set or unset extra_spec for a flavor.
|
|
|
|
Positional arguments:
|
|
<flavor> Name or ID of flavor
|
|
<action> Actions: 'set' or 'unset'
|
|
<key=value> Extra_specs to set/unset (only key is necessary on unset)
|
|
|
|
</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 <flavor>
|
|
|
|
Show details about the given flavor.
|
|
|
|
Positional arguments:
|
|
<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 <fixed_address>]
|
|
<server> <address>
|
|
|
|
Associate a floating IP address to a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<address> IP Address.
|
|
|
|
Optional arguments:
|
|
--fixed-address <fixed_address>
|
|
Fixed IP Address to associate with.
|
|
|
|
</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 <pool>] [--interface <interface>]
|
|
<range>
|
|
|
|
Bulk create floating ips by range.
|
|
|
|
Positional arguments:
|
|
<range> Address range to create
|
|
|
|
Optional arguments:
|
|
--pool <pool> Pool for new Floating IPs
|
|
--interface <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 <range>
|
|
|
|
Bulk delete floating ips by range.
|
|
|
|
Positional arguments:
|
|
<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 <host>]
|
|
|
|
List all floating ips.
|
|
|
|
Optional arguments:
|
|
--host <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 [<floating-ip-pool>]
|
|
|
|
Allocate a floating IP for the current tenant.
|
|
|
|
Positional arguments:
|
|
<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 <address>
|
|
|
|
De-allocate a floating IP.
|
|
|
|
Positional arguments:
|
|
<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 <server> <address>
|
|
|
|
Disassociate a floating IP address from a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<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 <server>
|
|
|
|
Force delete a server.
|
|
|
|
Positional arguments:
|
|
<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 <server> [<private-key>]
|
|
|
|
Get password for a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<private-key> Private key (used locally to decrypt password) (Optional).
|
|
When specified, the command displays the clear (decrypted) VM
|
|
password. When not specified, the ciphered VM password is
|
|
displayed.
|
|
|
|
</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 <server> <console-type>
|
|
|
|
Get a spice console to a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<console-type> Type of spice console ("spice-html5").
|
|
|
|
</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 <server> <console-type>
|
|
|
|
Get a vnc console to a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<console-type> Type of vnc console ("novnc" or "xvpvnc").
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-action">
|
|
<title>nova host-action command</title>
|
|
<screen><computeroutput>usage: nova host-action [--action <action>] <hostname>
|
|
|
|
Perform a power action on a host.
|
|
|
|
Positional arguments:
|
|
<hostname> Name of host.
|
|
|
|
Optional arguments:
|
|
--action <action> A power action: startup, reboot, or shutdown.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-describe">
|
|
<title>nova host-describe command</title>
|
|
<screen><computeroutput>usage: nova host-describe <hostname>
|
|
|
|
Describe a specific host.
|
|
|
|
Positional arguments:
|
|
<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 <target_host>] [--on-shared-storage]
|
|
<host>
|
|
|
|
Evacuate all instances from failed host to specified one.
|
|
|
|
Positional arguments:
|
|
<host> Name of host.
|
|
|
|
Optional arguments:
|
|
--target_host <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 <zone>]
|
|
|
|
List all hosts by service.
|
|
|
|
Optional arguments:
|
|
--zone <zone> Filters the list, returning only those hosts in the
|
|
availability zone <zone>.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_host-meta">
|
|
<title>nova host-meta command</title>
|
|
<screen><computeroutput>usage: nova host-meta <host> <action> <key=value> [<key=value> ...]
|
|
|
|
Set or Delete metadata on all instances of a host.
|
|
|
|
Positional arguments:
|
|
<host> Name of host.
|
|
<action> Actions: 'set' or 'delete'
|
|
<key=value> Metadata to set or delete (only key is necessary on delete)
|
|
|
|
</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 <host>
|
|
|
|
Migrate all instances of the specified host to other available hosts.
|
|
|
|
Positional arguments:
|
|
<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 <enable|disable>]
|
|
[--maintenance <enable|disable>]
|
|
<hostname>
|
|
|
|
Update host settings.
|
|
|
|
Positional arguments:
|
|
<hostname> Name of host.
|
|
|
|
Optional arguments:
|
|
--status <enable|disable>
|
|
Either enable or disable a host.
|
|
--maintenance <enable|disable>
|
|
Either put or resume host to/from maintenance.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_hypervisor-list">
|
|
<title>nova hypervisor-list command</title>
|
|
<screen><computeroutput>usage: nova hypervisor-list [--matching <hostname>]
|
|
|
|
List hypervisors.
|
|
|
|
Optional arguments:
|
|
--matching <hostname>
|
|
List hypervisors matching the given <hostname>.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_hypervisor-servers">
|
|
<title>nova hypervisor-servers command</title>
|
|
<screen><computeroutput>usage: nova hypervisor-servers <hostname>
|
|
|
|
List servers belonging to specific hypervisors.
|
|
|
|
Positional arguments:
|
|
<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 <hypervisor>
|
|
|
|
Display the details of the specified hypervisor.
|
|
|
|
Positional arguments:
|
|
<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 <hypervisor>
|
|
|
|
Display the uptime of the specified hypervisor.
|
|
|
|
Positional arguments:
|
|
<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] <server> <name>
|
|
|
|
Create a new image by taking a snapshot of a running server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<name> Name of snapshot.
|
|
|
|
Optional arguments:
|
|
--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 <image> [<image> ...]
|
|
|
|
Delete specified image(s).
|
|
|
|
Positional arguments:
|
|
<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 <limit>]
|
|
|
|
Print a list of available images to boot from.
|
|
|
|
Optional arguments:
|
|
--limit <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 <image> <action> <key=value> [<key=value> ...]
|
|
|
|
Set or Delete metadata on an image.
|
|
|
|
Positional arguments:
|
|
<image> Name or ID of image
|
|
<action> Actions: 'set' or 'delete'
|
|
<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 <image>
|
|
|
|
Show details about the given image.
|
|
|
|
Positional arguments:
|
|
<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 <server> <request_id>
|
|
|
|
Show an action.
|
|
|
|
Positional arguments:
|
|
<server> Name or UUID of the server to show an action for.
|
|
<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 <server>
|
|
|
|
List actions on a server.
|
|
|
|
Positional arguments:
|
|
<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 <port_id>] [--net-id <net_id>]
|
|
[--fixed-ip <fixed_ip>]
|
|
<server>
|
|
|
|
Attach a network interface to a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
|
|
Optional arguments:
|
|
--port-id <port_id> Port ID.
|
|
--net-id <net_id> Network ID
|
|
--fixed-ip <fixed_ip>
|
|
Requested fixed IP.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_interface-detach">
|
|
<title>nova interface-detach command</title>
|
|
<screen><computeroutput>usage: nova interface-detach <server> <port_id>
|
|
|
|
Detach a network interface from a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<port_id> Port ID.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_interface-list">
|
|
<title>nova interface-list command</title>
|
|
<screen><computeroutput>usage: nova interface-list <server>
|
|
|
|
List interfaces attached to a server.
|
|
|
|
Positional arguments:
|
|
<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 <pub-key>] <name>
|
|
|
|
Create a new key pair for use with servers.
|
|
|
|
Positional arguments:
|
|
<name> Name of key.
|
|
|
|
Optional arguments:
|
|
--pub-key <pub-key> Path to a public ssh key.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_keypair-delete">
|
|
<title>nova keypair-delete command</title>
|
|
<screen><computeroutput>usage: nova keypair-delete <name>
|
|
|
|
Delete keypair given by its name.
|
|
|
|
Positional arguments:
|
|
<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 <keypair>
|
|
|
|
Show details about the given keypair.
|
|
|
|
Positional arguments:
|
|
<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 <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]
|
|
|
|
List active servers.
|
|
|
|
Optional arguments:
|
|
--reservation-id <reservation-id>
|
|
Only return servers that match reservation-id.
|
|
--ip <ip-regexp> Search with regular expression match by IP address
|
|
(Admin only).
|
|
--ip6 <ip6-regexp> Search with regular expression match by IPv6 address
|
|
(Admin only).
|
|
--name <name-regexp> Search with regular expression match by name
|
|
--instance-name <name-regexp>
|
|
Search with regular expression match by server name
|
|
(Admin only).
|
|
--status <status> Search by server status
|
|
--flavor <flavor> Search by flavor name or ID
|
|
--image <image> Search by image name or ID
|
|
--host <hostname> Search servers by hostname to which they are assigned
|
|
(Admin only).
|
|
--all-tenants [<0|1>]
|
|
Display information from all tenants (Admin only).
|
|
--tenant [<tenant>] Display information from single tenant (Admin only).
|
|
--deleted Only display deleted servers (Admin only).
|
|
--fields <fields> Comma-separated list of fields to display. Use the
|
|
show command to see which fields are available.
|
|
--minimal Get only uuid and name.
|
|
|
|
</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 <server>
|
|
|
|
List Security Group(s) of a server.
|
|
|
|
Positional arguments:
|
|
<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]
|
|
<server> [<host>]
|
|
|
|
Migrate running server to a new machine.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<host> destination host name.
|
|
|
|
Optional arguments:
|
|
--block-migrate True in case of block_migration.
|
|
(Default=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 <server>
|
|
|
|
Lock a server.
|
|
|
|
Positional arguments:
|
|
<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 <server> <action> <key=value> [<key=value> ...]
|
|
|
|
Set or Delete metadata on a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server
|
|
<action> Actions: 'set' or 'delete'
|
|
<key=value> Metadata to set or delete (only key is necessary on delete)
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_migrate">
|
|
<title>nova migrate command</title>
|
|
<screen><computeroutput>usage: nova migrate [--poll] <server>
|
|
|
|
Migrate a server. The new host will be selected by the scheduler.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
|
|
Optional arguments:
|
|
--poll 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 <host>] [--status <status>]
|
|
[--cell_name <cell_name>]
|
|
|
|
Print a list of migrations.
|
|
|
|
Optional arguments:
|
|
--host <host> Fetch migrations for the given host.
|
|
--status <status> Fetch migrations for the given status.
|
|
--cell_name <cell_name>
|
|
Fetch migrations for the given cell_name.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_net">
|
|
<title>nova net command</title>
|
|
<screen><computeroutput>usage: nova net <network_id>
|
|
|
|
Show a network
|
|
|
|
Positional arguments:
|
|
<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 <network_label> <cidr>
|
|
|
|
Create a network
|
|
|
|
Positional arguments:
|
|
<network_label> Network label (ex. my_new_network)
|
|
<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 <network_id>
|
|
|
|
Delete a network
|
|
|
|
Positional arguments:
|
|
<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 <network> <host>
|
|
|
|
Associate host with network.
|
|
|
|
Positional arguments:
|
|
<network> uuid of network
|
|
<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 <network>
|
|
|
|
Associate project with network.
|
|
|
|
Positional arguments:
|
|
<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 <x.x.x.x/yy>]
|
|
[--fixed-range-v6 CIDR_V6] [--vlan <vlan id>]
|
|
[--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>]
|
|
<network_label>
|
|
|
|
Create a network.
|
|
|
|
Positional arguments:
|
|
<network_label> Label for network
|
|
|
|
Optional arguments:
|
|
--fixed-range-v4 <x.x.x.x/yy>
|
|
IPv4 subnet (ex: 10.0.0.0/8)
|
|
--fixed-range-v6 CIDR_V6
|
|
IPv6 subnet (ex: fe80::/64
|
|
--vlan <vlan id> vlan id
|
|
--vpn <vpn start> vpn start
|
|
--gateway GATEWAY gateway
|
|
--gateway-v6 GATEWAY_V6
|
|
ipv6 gateway
|
|
--bridge <bridge> VIFs on this network are connected to this bridge
|
|
--bridge-interface <bridge interface>
|
|
the bridge is connected to this interface
|
|
--multi-host <'T'|'F'>
|
|
Multi host
|
|
--dns1 <DNS Address> First DNS
|
|
--dns2 <DNS Address> Second DNS
|
|
--uuid <network uuid>
|
|
Network UUID
|
|
--fixed-cidr <x.x.x.x/yy>
|
|
IPv4 subnet for fixed IPS (ex: 10.20.0.0/16)
|
|
--project-id <project id>
|
|
Project id
|
|
--priority <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 [<0|1>]]
|
|
[--project-only [<0|1>]]
|
|
<network>
|
|
|
|
Disassociate host and/or project from the given network.
|
|
|
|
Positional arguments:
|
|
<network> uuid of network
|
|
|
|
Optional arguments:
|
|
--host-only [<0|1>]
|
|
--project-only [<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 <network>
|
|
|
|
Show details about the given network.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Pause a server.
|
|
|
|
Positional arguments:
|
|
<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 <class>
|
|
|
|
List the quotas for a quota class.
|
|
|
|
Positional arguments:
|
|
<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 <instances>] [--cores <cores>]
|
|
[--ram <ram>] [--volumes <volumes>]
|
|
[--gigabytes <gigabytes>]
|
|
[--floating-ips <floating-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>]
|
|
<class>
|
|
|
|
Update the quotas for a quota class.
|
|
|
|
Positional arguments:
|
|
<class> Name of quota class to set the quotas for.
|
|
|
|
Optional arguments:
|
|
--instances <instances>
|
|
New value for the "instances" quota.
|
|
--cores <cores> New value for the "cores" quota.
|
|
--ram <ram> New value for the "ram" quota.
|
|
--volumes <volumes> New value for the "volumes" quota.
|
|
--gigabytes <gigabytes>
|
|
New value for the "gigabytes" quota.
|
|
--floating-ips <floating-ips>
|
|
New value for the "floating-ips" quota.
|
|
--metadata-items <metadata-items>
|
|
New value for the "metadata-items" quota.
|
|
--injected-files <injected-files>
|
|
New value for the "injected-files" quota.
|
|
--injected-file-content-bytes <injected-file-content-bytes>
|
|
New value for the "injected-file-content-bytes" quota.
|
|
--injected-file-path-bytes <injected-file-path-bytes>
|
|
New value for the "injected-file-path-bytes" quota.
|
|
--key-pairs <key-pairs>
|
|
New value for the "key-pairs" quota.
|
|
--security-groups <security-groups>
|
|
New value for the "security-groups" quota.
|
|
--security-group-rules <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 <tenant-id>]
|
|
|
|
List the default quotas for a tenant.
|
|
|
|
Optional arguments:
|
|
--tenant <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 <tenant-id>] [--user <user-id>]
|
|
|
|
Delete quota for a tenant/user so their quota will Revert back to default.
|
|
|
|
Optional arguments:
|
|
--tenant <tenant-id> ID of tenant to delete quota for.
|
|
--user <user-id> ID of user to delete quota for.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_quota-show">
|
|
<title>nova quota-show command</title>
|
|
<screen><computeroutput>usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>]
|
|
|
|
List the quotas for a tenant/user.
|
|
|
|
Optional arguments:
|
|
--tenant <tenant-id> ID of tenant to list the quotas for.
|
|
--user <user-id> ID of user to list the quotas for.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_quota-update">
|
|
<title>nova quota-update command</title>
|
|
<screen><computeroutput>usage: nova quota-update [--user <user-id>] [--instances <instances>]
|
|
[--cores <cores>] [--ram <ram>] [--volumes <volumes>]
|
|
[--gigabytes <gigabytes>]
|
|
[--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>]
|
|
[--force]
|
|
<tenant-id>
|
|
|
|
Update the quotas for a tenant/user.
|
|
|
|
Positional arguments:
|
|
<tenant-id> ID of tenant to set the quotas for.
|
|
|
|
Optional arguments:
|
|
--user <user-id> ID of user to set the quotas for.
|
|
--instances <instances>
|
|
New value for the "instances" quota.
|
|
--cores <cores> New value for the "cores" quota.
|
|
--ram <ram> New value for the "ram" quota.
|
|
--volumes <volumes> New value for the "volumes" quota.
|
|
--gigabytes <gigabytes>
|
|
New value for the "gigabytes" quota.
|
|
--floating-ips <floating-ips>
|
|
New value for the "floating-ips" quota.
|
|
--fixed-ips <fixed-ips>
|
|
New value for the "fixed-ips" quota.
|
|
--metadata-items <metadata-items>
|
|
New value for the "metadata-items" quota.
|
|
--injected-files <injected-files>
|
|
New value for the "injected-files" quota.
|
|
--injected-file-content-bytes <injected-file-content-bytes>
|
|
New value for the "injected-file-content-bytes" quota.
|
|
--injected-file-path-bytes <injected-file-path-bytes>
|
|
New value for the "injected-file-path-bytes" quota.
|
|
--key-pairs <key-pairs>
|
|
New value for the "key-pairs" quota.
|
|
--security-groups <security-groups>
|
|
New value for the "security-groups" quota.
|
|
--security-group-rules <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] <server>
|
|
|
|
Reboot a server.
|
|
|
|
Positional arguments:
|
|
<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 <rebuild-password>] [--poll]
|
|
[--minimal] [--preserve-ephemeral]
|
|
<server> <image>
|
|
|
|
Shutdown, re-image, and re-boot a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<image> Name or ID of new image.
|
|
|
|
Optional arguments:
|
|
--rebuild-password <rebuild-password>
|
|
Set the provided 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 <server> <address>
|
|
|
|
Remove an IP address from a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<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 <server> <secgroup>
|
|
|
|
Remove a Security Group from a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<secgroup> Name of Security Group.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_rename">
|
|
<title>nova rename command</title>
|
|
<screen><computeroutput>usage: nova rename <server> <name>
|
|
|
|
Rename a server.
|
|
|
|
Positional arguments:
|
|
<server> Name (old name) or ID of server.
|
|
<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 <server>
|
|
|
|
Rescue a server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Reset network of a server.
|
|
|
|
Positional arguments:
|
|
<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] <server>
|
|
|
|
Reset the state of a server.
|
|
|
|
Positional arguments:
|
|
<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] <server> <flavor>
|
|
|
|
Resize a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<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 <server>
|
|
|
|
Confirm a previous resize.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Revert a previous resize (and return to the previous VM).
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Restore a soft-deleted server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Resume a server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Change the root password for a server.
|
|
|
|
Positional arguments:
|
|
<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 <project_id>
|
|
|
|
Delete data associated with the project.
|
|
|
|
Positional arguments:
|
|
<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 <secgroup> <source-group> <ip-proto>
|
|
<from-port> <to-port>
|
|
|
|
Add a source group rule to a security group.
|
|
|
|
Positional arguments:
|
|
<secgroup> ID or name of security group.
|
|
<source-group> ID or name of source group.
|
|
<ip-proto> IP protocol (icmp, tcp, udp).
|
|
<from-port> Port at start of range.
|
|
<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 <secgroup> <ip-proto> <from-port> <to-port>
|
|
<cidr>
|
|
|
|
Add a rule to a security group.
|
|
|
|
Positional arguments:
|
|
<secgroup> ID or name of security group.
|
|
<ip-proto> IP protocol (icmp, tcp, udp).
|
|
<from-port> Port at start of range.
|
|
<to-port> Port at end of range.
|
|
<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 <name> <description>
|
|
|
|
Create a security group.
|
|
|
|
Positional arguments:
|
|
<name> Name of security group.
|
|
<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 <secgroup>
|
|
|
|
Delete a security group.
|
|
|
|
Positional arguments:
|
|
<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 <secgroup> <source-group> <ip-proto>
|
|
<from-port> <to-port>
|
|
|
|
Delete a source group rule from a security group.
|
|
|
|
Positional arguments:
|
|
<secgroup> ID or name of security group.
|
|
<source-group> ID or name of source group.
|
|
<ip-proto> IP protocol (icmp, tcp, udp).
|
|
<from-port> Port at start of range.
|
|
<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 <secgroup> <ip-proto> <from-port> <to-port>
|
|
<cidr>
|
|
|
|
Delete a rule from a security group.
|
|
|
|
Positional arguments:
|
|
<secgroup> ID or name of security group.
|
|
<ip-proto> IP protocol (icmp, tcp, udp).
|
|
<from-port> Port at start of range.
|
|
<to-port> Port at end of range.
|
|
<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 [<0|1>]]
|
|
|
|
List security groups for the current tenant.
|
|
|
|
Optional arguments:
|
|
--all-tenants [<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 <secgroup>
|
|
|
|
List rules for a security group.
|
|
|
|
Positional arguments:
|
|
<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 <secgroup> <name> <description>
|
|
|
|
Update a security group.
|
|
|
|
Positional arguments:
|
|
<secgroup> ID or name of security group.
|
|
<name> Name of security group.
|
|
<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 <reason>] <hostname> <binary>
|
|
|
|
Disable the service.
|
|
|
|
Positional arguments:
|
|
<hostname> Name of host.
|
|
<binary> Service binary.
|
|
|
|
Optional arguments:
|
|
--reason <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 <hostname> <binary>
|
|
|
|
Enable the service.
|
|
|
|
Positional arguments:
|
|
<hostname> Name of host.
|
|
<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 <hostname>] [--binary <binary>]
|
|
|
|
Show a list of all running services. Filter by host & binary.
|
|
|
|
Optional arguments:
|
|
--host <hostname> Name of host.
|
|
--binary <binary> Service binary.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_shelve">
|
|
<title>nova shelve command</title>
|
|
<screen><computeroutput>usage: nova shelve <server>
|
|
|
|
Shelve a server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Remove a shelved server from the compute node.
|
|
|
|
Positional arguments:
|
|
<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] <server>
|
|
|
|
Show details about the given server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
|
|
Optional arguments:
|
|
--minimal Skips flavor/image lookups when showing servers
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_ssh">
|
|
<title>nova ssh command</title>
|
|
<screen><computeroutput>usage: nova ssh [--port PORT] [--private] [--ipv6] [--login <login>]
|
|
[-i IDENTITY] [--extra-opts EXTRA]
|
|
<server>
|
|
|
|
SSH into a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
|
|
Optional arguments:
|
|
--port PORT Optional flag to indicate which port to use for ssh.
|
|
(Default=22)
|
|
--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 <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 <server>
|
|
|
|
Start a server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Stop a server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Suspend a server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Unlock a server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Unpause a server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Unrescue a server.
|
|
|
|
Positional arguments:
|
|
<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 <server>
|
|
|
|
Unshelve a server.
|
|
|
|
Positional arguments:
|
|
<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 <start>] [--end <end>] [--tenant <tenant-id>]
|
|
|
|
Show usage data for a single tenant.
|
|
|
|
Optional arguments:
|
|
--start <start> Usage range start date ex 2012-01-20 (default: 4 weeks
|
|
ago)
|
|
--end <end> Usage range end date, ex 2012-01-20 (default:
|
|
tomorrow)
|
|
--tenant <tenant-id> UUID 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 <start>] [--end <end>]
|
|
|
|
List usage data for all tenants.
|
|
|
|
Optional arguments:
|
|
--start <start> Usage range start date ex 2012-01-20 (default: 4 weeks ago)
|
|
--end <end> Usage range end date, ex 2012-01-20 (default: tomorrow)
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-attach">
|
|
<title>nova volume-attach command</title>
|
|
<screen><computeroutput>usage: nova volume-attach <server> <volume> [<device>]
|
|
|
|
Attach a volume to a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<volume> ID of the volume to attach.
|
|
<device> Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if
|
|
supported)
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="novaclient_subcommand_volume-create">
|
|
<title>nova volume-create command</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>
|
|
|
|
Add a new volume.
|
|
|
|
Positional arguments:
|
|
<size> Size of volume in GB
|
|
|
|
Optional arguments:
|
|
--snapshot-id <snapshot-id>
|
|
Optional snapshot id to create the volume from.
|
|
(Default=None)
|
|
--image-id <image-id>
|
|
Optional image id to create the volume from.
|
|
(Default=None)
|
|
--display-name <display-name>
|
|
Optional volume name. (Default=None)
|
|
--display-description <display-description>
|
|
Optional volume description. (Default=None)
|
|
--volume-type <volume-type>
|
|
Optional volume type. (Default=None)
|
|
--availability-zone <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 <volume> [<volume> ...]
|
|
|
|
Remove volume(s).
|
|
|
|
Positional arguments:
|
|
<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 <server> <volume>
|
|
|
|
Detach a volume from a server.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<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 [<0|1>]]
|
|
|
|
List all the volumes.
|
|
|
|
Optional arguments:
|
|
--all-tenants [<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 <volume>
|
|
|
|
Show details about a volume.
|
|
|
|
Positional arguments:
|
|
<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 <True|False>]
|
|
[--display-name <display-name>]
|
|
[--display-description <display-description>]
|
|
<volume-id>
|
|
|
|
Add a new snapshot.
|
|
|
|
Positional arguments:
|
|
<volume-id> ID of the volume to snapshot
|
|
|
|
Optional arguments:
|
|
--force <True|False> Optional flag to indicate whether to snapshot a volume
|
|
even if its attached to a server. (Default=False)
|
|
--display-name <display-name>
|
|
Optional snapshot name. (Default=None)
|
|
--display-description <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 <snapshot>
|
|
|
|
Remove a snapshot.
|
|
|
|
Positional arguments:
|
|
<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 <snapshot>
|
|
|
|
Show details about a snapshot.
|
|
|
|
Positional arguments:
|
|
<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 <name>
|
|
|
|
Create a new volume type.
|
|
|
|
Positional arguments:
|
|
<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 <id>
|
|
|
|
Delete a specific flavor
|
|
|
|
Positional arguments:
|
|
<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 <server> <volume> <volume>
|
|
|
|
Update volume attachment.
|
|
|
|
Positional arguments:
|
|
<server> Name or ID of server.
|
|
<volume> Attachment ID of the volume.
|
|
<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 [<private-key-filename>] [<x509-cert-filename>]
|
|
|
|
Create x509 cert for a user in tenant.
|
|
|
|
Positional arguments:
|
|
<private-key-filename>
|
|
Filename for the private key [Default: pk.pem]
|
|
<x509-cert-filename> Filename for the X.509 certificate [Default: cert.pem]
|
|
|
|
</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 [<filename>]
|
|
|
|
Fetch the x509 root cert.
|
|
|
|
Positional arguments:
|
|
<filename> Filename to write the x509 root cert.
|
|
|
|
</computeroutput></screen>
|
|
</section>
|
|
</section>
|