root / man / gnt-group.rst @ 0ce212e5
History | View | Annotate | Download (7.1 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** |
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 |
| [--specs-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-...`` options specify instance policies on the node group, |
71 |
and are documented in the **gnt-cluster**(8) man page. |
72 |
|
73 |
ASSIGN-NODES |
74 |
~~~~~~~~~~~~ |
75 |
|
76 |
| **assign-nodes** |
77 |
| [--force] |
78 |
| {*group*} {*node*...} |
79 |
|
80 |
Assigns one or more nodes to the specified group, moving them from their |
81 |
original group (or groups). |
82 |
|
83 |
By default, this command will refuse to proceed if the move would split |
84 |
between groups any instance that was not previously split (a split |
85 |
instance is an instance with a mirrored disk template, e.g. DRBD, that |
86 |
has the primary and secondary nodes in different node groups). You can |
87 |
force the operation with ``--force``. |
88 |
|
89 |
MODIFY |
90 |
~~~~~~ |
91 |
|
92 |
| **modify** |
93 |
| [--node-parameters=*NDPARAMS*] |
94 |
| [--alloc-policy=*POLICY*] |
95 |
| [--hypervisor-state *hvstate*] |
96 |
| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]] |
97 |
| [--disk-state *diskstate*] |
98 |
| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]] |
99 |
| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]] |
100 |
| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]] |
101 |
| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]] |
102 |
| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]] |
103 |
| [--specs-disk-templates *template* [,*template*...]] |
104 |
| {*group*} |
105 |
|
106 |
Modifies some parameters from the node group. |
107 |
|
108 |
The ``--node-parameters`` and ``--alloc-policy`` options are documented |
109 |
in the **add** command above. ``--hypervisor-state`` as well as |
110 |
``--disk-state`` are documented in detail in **ganeti**(7). |
111 |
|
112 |
The ``--node-parameters``, ``--alloc-policy``, ``-D |
113 |
(--disk-parameters)`` options are documented in the **add** command |
114 |
above. |
115 |
|
116 |
The ``--specs-...`` options specify instance policies on the node group, |
117 |
and are documented in the **gnt-cluster**(8) man page. |
118 |
|
119 |
REMOVE |
120 |
~~~~~~ |
121 |
|
122 |
| **remove** {*group*} |
123 |
|
124 |
Deletes the indicated node group, which must be empty. There must always be at |
125 |
least one group, so the last group cannot be removed. |
126 |
|
127 |
LIST |
128 |
~~~~ |
129 |
|
130 |
| **list** [--no-headers] [--separator=*SEPARATOR*] [-v] |
131 |
| [-o *[+]FIELD,...*] [--filter] [group...] |
132 |
|
133 |
Lists all existing node groups in the cluster. |
134 |
|
135 |
The ``--no-headers`` option will skip the initial header line. The |
136 |
``--separator`` option takes an argument which denotes what will be |
137 |
used between the output fields. Both these options are to help |
138 |
scripting. |
139 |
|
140 |
The ``-v`` option activates verbose mode, which changes the display of |
141 |
special field states (see **ganeti(7)**). |
142 |
|
143 |
The ``-o`` option takes a comma-separated list of output fields. |
144 |
If the value of the option starts with the character ``+``, the new |
145 |
fields will be added to the default list. This allows one to quickly |
146 |
see the default list plus a few other fields, instead of retyping |
147 |
the entire list of fields. |
148 |
|
149 |
The available fields and their meaning are: |
150 |
|
151 |
@QUERY_FIELDS_GROUP@ |
152 |
|
153 |
If exactly one argument is given and it appears to be a query filter |
154 |
(see **ganeti(7)**), the query result is filtered accordingly. For |
155 |
ambiguous cases (e.g. a single field name as a filter) the ``--filter`` |
156 |
(``-F``) option forces the argument to be treated as a filter. |
157 |
|
158 |
If no group names are given, then all groups are included. Otherwise, |
159 |
only the named groups will be listed. |
160 |
|
161 |
LIST-FIELDS |
162 |
~~~~~~~~~~~ |
163 |
|
164 |
**list-fields** [field...] |
165 |
|
166 |
List available fields for node groups. |
167 |
|
168 |
RENAME |
169 |
~~~~~~ |
170 |
|
171 |
| **rename** {*oldname*} {*newname*} |
172 |
|
173 |
Renames a given group from *oldname* to *newname*. |
174 |
|
175 |
|
176 |
EVACUATE |
177 |
~~~~~~~~ |
178 |
|
179 |
**evacuate** [--iallocator *NAME*] [--to *GROUP*...] {*group*} |
180 |
|
181 |
This command will move all instances out of the given node group. |
182 |
Instances are placed in a new group by an iallocator, either given on |
183 |
the command line or as a cluster default. |
184 |
|
185 |
If no specific destination groups are specified using ``--to``, all |
186 |
groups except the evacuated group are considered. |
187 |
|
188 |
Example:: |
189 |
|
190 |
# gnt-group evacuate -I hail --to rack4 rack1 |
191 |
|
192 |
|
193 |
TAGS |
194 |
~~~~ |
195 |
|
196 |
ADD-TAGS |
197 |
^^^^^^^^ |
198 |
|
199 |
**add-tags** [--from *file*] {*groupname*} {*tag*...} |
200 |
|
201 |
Add tags to the given node group. If any of the tags contains invalid |
202 |
characters, the entire operation will abort. |
203 |
|
204 |
If the ``--from`` option is given, the list of tags will be extended |
205 |
with the contents of that file (each line becomes a tag). In this case, |
206 |
there is not need to pass tags on the command line (if you do, both |
207 |
sources will be used). A file name of ``-`` will be interpreted as |
208 |
stdin. |
209 |
|
210 |
LIST-TAGS |
211 |
^^^^^^^^^ |
212 |
|
213 |
**list-tags** {*groupname*} |
214 |
|
215 |
List the tags of the given node group. |
216 |
|
217 |
REMOVE-TAGS |
218 |
^^^^^^^^^^^ |
219 |
|
220 |
**remove-tags** [--from *file*] {*groupname*} {*tag*...} |
221 |
|
222 |
Remove tags from the given node group. If any of the tags are not |
223 |
existing on the node, the entire operation will abort. |
224 |
|
225 |
If the ``--from`` option is given, the list of tags to be removed will |
226 |
be extended with the contents of that file (each line becomes a tag). In |
227 |
this case, there is not need to pass tags on the command line (if you |
228 |
do, tags from both sources will be removed). A file name of ``-`` will |
229 |
be interpreted as stdin. |
230 |
|
231 |
.. vim: set textwidth=72 : |
232 |
.. Local Variables: |
233 |
.. mode: rst |
234 |
.. fill-column: 72 |
235 |
.. End: |