shaba/one
1
0
Fork 0
mirror of https://github.com/OpenNebula/one.git synced 2025-03-25 02:50:08 +03:00
Code Releases Wiki Activity

new man documentation

Browse Source
This commit is contained in:
Javi Fontan 2011-07-14 18:33:54 +02:00
parent 4a412494a6
commit 4f6341bed9
10 changed files with 1834 additions and 892 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
share/man/oneacl.1 Normal file
View File

@ -0,0 +1,90 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEACL" "1" "July 2011" "" "oneacl(1) -- manages OpenNebula ACLs"
.
.SH "NAME"
\fBoneacl\fR
.
.SH "SYNOPSIS"
\fBoneacl\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-x, \-\-xml Show the resource in xml format
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
list
.
.IP "" 4
.
.nf
Lists the ACL rule set
valid options: xml
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
delete \fIrange\fR
.
.IP "" 4
.
.nf
Deletes an existing ACL rule
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
create \fIuser|rulestr\fR [\fIresource\fR] [\fIrights\fR]
.
.IP "" 4
.
.nf
Adds a new ACL rule
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
text
.
.IP "\(bu" 4
range
.
.IP "\(bu" 4
file
.
.IP "\(bu" 4
aclid_list
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org)
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0

87
share/man/oneauth.1
View File

@ -0,0 +1,87 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEAUTH" "1" "July 2011" "" "oneauth(1) -- OpenNebula authentication client"
.
.SH "NAME"
\fBoneauth\fR
.
.SH "SYNOPSIS"
oneauth COMMAND [args\.\.]
.
.P
This command contains a set of utilities to manage authorization module\.
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
quota\-set \fIuserid\fR \fIcpu\fR \fImemory\fR \fInum_vms\fR
.
.IP "" 4
.
.nf
Sets CPU, MEMORY and NUM_VMs quota for a given user
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
key
.
.IP "" 4
.
.nf
Gets public key
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
login \fIuserid\fR \fItext\fR
.
.IP "" 4
.
.nf
Generates authentication proxy\. The last argument specifies
the expiration time in seconds
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
userid
.
.IP "\(bu" 4
text
.
.IP "\(bu" 4
range
.
.IP "\(bu" 4
file
.
.IP "" 0

227
share/man/onedb.1
View File

@ -1,97 +1,132 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands"
.SH NAME
OpenNebulaPro \- OpenNebula Database command
.SH SYNOPSIS
.B onedb
[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
.SH DESCRIPTION
This command enables the user to manage the OpenNebula database. It provides
information about the DB version, means to upgrade it to the latest version, and
backup tools.
.SH OPTIONS
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Tells more information if the command
is successful
.TP
\fB\-f\fR, \fB\-\-force\fR
Forces the backup even if the DB exists
.TP
\fB\-\-backup\fR file
Use this file to store/read SQL dump
.TP
\fB\-s\fR, \fB\-\-sqlite\fR file
SQLite DB file
.TP
\fB\-\-server\fR host
MySQL server hostname or IP. Defaults to localhost
.TP
\fB\-\-port\fR port
MySQL server port. Defaults to 3306
.TP
\fB\-\-user\fR username
MySQL username
.TP
\fB\-\-passwd\fR password
MySQL password. Leave unset to be prompted for it
.TP
\fB\-\-dbname\fR name
MySQL DB name for OpenNebula
.TP
\fB\-h\fR, \fB\-\-help\fR
Shows this help message
.TP
\fB\-\-version\fR
Shows version and copyright information
.PP
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEDB" "1" "July 2011" "" "onedb(1) -- OpenNebula database migration tool"
.
.SH "NAME"
\fBonedb\fR
.
.P
DB Connection options:
.PP
By default, onedb reads the connection data from oned.conf
If any of these options is set, oned.conf is ignored (i.e. if you set MySQL's
port onedb won't look for the rest of the options in oned.conf)
.SH COMMANDS
.TP
\fBupgrade\fR (Upgrades the DB to the latest version)
.IP
onedb upgrade [<version>]
.IP
where <version> : DB version (e.g. 1, 3) to upgrade. By default the DB is
.IP
upgraded to the latest version
.TP
\fBversion\fR (Prints the current DB version. Use \fB\-v\fR flag to see also OpenNebula version)
.IP
onedb version
.TP
\fBhistory\fR (Prints the upgrades history)
.IP
onedb history
.TP
\fBbackup\fR (Dumps the DB to a file)
.IP
onedb backup [<output_file>]
.IP
where <output_file> : Same as \fB\-\-backup\fR
.TP
\fBrestore\fR (Restores the DB from a backup file. Only restores backups generated
.IP
from the same backend (SQLite or MySQL))
.IP
onedb restore [<backup_file>]
.IP
where <backup_file> : Same as \fB\-\-backup\fR
.SH COPYRIGHT
Copyright 2010\-2011, C12G Labs S.L.
.PP
Licensed under the C12G Commercial Open\-source License (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License as part
of the software distribution.
.PP
Unless agreed to in writing, software distributed under the
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and
limitations under the License.
.
.P
By default, onedb reads the connection data from oned\.conf If any of these options is set, oned\.conf is ignored (i\.e\. if you set MySQL\'s port onedb won\'t look for the rest of the options in oned\.conf)
.
.P
Description:
.
.P
This command enables the user to manage the OpenNebula database\. It provides information about the DB version, means to upgrade it to the latest version, and backup tools\.
.
.SH "OPTIONS"
.
.nf
\-f, \-\-force Forces the backup even if the DB exists
\-b, \-\-backup file Use this file to store SQL dump
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-s file, \-\-sqlite file SQLite DB file
\-S host, \-\-server host MySQL server hostname or IP\. Defaults to localhost
\-P port, \-\-port port MySQL server port\. Defaults to 3306
\-u user, \-\-username user MySQL username
\-p pass, \-\-password pass MySQL password\. Leave unset to be prompted for it
\-d dbname, \-\-dbname dbname MySQL DB name for OpenNebula
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
restore [\fIbackup_file\fR]
.
.IP "" 4
.
.nf
Restores the DB from a backup file\. Only restores backups generated
from the same backend (SQLite or MySQL)
valid options: force
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
version
.
.IP "" 4
.
.nf
Prints the current DB version\.
Use \-v flag to see also OpenNebula version
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
upgrade [\fIversion\fR]
.
.IP "" 4
.
.nf
Upgrades the DB to the latest version
where <version> : DB version (e\.g\. 1, 3) to upgrade\.
By default the DB is upgraded to the latest version
valid options: force, backup
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
backup [\fIoutput_file\fR]
.
.IP "" 4
.
.nf
Dumps the DB to a file specified in the argument
valid options: force
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
history
.
.IP "" 4
.
.nf
Prints the upgrades history
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
text
.
.IP "\(bu" 4
file
.
.IP "\(bu" 4
range
.
.IP "" 0

111
share/man/onegroup.1 Normal file
View File

@ -0,0 +1,111 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEGROUP" "1" "July 2011" "" "onegroup(1) -- manages OpenNebula groups"
.
.SH "NAME"
\fBonegroup\fR
.
.SH "SYNOPSIS"
\fBonegroup\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-l, \-\-list x,y,z Selects columns to display with list command
\-d, \-\-delay x Sets the delay in seconds for top command
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIname\fR
.
.IP "" 4
.
.nf
Creates a new Group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
list
.
.IP "" 4
.
.nf
Lists Groups in the pool
valid options: list, delay, xml, numeric
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
delete \fIrange|groupid_list\fR
.
.IP "" 4
.
.nf
Deletes the given Group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
show \fIgroupid\fR
.
.IP "" 4
.
.nf
Shows information for the given Group
valid options: xml
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
groupid_list
.
.IP "\(bu" 4
text
.
.IP "\(bu" 4
groupid
.
.IP "\(bu" 4
file
.
.IP "\(bu" 4
range
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org)
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0

295
share/man/onehost.1
View File

@ -1,112 +1,185 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands"
.SH NAME
OpenNebulaPro \- OpenNebula Host command
.SH SYNOPSIS
.B onehost
[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
.SH DESCRIPTION
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEHOST" "1" "July 2011" "" "onehost(1) -- manages OpenNebula hosts"
.
.SH "NAME"
\fBonehost\fR
.
.SH "SYNOPSIS"
\fBonehost\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
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.
.SH OPTIONS
.TP
\fB\-l\fR, \fB\-\-list\fR x,y,z
Selects columns to display with list
command
.TP
\fB\-\-list\-columns\fR
Information about the columns available
to display, order or filter
.TP
\fB\-o\fR, \fB\-\-order\fR x,y,z
Order by these columns, column starting
with \- means decreasing order
.TP
\fB\-f\fR, \fB\-\-filter\fR x,y,z
Filter data. An array is specified
with column=value pairs.
.TP
\fB\-d\fR, \fB\-\-delay\fR seconds
Sets the delay in seconds for top
command
.TP
\fB\-x\fR, \fB\-\-xml\fR
Returns xml instead of human readable text
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Tells more information if the command
is successful
.TP
\fB\-h\fR, \fB\-\-help\fR
Shows this help message
.TP
\fB\-\-version\fR
Shows version and copyright information
.SH COMMANDS
.TP
\fBcreate\fR (Adds a new machine to the pool)
.IP
onehost create <hostname> <im_mad> <vmm_mad> <tm_mad>
.TP
\fBshow\fR (Gets info from a host)
.IP
onehost show <host_id>
.TP
\fBdelete\fR (Removes a machine from the pool)
.IP
onehost delete <host_id>
.TP
\fBlist\fR (Lists machines in the pool)
.IP
onehost list
.TP
\fBenable\fR (Enables host)
.IP
onehost enable <host_id>
.TP
\fBdisable\fR (Disables host)
.IP
onehost disable <host_id>
.TP
\fBtop\fR (Lists hosts continuously)
.IP
onehost top
.TP
\fBsync\fR (synchronizes probes with remote hosts)
.IP
onehost sync
.PP
Information Columns:
.TP
\fBHID\fR Host ID
.TP
\fBNAME\fR Host name
.TP
\fBRVM\fR Number of running VMs
.TP
\fBTCPU\fR Total CPU (percentage)
.TP
\fBFCPU\fR Free CPU (percentage)
.TP
\fBACPU\fR Available CPU (not allocated by VMs)
.TP
\fBTMEM\fR Total memory
.TP
\fBFMEM\fR Free memory
.TP
\fBSTAT\fR Host status
.SH COPYRIGHT
Copyright 2010\-2011, C12G Labs S.L.
.PP
Licensed under the C12G Commercial Open\-source License (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License as part
of the software distribution.
.PP
Unless agreed to in writing, software distributed under the
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and
limitations under the License.
\-l, \-\-list x,y,z Selects columns to display with list command
\-d, \-\-delay x Sets the delay in seconds for top command
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-k, \-\-kilobytes Show units in kilobytes
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
enable \fIrange|hostid_list\fR
.
.IP "" 4
.
.nf
Enables the given Host
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
update \fIhostid\fR
.
.IP "" 4
.
.nf
Launches the system editor to modify and update the template contents
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
disable \fIrange|hostid_list\fR
.
.IP "" 4
.
.nf
Disables the given Host
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
top
.
.IP "" 4
.
.nf
Lists Hosts continuously
valid options: list, delay, xml, numeric, kilobytes
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
create \fIhostname\fR \fIim_mad\fR \fIvmm_mad\fR \fItm_mad\fR
.
.IP "" 4
.
.nf
Creates a new Host
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
sync
.
.IP "" 4
.
.nf
Synchronizes probes in /var/lib/one/remotes ($ONE_LOCATION/var/remotes
in self\-contained installations) with Hosts\.
The copy is performed the next time the Host is monitored
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
show \fIhostid\fR
.
.IP "" 4
.
.nf
Shows information for the given Host
valid options: xml
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
list
.
.IP "" 4
.
.nf
Lists Hosts in the pool
valid options: list, delay, xml, numeric, kilobytes
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
delete \fIrange|hostid_list\fR
.
.IP "" 4
.
.nf
Deletes the given Host
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
hostid_list
.
.IP "\(bu" 4
file
.
.IP "\(bu" 4
text
.
.IP "\(bu" 4
hostid
.
.IP "\(bu" 4
range
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org)
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0

397
share/man/oneimage.1
View File

@ -1,133 +1,266 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands"
.SH NAME
OpenNebulaPro \- OpenNebula Image command
.SH SYNOPSIS
.B oneimage
[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
.SH DESCRIPTION
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEIMAGE" "1" "July 2011" "" "oneimage(1) -- manages OpenNebula images"
.
.SH "NAME"
\fBoneimage\fR
.
.SH "SYNOPSIS"
\fBoneimage\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
This command enables the user to manage images.
.SH OPTIONS
.TP
\fB\-l\fR, \fB\-\-list\fR x,y,z
Selects columns to display with list
command
.TP
\fB\-\-list\-columns\fR
Information about the columns available
to display, order or filter
.TP
\fB\-o\fR, \fB\-\-order\fR x,y,z
Order by these columns, column starting
with \- means decreasing order
.TP
\fB\-f\fR, \fB\-\-filter\fR x,y,z
Filter data. An array is specified
with column=value pairs.
.TP
\fB\-d\fR, \fB\-\-delay\fR seconds
Sets the delay in seconds for top
command
.TP
\fB\-x\fR, \fB\-\-xml\fR
Returns xml instead of human readable text
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Tells more information if the command
is successful
.TP
\fB\-h\fR, \fB\-\-help\fR
Shows this help message
.TP
\fB\-\-version\fR
Shows version and copyright information
.SH COMMANDS
.TP
\fBregister\fR (Registers an image, copying it to the repository if it applies)
.IP
oneimage register <template>
.IP
template is a file name where the Image description is located
.TP
\fBaddattr\fR (Add a new image attribute)
.IP
oneimage addattr <image_id> <attribute_name> <attribute_value>
.TP
\fBupdate\fR (Modifies an image attribute)
.IP
oneimage update <image_id> <attribute_name> <attribute_value>
.TP
\fBrmattr\fR (Deletes an Image attribute)
.IP
oneimage rmattr <image_id> <attribute_name>
.TP
\fBenable\fR (Enabled an Image)
.IP
oneimage enable <image_id>
.TP
\fBdisable\fR (Disabled an Image)
.IP
oneimage disable <image_id>
.TP
\fBpublish\fR (Publish an Image)
.IP
oneimage publish <image_id>
.TP
\fBunpublish\fR (Unpublish an Image)
.IP
oneimage unpublish <image_id>
.TP
\fBpersistent\fR (Makes an Image persistent)
.IP
oneimage persistent <image_id>
.TP
\fBnonpersistent\fR (Makes an Image non persistent)
.IP
oneimage nonpersistent <image_id>
.TP
\fBlist\fR (Shows Images in the pool)
.IP
oneimage list <filter_flag>
.IP
where filter_flag can be
.TP
a, all
\fB\-\-\fR> all the known Images
.TP
m, mine
\fB\-\-\fR> the Images belonging to the user in ONE_AUTH
.TP
and all the
Public Images
.TP
uid
\fB\-\-\fR> Images of the user identified by this uid
.TP
user
\fB\-\-\fR> Images of the user identified by the username
.TP
\fBtop\fR (Lists Images continuously)
.IP
oneimage top
.TP
\fBshow\fR (Gets information about an specific Image)
.IP
oneimage show <image_id>
.TP
\fBdelete\fR (Deletes an already deployed Image)
.IP
oneimage delete <image_id>
.SH COPYRIGHT
Copyright 2010\-2011, C12G Labs S.L.
.PP
Licensed under the C12G Commercial Open\-source License (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License as part
of the software distribution.
.PP
Unless agreed to in writing, software distributed under the
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and
limitations under the License.
\-x, \-\-xml Show the resource in xml format
\-l, \-\-list x,y,z Selects columns to display with list command
\-d, \-\-delay x Sets the delay in seconds for top command
\-n, \-\-numeric Do not translate user and group IDs
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
enable \fIrange|imageid_list\fR
.
.IP "" 4
.
.nf
Enables the given Image
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
update \fIimageid\fR
.
.IP "" 4
.
.nf
Launches the system editor to modify and update the template contents
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
disable \fIrange|imageid_list\fR
.
.IP "" 4
.
.nf
Disables the given Image
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
unpublish \fIrange|imageid_list\fR
.
.IP "" 4
.
.nf
Unpublishes the given Image\. A private Image can\'t be used by any other
User
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
show \fIimageid\fR
.
.IP "" 4
.
.nf
Shows information for the given Image
valid options: xml
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chgrp \fIrange|imageid_list\fR \fIgroupid\fR
.
.IP "" 4
.
.nf
Changes the Image group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
create \fIfile\fR
.
.IP "" 4
.
.nf
Creates a new Image from the given template file
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
list [\fIfilterflag\fR]
.
.IP "" 4
.
.nf
Lists Images in the pool
valid options: list, delay, xml, numeric
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
persistent \fIrange|imageid_list\fR
.
.IP "" 4
.
.nf
Makes the given Image persistent\. A persistent Image saves the changes
made to the contents after the VM instance is shutdown (or in real time
if a shared FS is used)\. Persistent Images can be used by only
one VM instance at a time\.
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
delete \fIrange|imageid_list\fR
.
.IP "" 4
.
.nf
Deletes the given Image
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
top [\fIfilterflag\fR]
.
.IP "" 4
.
.nf
Lists Images continuously
valid options: list, delay, xml, numeric
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chown \fIrange|imageid_list\fR \fIuserid\fR [\fIgroupid\fR]
.
.IP "" 4
.
.nf
Changes the Image owner and group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
publish \fIrange|imageid_list\fR
.
.IP "" 4
.
.nf
Publishes the given Image\. A public Image can be seen and used by other
Users in the Image\'s group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
nonpersistent \fIrange|imageid_list\fR
.
.IP "" 4
.
.nf
Makes the given Image non persistent\. See \'oneimage persistent\'
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
userid
.
.IP "\(bu" 4
imageid
.
.IP "\(bu" 4
filterflag
.
.IP "\(bu" 4
groupid
.
.IP "\(bu" 4
range
.
.IP "\(bu" 4
file
.
.IP "\(bu" 4
imageid_list
.
.IP "\(bu" 4
text
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org)
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0

337
share/man/onetemplate.1
View File

@ -1,117 +1,222 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands"
.SH NAME
OpenNebulaPro \- OpenNebula Template command
.SH SYNOPSIS
.B onetemplate
[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
.SH DESCRIPTION
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONETEMPLATE" "1" "July 2011" "" "onetemplate(1) -- manages OpenNebula templates"
.
.SH "NAME"
\fBonetemplate\fR
.
.SH "SYNOPSIS"
\fBonetemplate\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
This command enables the user to manage templates.
.SH OPTIONS
.TP
\fB\-l\fR, \fB\-\-list\fR x,y,z
Selects columns to display with list
command
.TP
\fB\-\-list\-columns\fR
Information about the columns available
to display, order or filter
.TP
\fB\-o\fR, \fB\-\-order\fR x,y,z
Order by these columns, column starting
with \- means decreasing order
.TP
\fB\-f\fR, \fB\-\-filter\fR x,y,z
Filter data. An array is specified
with column=value pairs.
.TP
\fB\-d\fR, \fB\-\-delay\fR seconds
Sets the delay in seconds for top
command
.TP
\fB\-x\fR, \fB\-\-xml\fR
Returns xml instead of human readable text
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Tells more information if the command
is successful
.TP
\fB\-h\fR, \fB\-\-help\fR
Shows this help message
.TP
\fB\-\-version\fR
Shows version and copyright information
.SH COMMANDS
.TP
\fBcreate\fR (Registers a Template from a template file)
.IP
onetemplate create <file>
.IP
file is a file name where the Template description is located
.TP
\fBaddattr\fR (Add a new Template attribute)
.IP
onetemplate addattr <template_id> <attribute_name> <attribute_value>
.TP
\fBupdate\fR (Modifies a Template attribute)
.IP
onetemplate update <template_id> <attribute_name> <attribute_value>
.TP
\fBrmattr\fR (Deletes a Template attribute)
.IP
onetemplate rmattr <template_id> <attribute_name>
.TP
\fBpublish\fR (Publish a Template)
.IP
onetemplate publish <template_id>
.TP
\fBunpublish\fR (Unpublish an Template)
.IP
onetemplate unpublish <template_id>
.TP
\fBlist\fR (Shows Templates in the pool)
.IP
onetemplate list <filter_flag>
.IP
where filter_flag can be
.TP
a, all
\fB\-\-\fR> all the known Templates
.TP
m, mine
\fB\-\-\fR> the Templates belonging to the user in ONE_AUTH
.TP
and all the
Public Templates
.TP
uid
\fB\-\-\fR> Templates of the user identified by this uid
.TP
user
\fB\-\-\fR> Templates of the user identified by the username
.TP
\fBtop\fR (Lists Templates continuously)
.IP
onetemplate top
.TP
\fBshow\fR (Gets information about an specific Template)
.IP
onetemplate show <template_id>
.TP
\fBdelete\fR (Deletes a Template)
.IP
onetemplate delete <template_id>
.SH COPYRIGHT
Copyright 2010\-2011, C12G Labs S.L.
.PP
Licensed under the C12G Commercial Open\-source License (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License as part
of the software distribution.
.PP
Unless agreed to in writing, software distributed under the
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and
limitations under the License.
\-x, \-\-xml Show the resource in xml format
\-l, \-\-list x,y,z Selects columns to display with list command
\-d, \-\-delay x Sets the delay in seconds for top command
\-n, \-\-numeric Do not translate user and group IDs
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
show \fItemplateid\fR
.
.IP "" 4
.
.nf
Shows information for the given Template
valid options: xml
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
update \fItemplateid\fR
.
.IP "" 4
.
.nf
Launches the system editor to modify and update the template contents
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
unpublish \fIrange|templateid_list\fR
.
.IP "" 4
.
.nf
Unpublishes the given Template\. A private Template can\'t be
instantiated by any other User
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
create \fIfile\fR
.
.IP "" 4
.
.nf
Creates a new Template from the given template file
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chgrp \fIrange|templateid_list\fR \fIgroupid\fR
.
.IP "" 4
.
.nf
Changes the Template group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
list [\fIfilterflag\fR]
.
.IP "" 4
.
.nf
Lists Templates in the pool
valid options: list, delay, xml, numeric
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
top [\fIfilterflag\fR]
.
.IP "" 4
.
.nf
Lists Templates continuously
valid options: list, delay, xml, numeric
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
delete \fIrange|templateid_list\fR
.
.IP "" 4
.
.nf
Deletes the given Image
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
publish \fIrange|templateid_list\fR
.
.IP "" 4
.
.nf
Publishes the given Template\. A public Template can be seen and
instantiated by other Users in the Template\'s group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chown \fIrange|templateid_list\fR \fIuserid\fR [\fIgroupid\fR]
.
.IP "" 4
.
.nf
Changes the Template owner and group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
instantiate \fIrange|templateid_list\fR
.
.IP "" 4
.
.nf
Creates a new VM instance from the given Template\. This VM can be
managed with the \'onevm\' command
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
userid
.
.IP "\(bu" 4
templateid
.
.IP "\(bu" 4
filterflag
.
.IP "\(bu" 4
groupid
.
.IP "\(bu" 4
range
.
.IP "\(bu" 4
file
.
.IP "\(bu" 4
templateid_list
.
.IP "\(bu" 4
text
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org)
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0

236
share/man/oneuser.1
View File

@ -1,90 +1,148 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands"
.SH NAME
OpenNebulaPro \- OpenNebula User command
.SH SYNOPSIS
.B oneuser
[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
.SH DESCRIPTION
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEUSER" "1" "July 2011" "" "oneuser(1) -- manages OpenNebula users"
.
.SH "NAME"
\fBoneuser\fR
.
.SH "SYNOPSIS"
\fBoneuser\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
This command enables the OpenNebula administrator to manage users, adding,
listing and deleting them.
.PP
The create and passwd commands accept the [\-r, \fB\-\-read\-file]\fR option. Use this
option to store the contents of a file (without hashing it) as the password.
.SH OPTIONS
.TP
\fB\-l\fR, \fB\-\-list\fR x,y,z
Selects columns to display with list
command
.TP
\fB\-\-list\-columns\fR
Information about the columns available
to display, order or filter
.TP
\fB\-o\fR, \fB\-\-order\fR x,y,z
Order by these columns, column starting
with \- means decreasing order
.TP
\fB\-f\fR, \fB\-\-filter\fR x,y,z
Filter data. An array is specified
with column=value pairs.
.TP
\fB\-x\fR, \fB\-\-xml\fR
Returns xml instead of human readable text
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Tells more information if the command
is successful
.TP
\fB\-n\fR, \fB\-\-no\-hash\fR
Store plain password into the database
.TP
\fB\-r\fR, \fB\-\-read\-file\fR
Read password from file
.TP
\fB\-h\fR, \fB\-\-help\fR
Shows this help message
.TP
\fB\-\-version\fR
Shows version and copyright information
.SH COMMANDS
.TP
\fBcreate\fR (Creates a new user)
.IP
oneuser create username password
.TP
\fBdelete\fR (Removes a user)
.IP
oneuser delete <id>
.TP
\fBlist\fR (Lists all the users in the pool)
.IP
oneuser list
.TP
\fBpasswd\fR (Changes the given user's password)
.IP
oneuser passwd <id> password
.PP
Information Columns:
.TP
\fBUID\fR User ID
.TP
\fBNAME\fR Name of the user
.TP
\fBPASSWORD\fR SHA1 encrypted password
.TP
\fBENABLE\fR Whether the user is enabled or not
.SH COPYRIGHT
Copyright 2010\-2011, C12G Labs S.L.
.PP
Licensed under the C12G Commercial Open\-source License (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License as part
of the software distribution.
.PP
Unless agreed to in writing, software distributed under the
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and
limitations under the License.
\-x, \-\-xml Show the resource in xml format
\-r, \-\-read\-file Read password from file
\-p, \-\-plain Store plain password
\-l, \-\-list x,y,z Selects columns to display with list command
\-d, \-\-delay x Sets the delay in seconds for top command
\-n, \-\-numeric Do not translate user and group IDs
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
show [\fIuserid\fR]
.
.IP "" 4
.
.nf
Shows information for the given User
valid options: xml
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chgrp \fIrange|userid_list\fR \fIgroupid\fR
.
.IP "" 4
.
.nf
Changes the User\'s main group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
create \fIusername\fR \fIpassword\fR
.
.IP "" 4
.
.nf
Creates a new User
valid options: read_file, plain
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
list
.
.IP "" 4
.
.nf
Lists Users in the pool
valid options: list, delay, xml, numeric
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
delete \fIrange|userid_list\fR
.
.IP "" 4
.
.nf
Deletes the given User
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
passwd \fIuserid\fR \fIpassword\fR
.
.IP "" 4
.
.nf
Changes the given User\'s password
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
userid
.
.IP "\(bu" 4
password
.
.IP "\(bu" 4
range
.
.IP "\(bu" 4
text
.
.IP "\(bu" 4
file
.
.IP "\(bu" 4
groupid
.
.IP "\(bu" 4
userid_list
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org)
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0

624
share/man/onevm.1
View File

@ -1,235 +1,395 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands"
.SH NAME
OpenNebulaPro \- OpenNebula Virtual Machine command
.SH SYNOPSIS
.B onevm
[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
.SH DESCRIPTION
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEVM" "1" "July 2011" "" "onevm(1) -- manages OpenNebula virtual machines"
.
.SH "NAME"
\fBonevm\fR
.
.SH "SYNOPSIS"
\fBonevm\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-x, \-\-xml Show the resource in xml format
\-l, \-\-list x,y,z Selects columns to display with list command
\-d, \-\-delay x Sets the delay in seconds for top command
\-n, \-\-numeric Do not translate user and group IDs
\-k, \-\-kilobytes Show units in kilobytes
\-m, \-\-multiple x Instance multiple VMs
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
chgrp \fIrange|vmid_list\fR \fIgroupid\fR
.
.IP "" 4
.
.nf
Changes the VM group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
restart \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Forces a re\-deployment of the given VM, issuing a boot action\.
This command enables the user to manage virtual machines in OpenNebula.
The user can allocate, deploy, migrate, suspend, resume and shutdown a virtual
machine with the functionality present in onevm.
.SH OPTIONS
.TP
\fB\-l\fR, \fB\-\-list\fR x,y,z
Selects columns to display with list
command
.TP
\fB\-\-list\-columns\fR
Information about the columns available
to display, order or filter
.TP
\fB\-o\fR, \fB\-\-order\fR x,y,z
Order by these columns, column starting
with \- means decreasing order
.TP
\fB\-f\fR, \fB\-\-filter\fR x,y,z
Filter data. An array is specified
with column=value pairs.
.TP
\fB\-d\fR, \fB\-\-delay\fR seconds
Sets the delay in seconds for top
command
.TP
\fB\-x\fR, \fB\-\-xml\fR
Returns xml instead of human readable text
.TP
\fB\-t\fR, \fB\-\-type\fR type
Image type
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Tells more information if the command
is successful
.TP
\fB\-h\fR, \fB\-\-help\fR
Shows this help message
.TP
\fB\-\-version\fR
Shows version and copyright information
.SH COMMANDS
.TP
\fBcreate\fR (Submits a new virtual machine, adding it to the ONE VM pool)
.IP
onevm create <template>
.IP
template is a file name where the VM description is located
.TP
\fBdeploy\fR (Starts an existing VM in an specific host)
.IP
onevm deploy <vm_id> <host_id>
.IP
States: PENDING
.TP
\fBshutdown\fR (Shuts down an already deployed VM)
.IP
onevm shutdown <vm_id>
.IP
States: RUNNING
.TP
\fBlivemigrate\fR (Migrates a running VM to another host without downtime)
.IP
onevm livemigrate <vm_id> <host_id>
.IP
States: RUNNING
.TP
\fBmigrate\fR (Saves a running VM and starts it again in the specified host)
.IP
onevm migrate <vm_id> <host_id>
.IP
States: RUNNING
.TP
\fBhold\fR (Sets a VM to hold state, scheduler will not deploy it)
.IP
onevm hold <vm_id>
.IP
States: PENDING
.TP
\fBrelease\fR (Releases a VM from hold state, setting it to pending)
.IP
onevm release <vm_id>
.IP
States: HOLD
.TP
\fBstop\fR (Stops a running VM)
.IP
onevm stop <vm_id>
.IP
States: RUNNING
.TP
\fBcancel\fR (Cancels a running VM)
.IP
onevm cancel <vm_id>
.IP
States: RUNNING
.TP
\fBsuspend\fR (Saves a running VM)
.IP
onevm suspend <vm_id>
.IP
States: RUNNING
.TP
\fBresume\fR (Resumes the execution of a saved VM)
.IP
onevm resume <vm_id>
.IP
States: STOPPED, SUSPENDED
.TP
\fBsaveas\fR (Set the specified vms disk to be saved in a new image (image_name)
.IP
when the vm shuts down)
.IP
onevm saveas <vm_id> <disk_id> <image_name>
.IP
(Set a different type for the new Image)
.IP
onevm saveas <vm_id> <disk_id> <image_name> \fB\-t\fR/\-\-type <type>
.TP
\fBdelete\fR (Deletes a VM from the pool)
.IP
onevm delete <vm_id>
.IP
States: ANY
.TP
\fBrestart\fR (Forces a re\-deployment of a VM in UNKNOWN or BOOT state)
.IP
onevm restart <vm_id>
.IP
States: UNKNOWN, BOOT
.TP
\fBresubmit\fR (Resubmits a VM to PENDING state)
.IP
onevm resubmit <vm_id>
.IP
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
saveas \fIvmid\fR \fIdiskid\fR \fIimg_name\fR
.
.IP "" 4
.
.nf
Sets the specified VM disk to be saved in a new Image\. The Image is
created inmediately, but the contents are saved only if the VM is
shut down gracefuly (i\.e\., using \'onevm shutdown\' and not
\'onevm delete\')
States: ANY
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
show \fIvmid\fR
.
.IP "" 4
.
.nf
Shows information for the given VM
valid options: xml
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
livemigrate \fIrange|vmid_list\fR \fIhostid\fR
.
.IP "" 4
.
.nf
Migrates the given running VM to another Host without downtime
States: RUNNING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
shutdown \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Shuts down the given VM\.
States: RUNNING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
suspend \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Saves a running VM\. It is the same as \'onevm stop\', but the files
are left in the remote machine to later restart the VM there
(i\.e\. the resources are not freed and there is no need to
re\-schedule the VM)\.
States: RUNNING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
hold \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Sets the given VM on hold\. A VM on hold is not scheduled until it is
released\. It can be, however, deployed manually; see \'onevm deploy\'
States: PENDING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
resubmit \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Resubmits the VM to PENDING state\. This is intented for VMs stuck in a
transient state\. To re\-deploy a fresh copy of the same VM, create a
Template and instantiante it, see \'onetemplate instantiate\'
States: ANY, except SUSPENDED or DONE
.TP
\fBlist\fR (Shows VMs in the pool)
.IP
onevm list <filter_flag>
.IP
where filter_flag can be
.TP
a, all
\fB\-\-\fR> all the known VMs
.TP
m, mine
\fB\-\-\fR> the VMs belonging to the user in ONE_AUTH
.TP
uid
\fB\-\-\fR> VMs of the user identified by this uid
.TP
user
\fB\-\-\fR> VMs of the user identified by the username
.TP
\fBshow\fR (Gets information about a specific VM)
.IP
onevm show <vm_id>
.TP
\fBtop\fR (Lists VMs continuously)
.IP
onevm top
.TP
\fBhistory\fR (Gets history from VMs)
.IP
onevm history [<vm_id> <vm_id> ...]
.IP
if no vm_id is provided it will list history for all known VMs
.PP
Information Columns:
.TP
\fBID\fR ONE VM identifier
.TP
\fBUSER\fR Username of the VM owner
.TP
\fBNAME\fR Name of the VM
.TP
\fBSTAT\fR Status of the VM
.TP
\fBCPU\fR CPU percentage used by the VM
.TP
\fBMEM\fR Memory used by the VM
.TP
\fBHOSTNAME\fR Host where the VM is being or was run
.TP
\fBTIME\fR Time since the submission of the VM (days hours:minutes:seconds)
.PP
VM States:
.TP
\fBpend\fR pending
.TP
\fBhold\fR VM on hold (not runnable)
.TP
\fBstop\fR stopped
.TP
\fBsusp\fR suspended
.TP
\fBdone\fR finished
.TP
\fBprol\fR prolog
.TP
\fBboot\fR booting
.TP
\fBrunn\fR running
.TP
\fBmigr\fR migrating
.TP
\fBsave\fR saving the VM to disk
.TP
\fBepil\fR epilog
.TP
\fBshut\fR shutting down
.TP
\fBfail\fR failed
.SH COPYRIGHT
Copyright 2010\-2011, C12G Labs S.L.
.PP
Licensed under the C12G Commercial Open\-source License (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License as part
of the software distribution.
.PP
Unless agreed to in writing, software distributed under the
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and
limitations under the License.
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
list [\fIfilterflag\fR]
.
.IP "" 4
.
.nf
Lists VMs in the pool
valid options: list, delay, xml, numeric, kilobytes
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
stop \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Stops a running VM\. The VM state is saved and transferred back to the
front\-end along with the disk files
States: RUNNING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
deploy \fIrange|vmid_list\fR \fIhostid\fR
.
.IP "" 4
.
.nf
Deploys the given VM in the specified Host\. This command forces the
deployment, in a standard installation the Scheduler is in charge
of this decision
States: PENDING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
delete \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Deletes the given VM
States: ANY
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
resume \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Resumes the execution of the a saved VM
States: STOPPED, SUSPENDED
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
migrate \fIrange|vmid_list\fR \fIhostid\fR
.
.IP "" 4
.
.nf
Saves the given running VM and starts it again in the specified Host
States: RUNNING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
release \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Releases a VM on hold\. See \'onevm hold\'
States: HOLD
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chown \fIrange|vmid_list\fR \fIuserid\fR [\fIgroupid\fR]
.
.IP "" 4
.
.nf
Changes the Image owner and group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
cancel \fIrange|vmid_list\fR
.
.IP "" 4
.
.nf
Cancels the given VM\. The process is checked by OpenNebula, so
if the process fails the VM remains in running state\. If the action
succeeds the VMDIR in the remote machine is not deleted
States: RUNNING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
create \fIfile\fR
.
.IP "" 4
.
.nf
Creates a new VM from the given template file\. This command bypasses
the Template pool, which is the preferred way to instantiate new VMs\.
See \'onetemplate create\' and \'onetemplate instantiate\'
valid options: multiple, xml, numeric, kilobytes
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
top [\fIfilterflag\fR]
.
.IP "" 4
.
.nf
Lists Images continuously
valid options: list, delay, xml, numeric, kilobytes
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
text
.
.IP "\(bu" 4
vmid_list
.
.IP "\(bu" 4
groupid
.
.IP "\(bu" 4
file
.
.IP "\(bu" 4
userid
.
.IP "\(bu" 4
hostid
.
.IP "\(bu" 4
vmid
.
.IP "\(bu" 4
range
.
.IP "\(bu" 4
filterflag
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org)
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0

322
share/man/onevnet.1
View File

@ -1,117 +1,207 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands"
.SH NAME
OpenNebulaPro \- OpenNebula Virtual Network command
.SH SYNOPSIS
.B onevnet
[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
.SH DESCRIPTION
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEVNET" "1" "July 2011" "" "onevnet(1) -- manages OpenNebula networks"
.
.SH "NAME"
\fBonevnet\fR
.
.SH "SYNOPSIS"
\fBonevnet\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
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.
.SH OPTIONS
.TP
\fB\-l\fR, \fB\-\-list\fR x,y,z
Selects columns to display with list
command
.TP
\fB\-\-list\-columns\fR
Information about the columns available
to display, order or filter
.TP
\fB\-o\fR, \fB\-\-order\fR x,y,z
Order by these columns, column starting
with \- means decreasing order
.TP
\fB\-f\fR, \fB\-\-filter\fR x,y,z
Filter data. An array is specified
with column=value pairs.
.TP
\fB\-x\fR, \fB\-\-xml\fR
Returns xml instead of human readable text
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Tells more information if the command
is successful
.TP
\fB\-h\fR, \fB\-\-help\fR
Shows this help message
.TP
\fB\-\-version\fR
Shows version and copyright information
.SH COMMANDS
.TP
\fBcreate\fR (Creates a new virtual network)
.IP
onevnet create <template>
.IP
template is a filename where the virtual network is described
.TP
\fBshow\fR (Gets info from a virtual network)
.IP
onevnet show <network_id>
.TP
\fBpublish\fR (Publish a virtual network)
.IP
onevnet publish <network_id>
.TP
\fBunpublish\fR (Unpublish a virtual network)
.IP
onevnet unpublish <network_id>
.TP
\fBdelete\fR (Removes a virtual network)
.IP
onevnet delete <network_id>
.TP
\fBaddleases\fR (Adds a lease to the virtual network)
.IP
onevnet addleases <network_id> <IP> [<MAC>]
.TP
\fBrmleases\fR (Removes a lease fom the virtual network)
.IP
onevnet rmleases <network_id> <IP>
.TP
\fBlist\fR (Lists virtual networks in the pool)
.IP
onevnet list <filter_flag>
.IP
where filter_flag can be
.TP
a, all
: all the known VNs
.IP
m, mine : the VNs belonging to the user in ONE_AUTH
.IP
and all the Public VNs
.TP
uid
: VNs of the user identified by this uid
.TP
user
: VNs of the user identified by the username
.PP
Information columns:
.TP
\fBNID\fR Network ID
.TP
\fBNAME\fR Name of the virtual network
.TP
\fBTYPE\fR Type of virtual network (0=ranged, 1=fixed)
.TP
\fBBRIDGE\fR Bridge associated to the virtual network
.TP
\fBLEASES\fR Number of leases used from this virtual network
.SH COPYRIGHT
Copyright 2010\-2011, C12G Labs S.L.
.PP
Licensed under the C12G Commercial Open\-source License (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License as part
of the software distribution.
.PP
Unless agreed to in writing, software distributed under the
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and
limitations under the License.
\-x, \-\-xml Show the resource in xml format
\-l, \-\-list x,y,z Selects columns to display with list command
\-d, \-\-delay x Sets the delay in seconds for top command
\-n, \-\-numeric Do not translate user and group IDs
\-k, \-\-kilobytes Show units in kilobytes
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
rmleases \fIvnetid\fR \fIip\fR
.
.IP "" 4
.
.nf
Removes a lease from the Virtual Network
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chgrp \fIrange|vnid_list\fR \fIgroupid\fR
.
.IP "" 4
.
.nf
Changes the Virtual Network group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
addleases \fIvnetid\fR \fIip\fR [\fImac\fR]
.
.IP "" 4
.
.nf
Adds a lease to the Virtual Network
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
show \fIvnetid\fR
.
.IP "" 4
.
.nf
Shows information for the given Virtual Network
valid options: xml
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
publish \fIrange|vnetid_list\fR
.
.IP "" 4
.
.nf
Publishes the given Virtual Network\. A public Virtual Network can be
seen and used by other Users in the Virtual Network\'s group
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
list [\fIfilterflag\fR]
.
.IP "" 4
.
.nf
Lists Virtual Networks in the pool
valid options: list, delay, xml, numeric, kilobytes
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
delete \fIrange|vnetid_list\fR
.
.IP "" 4
.
.nf
Deletes the given Virtual Network
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
create \fIfile\fR
.
.IP "" 4
.
.nf
Creates a new Virtual Network from the given template file
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
unpublish \fIrange|vnetid_list\fR
.
.IP "" 4
.
.nf
Unpublishes the given Virtual Network\. A private Virtual Network
can\'t be used by any other User
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chown \fIrange|vnid_list\fR \fIuserid\fR [\fIgroupid\fR]
.
.IP "" 4
.
.nf
Changes the Virtual Network owner and group
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
vnetid_list
.
.IP "\(bu" 4
userid
.
.IP "\(bu" 4
file
.
.IP "\(bu" 4
vnetid
.
.IP "\(bu" 4
filterflag
.
.IP "\(bu" 4
groupid
.
.IP "\(bu" 4
range
.
.IP "\(bu" 4
text
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org)
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0