1 gnt-group(8) Ganeti | Version @GANETI_VERSION@
2 ==============================================
7 gnt-group - Ganeti node-group administration
12 **gnt-group** {command} [arguments...]
17 The **gnt-group** command is used for node group administration in
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 | [\--ipol-disk-templates *template* [,*template*...]]
36 | [\--disk-state *diskstate*]
37 | [\--hypervisor-state *hvstate*]
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``.
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
48 The ``--alloc-policy`` option allows you to set an allocation policy for
49 the group at creation time. Possible values are:
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.
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.
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.
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
70 The ``--specs-...`` and ``--ipol-disk-templates`` options specify
71 instance policies on the node group, and are documented in the
72 **gnt-cluster**(8) man page.
74 See **ganeti(7)** for a description of ``--submit`` and other common
81 | [\--force] [\--submit]
82 | {*group*} {*node*...}
84 Assigns one or more nodes to the specified group, moving them from their
85 original group (or groups).
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``.
93 See **ganeti(7)** for a description of ``--submit`` and other common
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 | [\--ipol-disk-templates *template* [,*template*...]]
113 Modifies some parameters from the node group.
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).
119 The ``--node-parameters``, ``--alloc-policy``, ``-D
120 (--disk-parameters)`` options are documented in the **add** command
123 The ``--specs-...`` and ``--ipol-disk-templates`` options specify
124 instance policies on the node group, and are documented in the
125 **gnt-cluster**(8) man page.
127 See **ganeti(7)** for a description of ``--submit`` and other common
133 | **remove** [\--submit] {*group*}
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.
138 See **ganeti(7)** for a description of ``--submit`` and other common
144 | **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
145 | [-o *[+]FIELD,...*] [\--filter] [group...]
147 Lists all existing node groups in the cluster.
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
154 The ``-v`` option activates verbose mode, which changes the display of
155 special field states (see **ganeti(7)**).
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.
163 The available fields and their meaning are:
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.
172 If no group names are given, then all groups are included. Otherwise,
173 only the named groups will be listed.
178 **list-fields** [field...]
180 List available fields for node groups.
185 | **rename** [\--submit] {*oldname*} {*newname*}
187 Renames a given group from *oldname* to *newname*.
189 See **ganeti(7)** for a description of ``--submit`` and other common
196 **evacuate** [\--submit] [\--iallocator *NAME*] [\--to *GROUP*...] {*group*}
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.
202 If no specific destination groups are specified using ``--to``, all
203 groups except the evacuated group are considered.
205 See **ganeti(7)** for a description of ``--submit`` and other common
210 # gnt-group evacuate -I hail --to rack4 rack1
219 **add-tags** [\--from *file*] {*groupname*} {*tag*...}
221 Add tags to the given node group. If any of the tags contains invalid
222 characters, the entire operation will abort.
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
233 **list-tags** {*groupname*}
235 List the tags of the given node group.
240 **remove-tags** [\--from *file*] {*groupname*} {*tag*...}
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.
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.
256 Shows config information for all (or given) groups.
259 .. vim: set textwidth=72 :