diff --git a/share/man/econe-describe-images.8.gz b/share/man/econe-describe-images.8.gz index a499ffdb77..c0aa5db454 100644 Binary files a/share/man/econe-describe-images.8.gz and b/share/man/econe-describe-images.8.gz differ diff --git a/share/man/econe-describe-instances.8.gz b/share/man/econe-describe-instances.8.gz index d58e8d618d..143bb28a5f 100644 Binary files a/share/man/econe-describe-instances.8.gz and b/share/man/econe-describe-instances.8.gz differ diff --git a/share/man/econe-register.8.gz b/share/man/econe-register.8.gz index 6cef0d9e58..bc5e8b13f3 100644 Binary files a/share/man/econe-register.8.gz and b/share/man/econe-register.8.gz differ diff --git a/share/man/econe-run-instances.8.gz b/share/man/econe-run-instances.8.gz index d20b54dd8c..22e1d8d65b 100644 Binary files a/share/man/econe-run-instances.8.gz and b/share/man/econe-run-instances.8.gz differ diff --git a/share/man/econe-terminate-instances.8.gz b/share/man/econe-terminate-instances.8.gz index 100e08c09b..ba19ff45c7 100644 Binary files a/share/man/econe-terminate-instances.8.gz and b/share/man/econe-terminate-instances.8.gz differ diff --git a/share/man/econe-upload.8.gz b/share/man/econe-upload.8.gz index b301c9542a..fb0704f662 100644 Binary files a/share/man/econe-upload.8.gz and b/share/man/econe-upload.8.gz differ diff --git a/share/man/occi-compute.8.gz b/share/man/occi-compute.8.gz index 0e0d8a2d2a..11842ea221 100644 Binary files a/share/man/occi-compute.8.gz and b/share/man/occi-compute.8.gz differ diff --git a/share/man/occi-network.8.gz b/share/man/occi-network.8.gz index baeb1c0ae1..35e512a6fd 100644 Binary files a/share/man/occi-network.8.gz and b/share/man/occi-network.8.gz differ diff --git a/share/man/occi-storage.8.gz b/share/man/occi-storage.8.gz index c765dfbc4e..2cdb242469 100644 Binary files a/share/man/occi-storage.8.gz and b/share/man/occi-storage.8.gz differ diff --git a/share/man/oneauth.8.gz b/share/man/oneauth.8.gz index a62a80b05b..95554bb729 100644 Binary files a/share/man/oneauth.8.gz and b/share/man/oneauth.8.gz differ diff --git a/share/man/onecluster.8.gz b/share/man/onecluster.8.gz index c83e24b503..69544f59c9 100644 Binary files a/share/man/onecluster.8.gz and b/share/man/onecluster.8.gz differ diff --git a/share/man/onehost.8.gz b/share/man/onehost.8.gz index 973e5035cd..fcecb4540e 100644 Binary files a/share/man/onehost.8.gz and b/share/man/onehost.8.gz differ diff --git a/share/man/oneimage.8.gz b/share/man/oneimage.8.gz index 8ac5ba4296..ea2abbb5fb 100644 Binary files a/share/man/oneimage.8.gz and b/share/man/oneimage.8.gz differ diff --git a/share/man/oneuser.8.gz b/share/man/oneuser.8.gz index 9295b94f39..73e54fb803 100644 Binary files a/share/man/oneuser.8.gz and b/share/man/oneuser.8.gz differ diff --git a/share/man/onevm.8.gz b/share/man/onevm.8.gz index d114807a07..80943fde9b 100644 Binary files a/share/man/onevm.8.gz and b/share/man/onevm.8.gz differ diff --git a/share/man/onevnet.8.gz b/share/man/onevnet.8.gz index 125d4bd60e..6d4825c056 100644 Binary files a/share/man/onevnet.8.gz and b/share/man/onevnet.8.gz differ diff --git a/src/authm_mad/oneauth b/src/authm_mad/oneauth index 435c0aac38..3f5581620c 100755 --- a/src/authm_mad/oneauth +++ b/src/authm_mad/oneauth @@ -45,6 +45,12 @@ COMMANDS_HELP=<<-EOT Usage: oneauth [] + +Description: + +This command contains a set of utilities to manage authorization module. + + Commands: * quota set (sets quota for a user) diff --git a/src/cli/onecluster b/src/cli/onecluster index 933073bb4f..e5128e2614 100755 --- a/src/cli/onecluster +++ b/src/cli/onecluster @@ -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) diff --git a/src/cli/onehost b/src/cli/onehost index c05c18fd32..2bf1ec1eb3 100755 --- a/src/cli/onehost +++ b/src/cli/onehost @@ -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 diff --git a/src/cli/oneimage b/src/cli/oneimage index 7b06df07b9..c1a7564fb0 100755 --- a/src/cli/oneimage +++ b/src/cli/oneimage @@ -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) diff --git a/src/cli/oneuser b/src/cli/oneuser index 710c7ed1af..0ca2ad1a59 100755 --- a/src/cli/oneuser +++ b/src/cli/oneuser @@ -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 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 diff --git a/src/cli/onevm b/src/cli/onevm index c813fa2b3a..e454e20cc5 100755 --- a/src/cli/onevm +++ b/src/cli/onevm @@ -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 @@ -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 diff --git a/src/cli/onevnet b/src/cli/onevnet index 4f7a7d9c92..c8abec8361 100755 --- a/src/cli/onevnet +++ b/src/cli/onevnet @@ -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 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