Red Hat Bugzilla – Bug 976431
nova: nova boot usage is not clear
Last modified: 2015-06-04 17:52:08 EDT
Description of problem:
there are a few things that I could not figure out in 'nova boot':
1. if running 'nova boot' without any paranms I would expect to see what are the optional and what are the required params for the command. but this is the output and I am not sure which is required and which is not:
[root@opens-vdsb log(keystone_admin)]# nova boot
usage: nova boot [--flavor <flavor>] [--image <image>]
[--image-with <key=value>] [--num-instances <number>]
[--meta <key=value>] [--file <dst-path=src-path>]
[--key-name <key-name>] [--user-data <user-data>]
[--config-drive <value>] [--poll]
error: too few arguments
Try 'nova help boot' for more information.
2. I tried to find --key-name option in both --help and man page and could not find it. also asking around I found that the command actually runs with key_name and not key-name
Version-Release number of selected component (if applicable):
Steps to Reproduce:
1. run 'nova boot'
command is not clear and not all params explanations are in man or --help
users need to know what params are required and have information in man on other optional params.
All OpenStack clients use the same syntax for getting the help associated to a subcommand or the client itself:
1. To get help for the a client use: <client> help
2. To get help for the a subcommand use: <client> help <subcommand>
e.g. In your case you would run 'nova help boot', there you can find a proper explanation with all the parameters needed to boot (including key-name).