Statistics
| Branch: | Tag: | Revision:

root / man / gnt-group.rst @ fcdb582d

History | View | Annotate | Download (3.5 kB)

1 667dbd6b Adeodato Simo
gnt-group(8) Ganeti | Version @GANETI_VERSION@
2 667dbd6b Adeodato Simo
==============================================
3 667dbd6b Adeodato Simo
4 667dbd6b Adeodato Simo
Name
5 667dbd6b Adeodato Simo
----
6 667dbd6b Adeodato Simo
7 667dbd6b Adeodato Simo
gnt-group - Ganeti node-group administration
8 667dbd6b Adeodato Simo
9 667dbd6b Adeodato Simo
Synopsis
10 667dbd6b Adeodato Simo
--------
11 667dbd6b Adeodato Simo
12 667dbd6b Adeodato Simo
**gnt-group** {command} [arguments...]
13 667dbd6b Adeodato Simo
14 667dbd6b Adeodato Simo
DESCRIPTION
15 667dbd6b Adeodato Simo
-----------
16 667dbd6b Adeodato Simo
17 667dbd6b Adeodato Simo
The **gnt-group** command is used for node group administration in
18 667dbd6b Adeodato Simo
the Ganeti system.
19 667dbd6b Adeodato Simo
20 667dbd6b Adeodato Simo
COMMANDS
21 667dbd6b Adeodato Simo
--------
22 667dbd6b Adeodato Simo
23 66e884e1 Adeodato Simo
ADD
24 66e884e1 Adeodato Simo
~~~
25 66e884e1 Adeodato Simo
26 483be60d Adeodato Simo
| **add**
27 483be60d Adeodato Simo
| [--node-parameters=*NDPARAMS*]
28 90e99856 Adeodato Simo
| [--alloc-policy=*POLICY*]
29 483be60d Adeodato Simo
| {*group*}
30 66e884e1 Adeodato Simo
31 66e884e1 Adeodato Simo
Creates a new group with the given name. The node group will be
32 919852da Adeodato Simo
initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
33 66e884e1 Adeodato Simo
34 483be60d Adeodato Simo
The ``--node-parameters`` option allows you to set default node
35 483be60d Adeodato Simo
parameters for nodes in the group. Please see **ganeti**(7) for more
36 483be60d Adeodato Simo
information about supported key=value pairs.
37 483be60d Adeodato Simo
38 90e99856 Adeodato Simo
The ``--alloc-policy`` option allows you to set an allocation policy for
39 90e99856 Adeodato Simo
the group at creation time. Possible values are:
40 90e99856 Adeodato Simo
41 90e99856 Adeodato Simo
unallocable
42 90e99856 Adeodato Simo
    nodes in the group should not be candidates for instance allocation,
43 90e99856 Adeodato Simo
    and the operation (e.g., instance creation) should fail if only
44 90e99856 Adeodato Simo
    groups in this state could be found to satisfy the requirements.
45 90e99856 Adeodato Simo
46 90e99856 Adeodato Simo
last_resort
47 90e99856 Adeodato Simo
    nodes in the group should not be used for instance allocations,
48 90e99856 Adeodato Simo
    unless this would be the only way to have the operation succeed.
49 90e99856 Adeodato Simo
50 90e99856 Adeodato Simo
preferred
51 90e99856 Adeodato Simo
    nodes in the group can be used freely for allocation of instances
52 90e99856 Adeodato Simo
    (this is the default). Note that prioritization among groups in this
53 90e99856 Adeodato Simo
    state will be deferred to the iallocator plugin that's being used.
54 90e99856 Adeodato Simo
55 919852da Adeodato Simo
ASSIGN-NODES
56 919852da Adeodato Simo
~~~~~~~~~~~~
57 919852da Adeodato Simo
58 919852da Adeodato Simo
| **assign-nodes**
59 919852da Adeodato Simo
| [--force]
60 919852da Adeodato Simo
| {*group*} {*node*...}
61 919852da Adeodato Simo
62 919852da Adeodato Simo
Assigns one or more nodes to the specified group, moving them from their
63 919852da Adeodato Simo
original group (or groups).
64 919852da Adeodato Simo
65 919852da Adeodato Simo
By default, this command will refuse to proceed if the move would split
66 919852da Adeodato Simo
between groups any instance that was not previously split (a split
67 919852da Adeodato Simo
instance is an instance with a mirrored disk template, e.g. DRBD, that
68 919852da Adeodato Simo
has the primary and secondary nodes in different node groups). You can
69 919852da Adeodato Simo
force the operation with ``--force``.
70 90e99856 Adeodato Simo
71 4da7909a Adeodato Simo
MODIFY
72 4da7909a Adeodato Simo
~~~~~~
73 4da7909a Adeodato Simo
74 4da7909a Adeodato Simo
| **modify**
75 4da7909a Adeodato Simo
| [--node-parameters=*NDPARAMS*]
76 90e99856 Adeodato Simo
| [--alloc-policy=*POLICY*]
77 4da7909a Adeodato Simo
| {*group*}
78 4da7909a Adeodato Simo
79 4da7909a Adeodato Simo
Modifies some parameters from the node group.
80 4da7909a Adeodato Simo
81 90e99856 Adeodato Simo
The ``--node-parameters`` and ``--alloc-policy`` optiosn are documented
82 90e99856 Adeodato Simo
in the **add** command above.
83 4da7909a Adeodato Simo
84 66e884e1 Adeodato Simo
REMOVE
85 66e884e1 Adeodato Simo
~~~~~~
86 66e884e1 Adeodato Simo
87 66e884e1 Adeodato Simo
| **remove** {*group*}
88 66e884e1 Adeodato Simo
89 a7c5085d Stephen Shirley
Deletes the indicated node group, which must be empty. There must always be at
90 a7c5085d Stephen Shirley
least one group, so the last group cannot be removed.
91 66e884e1 Adeodato Simo
92 667dbd6b Adeodato Simo
LIST
93 667dbd6b Adeodato Simo
~~~~
94 667dbd6b Adeodato Simo
95 f0b1bafe Iustin Pop
| **list** [--no-headers] [--separator=*SEPARATOR*] [-v]
96 667dbd6b Adeodato Simo
| [-o *[+]FIELD,...*] [group...]
97 667dbd6b Adeodato Simo
98 667dbd6b Adeodato Simo
Lists all existing node groups in the cluster.
99 667dbd6b Adeodato Simo
100 667dbd6b Adeodato Simo
The ``--no-headers`` option will skip the initial header line. The
101 667dbd6b Adeodato Simo
``--separator`` option takes an argument which denotes what will be
102 667dbd6b Adeodato Simo
used between the output fields. Both these options are to help
103 667dbd6b Adeodato Simo
scripting.
104 667dbd6b Adeodato Simo
105 f0b1bafe Iustin Pop
The ``-v`` option activates verbose mode, which changes the display of
106 f0b1bafe Iustin Pop
special field states (see **ganeti(7)**).
107 f0b1bafe Iustin Pop
108 667dbd6b Adeodato Simo
The ``-o`` option takes a comma-separated list of output fields.
109 667dbd6b Adeodato Simo
If the value of the option starts with the character ``+``, the new
110 667dbd6b Adeodato Simo
fields will be added to the default list. This allows to quickly
111 667dbd6b Adeodato Simo
see the default list plus a few other fields, instead of retyping
112 667dbd6b Adeodato Simo
the entire list of fields.
113 667dbd6b Adeodato Simo
114 667dbd6b Adeodato Simo
The available fields and their meaning are:
115 667dbd6b Adeodato Simo
116 fcdb582d Michael Hanselmann
@QUERY_FIELDS_GROUP@
117 4edc512c Adeodato Simo
118 667dbd6b Adeodato Simo
If no group names are given, then all groups are included. Otherwise,
119 667dbd6b Adeodato Simo
only the named groups will be listed.
120 66e884e1 Adeodato Simo
121 ca4ac9c9 Adeodato Simo
LIST-FIELDS
122 ca4ac9c9 Adeodato Simo
~~~~~~~~~~~
123 ca4ac9c9 Adeodato Simo
124 ca4ac9c9 Adeodato Simo
**list-fields** [field...]
125 ca4ac9c9 Adeodato Simo
126 ca4ac9c9 Adeodato Simo
List available fields for node groups.
127 ca4ac9c9 Adeodato Simo
128 66e884e1 Adeodato Simo
RENAME
129 66e884e1 Adeodato Simo
~~~~~~
130 66e884e1 Adeodato Simo
131 66e884e1 Adeodato Simo
| **rename** {*oldname*} {*newname*}
132 66e884e1 Adeodato Simo
133 66e884e1 Adeodato Simo
Renames a given group from *oldname* to *newname*.