Statistics
| Branch: | Tag: | Revision:

one / share / man / onegroup.1 @ 27e61bae

History | View | Annotate | Download (4.07 KB)

1
.\" generated with Ronn/v0.7.3
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3
.
4
.TH "ONEGROUP" "1" "July 2017" "" "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
 \-c, \-\-listconf conf       Selects a predefined column list
25
 \-d, \-\-delay x             Sets the delay in seconds for top command
26
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
27
                           column=value pairs\.
28
 \-\-csv                     Write table in csv format
29
 \-x, \-\-xml                 Show the resource in xml format
30
 \-n, \-\-numeric             Do not translate user and group IDs
31
 \-\-describe                Describe list columns
32
 \-v, \-\-verbose             Verbose mode
33
 \-h, \-\-help                Show this message
34
 \-V, \-\-version             Show version and copyright information
35
 \-\-user name               User name used to connect to OpenNebula
36
 \-\-password password       Password to authenticate with OpenNebula
37
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
38
.
39
.fi
40
.
41
.SH "COMMANDS"
42
.
43
.IP "\(bu" 4
44
create [\fIgroup_name\fR] Creates a new Group\. A group name can be passed as the only argument, or via command line arguments
45
.
46
.IP "" 4
47
.
48
.nf
49

    
50
Examples:
51

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

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

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