Skip to content

Commit

Permalink
Complete sentence in nova cli commands section
Browse files Browse the repository at this point in the history 
Completed the definition for bash-completion
Added info about tab completion of commands
Fixed punctuation and ran a spellcheck of the file
Removed white spaces from patch 1

Closes-Bug: 1214505
Change-Id: I2be0c5fcf564526fa74a6f0210f174369312288d
Author: Nermina Miller
  • Loading branch information
@nerminamiller
nerminamiller committed Sep 22, 2013
1 parent e9a8d33 commit a3456b8
Showing 1 changed file with 30 additions and 29 deletions.
59 changes: 30 additions & 29 deletions doc/common/section_nova_cli_commands.xml
View file
Expand Up @@ -4,8 +4,8 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="novaclient_commands">
<title>nova commands</title>
<para>The nova client is the command-line interface for the
OpenStack Compute API and its extensions.</para>
<para>The nova client is the command-line interface for the Compute API and its
extensions.</para>
<para>For help on a specific nova command, enter:</para>
<screen><prompt>$</prompt> <userinput><command>nova</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
Expand All @@ -26,13 +26,13 @@
<example>
<title>Positional arguments</title>
<screen><computeroutput>&lt;subcommand>
absolute-limits Print a list of absolute limits for a user
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 Add a floating IP address to a server.
add-secgroup Add a Security Group to a server.
agent-create Creates a new agent build.
agent-delete Deletes an existing agent build.
agent-list List all builds
agent-list List all builds.
agent-modify Modify an existing agent build.
aggregate-add-host Add the host to the specified aggregate.
aggregate-create Create a new aggregate with the specified details.
Expand All @@ -48,18 +48,18 @@
availability zone.
availability-zone-list
List all the availability zones.
backup Backup a instance by create a 'backup' type snapshot
backup Backup a instance by create 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
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.
coverage-report Generate a coverage report
coverage-report Generate a coverage report.
coverage-reset Reset coverage data.
coverage-start Start Nova coverage reporting
coverage-stop Stop Nova coverage reporting
coverage-start Start Nova coverage reporting.
coverage-stop Stop Nova coverage reporting.
credentials Show user credentials returned from auth
delete Immediately shut down and delete specified server(s).
diagnostics Retrieve server diagnostics.
Expand All @@ -74,16 +74,16 @@
dns-list List current DNS entries for domain and ip or domain
and name.
endpoints Discover endpoints that get returned from the
authenticate services
authenticate services.
evacuate Evacuate server from failed host to specified one.
fixed-ip-get Get info on a fixed ip
fixed-ip-reserve Reserve a fixed ip
fixed-ip-unreserve Unreserve a fixed ip
fixed-ip-get Get 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-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
Expand All @@ -104,8 +104,8 @@
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-describe Describe a specific host.
host-list List all hosts by service.
host-update Update host settings.
hypervisor-list List hypervisors.
hypervisor-servers List instances belonging to specific hypervisors.
Expand All @@ -121,9 +121,9 @@
interface-attach Attach a network interface to an instance.
interface-detach Detach a network interface from an instance.
interface-list List interfaces attached to an instance.
keypair-add Create a new key pair for use with instances
keypair-delete Delete keypair by its name
keypair-list Print a list of keypairs for a user
keypair-add Create a new key pair for use with instances.
keypair-delete Delete keypair by its name.
keypair-list Print a list of keypairs for a user.
list List active servers.
live-migration Migrates a running instance to a new machine.
lock Lock a server.
Expand All @@ -148,7 +148,7 @@
back to default.
quota-show List the quotas for a tenant.
quota-update Update the quotas for a tenant.
rate-limits Print a list of rate limits for a 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.
Expand All @@ -157,14 +157,14 @@
rename Rename a server.
rescue Rescue a server.
reset-network Reset network of an instance.
reset-state Reset the state of an instance
reset-state Reset the state of an instance.
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 Deletes data associated with the project
scrub Deletes 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.
Expand All @@ -178,8 +178,8 @@
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-disable Disable the service.
service-enable Enable the service.
service-list Show a list of all running services. Filter by host &amp;
binary.
show Show details about the given server.
Expand Down Expand Up @@ -209,10 +209,11 @@
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'.
x509-create-cert Create x509 cert for a user in tenant
x509-create-cert Create x509 cert for a user in tenant.
x509-get-root-cert Fetches the x509 root cert.
bash-completion Prints all of the commands and options to stdout so
that the
bash-completion Prints out a list of all possible commands and flags
that the nova command can accept. Can be used by bash
for tab-completion of commands.
help Display help about this program or one of its
subcommands.
baremetal-interface-add
Expand Down Expand Up @@ -244,7 +245,7 @@
</example>
<example>
<title>Optional arguments</title>
<screen><computeroutput> --version Show program's version number and exit.
<screen><computeroutput> --version Show program's version number and exit.
--debug Print debugging output.
--force Force quota-update.
--os-cache Use the auth token cache.
Expand Down

0 comments on commit a3456b8

Please sign in to comment.