one/share/man/onegroup.1

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEGROUP" "1" "April 2014" "" "onegroup(1) -- manages OpenNebula groups"
.
.SH "NAME"
\fBonegroup\fR
.
.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)
 \-o, \-\-admin_resources res_str Which resources can be created by the admin
                           user (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
 \-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 a file containing a group template or via command line arguments
.
.IP "" 4
.
.nf

Examples:

  \- create a group with admin user and allow group users
    to only create new templates and VMs, and group admin to manage
    templates, vms, images and virtual networks

    onegroup create \-\-name groupA
                    \-\-admin_user admin_userA \-\-admin_password somestr
                    \-\-resources TEMPLATE+VM
                    \-\-admin_resources TEMPLATE+VM+IMAGE+NET
valid options: name, admin_user, admin_password, admin_driver, resources, admin_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, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show [\fIgroupid\fR] Shows information for the given Group valid options: xml
.
.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 "\(bu" 4
add_provider \fIrange|groupid_list\fR \fIzoneid\fR \fIclusterid\fR Adds a resource provider (cluster of a zone) to the given group\. clusterid can be set to ALL
.
.IP "\(bu" 4
del_provider \fIrange|groupid_list\fR \fIzoneid\fR \fIclusterid\fR Deletes a resource provider (cluster of a zone) from the given group clusterid can be set to ALL
.
.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
clusterid OpenNebula CLUSTER name or id
.
.IP "\(bu" 4
zoneid OpenNebula ZONE name or id
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 4\.6\.0 Copyright 2002\-2014, OpenNebula Project (OpenNebula\.org), C12G Labs
.
.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