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

F #5522: Remove manual pages (#554)

Browse Source
This commit is contained in:
Vlastimil Holer 2017-11-02 10:08:41 +01:00 committed by Ruben S. Montero
parent 890b5636d4
commit 790d620780
47 changed files with 0 additions and 4408 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
SConstruct
View File

@ -247,7 +247,6 @@ build_scripts=[
'src/vrouter/SConstruct',
'src/market/SConstruct',
'src/ipamm/SConstruct',
'share/man/SConstruct',
'src/sunstone/public/locale/languages/SConstruct',
'src/sunstone/public/SConstruct',
'share/rubygems/SConstruct',

74
share/man/SConstruct
View File

@ -1,74 +0,0 @@
# SConstruct for share/man
# -------------------------------------------------------------------------- #
# Copyright 2002-2017, OpenNebula Project, OpenNebula Systems #
# #
# 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 #
# #
# Unless required by applicable law or 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. #
#--------------------------------------------------------------------------- #
Import('env')
gzip_bld = Builder(action = 'gzip -c $SOURCE > $TARGET',
suffix = '.1.gz',
src_suffix = '.1')
env.Append(BUILDERS = {'Man' : gzip_bld})
env.Man('econe-allocate-address')
env.Man('econe-associate-address')
env.Man('econe-attach-volume')
env.Man('econe-create-keypair')
env.Man('econe-create-volume')
env.Man('econe-delete-keypair')
env.Man('econe-delete-volume')
env.Man('econe-describe-addresses')
env.Man('econe-describe-images')
env.Man('econe-describe-instances')
env.Man('econe-describe-keypairs')
env.Man('econe-describe-volumes')
env.Man('econe-detach-volume')
env.Man('econe-disassociate-address')
env.Man('econe-reboot-instances')
env.Man('econe-register')
env.Man('econe-release-address')
env.Man('econe-run-instances')
env.Man('econe-start-instances')
env.Man('econe-stop-instances')
env.Man('econe-terminate-instances')
env.Man('econe-upload')
env.Man('oneacct')
env.Man('oneshowback')
env.Man('oneacl')
env.Man('onecluster')
env.Man('onedatastore')
env.Man('onedb')
env.Man('onehost')
env.Man('oneimage')
env.Man('onetemplate')
env.Man('oneuser')
env.Man('onevm')
env.Man('onevnet')
env.Man('onegroup')
env.Man('onezone')
env.Man('onevcenter')
env.Man('onesecgroup')
env.Man('onevdc')
env.Man('onevrouter')
env.Man('onemarket')
env.Man('onemarketapp')
env.Man('onevmgroup')
env.Man('oneflow')
env.Man('oneflow-template')

45
share/man/econe-allocate-address.1
View File

@ -1,45 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-ALLOCATE\-ADDRESS" "1" "July 2017" "" "econe-allocate-address(1) -- Allocates a new elastic IP address for the user"
.
.SH "NAME"
\fBecone\-allocate\-address\fR \- Allocates a new elastic IP address for the user
.
.SH "SYNOPSIS"
econe\-allocate\-address \fIOPTIONS\fR
.
.P
Allocate a new elastic IP address for the user
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

48
share/man/econe-associate-address.1
View File

@ -1,48 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-ASSOCIATE\-ADDRESS" "1" "July 2017" "" "econe-associate-address(1) -- Associates a publicIP of the user with a given instance"
.
.SH "NAME"
\fBecone\-associate\-address\fR \- Associates a publicIP of the user with a given instance
.
.SH "SYNOPSIS"
econe\-associate\-address \fIOPTIONS\fR PUBLIC\-IP INSTANCE\-ID
.
.P
Associate a publicIP of the user with a given instance PUBLIC\-IP: ElasticIP owned by the user\. To see the list of ips use econe\-describe\-addresses INSTANCE\-ID: Id of the instance to be associated with the ElasticIP
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIpublic_ip\fR \fIinstance_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

51
share/man/econe-attach-volume.1
View File

@ -1,51 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-ATTACH\-VOLUME" "1" "July 2017" "" "econe-attach-volume(1) -- Attaches a DATABLOCK to an instance"
.
.SH "NAME"
\fBecone\-attach\-volume\fR \- Attaches a DATABLOCK to an instance
.
.SH "SYNOPSIS"
econe\-attach\-volume \fIOPTIONS\fR VOLUME\-ID
.
.P
Attaches a DATABLOCK to a running instance and exposes it as the specified device\. VOLUME\-ID: The ID of the DATABLOCK
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
\-i, \-\-instance instance_id The ID of the instance to attach the volume to
\-d, \-\-device device Specifies the device name to expose to the
instance\. Example: \-d /dev/sdf
.
.fi
.
.P
\fIvolume_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

48
share/man/econe-create-keypair.1
View File

@ -1,48 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-CREATE\-KEYPAIR" "1" "July 2017" "" "econe-create-keypair(1) -- Creates the named keypair"
.
.SH "NAME"
\fBecone\-create\-keypair\fR \- Creates the named keypair
.
.SH "SYNOPSIS"
econe\-create\-keypair \fIOPTIONS\fR \fIkeypair name\fR
.
.P
Creates the named keypair\. On success returns the keypair identifier and fingerprint, and the private key
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIkeyName\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

46
share/man/econe-create-volume.1
View File

@ -1,46 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-CREATE\-VOLUME" "1" "July 2017" "" "econe-create-volume(1) -- Creates a new DATABLOCK in OpenNebula"
.
.SH "NAME"
\fBecone\-create\-volume\fR \- Creates a new DATABLOCK in OpenNebula
.
.SH "SYNOPSIS"
econe\-create\-volume \fIOPTIONS\fR
.
.P
Create a new VOLUME
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
\-s, \-\-size size The size of the volume, in GiBs\.
.
.fi
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

48
share/man/econe-delete-keypair.1
View File

@ -1,48 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-DELETE\-KEYPAIR" "1" "July 2017" "" "econe-delete-keypair(1) -- Deletes the named keypair, removes the associated keys"
.
.SH "NAME"
\fBecone\-delete\-keypair\fR \- Deletes the named keypair, removes the associated keys
.
.SH "SYNOPSIS"
econe\-delete\-keypair \fIOPTIONS\fR \fIkeypair name\fR
.
.P
Deletes the named keypair, removes the associated keys\. On success returns the identifier of the removed key\.
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIkeyName\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

48
share/man/econe-delete-volume.1
View File

@ -1,48 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-DELETE\-VOLUME" "1" "July 2017" "" "econe-delete-volume(1) -- Deletes an existing DATABLOCK"
.
.SH "NAME"
\fBecone\-delete\-volume\fR \- Deletes an existing DATABLOCK
.
.SH "SYNOPSIS"
econe\-delete\-volume \fIOPTIONS\fR VOLUME\-ID
.
.P
Deletes the targe VOLUME VOLUME\-ID: The ID of the DATABLOCK
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIvolume_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

45
share/man/econe-describe-addresses.1
View File

@ -1,45 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-DESCRIBE\-ADDRESSES" "1" "July 2017" "" "econe-describe-addresses(1) -- Lists elastic IP addresses"
.
.SH "NAME"
\fBecone\-describe\-addresses\fR \- Lists elastic IP addresses
.
.SH "SYNOPSIS"
econe\-describe\-addresses \fIOPTIONS\fR
.
.P
List elastic IP addresses
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

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

@ -1,45 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-DESCRIBE\-IMAGES" "1" "July 2017" "" "econe-describe-images(1) -- Lists all registered images belonging to one particular user"
.
.SH "NAME"
\fBecone\-describe\-images\fR \- Lists all registered images belonging to one particular user
.
.SH "SYNOPSIS"
econe\-describe\-images \fIOPTIONS\fR
.
.P
List and describe previously uploaded images of a user to be used with an OpenNebula Cloud\.
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

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

@ -1,45 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-DESCRIBE\-INSTANCES" "1" "July 2017" "" "econe-describe-instances(1) -- Outputs a list of launched images belonging to one particular user"
.
.SH "NAME"
\fBecone\-describe\-instances\fR \- Outputs a list of launched images belonging to one particular user
.
.SH "SYNOPSIS"
econe\-describe\-instances \fIOPTIONS\fR
.
.P
List and describe running instances
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

45
share/man/econe-describe-keypairs.1
View File

@ -1,45 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-DESCRIBE\-KEYPAIRS" "1" "July 2017" "" "econe-describe-keypairs(1) -- List and describe the key pairs available to the user"
.
.SH "NAME"
\fBecone\-describe\-keypairs\fR \- List and describe the key pairs available to the user
.
.SH "SYNOPSIS"
econe\-describe\-keypairs \fIOPTIONS\fR
.
.P
List and describe the key pairs available to you\.
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

45
share/man/econe-describe-volumes.1
View File

@ -1,45 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-DESCRIBE\-VOLUMES" "1" "July 2017" "" "econe-describe-volumes(1) -- Describe all available DATABLOCKs for this user"
.
.SH "NAME"
\fBecone\-describe\-volumes\fR \- Describe all available DATABLOCKs for this user
.
.SH "SYNOPSIS"
econe\-describe\-volumes \fIOPTIONS\fR
.
.P
List and describe volumes
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

51
share/man/econe-detach-volume.1
View File

@ -1,51 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-DETACH\-VOLUME" "1" "July 2017" "" "econe-detach-volume(1) -- Detaches a DATABLOCK from an instance"
.
.SH "NAME"
\fBecone\-detach\-volume\fR \- Detaches a DATABLOCK from an instance
.
.SH "SYNOPSIS"
econe\-detach\-volume \fIOPTIONS\fR VOLUME\-ID
.
.P
Detaches a volume from an instance\. Make sure to unmount any file systems on the device within your operating system before detaching the volume VOLUME\-ID: The ID of the DATABLOCK
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
\-i, \-\-instance instance_id The ID of the instance to attach the volume to
\-d, \-\-device device Specifies the device name to expose to the
instance\. Example: \-d /dev/sdf
.
.fi
.
.P
\fIvolume_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

48
share/man/econe-disassociate-address.1
View File

@ -1,48 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-DISASSOCIATE\-ADDRESS" "1" "July 2017" "" "econe-disassociate-address(1) -- Disasociate a publicIP of the user currently associated with an instance"
.
.SH "NAME"
\fBecone\-disassociate\-address\fR \- Disasociate a publicIP of the user currently associated with an instance
.
.SH "SYNOPSIS"
econe\-disasociate\-address \fIOPTIONS\fR PUBLIC\-IP
.
.P
<<\-EOT Disasociate a publicIP of the user currently associated with an instance PUBLIC\-IP: ElasticIP owned by the user\. To see the list of ips use econe\-describe\-addresses EOT
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIpublic_ip\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

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

@ -1,51 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-REBOOT\-INSTANCES" "1" "July 2017" "" "econe-reboot-instances(1) -- Reboots a set of virtual machines"
.
.SH "NAME"
\fBecone\-reboot\-instances\fR \- Reboots a set of virtual machines
.
.SH "SYNOPSIS"
econe\-reboot\-instances \fIOPTIONS\fR INSTANCE\-ID[,INSTANCE\-ID\.\.\.]
.
.P
Reboot the selected running instance INSTANCE\-ID: The instance identification as returned by the econe\-run\-instances command
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIinstance_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
instance_id The IDs of instances, comma\-separated
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

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

@ -1,48 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-REGISTER" "1" "July 2017" "" "econe-register(1) -- Registers an image"
.
.SH "NAME"
\fBecone\-register\fR \- Registers an image
.
.SH "SYNOPSIS"
econe\-register \fIOPTIONS\fR IMAGE\-ID
.
.P
<<\-EOT Register a previously uploaded image for use with an OpenNebula Cloud\. IMAGE\-ID: The image identification as returned by the econe\-upload command EOT
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIinstance_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

48
share/man/econe-release-address.1
View File

@ -1,48 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-RELEASE\-ADDRESS" "1" "July 2017" "" "econe-release-address(1) -- Releases a publicIP of the user"
.
.SH "NAME"
\fBecone\-release\-address\fR \- Releases a publicIP of the user
.
.SH "SYNOPSIS"
econe\-release\-address \fIOPTIONS\fR PUBLIC\-IP
.
.P
Release a publicIP of the user" PUBLIC\-IP: ElasticIP owned by the user\. To see the list of ips use econe\-describe\-addresses
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIpublic_ip\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

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

@ -1,59 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-RUN\-INSTANCES" "1" "July 2017" "" "econe-run-instances(1) -- Runs an instance of a particular image (that needs to be referenced)"
.
.SH "NAME"
\fBecone\-run\-instances\fR \- Runs an instance of a particular image (that needs to be referenced)
.
.SH "SYNOPSIS"
econe\-run\-instances \fIOPTIONS\fR IMAGE\-ID
.
.P
Runs an instance of a particular image IMAGE\-ID: The image identification as returned by the econe\-upload command
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
\-d, \-\-user\-data data Specifies Base64\-encoded MIME user data to be
made available to the instance
\-n, \-\-instance\-count count The number of instances to launch\. If OpenNebula
cannot launch the specified number of instances,
no instances will launch\. If this is specified
as a range (min\-max), OpenNebula will try to
launch the maximum number, but no fewer than the
minimum number\.Example: \-n 5\-10
\-t, \-\-type type OpenNebula template in which is based this
instance
\-k, \-\-keypair keypair The name of the key pair\.
.
.fi
.
.P
\fIimage_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

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

@ -1,51 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-START\-INSTANCES" "1" "July 2017" "" "econe-start-instances(1) -- Starts a set of virtual machines"
.
.SH "NAME"
\fBecone\-start\-instances\fR \- Starts a set of virtual machines
.
.SH "SYNOPSIS"
econe\-start\-instances \fIOPTIONS\fR INSTANCE\-ID[,INSTANCE\-ID\.\.\.]
.
.P
Start the selected stopped instance INSTANCE\-ID: The instance identification as returned by the econe\-run\-instances command
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIinstance_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
instance_id The IDs of instances, comma\-separated
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

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

@ -1,51 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-STOP\-INSTANCES" "1" "July 2017" "" "econe-stop-instances(1) -- Stops a set of virtual machines"
.
.SH "NAME"
\fBecone\-stop\-instances\fR \- Stops a set of virtual machines
.
.SH "SYNOPSIS"
econe\-stop\-instances \fIOPTIONS\fR INSTANCE\-ID[,INSTANCE\-ID\.\.\.]
.
.P
Stop the selected running instance INSTANCE\-ID: The instance identification as returned by the econe\-run\-instances command
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIinstance_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
instance_id The IDs of instances, comma\-separated
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

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

@ -1,51 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-TERMINATE\-INSTANCES" "1" "July 2017" "" "econe-terminate-instances(1) -- Shutdowns a set of virtual machines (or cancel, depending on its state)"
.
.SH "NAME"
\fBecone\-terminate\-instances\fR \- Shutdowns a set of virtual machines (or cancel, depending on its state)
.
.SH "SYNOPSIS"
econe\-terminate\-instances \fIOPTIONS\fR INSTANCE\-ID[,INSTANCE\-ID\.\.\.]
.
.P
Terminate the selected running instance INSTANCE\-ID: The instance identification as returned by the econe\-run\-instances command\.
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
.
.fi
.
.P
\fIinstance_id\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
instance_id The IDs of instances, comma\-separated
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

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

@ -1,49 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ECONE\-UPLOAD" "1" "July 2017" "" "econe-upload(1) -- Uploads an image to OpenNebula"
.
.SH "NAME"
\fBecone\-upload\fR \- Uploads an image to OpenNebula
.
.SH "SYNOPSIS"
econe\-upload \fIOPTIONS\fR IMAGE\-PATH
.
.P
Uploads an image for use with an OpenNebula Cloud\. This image should be later register with econe\-register using the returned ImageId IMAGE\-PATH: Path to the image to upload
.
.SH "OPTIONS"
.
.nf
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-K, \-\-access\-key id The username of the user
\-S, \-\-secret\-key key The sha1 hashed password of the user
\-U, \-\-url url Set url as the web service url to use
\-M, \-\-multipart Use \'multipart\-post\' library instead of Curb/Curl
.
.fi
.
.P
\fIfile\fR
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

55
share/man/oneacct.1
View File

@ -1,55 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEACCT" "1" "July 2017" "" "oneacct(1) -- OpenNebula Accounting Tool"
.
.SH "NAME"
\fBoneacct\fR \- OpenNebula Accounting Tool
.
.SH "SYNOPSIS"
\fBoneacct\fR [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-s, \-\-start TIME First day of the data to retrieve
\-e, \-\-end TIME Last day of the data to retrieve
\-u, \-\-userfilter user User name or id to filter the results
\-g, \-\-group group Group name or id to filter the results
\-H, \-\-host HOST Host name or id to filter the results
\-\-xpath XPATH_EXPRESSION Xpath expression to filter the results\. For
example: oneacct \-\-xpath \'HISTORY[ETIME>0]\'
\-x, \-\-xml Show the resource in xml format
\-j, \-\-json Show the resource in json format
\-\-split Split the output in a table for each VM
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-describe Describe list columns
\-l, \-\-list x,y,z Selects columns to display with list command
\-\-csv Write table in csv format
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

60
share/man/oneacl.1
View File

@ -1,60 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEACL" "1" "July 2017" "" "oneacl(1) -- manages OpenNebula ACLs"
.
.SH "NAME"
\fBoneacl\fR \- manages OpenNebula ACLs
.
.SH "SYNOPSIS"
\fBoneacl\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-x, \-\-xml Show the resource in xml format
\-\-describe Describe list columns
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIuser|rulestr\fR [\fIresource\fR] [\fIrights\fR] Adds a new ACL rule
.
.IP "\(bu" 4
delete \fIrange\fR Deletes an existing ACL rule
.
.IP "\(bu" 4
list Lists the ACL rule set valid options: xml, describe
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
aclid_list Comma\-separated list of OpenNebula ACL names or ids
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

107
share/man/onecluster.1
View File

@ -1,107 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONECLUSTER" "1" "July 2017" "" "onecluster(1) -- manages OpenNebula clusters"
.
.SH "NAME"
\fBonecluster\fR \- manages OpenNebula clusters
.
.SH "SYNOPSIS"
\fBonecluster\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-a, \-\-append Append new attributes to the current template
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIname\fR Creates a new Cluster
.
.IP "\(bu" 4
delete \fIrange|clusterid_list\fR Deletes the given Cluster
.
.IP "\(bu" 4
list Lists Clusters in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIclusterid\fR Shows information for the given Cluster valid options: xml
.
.IP "\(bu" 4
addhost \fIclusterid\fR \fIhostid\fR Adds a Host to the given Cluster
.
.IP "\(bu" 4
delhost \fIclusterid\fR \fIhostid\fR Deletes a Host from the given Cluster
.
.IP "\(bu" 4
adddatastore \fIclusterid\fR \fIdatastoreid\fR Adds a Datastore to the given Cluster
.
.IP "\(bu" 4
deldatastore \fIclusterid\fR \fIdatastoreid\fR Deletes a Datastore from the given Cluster
.
.IP "\(bu" 4
addvnet \fIclusterid\fR \fIvnetid\fR Adds a Virtual Network to the given Cluster
.
.IP "\(bu" 4
delvnet \fIclusterid\fR \fIvnetid\fR Deletes a Virtual Network from the given Cluster
.
.IP "\(bu" 4
update \fIclusterid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
rename \fIclusterid\fR \fIname\fR Renames the Cluster
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
clusterid OpenNebula CLUSTER name or id
.
.IP "\(bu" 4
clusterid_list Comma\-separated list of OpenNebula CLUSTER names or ids
.
.IP "\(bu" 4
vnetid OpenNebula VNET name or id
.
.IP "\(bu" 4
hostid OpenNebula HOST name or id
.
.IP "\(bu" 4
datastoreid OpenNebula DATASTORE name or id
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

105
share/man/onedatastore.1
View File

@ -1,105 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEDATASTORE" "1" "July 2017" "" "onedatastore(1) -- manages OpenNebula datastores"
.
.SH "NAME"
\fBonedatastore\fR \- manages OpenNebula datastores
.
.SH "SYNOPSIS"
\fBonedatastore\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-c, \-\-cluster id|name Selects the cluster
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-a, \-\-append Append new attributes to the current template
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIfile\fR Creates a new Datastore from the given template file valid options: cluster
.
.IP "\(bu" 4
delete \fIrange|datastoreid_list\fR Deletes the given Datastore
.
.IP "\(bu" 4
chgrp \fIrange|datastoreid_list\fR \fIgroupid\fR Changes the Datastore group
.
.IP "\(bu" 4
chown \fIrange|datastoreid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Datastore owner and group
.
.IP "\(bu" 4
chmod \fIrange|datastoreid_list\fR \fIoctet\fR Changes the Datastore permissions
.
.IP "\(bu" 4
list Lists Datastores in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIdatastoreid\fR Shows information for the given Datastore valid options: xml
.
.IP "\(bu" 4
update \fIdatastoreid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
rename \fIdatastoreid\fR \fIname\fR Renames the Datastore
.
.IP "\(bu" 4
enable \fIrange|datastoreid_list\fR Enables the given Datastore\. Only available for System Datastores
.
.IP "\(bu" 4
disable \fIrange|datastoreid_list\fR Disables the given Datastore\. Only available for System Datastores
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
datastoreid OpenNebula DATASTORE name or id
.
.IP "\(bu" 4
datastoreid_list Comma\-separated list of OpenNebula DATASTORE names or ids
.
.IP "\(bu" 4
clusterid OpenNebula CLUSTER name or id
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

155
share/man/onedb.1
View File

@ -1,155 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEDB" "1" "July 2017" "" "onedb(1) -- OpenNebula database migration tool"
.
.SH "NAME"
\fBonedb\fR \- OpenNebula database migration tool
.
.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
\-\-federated Limit backup/restore to federated tables
\-b, \-\-backup file Use this file to store SQL dump
\-\-extra arg Extra args
\-s, \-\-start TIME First time to process
\-e, \-\-end TIME Last time to process
\-i, \-\-id ID Filter by ID
\-x, \-\-xpath ID Filter by xpath
\-e, \-\-expr ID Filter by expression (UNAME=oneadmin)
\-\-dry Do not write in the database, output xml
\-d, \-\-delete Delete all matched xpaths
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-s, \-\-sqlite file SQLite DB file
\-S, \-\-server host MySQL server hostname or IP\. Defaults to
localhost
\-P, \-\-port port MySQL server port\. Defaults to 3306
\-u, \-\-username user MySQL username
\-p, \-\-password pass MySQL password\. Leave unset to be prompted for it
\-d, \-\-dbname dbname MySQL DB name for OpenNebula
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
backup [\fIoutput_file\fR] Dumps the DB to a file specified in the argument valid options: force, federated
.
.IP "\(bu" 4
version Prints the current DB version\. Use \-v flag to see also OpenNebula version
.
.IP "\(bu" 4
history Prints the upgrades history
.
.IP "\(bu" 4
restore \fIbackup_file\fR Restores the DB from a backup file\. Only restores backups generated from the same backend (SQLite or MySQL) valid options: force, federated
.
.IP "\(bu" 4
upgrade [\fIversion\fR] Upgrades the DB to the latest version where \fIversion\fR : DB version (e\.g\. 1, 3) to upgrade\. By default the DB is upgraded to the latest version valid options: force, backup
.
.IP "\(bu" 4
fsck Checks the consistency of the DB, and fixes the problems found valid options: force, backup
.
.IP "\(bu" 4
vcenter\-one54 Migrate VM and templates so they can be used by OpenNebula 5\.4 valid options: force, backup
.
.IP "\(bu" 4
patch \fIfile\fR Applies a database patch file valid options: backup, extra
.
.IP "\(bu" 4
sqlite2mysql Migrates a SQLite OpenNebula Database to MySQL valid options: backup
.
.IP "\(bu" 4
purge\-history Deletes all but the last history records from non DONE VMs
.
.IP "" 4
.
.nf
**WARNING**: This action is done while OpenNebula is running\. Make
a backup of the datasbase before executing\.
valid options: start_time, end_time
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
purge\-done Deletes all VMs in DONE state
.
.IP "" 4
.
.nf
**WARNING**: This action is done while OpenNebula is running\. Make
a backup of the datasbase before executing\.
valid options: start_time, end_time
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
change\-body
.
.IP "" 4
.
.nf
You can filter the objects to modify using one of these options:
* \-\-id: object id, example: 156
* \-\-xpath: xpath expression, example: TEMPLATE[count(NIC)>1]
* \-\-expr: xpath expression, can use operators =, !=, <, >, <= or >=
examples: UNAME=oneadmin, TEMPLATE/NIC/NIC_ID>0
If you want to change a value use a third parameter\. In case you want
to delete it use \-\-delete option\.
Change the second network of VMs that belong to "user":
onedb change\-body vm \-\-expr UNAME=user \e
\'/VM/TEMPLATE/NIC[NETWORK="service"]/NETWORK\' new_network
Delete cache attribute in all disks, write xml, do not modify DB:
onedb change\-body vm \'/VM/TEMPLATE/DISK/CACHE\' \-\-delete \-\-dry
Delete cache attribute in all disks in poweroff:
onedb change\-body vm \-\-expr LCM_STATE=8 \e
\'/VM/TEMPLATE/DISK/CACHE\' \-\-delete
**WARNING**: This action is done while OpenNebula is running\. Make
a backup of the datasbase before executing\.
valid options: id, xpath, expr, dry, delete
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0

96
share/man/oneflow-template.1
View File

@ -1,96 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEFLOW\-TEMPLATE" "1" "July 2017" "" "oneflow-template(1) -- Manage oneFlow Templates"
.
.SH "NAME"
\fBoneflow\-template\fR \- Manage oneFlow Templates
.
.SH "SYNOPSIS"
\fBoneflow\-template\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-j, \-\-json Print the resource in JSON
\-t, \-\-top Top for the command
\-d, \-\-delay x Sets the delay in seconds for top command
\-s, \-\-server url Service endpoint
\-u, \-\-username name User name
\-p, \-\-password pass User password
\-V, \-\-version Show version and copyright information
\-h, \-\-help Show this message
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
list List the available Service Templates valid options: json
.
.IP "\(bu" 4
top List the available Service Templates continuously valid options: json, top, delay
.
.IP "\(bu" 4
create \fIfile\fR Create a new Service Template valid options: json
.
.IP "\(bu" 4
show \fItemplateid\fR Show detailed information of a given Service Template valid options: json
.
.IP "\(bu" 4
delete \fIrange|templateid_list\fR Delete a given Service Template
.
.IP "\(bu" 4
instantiate \fItemplateid\fR [\fIfile\fR] Instantiate a Service Template valid options: json, top
.
.IP "\(bu" 4
chgrp \fIrange|templateid_list\fR \fIgroupid\fR Changes the service template group
.
.IP "\(bu" 4
chown \fIrange|templateid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the service template owner and group
.
.IP "\(bu" 4
chmod \fIrange|templateid_list\fR \fIoctet\fR Changes the service template permissions
.
.IP "\(bu" 4
clone \fItemplateid\fR \fIname\fR Creates a new Service Template from an existing one
.
.IP "\(bu" 4
rename \fItemplateid\fR \fIname\fR Renames the Service Template
.
.IP "\(bu" 4
update \fItemplateid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\.
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
templateid OpenNebula SERVICE TEMPLATE name or id
.
.IP "\(bu" 4
templateid_list Comma\-separated list of OpenNebula SERVICE TEMPLATE names or ids
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

103
share/man/oneflow.1
View File

@ -1,103 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEFLOW" "1" "July 2017" "" "oneflow(1) -- Manage oneFlow Services"
.
.SH "NAME"
\fBoneflow\fR \- Manage oneFlow Services
.
.SH "SYNOPSIS"
\fBoneflow\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-j, \-\-json Print the resource in JSON
\-t, \-\-top Top for the command
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-force Force the new cardinality even if it is outside
the limits
\-p, \-\-period x Seconds between each group of actions
\-n, \-\-number x Number of VMs to apply the action to each period
\-s, \-\-server url Service endpoint
\-u, \-\-username name User name
\-p, \-\-password pass User password
\-V, \-\-version Show version and copyright information
\-h, \-\-help Show this message
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
list List the available services valid options: json
.
.IP "\(bu" 4
show \fIservice_id\fR Show detailed information of a given service valid options: json
.
.IP "\(bu" 4
top [\fIservice_id\fR] Top the services or the extended information of the target service if a id is specified valid options: json, top, delay
.
.IP "\(bu" 4
delete \fIrange|service_id_list\fR Delete a given service
.
.IP "\(bu" 4
shutdown \fIrange|service_id_list\fR Shutdown a service\. From RUNNING or WARNING shuts down the Service
.
.IP "\(bu" 4
recover \fIrange|service_id_list\fR Recover a failed service, cleaning the failed VMs\. From FAILED_DEPLOYING continues deploying the Service From FAILED_SCALING continues scaling the Service From FAILED_UNDEPLOYING continues shutting down the Service From COOLDOWN the Service is set to running ignoring the cooldown duration From WARNING failed VMs are deleted, and new VMs are instantiated
.
.IP "\(bu" 4
scale \fIservice_id\fR \fIrole_name\fR \fIcardinality\fR Scale a role to the given cardinality valid options: force
.
.IP "\(bu" 4
chgrp \fIrange|service_id_list\fR \fIgroupid\fR Changes the service group
.
.IP "\(bu" 4
chown \fIrange|service_id_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the service owner and group
.
.IP "\(bu" 4
chmod \fIrange|service_id_list\fR \fIoctet\fR Changes the service permissions
.
.IP "\(bu" 4
rename \fIservice_id\fR \fIname\fR Renames the Service
.
.IP "\(bu" 4
action \fIservice_id\fR \fIrole_name\fR \fIvm_action\fR Perform an action on all the Virtual Machines of a given role\. Actions supported: terminate,terminate\-hard,undeploy,undeploy\-hard,hold,release,stop,suspend,resume,reboot,reboot\-hard,poweroff,poweroff\-hard,snapshot\-create valid options: period, number
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
service_id OpenNebula SERVICE name or id
.
.IP "\(bu" 4
service_id_list Comma\-separated list of OpenNebula SERVICE names or ids
.
.IP "\(bu" 4
vm_action Actions supported: terminate, terminate\-hard, undeploy, undeploy\-hard, hold, release, stop, suspend, resume, reboot, reboot\-hard, poweroff, poweroff\-hard, snapshot\-create
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

120
share/man/onegroup.1
View File

@ -1,120 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEGROUP" "1" "July 2017" "" "onegroup(1) -- manages OpenNebula groups"
.
.SH "NAME"
\fBonegroup\fR \- manages OpenNebula groups
.
.SH "SYNOPSIS"
\fBonegroup\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-n, \-\-name name Name for the new group
\-u, \-\-admin_user name Creates an admin user for the group with name
\-p, \-\-admin_password pass Password for the admin user of the group
\-d, \-\-admin_driver driver Auth driver for the admin user of the group
\-r, \-\-resources res_str Which resources can be created by group users
(VM+NET+IMAGE+TEMPLATE by default)
\-a, \-\-append Append new attributes to the current template
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create [\fIgroup_name\fR] Creates a new Group\. A group name can be passed as the only argument, or via command line arguments
.
.IP "" 4
.
.nf
Examples:
\- create a group with an admin user and allow group users
to only create new templates and VMs
onegroup create \-\-name groupA
\-\-admin_user admin_userA \-\-admin_password somestr
\-\-resources TEMPLATE+VM
valid options: name, admin_user, admin_password, admin_driver, resources
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
update \fIgroupid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
delete \fIrange|groupid_list\fR Deletes the given Group
.
.IP "\(bu" 4
list Lists Groups in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show [\fIgroupid\fR] Shows information for the given Group valid options: xml
.
.IP "\(bu" 4
addadmin \fIrange|groupid_list\fR \fIuserid\fR Adds a User to the Group administrators set
.
.IP "\(bu" 4
deladmin \fIrange|groupid_list\fR \fIuserid\fR Removes a User from the Group administrators set
.
.IP "\(bu" 4
quota \fIgroupid\fR [\fIfile\fR] Set the quota limits for the group\. If a path is not provided the editor will be launched to modify the current quotas\.
.
.IP "\(bu" 4
batchquota \fIrange|groupid_list\fR [\fIfile\fR] Sets the quota limits in batch for various groups\. If a path is not provided the editor will be launched to create new quotas\.
.
.IP "\(bu" 4
defaultquota [\fIfile\fR] Sets the default quota limits for the groups\. If a path is not provided the editor will be launched to modify the current default quotas\.
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
groupid_list Comma\-separated list of OpenNebula GROUP names or ids
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

136
share/man/onehost.1
View File

@ -1,136 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEHOST" "1" "July 2017" "" "onehost(1) -- manages OpenNebula hosts"
.
.SH "NAME"
\fBonehost\fR \- manages OpenNebula hosts
.
.SH "SYNOPSIS"
\fBonehost\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-i, \-\-im im_mad Set the information driver for the host
\-v, \-\-vm vmm_mad Set the virtualization driver for the host
\-c, \-\-cluster id|name Selects the cluster
\-t, \-\-type remote_provider Use type to create a host using Cloud Bursting
\-a, \-\-append Append new attributes to the current template
\-\-force Force probe upgrade in onehost sync
\-\-rsync Use rsync to synchronize remotes\. In case some
probes are no longer in the fronted are deleted
in the hosts\. rsync command must be installed in
the frontend and nodes\.
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-k, \-\-kilobytes Show units in kilobytes
\-\-describe Describe list columns
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIhostname\fR [\fIfile\fR] Creates a new Host valid options: im, vm, cluster, type
.
.IP "\(bu" 4
delete \fIrange|hostid_list\fR Deletes the given Host
.
.IP "\(bu" 4
enable \fIrange|hostid_list\fR Enables the given host, fully operational
.
.IP "\(bu" 4
disable \fIrange|hostid_list\fR Disables the given host:
.
.IP "" 4
.
.nf
\- monitor: enabled
\- scheduler deployment: disabled
\- manual deployment: enabled
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
offline \fIrange|hostid_list\fR Sets the host offline:
.
.IP "" 4
.
.nf
\- monitor: disabled
\- scheduler deployment: disabled
\- manual deployment: disabled
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
update \fIhostid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
sync [\fIrange|hostid_list\fR] Synchronizes probes in /var/lib/one/remotes ($ONE_LOCATION/var/remotes in self\-contained installations) with Hosts\. Examples: onehost sync onehost sync \-c myCluster onehost sync host01,host02,host03 valid options: cluster, force, rsync
.
.IP "\(bu" 4
list Lists Hosts in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, kilobytes, describe
.
.IP "\(bu" 4
show \fIhostid\fR Shows information for the given Host valid options: xml
.
.IP "\(bu" 4
top Lists Hosts continuously valid options: list, listconf, delay, filter, csv, xml, numeric, kilobytes
.
.IP "\(bu" 4
flush \fIrange|hostid_list\fR Disables the host and reschedules all the running VMs in it\.
.
.IP "\(bu" 4
rename \fIhostid\fR \fIname\fR Renames the Host
.
.IP "\(bu" 4
importvm \fIhostid\fR \fIname\fR Import VM to OpenNebula
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
hostid OpenNebula HOST name or id
.
.IP "\(bu" 4
hostid_list Comma\-separated list of OpenNebula HOST names or ids
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

184
share/man/oneimage.1
View File

@ -1,184 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEIMAGE" "1" "July 2017" "" "oneimage(1) -- manages OpenNebula images"
.
.SH "NAME"
\fBoneimage\fR \- manages OpenNebula images
.
.SH "SYNOPSIS"
\fBoneimage\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-d, \-\-datastore id|name Selects the datastore
\-\-name name Name of the new image
\-\-description description Description for the new Image
\-\-type type Type of the new Image: OS, CDROM, DATABLOCK,
KERNEL, RAMDISK, CONTEXT
\-\-persistent Tells if the image will be persistent
\-\-prefix prefix Device prefix for the disk (eg\. hd, sd, xvd or
vd)
\-\-target target Device the disk will be attached to
\-\-path path Path of the image file
\-\-driver driver Driver to use image (raw, qcow2, tap:aio:\.\.\.)
\-\-disk_type disk_type Type of the image BLOCK, CDROM, RBD or FILE (for
others, check the documentation)
\-\-vcenter_disk_type vcenter_disk_type The vCenter Disk Type of the image
for vCenter: THIN, THICK, ZEROEDTHICK (for
others, check the documentation)
\-\-vcenter_adapter_type vcenter_adapter_type Controller that will handle
this image in vCenter (lsiLogic, ide, busLogic)\.
For other values check the documentation
\-\-source source Source to be used\. Useful for not file\-based
images
\-\-size size Size in MB\. Used for DATABLOCK type or SOURCE
based images\.
\-\-dry Just print the template
\-a, \-\-append Append new attributes to the current template
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create [\fIfile\fR] Creates a new Image Examples:
.
.IP "" 4
.
.nf
\- using a template description file:
oneimage create \-d default centOS\.tmpl
\- new image "arch" using a path:
oneimage create \-d default \-\-name arch \-\-path /tmp/arch\.img
\- new persistent image, OS type and qcow2 format:
oneimage create \-d 1 \-\-name ubuntu \-\-path /tmp/ubuntu\.qcow2 \e
\-\-prefix sd \-\-type OS \-\-driver qcow2 \e
\-\-description "A OS plain installation \e
\-\-persistent"
\- a datablock image of 400MB:
oneimage create \-d 1 \-\-name data \-\-type DATABLOCK \-\-size 400
valid options: datastore, name, description, type, persistent, prefix, target, path, driver, disk_type, vcenter_disk_type, vcenter_adapter_type, source, size, dry
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
clone \fIimageid\fR \fIname\fR Creates a new Image from an existing one valid options: datastore
.
.IP "\(bu" 4
delete \fIrange|imageid_list\fR Deletes the given Image
.
.IP "\(bu" 4
persistent \fIrange|imageid_list\fR 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\.
.
.IP "\(bu" 4
nonpersistent \fIrange|imageid_list\fR Makes the given Image non persistent\. See \'oneimage persistent\'
.
.IP "\(bu" 4
update \fIimageid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
enable \fIrange|imageid_list\fR Enables the given Image
.
.IP "\(bu" 4
chtype \fIrange|imageid_list\fR \fItype\fR Changes the Image\'s type
.
.IP "\(bu" 4
disable \fIrange|imageid_list\fR Disables the given Image
.
.IP "\(bu" 4
chgrp \fIrange|imageid_list\fR \fIgroupid\fR Changes the Image group
.
.IP "\(bu" 4
chown \fIrange|imageid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Image owner and group
.
.IP "\(bu" 4
chmod \fIrange|imageid_list\fR \fIoctet\fR Changes the Image permissions
.
.IP "\(bu" 4
rename \fIimageid\fR \fIname\fR Renames the Image
.
.IP "\(bu" 4
snapshot\-delete \fIimageid\fR \fIsnapshot_id\fR Deletes a snapshot from the image
.
.IP "\(bu" 4
snapshot\-revert \fIimageid\fR \fIsnapshot_id\fR Reverts image state to a snapshot
.
.IP "\(bu" 4
snapshot\-flatten \fIimageid\fR \fIsnapshot_id\fR Flattens the snapshot and removes all other snapshots in the image
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists Images in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIimageid\fR Shows information for the given Image valid options: xml
.
.IP "\(bu" 4
top [\fIfilterflag\fR] Lists Images continuously valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
imageid OpenNebula IMAGE name or id
.
.IP "\(bu" 4
imageid_list Comma\-separated list of OpenNebula IMAGE names or ids
.
.IP "\(bu" 4
filterflag a, all all the known IMAGEs m, mine the IMAGE belonging to the user in ONE_AUTH g, group \'mine\' plus the IMAGE belonging to the groups the user is member of G, primary group the IMAGE owned the user\'s primary group uid IMAGE of the user identified by this uid user IMAGE of the user identified by the username
.
.IP "\(bu" 4
type Image type: OS, CDROM, DATABLOCK, KERNEL, RAMDISK, CONTEXT
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

95
share/man/onemarket.1
View File

@ -1,95 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEMARKET" "1" "July 2017" "" "onemarket(1) -- manages internal and external Marketplaces"
.
.SH "NAME"
\fBonemarket\fR \- manages internal and external Marketplaces
.
.SH "SYNOPSIS"
\fBonemarket\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-a, \-\-append Append new attributes to the current template
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIfile\fR Creates a new Marketplace from the given template file
.
.IP "\(bu" 4
delete \fIrange|marketplaceid_list\fR Deletes the given Marketplace
.
.IP "\(bu" 4
chgrp \fIrange|marketplaceid_list\fR \fIgroupid\fR Changes the Marketplace group
.
.IP "\(bu" 4
chown \fIrange|marketplaceid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Marketplace owner and group
.
.IP "\(bu" 4
chmod \fIrange|marketplaceid_list\fR \fIoctet\fR Changes the Marketplace permissions
.
.IP "\(bu" 4
list Lists Marketplaces valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fImarketplaceid\fR Shows Marketplace information valid options: xml
.
.IP "\(bu" 4
update \fImarketplaceid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
rename \fImarketplaceid\fR \fIname\fR Renames the Marketplace
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
marketplaceid OpenNebula MARKETPLACE name or id
.
.IP "\(bu" 4
marketplaceid_list Comma\-separated list of OpenNebula MARKETPLACE names or ids
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

119
share/man/onemarketapp.1
View File

@ -1,119 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEMARKETAPP" "1" "July 2017" "" "onemarketapp(1) -- manages appliances from Marketplaces"
.
.SH "NAME"
\fBonemarketapp\fR \- manages appliances from Marketplaces
.
.SH "SYNOPSIS"
\fBonemarket\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-m, \-\-marketplace id|name Selects the marketplace
\-\-name name Name of the new MarketPlaceApp
\-\-description description Description for the new MarketPlaceApp
\-\-image id|name Selects the image
\-\-dry Just print the template
\-d, \-\-datastore id|name Selects the datastore
\-\-vmname name Selects the name for the new VM Template, if the
App contains one
\-\-force Overwrite the file
\-a, \-\-append Append new attributes to the current template
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create [\fIfile\fR] Creates a new marketplace app in the given marketplace valid options: marketplace, name, description, image, dry
.
.IP "\(bu" 4
export \fIappid\fR \fIname\fR Exports the marketplace app to the OpenNebula cloud valid options: datastore, vmname
.
.IP "\(bu" 4
download \fIappid\fR \fIpath\fR Downloads a MarketApp to a file valid options: force
.
.IP "\(bu" 4
delete \fIrange|appid_list\fR Deletes the given marketplace app
.
.IP "\(bu" 4
update \fIappid\fR [\fIfile\fR] Update the template contents for the app\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
chgrp \fIrange|appid_list\fR \fIgroupid\fR Changes the marketplace app group
.
.IP "\(bu" 4
chown \fIrange|appid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the marketplace app owner and group
.
.IP "\(bu" 4
chmod \fIrange|appid_list\fR \fIoctet\fR Changes the marketplace app permissions
.
.IP "\(bu" 4
rename \fIappid\fR \fIname\fR Renames the marketplace app
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists marketplace apps valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIappid\fR Shows information for the given marketplace app valid options: xml
.
.IP "\(bu" 4
enable \fIrange|appid_list\fR Enables the marketplace app
.
.IP "\(bu" 4
disable \fIrange|appid_list\fR Disables the marketplace app\. A disabled marketplace app cannot be exported to a cloud
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
appid OpenNebula MARKETPLACEAPP name or id
.
.IP "\(bu" 4
appid_list Comma\-separated list of OpenNebula MARKETPLACEAPP names or ids
.
.IP "\(bu" 4
filterflag a, all all the known MARKETPLACEAPPs m, mine the MARKETPLACEAPP belonging to the user in ONE_AUTH g, group \'mine\' plus the MARKETPLACEAPP belonging to the groups the user is member of G, primary group the MARKETPLACEAPP owned the user\'s primary group uid MARKETPLACEAPP of the user identified by this uid user MARKETPLACEAPP of the user identified by the username
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

108
share/man/onesecgroup.1
View File

@ -1,108 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONESECGROUP" "1" "July 2017" "" "onesecgroup(1) -- manages OpenNebula security groups"
.
.SH "NAME"
\fBonesecgroup\fR \- manages OpenNebula security groups
.
.SH "SYNOPSIS"
\fBonesecgroup\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-a, \-\-append Append new attributes to the current template
\-r, \-\-recover If set the commit operation will only operate on
outdated and error VMs\. This is intended for
retrying updates of VMs or reinitialize the
updating process if oned stopped or fail\.
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIfile\fR Creates a new Security Group from the given description
.
.IP "\(bu" 4
clone \fIsecgroupid\fR \fIname\fR Creates a new Security Group from an existing one
.
.IP "\(bu" 4
delete \fIrange|secgroupid_list\fR Deletes the given Security Group
.
.IP "\(bu" 4
chgrp \fIrange|secgroupid_list\fR \fIgroupid\fR Changes the Security Group\'s group
.
.IP "\(bu" 4
chown \fIrange|secgroupid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Security Group\'s owner and group
.
.IP "\(bu" 4
chmod \fIrange|secgroupid_list\fR \fIoctet\fR Changes the Security Group permissions
.
.IP "\(bu" 4
update \fIsecgroupid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
rename \fIsecgroupid\fR \fIname\fR Renames the Security Group
.
.IP "\(bu" 4
commit \fIsecgroupid\fR Commit SG changes to associated VMs\. This command is to propagate security group rules to VMs when they are updated\. This operation takes time to iterate over all VMs in the security group, progress can be checked through the outdated, updating and error VM sets\. valid options: recover
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists Security Group in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIsecgroupid\fR Shows information for the given Security Group valid options: xml
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
secgroupid OpenNebula SECURITY_GROUP name or id
.
.IP "\(bu" 4
secgroupid_list Comma\-separated list of OpenNebula SECURITY_GROUP names or ids
.
.IP "\(bu" 4
filterflag a, all all the known SECURITY_GROUPs m, mine the SECURITY_GROUP belonging to the user in ONE_AUTH g, group \'mine\' plus the SECURITY_GROUP belonging to the groups the user is member of G, primary group the SECURITY_GROUP owned the user\'s primary group uid SECURITY_GROUP of the user identified by this uid user SECURITY_GROUP of the user identified by the username
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

50
share/man/oneshowback.1
View File

@ -1,50 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONESHOWBACK" "1" "July 2017" "" "oneshowback(1) -- OpenNebula Showback Tool"
.
.SH "NAME"
\fBoneshowback\fR \- OpenNebula Showback Tool
.
.SH "SYNOPSIS"
\fBoneshowback\fR \fIcommand\fR [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-s, \-\-start TIME First month of the data
\-e, \-\-end TIME Last month of the data
\-u, \-\-userfilter user User name or id to filter the results
\-g, \-\-group group Group name or id to filter the results
\-x, \-\-xml Show the resource in xml format
\-j, \-\-json Show the resource in json format
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-describe Describe list columns
\-l, \-\-list x,y,z Selects columns to display with list command
\-\-csv Write table in csv format
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
list Returns the showback records valid options: start_time, end_time, userfilter, group, xml, json, verbose, help, version, describe, list, csv, user, password, endpoint
.
.IP "\(bu" 4
calculate Calculates the showback records valid options: start_time, end_time
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

205
share/man/onetemplate.1
View File

@ -1,205 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONETEMPLATE" "1" "July 2017" "" "onetemplate(1) -- manages OpenNebula templates"
.
.SH "NAME"
\fBonetemplate\fR \- manages OpenNebula templates
.
.SH "SYNOPSIS"
\fBonetemplate\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-\-name name Name of the new VM or TEMPLATE\. When
instantiating multiple VMs you can use the "%i"
wildcard to produce different names such as
vm\-0, vm\-1\.\.\.
\-\-cpu cpu CPU percentage reserved for the VM (1=100% one
CPU)
\-\-vcpu vcpu Number of virtualized CPUs
\-\-arch arch Architecture of the VM, e\.g\.: i386 or x86_64
\-\-memory memory Memory amount given to the VM\. By default the
unit is megabytes\. To use gigabytes add a \'g\',
floats can be used: 8g=8192, 0\.5g=512
\-\-disk image0,image1 Disks to attach\. To use an image owned by other
user use user[disk]\. Add any additional
attributes separated by \':\' and in the shape of
KEY=VALUE\. For example, if the disk must be
resized, use image0:size=1000 \. Or
image0:size=1000:target=vda,image1:target=vdb
\-\-nic network0,network1 Networks to attach\. To use a network owned by
other user use user[network]\. Additional
attributes are supported like with the \-\-disk
option\.
\-\-raw string Raw string to add to the template\. Not to be
confused with the RAW attribute
\-\-vnc Add VNC server to the VM
\-\-vnc\-password password VNC password
\-\-vnc\-listen ip VNC IP where to listen for connections\. By
default is 0\.0\.0\.0 (all interfaces)\.
\-\-vnc\-keymap keymap VNC keyboard layout
\-\-spice Add spice server to the VM
\-\-spice\-password password spice password
\-\-spice\-listen ip spice IP where to listen for connections\. By
default is 0\.0\.0\.0 (all interfaces)\.
\-\-spice\-keymap keymap spice keyboard layout
\-\-ssh [file] Add an ssh public key to the context\. If the file
is omited then the user variable SSH_PUBLIC_KEY
will be used\.
\-\-net_context Add network contextualization parameters
\-\-context line1,line2,line3 Lines to add to the context section
\-\-boot device_list Set boot device list e\.g\. disk0,disk2,nic0
\-\-files_ds file1,file2 Add files to the contextualization CD from
thefiles datastore
\-\-init script1,script2 Script or scripts to start in context
\-\-startscript [file] Start script to be executed
\-\-report_ready Sends READY=YES to OneGate, useful for OneFlow
\-\-vcenter_vm_folder path In a vCenter environment sets the the VMs and
Template folder where the VM will be placed in\.
The path uses slashes to separate folders\. For
example: \-\-vcenter_vm_folder "/Management/VMs"
\-\-dry Just print the template
\-\-recursive Applies the action to the template plus any image
defined in DISK
\-m, \-\-multiple x Instance multiple VMs
\-\-userdata userdata Integrate userdata into the EC2 section
\-\-hold Creates the new VM on hold state instead of
pending
\-\-persistent Creates a private persistent copy of the template
plus any image defined in DISK, and instantiates
that copy
\-a, \-\-append Append new attributes to the current template
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-\-extended Process the template and included extended
information, such as the SIZE for each DISK
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create [\fIfile\fR] Creates a new VM Template from the given description
.
.IP "" 4
.
.nf
Examples:
\- using a VM Template description file:
onetemplate create vm_description\.tmpl
\- new VM Template named "arch vm" with a disk and a nic:
onetemplate create \-\-name "arch vm" \-\-memory 128 \-\-cpu 1 \e
\-\-disk arch \-\-network private_lan
\- using two disks:
onetempate create \-\-name "test vm" \-\-memory 128 \-\-cpu 1 \e
\-\-disk arch,data
valid options: name, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, vnc_keymap, spice, spice_password, spice_listen, spice_keymap, ssh, net_context, context, boot, files_ds, init, startscript, report_ready, vcenter_vm_folder, dry
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
clone \fItemplateid\fR \fIname\fR Creates a new Template from an existing one valid options: recursive
.
.IP "\(bu" 4
delete \fIrange|templateid_list\fR Deletes the given Template valid options: recursive
.
.IP "\(bu" 4
instantiate \fItemplateid\fR [\fIfile\fR] Creates a new VM instance from the given Template\. This VM can be managed with the \'onevm\' command\.
.
.IP "" 4
.
.nf
The source Template can be modified adding or replacing attributes with
the optional file argument, or with the options\.
valid options: name, multiple, userdata, hold, persistent, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, vnc_keymap, spice, spice_password, spice_listen, spice_keymap, ssh, net_context, context, boot, files_ds, init, startscript, report_ready, vcenter_vm_folder
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chgrp \fIrange|templateid_list\fR \fIgroupid\fR Changes the Template group
.
.IP "\(bu" 4
chown \fIrange|templateid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Template owner and group
.
.IP "\(bu" 4
chmod \fIrange|templateid_list\fR \fIoctet\fR Changes the Template permissions valid options: recursive
.
.IP "\(bu" 4
update \fItemplateid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
rename \fItemplateid\fR \fIname\fR Renames the Template
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists Templates in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fItemplateid\fR Shows information for the given Template valid options: xml, extended
.
.IP "\(bu" 4
top [\fIfilterflag\fR] Lists Templates continuously valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
templateid OpenNebula VMTEMPLATE name or id
.
.IP "\(bu" 4
templateid_list Comma\-separated list of OpenNebula VMTEMPLATE names or ids
.
.IP "\(bu" 4
filterflag a, all all the known VMTEMPLATEs m, mine the VMTEMPLATE belonging to the user in ONE_AUTH g, group \'mine\' plus the VMTEMPLATE belonging to the groups the user is member of G, primary group the VMTEMPLATE owned the user\'s primary group uid VMTEMPLATE of the user identified by this uid user VMTEMPLATE of the user identified by the username
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

226
share/man/oneuser.1
View File

@ -1,226 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEUSER" "1" "July 2017" "" "oneuser(1) -- manages OpenNebula users"
.
.SH "NAME"
\fBoneuser\fR \- manages OpenNebula users
.
.SH "SYNOPSIS"
\fBoneuser\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-\-group id|name Comma\-separated list of Groups for the new User\.
The first Group will be the main one\.
\-r, \-\-read\-file Read password from file
\-\-sha1 The password will be hashed using the sha1
algorithm
\-\-ssh SSH Auth system
\-\-x509 x509 Auth system for x509 certificates
\-k, \-\-key path_to_private_key_pem Path to the Private Key of the User
\-c, \-\-cert path_to_user_cert_pem Path to the Certificate of the User
\-\-driver driver Driver to authenticate this user
\-a, \-\-append Append new attributes to the current template
\-\-x509_proxy x509 Auth system based on x509 proxy certificates
\-\-proxy path_to_user_proxy_pem Path to the user proxy certificate
\-\-time x Token duration in seconds, defaults to 36000 (10
h)\. To reset the token set time to 0\.To generate
a non\-expiring token use \-1 (not valid for ssh
and x509 tokens)\.
\-\-force Force one_auth file rewrite
\-\-stdin_password enable stdin password
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-\-token token_hint The Token to be loaded\.
\-\-global Find a global Token\.
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIusername\fR [\fIpassword\fR] Creates a new User Examples: oneuser create my_user my_password oneuser create my_user \-r /tmp/mypass oneuser create my_user my_password \-\-group users,102,testers oneuser create my_user \-\-ssh \-\-key /tmp/id_rsa oneuser create my_user \-\-ssh \-r /tmp/public_key oneuser create my_user \-\-x509 \-\-cert /tmp/my_cert\.pem valid options: group, read_file, sha1, ssh, x509, key, cert, driver
.
.IP "\(bu" 4
update \fIuserid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
quota \fIuserid\fR [\fIfile\fR] Set the quota limits for the user\. If a path is not provided the editor will be launched to modify the current quotas\.
.
.IP "\(bu" 4
batchquota \fIrange|userid_list\fR [\fIfile\fR] Sets the quota limits in batch for various users\. If a path is not provided the editor will be launched to create new quotas\.
.
.IP "\(bu" 4
defaultquota [\fIfile\fR] Sets the default quota limits for the users\. If a path is not provided the editor will be launched to modify the current default quotas\.
.
.IP "\(bu" 4
umask \fIrange|userid_list\fR [\fImask\fR] Changes the umask used to create the default permissions\. In a similar way to the Unix umask command, the expected value is a three\-digit base\-8 number\. Each digit is a mask that disables permissions for the owner, group and other, respectively\.
.
.IP "" 4
.
.nf
If mask is not given, or if it is an empty string, the umask will
be unset
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
login [\fIusername\fR] Alias of token\-create\. valid options: ssh, x509, x509_proxy, key, cert, proxy, time, force, group, stdin_password
.
.IP "\(bu" 4
key Shows a public key from a private SSH key\. Use it as password for the SSH authentication mechanism\. valid options: key
.
.IP "\(bu" 4
delete \fIrange|userid_list\fR Deletes the given User
.
.IP "\(bu" 4
passwd \fIuserid\fR [\fIpassword\fR] Changes the given User\'s password valid options: read_file, sha1, ssh, x509, key, cert, driver
.
.IP "\(bu" 4
chgrp \fIrange|userid_list\fR \fIgroupid\fR Changes the User\'s primary group
.
.IP "\(bu" 4
addgroup \fIrange|userid_list\fR \fIgroupid\fR Adds the User to a secondary group
.
.IP "\(bu" 4
delgroup \fIrange|userid_list\fR \fIgroupid\fR Removes the User from a secondary group
.
.IP "\(bu" 4
chauth \fIuserid\fR [\fIauth\fR] [\fIpassword\fR] Changes the User\'s auth driver and its password (optional) Examples: oneuser chauth my_user core oneuser chauth my_user core new_password oneuser chauth my_user core \-r /tmp/mypass oneuser chauth my_user \-\-ssh \-\-key /home/oneadmin/\.ssh/id_rsa oneuser chauth my_user \-\-ssh \-r /tmp/public_key oneuser chauth my_user \-\-x509 \-\-cert /tmp/my_cert\.pem valid options: read_file, sha1, ssh, x509, key, cert, driver
.
.IP "\(bu" 4
list Lists Users in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show [\fIuserid\fR] Shows information for the given User valid options: xml
.
.IP "\(bu" 4
encode \fIusername\fR [\fIpassword\fR] Encodes user and password to use it with ldap
.
.IP "\(bu" 4
passwdsearch \fIdriver\fR \fIpassword\fR Searches for users with a specific auth driver that has the given string in their password field valid options: csv, xml
.
.IP "\(bu" 4
token\-create [\fIusername\fR] Creates the login token for authentication\. The token can be used together with any authentication driver\. The token will be stored in $HOME/\.one/one_auth, and can be used subsequently to authenticate with oned through API, CLI or Sunstone\.
.
.IP "" 4
.
.nf
If <username> is ommited, it will infer it from the ONE_AUTH file\.
Example, request a valid token for a generic driver (e\.g\. core auth, LDAP\.\.\.):
oneuser token\-create my_user \-\-time 3600
Example, request a group spefici token (new resources will be created in that
group and only resources that belong to that group will be listed):
oneuser token\-create my_user \-\-group <id|group>
Example, generate and set a token for SSH based authentication:
oneuser token\-create my_user \-\-ssh \-\-key /tmp/id_rsa \-\-time 72000
Example, same using X509 certificates:
oneuser token\-create my_user \-\-x509 \-\-cert /tmp/my_cert\.pem
\-\-key /tmp/my_key\.pk \-\-time 72000
Example, now with a X509 proxy certificate
oneuser token\-create my_user \-\-x509_proxy \-\-proxy /tmp/my_cert\.pem
\-\-time 72000
valid options: ssh, x509, x509_proxy, key, cert, proxy, time, force, group, stdin_password
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
token\-set [\fIusername\fR] Generates a ONE_AUTH file that contains the token\.
.
.IP "" 4
.
.nf
You must provide one (and only one) of the following options:
\-\-token <token> searches for a token that starts with that string\. It must be
unique
\-\-group <id|group> returns the most durable token that provides access to that
specific group\.
\-\-global returns the most durable global token (non group specific)\.
The argument \'username\' is optional, if omitted it is inferred from the ONE_AUTH
file\.
Example, set a token:
$ oneuser token\-set my_user \-\-token 1d47
export ONE_AUTH=/var/lib/one/\.one/<file>\.token; export ONE_EGID=\-1
You can copy & paste the output of the command and will load the proper
environment variables\.
valid options: ssh, x509, x509_proxy, key, cert, proxy, time, force, group, stdin_password, token, global
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
token\-delete [\fIusername\fR] \fItoken\fR Expires a token and removes the associated ONE_AUTH file if present\. valid options: ssh, x509, x509_proxy, key, cert, proxy, time, force, group, stdin_password
.
.IP "\(bu" 4
token\-delete\-all \fIusername\fR Delete all the tokens of a user\. This command is intented to be executed by a user that has MANAGE permissions of the target user\. valid options: ssh, x509, x509_proxy, key, cert, proxy, time, force, group, stdin_password
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
userid_list Comma\-separated list of OpenNebula USER names or ids
.
.IP "\(bu" 4
password User password
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

67
share/man/onevcenter.1
View File

@ -1,67 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEVCENTER" "1" "July 2017" "" "onevcenter(1) -- vCenter import tool"
.
.SH "NAME"
\fBonevcenter\fR \- vCenter import tool
.
.SH "SYNOPSIS"
\fBonevcenter\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-\-vcenter vCenter The vCenter hostname
\-\-vuser username The username to interact with vCenter
\-\-vpass password The password for the user
\-\-use\-defaults Use defaults for answers to questions
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
hosts Import vCenter clusters as OpenNebula hosts valid options: vcenter, vuser, vpass, defaults
.
.IP "\(bu" 4
templates Import vCenter VM Templates into OpenNebula valid options: vcenter, vuser, vpass, defaults
.
.IP "\(bu" 4
vms Deprecated action in onevcenter, please use onehost importvm instead valid options: vcenter, vuser, vpass, defaults
.
.IP "\(bu" 4
networks Import vCenter networks into OpenNebula valid options: vcenter, vuser, vpass, defaults
.
.IP "\(bu" 4
datastores Import vCenter Datastores into OpenNebula valid options: vcenter, vuser, vpass, defaults
.
.IP "\(bu" 4
images \fIds_name\fR Import vCenter Images into OpenNebula valid options: vcenter, vuser, vpass, defaults
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

128
share/man/onevdc.1
View File

@ -1,128 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEVDC" "1" "July 2017" "" "onevdc(1) -- manages OpenNebula Virtual DataCenters"
.
.SH "NAME"
\fBonevdc\fR \- manages OpenNebula Virtual DataCenters
.
.SH "SYNOPSIS"
\fBonevdc\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-a, \-\-append Append new attributes to the current template
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIname\fR Creates a new VDC
.
.IP "\(bu" 4
rename \fIvdcid\fR \fIname\fR Renames the VDC
.
.IP "\(bu" 4
update \fIvdcid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
delete \fIrange|vdcid_list\fR Deletes the given VDC
.
.IP "\(bu" 4
addgroup \fIrange|vdcid_list\fR \fIgroupid\fR Adds a Group to the given VDC
.
.IP "\(bu" 4
delgroup \fIrange|vdcid_list\fR \fIgroupid\fR Deletes a Group from the given VDC
.
.IP "\(bu" 4
addcluster \fIrange|vdcid_list\fR \fIzoneid\fR \fIclusterid\fR Adds a Cluster (from a specific Zone) to the given VDC
.
.IP "\(bu" 4
delcluster \fIrange|vdcid_list\fR \fIzoneid\fR \fIclusterid\fR Deletes a Cluster (from a specific Zone) from the given VDC
.
.IP "\(bu" 4
addhost \fIrange|vdcid_list\fR \fIzoneid\fR \fIhostid\fR Adds a Host (from a specific Zone) to the given VDC
.
.IP "\(bu" 4
delhost \fIrange|vdcid_list\fR \fIzoneid\fR \fIhostid\fR Deletes a Host (from a specific Zone) from the given VDC
.
.IP "\(bu" 4
adddatastore \fIrange|vdcid_list\fR \fIzoneid\fR \fIdatastoreid\fR Adds a Datastore (from a specific Zone) to the given VDC
.
.IP "\(bu" 4
deldatastore \fIrange|vdcid_list\fR \fIzoneid\fR \fIdatastoreid\fR Deletes a Datastore (from a specific Zone) from the given VDC
.
.IP "\(bu" 4
addvnet \fIrange|vdcid_list\fR \fIzoneid\fR \fIvnetid\fR Adds a Virtual Network (from a specific Zone) to the given VDC
.
.IP "\(bu" 4
delvnet \fIrange|vdcid_list\fR \fIzoneid\fR \fIvnetid\fR Deletes a Virtual Network (from a specific Zone) from the given VDC
.
.IP "\(bu" 4
list Lists VDCs in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIvdcid\fR Shows information for the given VDC valid options: xml
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
vdcid OpenNebula VDC name or id
.
.IP "\(bu" 4
vdcid_list Comma\-separated list of OpenNebula VDC names or ids
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
zoneid OpenNebula ZONE name or id
.
.IP "\(bu" 4
clusterid OpenNebula CLUSTER name or id\. Can be set to ALL
.
.IP "\(bu" 4
hostid OpenNebula HOST name or id\. Can be set to ALL
.
.IP "\(bu" 4
datastoreid OpenNebula DATASTORE name or id\. Can be set to ALL
.
.IP "\(bu" 4
vnetid OpenNebula VNET name or id\. Can be set to ALL
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

613
share/man/onevm.1
View File

@ -1,613 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEVM" "1" "July 2017" "" "onevm(1) -- manages OpenNebula virtual machines"
.
.SH "NAME"
\fBonevm\fR \- manages OpenNebula virtual machines
.
.SH "SYNOPSIS"
\fBonevm\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-m, \-\-multiple x Instance multiple VMs
\-\-hold Creates the new VM on hold state instead of
pending
\-\-name name Name for the new VM
\-\-cpu cpu CPU percentage reserved for the VM (1=100% one
CPU)
\-\-vcpu vcpu Number of virtualized CPUs
\-\-arch arch Architecture of the VM, e\.g\.: i386 or x86_64
\-\-memory memory Memory amount given to the VM\. By default the
unit is megabytes\. To use gigabytes add a \'g\',
floats can be used: 8g=8192, 0\.5g=512
\-\-disk image0,image1 Disks to attach\. To use an image owned by other
user use user[disk]\. Add any additional
attributes separated by \':\' and in the shape of
KEY=VALUE\. For example, if the disk must be
resized, use image0:size=1000 \. Or
image0:size=1000:target=vda,image1:target=vdb
\-\-nic network0,network1 Networks to attach\. To use a network owned by
other user use user[network]\. Additional
attributes are supported like with the \-\-disk
option\.
\-\-raw string Raw string to add to the template\. Not to be
confused with the RAW attribute
\-\-vnc Add VNC server to the VM
\-\-vnc\-password password VNC password
\-\-vnc\-listen ip VNC IP where to listen for connections\. By
default is 0\.0\.0\.0 (all interfaces)\.
\-\-vnc\-keymap keymap VNC keyboard layout
\-\-spice Add spice server to the VM
\-\-spice\-password password spice password
\-\-spice\-listen ip spice IP where to listen for connections\. By
default is 0\.0\.0\.0 (all interfaces)\.
\-\-spice\-keymap keymap spice keyboard layout
\-\-ssh [file] Add an ssh public key to the context\. If the file
is omited then the user variable SSH_PUBLIC_KEY
will be used\.
\-\-net_context Add network contextualization parameters
\-\-context line1,line2,line3 Lines to add to the context section
\-\-boot device_list Set boot device list e\.g\. disk0,disk2,nic0
\-\-files_ds file1,file2 Add files to the contextualization CD from
thefiles datastore
\-\-init script1,script2 Script or scripts to start in context
\-\-startscript [file] Start script to be executed
\-\-report_ready Sends READY=YES to OneGate, useful for OneFlow
\-\-vcenter_vm_folder path In a vCenter environment sets the the VMs and
Template folder where the VM will be placed in\.
The path uses slashes to separate folders\. For
example: \-\-vcenter_vm_folder "/Management/VMs"
\-\-dry Just print the template
\-a, \-\-append Append new attributes to the current template
\-\-schedule TIME Schedules this action to be executed afterthe
given time\. For example: onevm resume 0
\-\-schedule "09/23 14:15"
\-t, \-\-type type Type of the new Image
\-s, \-\-snapshot snapshot ID of the Snapshot to save\.
\-\-hard Does not communicate with the guest OS
\-e, \-\-enforce Enforce that the host capacity is not exceeded
\-\-live Do the action with the VM running
\-\-success Recover a VM by succeeding the pending action
\-\-failure Recover a VM by failing the pending action
\-\-retry Recover a VM by retrying the last failed action
\-\-interactive Enables interactive recovery\. Only works
alongside the \-\-retry option\.
\-\-delete No recover action possible, delete the VM
\-\-recreate No recover action possible, delete and recreate
the VM
\-f, \-\-file file Selects the template file
\-i, \-\-image id|name Selects the image
\-t, \-\-target target Device where the image will be attached
\-\-cache cache_mode Hypervisor cache mode: default, none,
writethrough, writeback, directsync or unsafe\.
(Only KVM driver)
\-\-discard discard_mode Hypervisor discard mode: ignore or unmap\. (Only
KVM driver)
\-\-prefix prefix Overrides the DEV_PREFIX of the image
\-n, \-\-network id|name Selects the virtual network
\-i, \-\-ip ip IP address for the new NIC
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-k, \-\-kilobytes Show units in kilobytes
\-\-describe Describe list columns
\-\-all Show all template data
\-\-persistent Make the new images persistent
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create [\fIfile\fR] Creates a new VM from the given description instead of using a previously defined template (see \'onetemplate create\' and \'onetemplate instantiate\')\.
.
.IP "" 4
.
.nf
Examples:
\- using a template description file:
onevm create vm_description\.tmpl
\- new VM named "arch vm" with a disk and a nic
onevm create \-\-name "arch vm" \-\-memory 128 \-\-cpu 1 \-\-disk arch \e
\-\-network private_lan
\- a vm with two disks
onevm create \-\-name "test vm" \-\-memory 128 \-\-cpu 1 \-\-disk arch,data
valid options: multiple, hold, name, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, vnc_keymap, spice, spice_password, spice_listen, spice_keymap, ssh, net_context, context, boot, files_ds, init, startscript, report_ready, vcenter_vm_folder, dry
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
update \fIvmid\fR [\fIfile\fR] Update the user template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
hold \fIrange|vmid_list\fR 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\'
.
.IP "" 4
.
.nf
States: PENDING
valid options: schedule
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
release \fIrange|vmid_list\fR Releases a VM on hold\. See \'onevm hold\'
.
.IP "" 4
.
.nf
States: HOLD
valid options: schedule
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
disk\-saveas \fIvmid\fR \fIdiskid\fR \fIimg_name\fR Saves the specified VM disk as a new Image\. The Image is created immediately, and the contents of the VM disk will be saved to it\.
.
.IP "" 4
.
.nf
States: ANY
valid options: type, snapshot
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
terminate \fIrange|vmid_list\fR Terminates the given VM\. The VM life cycle will end\.
.
.IP "" 4
.
.nf
With \-\-hard it unplugs the VM\.
States: valid if no operation is being performed on the VM
valid options: schedule, hard
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
undeploy \fIrange|vmid_list\fR Shuts down the given VM\. The VM is saved in the system Datastore\.
.
.IP "" 4
.
.nf
With \-\-hard it unplugs the VM\.
States: RUNNING
valid options: schedule, hard
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
poweroff \fIrange|vmid_list\fR Powers off the given VM\. The VM will remain in the poweroff state, and can be powered on with the \'onevm resume\' command\.
.
.IP "" 4
.
.nf
States: RUNNING
valid options: schedule, hard
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
reboot \fIrange|vmid_list\fR Reboots the given VM, this is equivalent to execute the reboot command from the VM console\.
.
.IP "" 4
.
.nf
The VM will be ungracefully rebooted if \-\-hard is used\.
States: RUNNING
valid options: schedule, hard
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
deploy \fIrange|vmid_list\fR \fIhostid\fR [\fIdatastoreid\fR] 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
.
.IP "" 4
.
.nf
States: PENDING, HOLD, STOPPED, UNDEPLOYED
valid options: enforce
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
migrate \fIrange|vmid_list\fR \fIhostid\fR [\fIdatastoreid\fR] Migrates the given running VM to another Host\. If used with \-\-live parameter the miration is done without downtime\.
.
.IP "" 4
.
.nf
States: RUNNING
valid options: enforce, live
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
stop \fIrange|vmid_list\fR Stops a running VM\. The VM state is saved and transferred back to the front\-end along with the disk files
.
.IP "" 4
.
.nf
States: RUNNING
valid options: schedule
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
suspend \fIrange|vmid_list\fR 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)\.
.
.IP "" 4
.
.nf
States: RUNNING
valid options: schedule
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
resume \fIrange|vmid_list\fR Resumes the execution of the a saved VM
.
.IP "" 4
.
.nf
States: STOPPED, SUSPENDED, UNDEPLOYED, POWEROFF, UNKNOWN
valid options: schedule
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
recover \fIrange|vmid_list\fR Recovers a stuck VM that is waiting for a driver operation\. The recovery may be done by failing, succeeding or retrying the current operation\. YOU NEED TO MANUALLY CHECK THE VM STATUS ON THE HOST, to decide if the operation was successful or not, or if it can be retried\.
.
.IP "" 4
.
.nf
Example: A VM is stuck in "migrate" because of a hardware failure\. You
need to check if the VM is running in the new host or not to recover
the vm with \-\-success or \-\-failure, respectively\.
States for success/failure recovers: Any ACTIVE state\.
States for a retry recover: Any *FAILURE state
States for delete: Any
States for delete\-recreate: Any but STOP/UNDEPLOYED
valid options: success, failure, retry, interactive, delete, recreate
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
disk\-attach \fIvmid\fR Attaches a disk to a running VM\. When using \-\-file add only one DISK instance\.
.
.IP "" 4
.
.nf
States: RUNNING, POWEROFF
valid options: file, image, target, cache, discard, prefix
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
disk\-detach \fIvmid\fR \fIdiskid\fR Detaches a disk from a running VM
.
.IP "" 4
.
.nf
States: RUNNING, POWEROFF
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
nic\-attach \fIvmid\fR Attaches a NIC to a running VM\. When using \-\-file add only one NIC instance\.
.
.IP "" 4
.
.nf
States: RUNNING, POWEROFF
valid options: file, network, ip
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
nic\-detach \fIvmid\fR \fInicid\fR Detaches a NIC from a running VM
.
.IP "" 4
.
.nf
States: RUNNING, POWEROFF
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
chgrp \fIrange|vmid_list\fR \fIgroupid\fR Changes the VM group
.
.IP "\(bu" 4
chown \fIrange|vmid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the VM owner and group
.
.IP "\(bu" 4
chmod \fIrange|vmid_list\fR \fIoctet\fR Changes the VM permissions
.
.IP "\(bu" 4
resched \fIrange|vmid_list\fR Sets the rescheduling flag for the VM\.
.
.IP "" 4
.
.nf
States: RUNNING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
unresched \fIrange|vmid_list\fR Clears the rescheduling flag for the VM\.
.
.IP "" 4
.
.nf
States: RUNNING
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
rename \fIvmid\fR \fIname\fR Renames the VM
.
.IP "\(bu" 4
snapshot\-create \fIrange|vmid_list\fR [\fIname\fR] Creates a new VM snapshot valid options: schedule
.
.IP "\(bu" 4
snapshot\-revert \fIvmid\fR \fIsnapshot_id\fR Reverts a VM to a saved snapshot
.
.IP "\(bu" 4
snapshot\-delete \fIvmid\fR \fIsnapshot_id\fR Delets a snapshot of a VM
.
.IP "\(bu" 4
disk\-snapshot\-create \fIvmid\fR \fIdiskid\fR \fIname\fR Takes a new snapshot of the given disk\. This operation needs support from the Datastore drivers: QCOW2 or Ceph\.
.
.IP "" 4
.
.nf
States: RUNNING, POWEROFF, SUSPENDED
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
disk\-snapshot\-revert \fIvmid\fR \fIdiskid\fR \fIsnapshot_id\fR Reverts disk state to a previously taken snapshot\.
.
.IP "" 4
.
.nf
States: POWEROFF, SUSPENDED
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
disk\-snapshot\-delete \fIvmid\fR \fIdiskid\fR \fIsnapshot_id\fR Deletes a disk snapshot\.
.
.IP "" 4
.
.nf
States: RUNNING, POWEROFF, SUSPENDED
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
disk\-resize \fIvmid\fR \fIdiskid\fR \fIsize\fR Resizes a VM disk\. The new size should be larger than the old one\.
.
.IP "" 4
.
.nf
States: RUNNING, POWEROFF
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists VMs in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, kilobytes, describe
.
.IP "\(bu" 4
show \fIvmid\fR Shows information for the given VM valid options: xml, all
.
.IP "\(bu" 4
top [\fIfilterflag\fR] Lists Images continuously valid options: list, listconf, delay, filter, csv, xml, numeric, kilobytes
.
.IP "\(bu" 4
resize \fIvmid\fR Resizes the capacity of a Virtual Machine (offline, the VM cannot be RUNNING) valid options: cpu, vcpu, memory, enforce, file
.
.IP "\(bu" 4
save \fIvmid\fR \fIname\fR Clones the VM\'s source Template, replacing the disks with live snapshots of the current disks\. The VM capacity and NICs are also preserved
.
.IP "" 4
.
.nf
States: POWEROFF
valid options: persistent
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
updateconf \fIvmid\fR [\fIfile\fR] Updates the configuration of a VM\. The VM cannot be in an active (running) state, valid states are: pending, failure, poweroff, undeploy, hold or cloning\.
.
.IP "" 4
.
.nf
This command accepts a template file or opens an editor, the full list of
configuration attributes are:
OS = ["ARCH", "MACHINE", "KERNEL", "INITRD", "BOOTLOADER", "BOOT"]
FEATURES = ["ACPI", "PAE", "APIC", "LOCALTIME", "HYPERV", "GUEST_AGENT"]
INPUT = ["TYPE", "BUS"]
GRAPHICS = ["TYPE", "LISTEN", "PASSWD", "KEYMAP" ]
RAW = ["DATA", "DATA_VMX", "TYPE"]
CONTEXT (any value, **variable substitution will be made**)
.
.fi
.
.IP "" 0
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
hostid OpenNebula HOST name or id
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
datastoreid OpenNebula DATASTORE name or id
.
.IP "\(bu" 4
vmid OpenNebula VM name or id
.
.IP "\(bu" 4
vmid_list Comma\-separated list of OpenNebula VM names or ids
.
.IP "\(bu" 4
filterflag a, all all the known VMs m, mine the VM belonging to the user in ONE_AUTH g, group \'mine\' plus the VM belonging to the groups the user is member of G, primary group the VM owned the user\'s primary group uid VM of the user identified by this uid user VM of the user identified by the username
.
.IP "\(bu" 4
diskid Integer
.
.IP "\(bu" 4
size Disk size in MiB
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

98
share/man/onevmgroup.1
View File

@ -1,98 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEVMGROUP" "1" "July 2017" "" "onevmgroup(1) -- manages VM groups"
.
.SH "NAME"
\fBonevmgroup\fR \- manages VM groups
.
.SH "SYNOPSIS"
\fBonevmgroup\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-a, \-\-append Append new attributes to the current template
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIfile\fR Creates a new VM Group from the given description
.
.IP "\(bu" 4
delete \fIrange|vmgroupid_list\fR Deletes the VM Group
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists VM Group in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIvmgroupid\fR Shows information for the given VM Group valid options: xml
.
.IP "\(bu" 4
chgrp \fIrange|vmgroupid_list\fR \fIgroupid\fR Changes the VM Group\'s group
.
.IP "\(bu" 4
chown \fIrange|vmgroupid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the VM Group\'s owner and group
.
.IP "\(bu" 4
chmod \fIrange|vmgroupid_list\fR \fIoctet\fR Changes the VM Group permissions
.
.IP "\(bu" 4
update \fIvmgroupid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
rename \fIvmgroupid\fR \fIname\fR Renames the VM Group
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
vmgroupid OpenNebula VM_GROUP name or id
.
.IP "\(bu" 4
vmgroupid_list Comma\-separated list of OpenNebula VM_GROUP names or ids
.
.IP "\(bu" 4
filterflag a, all all the known VM_GROUPs m, mine the VM_GROUP belonging to the user in ONE_AUTH g, group \'mine\' plus the VM_GROUP belonging to the groups the user is member of G, primary group the VM_GROUP owned the user\'s primary group uid VM_GROUP of the user identified by this uid user VM_GROUP of the user identified by the username
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

150
share/man/onevnet.1
View File

@ -1,150 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEVNET" "1" "July 2017" "" "onevnet(1) -- manages OpenNebula networks"
.
.SH "NAME"
\fBonevnet\fR \- manages OpenNebula networks
.
.SH "SYNOPSIS"
\fBonevnet\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-c, \-\-cluster id|name Selects the cluster
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
\-s, \-\-size size Number of addresses
\-m, \-\-mac mac First MAC address in : notation
\-i, \-\-ip ip First IP address in \. notation
\-6, \-\-ip6 ip6 First IPv6 address, in CIDR notation e\.g\.
2001::1/48
\-g, \-\-ip6_global ip6_pref IP6 global prefix
\-u, \-\-ip6_ula ip6_pref IP6 ula prefix
\-\-gateway ip IP of the gateway
\-\-netmask mask Netmask in dot notation
\-\-vn_mad mad Use this driver for the network
\-\-vlanid id VLAN ID assigned
\-a, \-\-address_range ar_id ID of the address range
\-n, \-\-name reservation name Name of the address reservation
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-k, \-\-kilobytes Show units in kilobytes
\-\-describe Describe list columns
\-\-show\-ar Show also AR templates
\-a, \-\-append Append new attributes to the current template
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIfile\fR Creates a new Virtual Network from the given template file valid options: cluster
.
.IP "\(bu" 4
delete \fIrange|vnetid_list\fR Deletes the given Virtual Network
.
.IP "\(bu" 4
addar \fIvnetid\fR [\fIfile\fR] Adds an address range to the Virtual Network valid options: verbose, help, version, user, password, endpoint, size, mac, ip, ip6, ip6_global, ip6_ula, gateway, netmask, vn_mad, vlanid
.
.IP "\(bu" 4
addleases \fIvnetid\fR \fIip\fR [\fImac\fR] (DEPRECATED, use addar) Adds a lease to the Virtual Network
.
.IP "\(bu" 4
rmar \fIvnetid\fR \fIar_id\fR Removes an address range from the Virtual Network
.
.IP "\(bu" 4
rmleases \fIvnetid\fR \fIip\fR (DEPRECATED, use rmar) Removes a lease from the Virtual Network
.
.IP "\(bu" 4
free \fIvnetid\fR \fIar_id\fR Frees a reserved address range from the Virtual Network
.
.IP "\(bu" 4
hold \fIvnetid\fR \fIip\fR Holds a Virtual Network lease, marking it as used valid options: verbose, help, version, user, password, endpoint, address_range
.
.IP "\(bu" 4
release \fIvnetid\fR \fIip\fR Releases a Virtual Network lease on hold valid options: verbose, help, version, user, password, endpoint, address_range
.
.IP "\(bu" 4
reserve \fIvnetid\fR [\fIvnetid\fR] Reserve addresses from the Virtual Network\. A new virtual network will be created to hold the reservation\. Optionally the reservation can be put on an exisiting VNET, as long as it contains a valid reservation from the same VNET valid options: verbose, help, version, user, password, endpoint, address_range, name, size, mac, ip, ip6
.
.IP "\(bu" 4
chgrp \fIrange|vnetid_list\fR \fIgroupid\fR Changes the Virtual Network group
.
.IP "\(bu" 4
chown \fIrange|vnetid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Virtual Network owner and group
.
.IP "\(bu" 4
chmod \fIrange|vnetid_list\fR \fIoctet\fR Changes the Virtual Network permissions
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists Virtual Networks in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, kilobytes, describe
.
.IP "\(bu" 4
show \fIvnetid\fR Shows information for the given Virtual Network valid options: xml, show_ar
.
.IP "\(bu" 4
update \fIvnetid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
updatear \fIvnetid\fR \fIar_id\fR [\fIfile\fR] Update Address Range variables\. SIZE, IP, MAC and TYPE cannot be updated
.
.IP "\(bu" 4
rename \fIvnetid\fR \fIname\fR Renames the Virtual Network
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
vnetid OpenNebula VNET name or id
.
.IP "\(bu" 4
vnetid_list Comma\-separated list of OpenNebula VNET names or ids
.
.IP "\(bu" 4
filterflag a, all all the known VNETs m, mine the VNET belonging to the user in ONE_AUTH g, group \'mine\' plus the VNET belonging to the groups the user is member of G, primary group the VNET owned the user\'s primary group uid VNET of the user identified by this uid user VNET of the user identified by the username
.
.IP "\(bu" 4
ar_id Integer
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

196
share/man/onevrouter.1
View File

@ -1,196 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEVROUTER" "1" "July 2017" "" "onevrouter(1) -- manages OpenNebula Virtual Routers"
.
.SH "NAME"
\fBonevrouter\fR \- manages OpenNebula Virtual Routers
.
.SH "SYNOPSIS"
\fBonevrouter\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-\-name name Name of the new VM or TEMPLATE\. When
instantiating multiple VMs you can use the "%i"
wildcard to produce different names such as
vm\-0, vm\-1\.\.\.
\-m, \-\-multiple x Instance multiple VMs
\-\-hold Creates the new VM on hold state instead of
pending
\-\-cpu cpu CPU percentage reserved for the VM (1=100% one
CPU)
\-\-vcpu vcpu Number of virtualized CPUs
\-\-arch arch Architecture of the VM, e\.g\.: i386 or x86_64
\-\-memory memory Memory amount given to the VM\. By default the
unit is megabytes\. To use gigabytes add a \'g\',
floats can be used: 8g=8192, 0\.5g=512
\-\-disk image0,image1 Disks to attach\. To use an image owned by other
user use user[disk]\. Add any additional
attributes separated by \':\' and in the shape of
KEY=VALUE\. For example, if the disk must be
resized, use image0:size=1000 \. Or
image0:size=1000:target=vda,image1:target=vdb
\-\-nic network0,network1 Networks to attach\. To use a network owned by
other user use user[network]\. Additional
attributes are supported like with the \-\-disk
option\.
\-\-raw string Raw string to add to the template\. Not to be
confused with the RAW attribute
\-\-vnc Add VNC server to the VM
\-\-vnc\-password password VNC password
\-\-vnc\-listen ip VNC IP where to listen for connections\. By
default is 0\.0\.0\.0 (all interfaces)\.
\-\-vnc\-keymap keymap VNC keyboard layout
\-\-spice Add spice server to the VM
\-\-spice\-password password spice password
\-\-spice\-listen ip spice IP where to listen for connections\. By
default is 0\.0\.0\.0 (all interfaces)\.
\-\-spice\-keymap keymap spice keyboard layout
\-\-ssh [file] Add an ssh public key to the context\. If the file
is omited then the user variable SSH_PUBLIC_KEY
will be used\.
\-\-net_context Add network contextualization parameters
\-\-context line1,line2,line3 Lines to add to the context section
\-\-boot device_list Set boot device list e\.g\. disk0,disk2,nic0
\-\-files_ds file1,file2 Add files to the contextualization CD from
thefiles datastore
\-\-init script1,script2 Script or scripts to start in context
\-\-startscript [file] Start script to be executed
\-\-report_ready Sends READY=YES to OneGate, useful for OneFlow
\-\-vcenter_vm_folder path In a vCenter environment sets the the VMs and
Template folder where the VM will be placed in\.
The path uses slashes to separate folders\. For
example: \-\-vcenter_vm_folder "/Management/VMs"
\-a, \-\-append Append new attributes to the current template
\-f, \-\-file file Selects the template file
\-n, \-\-network id|name Selects the virtual network
\-i, \-\-ip ip IP address for the new NIC
\-\-float Makes this IP request a Floating one
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-\-all Show all template data
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIfile\fR Creates a new Virtual Router from the given description
.
.IP "\(bu" 4
instantiate \fIvrouterid\fR \fItemplateid\fR [\fIfile\fR] Creates a new VM instance from the given Template\. This VM can be managed with the \'onevm\' command\.
.
.IP "" 4
.
.nf
The NIC elements defined in the Virtual Router will be used\. The
source Template can be modified adding or replacing attributes with
the optional file argument, or with the options\.
valid options: name, multiple, hold, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, vnc_keymap, spice, spice_password, spice_listen, spice_keymap, ssh, net_context, context, boot, files_ds, init, startscript, report_ready, vcenter_vm_folder
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
delete \fIrange|vrouterid_list\fR Deletes the given Virtual Router
.
.IP "\(bu" 4
chgrp \fIrange|vrouterid_list\fR \fIgroupid\fR Changes the Virtual Router group
.
.IP "\(bu" 4
chown \fIrange|vrouterid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Virtual Router owner and group
.
.IP "\(bu" 4
chmod \fIrange|vrouterid_list\fR \fIoctet\fR Changes the Virtual Router permissions
.
.IP "\(bu" 4
update \fIvrouterid\fR [\fIfile\fR] Update the Virtual Router contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
rename \fIvrouterid\fR \fIname\fR Renames the Virtual Router
.
.IP "\(bu" 4
nic\-attach \fIvrouterid\fR Attaches a NIC to a VirtualRouter, and each one of its VMs\. When using \-\-file add only one NIC instance\.
.
.IP "" 4
.
.nf
Note if you are using a HA configuration for this router, \-\-float can be
added\. When an IP is requested in HA clusters use \-\-float\.
valid options: file, network, ip, float
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
nic\-detach \fIvrouterid\fR \fInicid\fR Detaches a NIC from a VirtualRouter, and each one of its VMs
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists the Virtual Routers in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIvrouterid\fR Shows information for the given Virtual Router valid options: xml, all
.
.IP "\(bu" 4
top [\fIfilterflag\fR] Lists Virtual Routers continuously valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
vrouterid OpenNebula VROUTER name or id
.
.IP "\(bu" 4
vrouterid_list Comma\-separated list of OpenNebula VROUTER names or ids
.
.IP "\(bu" 4
filterflag a, all all the known VROUTERs m, mine the VROUTER belonging to the user in ONE_AUTH g, group \'mine\' plus the VROUTER belonging to the groups the user is member of G, primary group the VROUTER owned the user\'s primary group uid VROUTER of the user identified by this uid user VROUTER of the user identified by the username
.
.IP "\(bu" 4
templateid OpenNebula VMTEMPLATE name or id
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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

91
share/man/onezone.1
View File

@ -1,91 +0,0 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEZONE" "1" "July 2017" "" "onezone(1) -- manages OpenNebula zones"
.
.SH "NAME"
\fBonezone\fR \- manages OpenNebula zones
.
.SH "SYNOPSIS"
\fBonezone\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf
\-n, \-\-name Zone server name
\-r, \-\-rpc Zone server RPC endpoint
\-a, \-\-append Append new attributes to the current template
\-l, \-\-list x,y,z Selects columns to display with list command
\-c, \-\-listconf conf Selects a predefined column list
\-d, \-\-delay x Sets the delay in seconds for top command
\-f, \-\-filter x,y,z Filter data\. An array is specified with
column=value pairs\.
\-\-csv Write table in csv format
\-x, \-\-xml Show the resource in xml format
\-n, \-\-numeric Do not translate user and group IDs
\-\-describe Describe list columns
\-v, \-\-verbose Verbose mode
\-h, \-\-help Show this message
\-V, \-\-version Show version and copyright information
\-\-user name User name used to connect to OpenNebula
\-\-password password Password to authenticate with OpenNebula
\-\-endpoint endpoint URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create \fIfile\fR Creates a new Zone
.
.IP "\(bu" 4
rename \fIzoneid\fR \fIname\fR Renames the Zone
.
.IP "\(bu" 4
server\-add \fIzoneid\fR Add an OpenNebula server to this zone\. valid options: server_name, server_rpc
.
.IP "\(bu" 4
server\-del \fIzoneid\fR \fIserverid\fR Delete an OpenNebula server from this zone\.
.
.IP "\(bu" 4
update \fIzoneid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
delete \fIrange|zoneid_list\fR Deletes the given Zone
.
.IP "\(bu" 4
list Lists Zones in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIzoneid\fR Shows information for the given Zone valid options: xml
.
.IP "\(bu" 4
set \fIzoneid\fR Set shell session access point for the CLI to the given Zone
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
zoneid OpenNebula ZONE name or id
.
.IP "\(bu" 4
zoneid_list Comma\-separated list of OpenNebula ZONE names or ids
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
.
.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