shaba/one
1
0
Fork 0
mirror of https://github.com/OpenNebula/one.git synced 2024-12-22 13:33:52 +03:00
Code Releases Wiki Activity

Added man pages for econe/occi CLI 3.0.0

Browse Source 
(cherry picked from commit 3df0c6dadc)
This commit is contained in:
Javi Fontan 2011-09-28 00:27:00 +02:00
parent 5f8f679669
commit c548c84780
9 changed files with 452 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
share/man/econe-describe-images.1
View File

@ -0,0 +1,39 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands"
.SH NAME
OpenNebula \- OpenNebula econe-describe-images
.SH SYNOPSIS
.B econe-describe-images
[\fIOPTIONS\fR]
.SH DESCRIPTION
econe\-describe\-images
.PP
List and describe previously uploaded images of a user to be
used with an OpenNebula Cloud.
.SH OPTIONS
.HP
\fB\-\-help\fR, \fB\-h\fR
.IP
Show help
.HP
\fB\-\-access\-key\fR <id>, \fB\-K\fR <id>
.IP
The username of the user
.HP
\fB\-\-secret\-key\fR <key>, \fB\-S\fR <key>
.IP
The password of the user
.HP
\fB\-\-url\fR <url>, \fB\-U\fR <url>
.IP
Set url as the web service url to use
.HP
\fB\-\-headers\fR, \fB\-H\fR
.IP
Display column headers
.SH COPYRIGHT
Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org)
.PP
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

39
share/man/econe-describe-instances.1
View File

@ -0,0 +1,39 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands"
.SH NAME
OpenNebula \- OpenNebula econe-describe-instances
.SH SYNOPSIS
.B econe-describe-instances
[\fIOPTIONS\fR]
.SH DESCRIPTION
econe\-describe\-instances
.PP
List and describe running instances
.SH OPTIONS
.HP
\fB\-\-help\fR, \fB\-h\fR
.IP
Show help
.HP
\fB\-\-access\-key\fR <id>, \fB\-K\fR <id>
.IP
The username of the user
.HP
\fB\-\-secret\-key\fR <key>, \fB\-S\fR <key>
.IP
The password of the user
.HP
\fB\-\-url\fR <url>, \fB\-U\fR <url>
.IP
Set url as the web service url to use
.HP
\fB\-\-headers\fR, \fB\-H\fR
.IP
Display column headers
.SH COPYRIGHT
Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org)
.PP
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

43
share/man/econe-register.1
View File

@ -0,0 +1,43 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands"
.SH NAME
OpenNebula \- OpenNebula econe-register
.SH SYNOPSIS
.B econe-register
[\fIOPTIONS\fR] \fIIMAGE-ID\fR
.SH DESCRIPTION
econe\-register
.PP
Register a previously uploaded image for use with an
OpenNebula Cloud.
.SH OPTIONS
.HP
\fB\-\-help\fR, \fB\-h\fR
.IP
Show help
.HP
\fB\-\-access\-key\fR <id>, \fB\-K\fR <id>
.IP
The username of the user
.HP
\fB\-\-secret\-key\fR <key>, \fB\-S\fR <key>
.IP
The password of the user
.HP
\fB\-\-url\fR <url>, \fB\-U\fR <url>
.IP
Set url as the web service url to use
.HP
\fB\-\-headers\fR, \fB\-H\fR
.IP
Display column headers
.PP
IMAGE\-ID: The image identification as returned by
the econe\-upload command
.SH COPYRIGHT
Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org)
.PP
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

51
share/man/econe-run-instances.1
View File

@ -0,0 +1,51 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands"
.SH NAME
OpenNebula \- OpenNebula econe-run-instances
.SH SYNOPSIS
.B econe-run-instances
[\fIOPTIONS\fR] \fIIMAGE-ID\fR
.SH DESCRIPTION
econe\-run\-instances
.PP
Runs an instance of a particular image
.SH OPTIONS
.HP
\fB\-\-help\fR, \fB\-h\fR
.IP
Show help
.HP
\fB\-\-access\-key\fR <id>, \fB\-K\fR <id>
.IP
The username of the user
.HP
\fB\-\-secret\-key\fR <key>, \fB\-S\fR <key>
.IP
The password of the user
.HP
\fB\-\-url\fR <url>, \fB\-U\fR <url>
.IP
Set url as the web service url to use
.HP
\fB\-\-type\fR <type>, \fB\-t\fR <type>
.IP
OpenNebula template in which is based this instance
.HP
\fB\-\-user\-data\fR, \fB\-d\fR
.IP
Specifies Base64\-encoded MIME user data to be made
available to the instance
.HP
\fB\-\-headers\fR, \fB\-H\fR
.IP
Display column headers
.PP
IMAGE\-ID: The image identification as returned by
the econe\-upload command
.SH COPYRIGHT
Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org)
.PP
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

38
share/man/econe-terminate-instances.1
View File

@ -0,0 +1,38 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands"
.SH NAME
OpenNebula \- OpenNebula econe-terminate-instances
.SH SYNOPSIS
.B econe-register
[\fIOPTIONS\fR] \fIINSTANCE-ID\fR
.SH DESCRIPTION
econe\-terminate\-instances
.PP
Terminate the selected running instance
.SH OPTIONS
.HP
\fB\-\-help\fR, \fB\-h\fR
.IP
Show help
.HP
\fB\-\-access\-key\fR <id>, \fB\-K\fR <id>
.IP
The username of the user
.HP
\fB\-\-secret\-key\fR <key>, \fB\-S\fR <key>
.IP
The password of the user
.HP
\fB\-\-url\fR <url>, \fB\-U\fR <url>
.IP
Set url as the web service url to use
.PP
INSTANCE\-ID: The instance identification as returned by
the econe\-run\-instances command
.SH COPYRIGHT
Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org)
.PP
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

42
share/man/econe-upload.1
View File

@ -0,0 +1,42 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands"
.SH NAME
OpenNebula \- OpenNebula econe-upload
.SH SYNOPSIS
.B econe-upload
[\fIOPTIONS\fR] \fIIMAGE-PATH\fR
.SH DESCRIPTION
econe\-upload
.PP
Uploads an image for use with an OpenNebula Cloud. This image should
be later register with econe\-register using the returned ImageId
.SH OPTIONS
.HP
\fB\-\-help\fR, \fB\-h\fR
.IP
Show help
.HP
\fB\-\-access\-key\fR <id>, \fB\-K\fR <id>
.IP
The username of the user
.HP
\fB\-\-secret\-key\fR <key>, \fB\-S\fR <key>
.IP
The password of the user
.HP
\fB\-\-url\fR <url>, \fB\-U\fR <url>
.IP
Set url as the web service url to use
.HP
\fB\-\-multipart\fR, \fB\-M\fR
.IP
Use 'multipart\-post' library instead of Curb/Curl
.PP
IMAGE\-PATH: Path to the image to upload
.SH COPYRIGHT
Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org)
.PP
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

64
share/man/occi-compute.1
View File

@ -0,0 +1,64 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands"
.SH NAME
OpenNebula \- OpenNebula occi-compute
.SH SYNOPSIS
.B occi-compute
\fI<COMMAND> \fR[\fIOPTIONS\fR] [\fIARGUMENTS\fR]
.SH DESCRIPTION
occi\-compute \- Manages compute resources
.SH OPTIONS
\fB\-\-help\fR, \fB\-h\fR
.IP
Show help
.PP
\fB\-\-username\fR <id>, \fB\-U\fR <id>
.IP
The username of the user
.PP
\fB\-\-password\fR <key>, \fB\-P\fR <key>
.IP
The password of the user
.PP
\fB\-\-url\fR <url>, \fB\-R\fR <url>
.IP
Set url as the web service url to use
.PP
\fB\-\-timeout\fR <seconds>, \fB\-T\fR <seconds>
.IP
Sets a timeout for the http connection
.PP
\fB\-\-debug\fR, \fB\-D\fR
.IP
Enables verbosity
.SH COMMANDS
.TP
\fBcreate\fR <occi xml file>
.IP
creates a new compute resource described by the provided
<occi xml file>
.TP
\fBlist\fR
.IP
lists available compute resources
.TP
\fBshow\fR <compute id>
.IP
retrieves the OCCI XML representation of the compute resource
identified by <compute id>
.TP
\fBupdate\fR <occi xml file>
.IP
updates the representation of the compute resource represented by the
provided <occi xml file>
.TP
\fBdelete\fR <compute id>
.IP
deletes the compute resource idenfitied by <compute id>
.SH COPYRIGHT
Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org)
.PP
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

68
share/man/occi-network.1
View File

@ -0,0 +1,68 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands"
.SH NAME
OpenNebula \- OpenNebula occi-network
.SH SYNOPSIS
.B occi-network
\fI<COMMAND> \fR[\fIOPTIONS\fR] [\fIARGUMENTS\fR]
.SH DESCRIPTION
occi\-network \- Manages virtual networks
.SH OPTIONS
\fB\-\-help\fR, \fB\-h\fR
.IP
Show help
.PP
\fB\-\-username\fR <id>, \fB\-U\fR <id>
.IP
The username of the user
.PP
\fB\-\-password\fR <key>, \fB\-P\fR <key>
.IP
The password of the user
.PP
\fB\-\-url\fR <url>, \fB\-R\fR <url>
.IP
Set url as the web service url to use
.PP
\fB\-\-timeout\fR <seconds>, \fB\-T\fR <seconds>
.IP
Sets a timeout for the http connection
.PP
\fB\-\-debug\fR, \fB\-D\fR
.IP
Enables verbosity
.PP
\fB\-\-multipart\fR, \fB\-M\fR
.IP
Use 'multipart\-post' library instead of Curb/Curl
.SH COMMANDS
.TP
\fBcreate\fR <occi xml file>
.IP
creates a new virtual network described by the provided
<occi xml file>
.TP
\fBlist\fR
.IP
lists available virtual networks
.TP
\fBshow\fR <network id>
.IP
retrieves the OCCI XML representation of the virtual network
identified by <network id>
.TP
\fBupdate\fR <occi xml file>
.IP
updates the representation of the network resource represented by the
provided <occi xml file>
.TP
\fBdelete\fR <network id>
.IP
deletes the virtual network idenfitied by <network id>
.SH COPYRIGHT
Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org)
.PP
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

68
share/man/occi-storage.1
View File

@ -0,0 +1,68 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands"
.SH NAME
OpenNebula \- OpenNebula occi-storage
.SH SYNOPSIS
.B occi-storage
\fI<COMMAND> \fR[\fIOPTIONS\fR] [\fIPARAMETERS\fR]
.SH DESCRIPTION
occi\-storage \- Manages OCCI storage resource
.SH OPTIONS
\fB\-\-help\fR, \fB\-h\fR
.IP
Show help
.PP
\fB\-\-username\fR <id>, \fB\-U\fR <id>
.IP
The username of the user
.PP
\fB\-\-password\fR <key>, \fB\-P\fR <key>
.IP
The password of the user
.PP
\fB\-\-url\fR <url>, \fB\-R\fR <url>
.IP
Set url as the web service url to use
.PP
\fB\-\-timeout\fR <seconds>, \fB\-T\fR <seconds>
.IP
Sets a timeout for the http connection
.PP
\fB\-\-debug\fR, \fB\-D\fR
.IP
Enables verbosity
.PP
\fB\-\-multipart\fR, \fB\-M\fR
.IP
Use 'multipart\-post' library instead of Curb/Curl
.SH COMMANDS
.TP
\fBcreate\fR <occi xml file>
.IP
creates a new storage resource described by the provided
<occi xml file>
.TP
\fBlist\fR
.IP
lists available storage resources
.TP
\fBshow\fR <storage id>
.IP
retrieves the OCCI XML representation of the storage resource
identified by <storage id>
.TP
\fBupdate\fR <occi xml file>
.IP
updates the representation of the storage resource represented by the
provided <occi xml file>
.TP
\fBdelete\fR <storage id>
.IP
deletes the storage resource idenfitied by <storage id>
.SH COPYRIGHT
Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org)
.PP
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