Statistics
| Branch: | Tag: | Revision:

one / share / man / onegroup.1 @ f3d57119

History | View | Annotate | Download (4.01 KB)

1
.\" generated with Ronn/v0.7.3
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3
.
4
.TH "ONEGROUP" "1" "August 2015" "" "onegroup(1) -- manages OpenNebula groups"
5
.
6
.SH "NAME"
7
\fBonegroup\fR \- manages OpenNebula groups
8
.
9
.SH "SYNOPSIS"
10
\fBonegroup\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
11
.
12
.SH "OPTIONS"
13
.
14
.nf
15

    
16
 \-n, \-\-name name           Name for the new group
17
 \-u, \-\-admin_user name     Creates an admin user for the group with name
18
 \-p, \-\-admin_password pass Password for the admin user of the group
19
 \-d, \-\-admin_driver driver Auth driver for the admin user of the group
20
 \-r, \-\-resources res_str   Which resources can be created by group users
21
                           (VM+NET+IMAGE+TEMPLATE by default)
22
 \-a, \-\-append              Append new attributes to the current template
23
 \-l, \-\-list x,y,z          Selects columns to display with list command
24
 \-d, \-\-delay x             Sets the delay in seconds for top command
25
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
26
                           column=value pairs\.
27
 \-\-csv                     Write table in csv format
28
 \-x, \-\-xml                 Show the resource in xml format
29
 \-n, \-\-numeric             Do not translate user and group IDs
30
 \-\-describe                Describe list columns
31
 \-v, \-\-verbose             Verbose mode
32
 \-h, \-\-help                Show this message
33
 \-V, \-\-version             Show version and copyright information
34
 \-\-user name               User name used to connect to OpenNebula
35
 \-\-password password       Password to authenticate with OpenNebula
36
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
37
.
38
.fi
39
.
40
.SH "COMMANDS"
41
.
42
.IP "\(bu" 4
43
create [\fIgroup_name\fR] Creates a new Group\. A group name can be passed as the only argument, or via command line arguments
44
.
45
.IP "" 4
46
.
47
.nf
48

    
49
Examples:
50

    
51
  \- create a group with an admin user and allow group users
52
    to only create new templates and VMs
53

    
54
    onegroup create \-\-name groupA
55
                    \-\-admin_user admin_userA \-\-admin_password somestr
56
                    \-\-resources TEMPLATE+VM
57
valid options: name, admin_user, admin_password, admin_driver, resources
58
.
59
.fi
60
.
61
.IP "" 0
62

    
63
.
64
.IP "\(bu" 4
65
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
66
.
67
.IP "\(bu" 4
68
delete \fIrange|groupid_list\fR Deletes the given Group
69
.
70
.IP "\(bu" 4
71
list Lists Groups in the pool valid options: list, delay, filter, csv, xml, numeric, describe
72
.
73
.IP "\(bu" 4
74
show [\fIgroupid\fR] Shows information for the given Group valid options: xml
75
.
76
.IP "\(bu" 4
77
addadmin \fIrange|groupid_list\fR \fIuserid\fR Adds a User to the Group administrators set
78
.
79
.IP "\(bu" 4
80
deladmin \fIrange|groupid_list\fR \fIuserid\fR Removes a User from the Group administrators set
81
.
82
.IP "\(bu" 4
83
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\.
84
.
85
.IP "\(bu" 4
86
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\.
87
.
88
.IP "\(bu" 4
89
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\.
90
.
91
.IP "" 0
92
.
93
.SH "ARGUMENT FORMATS"
94
.
95
.IP "\(bu" 4
96
file Path to a file
97
.
98
.IP "\(bu" 4
99
range List of id\'s in the form 1,8\.\.15
100
.
101
.IP "\(bu" 4
102
text String
103
.
104
.IP "\(bu" 4
105
groupid OpenNebula GROUP name or id
106
.
107
.IP "\(bu" 4
108
groupid_list Comma\-separated list of OpenNebula GROUP names or ids
109
.
110
.IP "\(bu" 4
111
userid OpenNebula USER name or id
112
.
113
.IP "" 0
114
.
115
.SH "LICENSE"
116
OpenNebula 4\.13\.80 Copyright 2002\-2015, OpenNebula Project (OpenNebula\.org), C12G Labs
117
.
118
.P
119
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