root / man / gnt-group.rst @ 66af5ec5
History | View | Annotate | Download (7.8 kB)
1 |
gnt-group(8) Ganeti | Version @GANETI_VERSION@ |
---|---|
2 |
============================================== |
3 |
|
4 |
Name |
5 |
---- |
6 |
|
7 |
gnt-group - Ganeti node-group administration |
8 |
|
9 |
Synopsis |
10 |
-------- |
11 |
|
12 |
**gnt-group** {command} [arguments...] |
13 |
|
14 |
DESCRIPTION |
15 |
----------- |
16 |
|
17 |
The **gnt-group** command is used for node group administration in |
18 |
the Ganeti system. |
19 |
|
20 |
COMMANDS |
21 |
-------- |
22 |
|
23 |
ADD |
24 |
~~~ |
25 |
|
26 |
| **add** [\--submit] |
27 |
| [\--node-parameters=*NDPARAMS*] |
28 |
| [\--alloc-policy=*POLICY*] |
29 |
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]] |
30 |
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]] |
31 |
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]] |
32 |
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]] |
33 |
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]] |
34 |
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]] |
35 |
| [\--ipolicy-disk-templates *template* [,*template*...]] |
36 |
| [\--disk-state *diskstate*] |
37 |
| [\--hypervisor-state *hvstate*] |
38 |
| {*group*} |
39 |
|
40 |
Creates a new group with the given name. The node group will be |
41 |
initially empty; to add nodes to it, use ``gnt-group assign-nodes``. |
42 |
|
43 |
The ``--node-parameters`` option allows you to set default node |
44 |
parameters for nodes in the group. Please see **ganeti**\(7) for more |
45 |
information about supported key=value pairs and their corresponding |
46 |
options. |
47 |
|
48 |
The ``--alloc-policy`` option allows you to set an allocation policy for |
49 |
the group at creation time. Possible values are: |
50 |
|
51 |
unallocable |
52 |
nodes in the group should not be candidates for instance allocation, |
53 |
and the operation (e.g., instance creation) should fail if only |
54 |
groups in this state could be found to satisfy the requirements. |
55 |
|
56 |
last_resort |
57 |
nodes in the group should not be used for instance allocations, |
58 |
unless this would be the only way to have the operation succeed. |
59 |
|
60 |
preferred |
61 |
nodes in the group can be used freely for allocation of instances |
62 |
(this is the default). Note that prioritization among groups in this |
63 |
state will be deferred to the iallocator plugin that's being used. |
64 |
|
65 |
The ``-D (--disk-parameters)`` option allows you to set the disk |
66 |
parameters for the node group; please see the section about |
67 |
**gnt-cluster add** in **gnt-cluster**\(8) for more information about |
68 |
disk parameters |
69 |
|
70 |
The ``--specs-...`` and ``--ipolicy-disk-templates`` options specify |
71 |
instance policies on the node group, and are documented in the |
72 |
**gnt-cluster**\(8) man page. |
73 |
|
74 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
75 |
options. |
76 |
|
77 |
ASSIGN-NODES |
78 |
~~~~~~~~~~~~ |
79 |
|
80 |
| **assign-nodes** |
81 |
| [\--force] [\--submit] |
82 |
| {*group*} {*node*...} |
83 |
|
84 |
Assigns one or more nodes to the specified group, moving them from their |
85 |
original group (or groups). |
86 |
|
87 |
By default, this command will refuse to proceed if the move would split |
88 |
between groups any instance that was not previously split (a split |
89 |
instance is an instance with a mirrored disk template, e.g. DRBD, that |
90 |
has the primary and secondary nodes in different node groups). You can |
91 |
force the operation with ``--force``. |
92 |
|
93 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
94 |
options. |
95 |
|
96 |
MODIFY |
97 |
~~~~~~ |
98 |
|
99 |
| **modify** [\--submit] |
100 |
| [\--node-parameters=*NDPARAMS*] |
101 |
| [\--alloc-policy=*POLICY*] |
102 |
| [\--hypervisor-state *hvstate*] |
103 |
| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]] |
104 |
| [\--disk-state *diskstate*] |
105 |
| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]] |
106 |
| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]] |
107 |
| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]] |
108 |
| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]] |
109 |
| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]] |
110 |
| [\--ipolicy-disk-templates *template* [,*template*...]] |
111 |
| {*group*} |
112 |
|
113 |
Modifies some parameters from the node group. |
114 |
|
115 |
The ``--node-parameters`` and ``--alloc-policy`` options are documented |
116 |
in the **add** command above. ``--hypervisor-state`` as well as |
117 |
``--disk-state`` are documented in detail in **ganeti**\(7). |
118 |
|
119 |
The ``--node-parameters``, ``--alloc-policy``, ``-D |
120 |
(--disk-parameters)`` options are documented in the **add** command |
121 |
above. |
122 |
|
123 |
The ``--specs-...`` and ``--ipolicy-disk-templates`` options specify |
124 |
instance policies on the node group, and are documented in the |
125 |
**gnt-cluster**\(8) man page. |
126 |
|
127 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
128 |
options. |
129 |
|
130 |
REMOVE |
131 |
~~~~~~ |
132 |
|
133 |
| **remove** [\--submit] {*group*} |
134 |
|
135 |
Deletes the indicated node group, which must be empty. There must always be at |
136 |
least one group, so the last group cannot be removed. |
137 |
|
138 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
139 |
options. |
140 |
|
141 |
LIST |
142 |
~~~~ |
143 |
|
144 |
| **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v] |
145 |
| [-o *[+]FIELD,...*] [\--filter] [group...] |
146 |
|
147 |
Lists all existing node groups in the cluster. |
148 |
|
149 |
The ``--no-headers`` option will skip the initial header line. The |
150 |
``--separator`` option takes an argument which denotes what will be |
151 |
used between the output fields. Both these options are to help |
152 |
scripting. |
153 |
|
154 |
The ``-v`` option activates verbose mode, which changes the display of |
155 |
special field states (see **ganeti**\(7)). |
156 |
|
157 |
The ``-o`` option takes a comma-separated list of output fields. |
158 |
If the value of the option starts with the character ``+``, the new |
159 |
fields will be added to the default list. This allows one to quickly |
160 |
see the default list plus a few other fields, instead of retyping |
161 |
the entire list of fields. |
162 |
|
163 |
The available fields and their meaning are: |
164 |
|
165 |
@QUERY_FIELDS_GROUP@ |
166 |
|
167 |
If exactly one argument is given and it appears to be a query filter |
168 |
(see **ganeti**\(7)), the query result is filtered accordingly. For |
169 |
ambiguous cases (e.g. a single field name as a filter) the ``--filter`` |
170 |
(``-F``) option forces the argument to be treated as a filter. |
171 |
|
172 |
If no group names are given, then all groups are included. Otherwise, |
173 |
only the named groups will be listed. |
174 |
|
175 |
LIST-FIELDS |
176 |
~~~~~~~~~~~ |
177 |
|
178 |
**list-fields** [field...] |
179 |
|
180 |
List available fields for node groups. |
181 |
|
182 |
RENAME |
183 |
~~~~~~ |
184 |
|
185 |
| **rename** [\--submit] {*oldname*} {*newname*} |
186 |
|
187 |
Renames a given group from *oldname* to *newname*. |
188 |
|
189 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
190 |
options. |
191 |
|
192 |
|
193 |
EVACUATE |
194 |
~~~~~~~~ |
195 |
|
196 |
**evacuate** [\--submit] [\--iallocator *NAME*] [\--to *GROUP*...] {*group*} |
197 |
|
198 |
This command will move all instances out of the given node group. |
199 |
Instances are placed in a new group by an iallocator, either given on |
200 |
the command line or as a cluster default. |
201 |
|
202 |
If no specific destination groups are specified using ``--to``, all |
203 |
groups except the evacuated group are considered. |
204 |
|
205 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
206 |
options. |
207 |
|
208 |
Example:: |
209 |
|
210 |
# gnt-group evacuate -I hail --to rack4 rack1 |
211 |
|
212 |
|
213 |
Tags |
214 |
~~~~ |
215 |
|
216 |
ADD-TAGS |
217 |
^^^^^^^^ |
218 |
|
219 |
**add-tags** [\--from *file*] {*groupname*} {*tag*...} |
220 |
|
221 |
Add tags to the given node group. If any of the tags contains invalid |
222 |
characters, the entire operation will abort. |
223 |
|
224 |
If the ``--from`` option is given, the list of tags will be extended |
225 |
with the contents of that file (each line becomes a tag). In this case, |
226 |
there is not need to pass tags on the command line (if you do, both |
227 |
sources will be used). A file name of ``-`` will be interpreted as |
228 |
stdin. |
229 |
|
230 |
LIST-TAGS |
231 |
^^^^^^^^^ |
232 |
|
233 |
**list-tags** {*groupname*} |
234 |
|
235 |
List the tags of the given node group. |
236 |
|
237 |
REMOVE-TAGS |
238 |
^^^^^^^^^^^ |
239 |
|
240 |
**remove-tags** [\--from *file*] {*groupname*} {*tag*...} |
241 |
|
242 |
Remove tags from the given node group. If any of the tags are not |
243 |
existing on the node, the entire operation will abort. |
244 |
|
245 |
If the ``--from`` option is given, the list of tags to be removed will |
246 |
be extended with the contents of that file (each line becomes a tag). In |
247 |
this case, there is not need to pass tags on the command line (if you |
248 |
do, tags from both sources will be removed). A file name of ``-`` will |
249 |
be interpreted as stdin. |
250 |
|
251 |
INFO |
252 |
~~~~ |
253 |
|
254 |
**info** [group...] |
255 |
|
256 |
Shows config information for all (or given) groups. |
257 |
|
258 |
|
259 |
.. vim: set textwidth=72 : |
260 |
.. Local Variables: |
261 |
.. mode: rst |
262 |
.. fill-column: 72 |
263 |
.. End: |