Added more information to cli help/man

This commit is contained in:
Javi Fontan committed 2010-10-20 17:53:25 +02:00
1 parent 480b1c515e
commit 4cd7ddff2c
23 files changed
+122 -6

No files matched your search

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
+6
View File
@@ -45,6 +45,12 @@ COMMANDS_HELP=<<-EOT
Usage:
oneauth <command> [<parameters>]
Description:
This command contains a set of utilities to manage authorization module.
Commands:
* quota set (sets quota for a user)
+8
View File
@@ -88,6 +88,14 @@ end
class OneUPParse < CommandParse
COMMANDS_HELP=<<-EOT
Description:
This command enables the OpenNebula administrator to manage clusters. The
administrator can create, delete, as well as add and remove hosts from them.
Any user can list available clusters.
Commands:
* create (Creates a new user)
+22
View File
@@ -166,6 +166,14 @@ end
class OnehostParse < CommandParse
COMMANDS_HELP=<<-EOT
Description:
This command enables the user to manage hosts in the Open Nebula server. It
provides functionality to allocate, get information and delete a particular
host or to list all the available hosts.
Commands:
* create (Adds a new machine to the pool)
@@ -191,6 +199,20 @@ Commands:
* sync (synchronizes probes with remote hosts)
onehost sync
Information Columns:
* HID Host ID
* NAME Host name
* RVM Number of running VMs
* TCPU Total CPU (percentage)
* FCPU Free CPU (percentage)
* ACPU Available CPU (not allocated by VMs)
* TMEM Total memory
* FMEM Free memory
* STAT Host status
EOT
+6
View File
@@ -199,6 +199,12 @@ end
class OneImageParse < CommandParse
COMMANDS_HELP=<<-EOT
Description:
This command enables the user to manage images.
Commands:
* register (Registers an image, copying it to the repository if it applies)
+19
View File
@@ -92,6 +92,16 @@ end
class OneUPParse < CommandParse
COMMANDS_HELP=<<-EOT
Description:
This command enables the OpenNebula administrator to manage users, adding,
listing and deleting them.
The create and passwd commands accept the [-r, –read-file] option. Use this
option to store the contents of a file (without hashing it) as the password.
Commands:
* create (Creates a new user)
@@ -106,6 +116,15 @@ Commands:
* passwd (Changes the given user's password)
oneuser passwd <id> password
Information Columns:
* UID User ID
* NAME Name of the user
* PASSWORD SHA1 encrypted password
* ENABLE Whether the user is enabled or not
EOT
def text_commands
+38 -1
View File
@@ -307,6 +307,14 @@ end
class OnevmParse < CommandParse
COMMANDS_HELP=<<-EOT
Description:
This command enables the user to manage virtual machines in the ONE server.
The user can allocate, deploy, migrate, suspend, resume and shutdown a virtual
machine with the functionality present in onevm.
Commands:
* create (Submits a new virtual machine, adding it to the ONE VM pool)
@@ -363,7 +371,7 @@ Commands:
a, all --> all the known VMs
m, mine --> the VMs belonging to the user in ONE_AUTH
uid --> VMs of the user identified by this uid
user--> VMs of the user identified by the username
user --> VMs of the user identified by the username
* show (Gets information about a specific VM)
onevm show <vm_id>
@@ -376,6 +384,35 @@ Commands:
if no vm_id is provided it will list history for all known VMs
Information Columns:
* ID ONE VM identifier
* USER Username of the VM owner
* NAME Name of the ONE
* STAT Status of the VM
* CPU CPU percentage used by the VM
* MEM Memory used by the VM
* HOSTNAME Host where the VM is being or was run
* TIME Time since the submission of the VM (days hours:minutes:seconds)
VM States:
* pend pending
* hold VM on hold (not runnable)
* stop stopped
* susp suspended
* done finished
* prol prolog
* boot booting
* runn running
* migr migrating
* save saving the VM to disk
* epil epilog
* shut shutting down
* fail failed
EOT
def text_commands
+23 -5
View File
@@ -137,6 +137,14 @@ end
class OneVNParse < CommandParse
COMMANDS_HELP=<<-EOT
Description:
This command enables the user to manage virtual networks in the OpenNebula
server. It provides functionality to create, get information and delete a
particular network or to list available and used IP's.
Commands:
* create (Creates a new virtual network)
@@ -159,11 +167,21 @@ Commands:
* list (Lists virtual networks in the pool)
onevnet list <filter_flag>
where filter_flag can be
a, all --> all the known VNs
m, mine --> the VNs belonging to the user in ONE_AUTH
and all the Public VNs
uid --> VNs of the user identified by this uid
user --> VNs of the user identified by the username
a, all : all the known VNs
m, mine : the VNs belonging to the user in ONE_AUTH
and all the Public VNs
uid : VNs of the user identified by this uid
user : VNs of the user identified by the username
Information columns:
* NID Network ID
* NAME Name of the virtual network
* TYPE Type of virtual network (0=ranged, 1=fixed)
* BRIDGE Bridge associated to the virtual network
* LEASES Number of leases used from this virtual network
EOT
def text_commands