From d119f8cb133c542f806e3b94cc236c625bbbcb31 Mon Sep 17 00:00:00 2001 From: Javi Fontan Date: Fri, 10 Mar 2017 11:12:45 +0100 Subject: [PATCH] F #2347: add onevmgroup man page --- install.sh | 1 + share/man/SConstruct | 1 + share/man/onevmgroup.1 | 98 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 100 insertions(+) create mode 100644 share/man/onevmgroup.1 diff --git a/install.sh b/install.sh index b18c11f56d..243d315571 100755 --- a/install.sh +++ b/install.sh @@ -1740,6 +1740,7 @@ MAN_FILES="share/man/oneacct.1.gz \ share/man/onevrouter.1.gz \ share/man/onemarket.1.gz \ share/man/onemarketapp.1.gz \ + share/man/onevmgroup.1.gz \ share/man/econe-allocate-address.1.gz \ share/man/econe-associate-address.1.gz \ share/man/econe-attach-volume.1.gz \ diff --git a/share/man/SConstruct b/share/man/SConstruct index 39b0f0705b..e879a7a4e6 100644 --- a/share/man/SConstruct +++ b/share/man/SConstruct @@ -67,6 +67,7 @@ env.Man('onevdc') env.Man('onevrouter') env.Man('onemarket') env.Man('onemarketapp') +env.Man('onevmgroup') env.Man('oneflow') env.Man('oneflow-template') diff --git a/share/man/onevmgroup.1 b/share/man/onevmgroup.1 new file mode 100644 index 0000000000..1e4248d107 --- /dev/null +++ b/share/man/onevmgroup.1 @@ -0,0 +1,98 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ONEVMGROUP" "1" "March 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\.2\.0 Copyright 2002\-2016, 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