gnt-group.rst 2.51 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
gnt-group(8) Ganeti | Version @GANETI_VERSION@
==============================================

Name
----

gnt-group - Ganeti node-group administration

Synopsis
--------

**gnt-group** {command} [arguments...]

DESCRIPTION
-----------

The **gnt-group** command is used for node group administration in
the Ganeti system.

COMMANDS
--------

23 24 25
ADD
~~~

26 27 28
| **add**
| [--node-parameters=*NDPARAMS*]
| {*group*}
29 30 31 32

Creates a new group with the given name. The node group will be
initially empty.

33 34 35 36
The ``--node-parameters`` option allows you to set default node
parameters for nodes in the group. Please see **ganeti**(7) for more
information about supported key=value pairs.

37 38 39 40 41 42 43
REMOVE
~~~~~~

| **remove** {*group*}

Deletes the indicated node group, which must be empty.

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
LIST
~~~~

| **list** [--no-headers] [--separator=*SEPARATOR*]
| [-o *[+]FIELD,...*] [group...]

Lists all existing node groups in the cluster.

The ``--no-headers`` option will skip the initial header line. The
``--separator`` option takes an argument which denotes what will be
used between the output fields. Both these options are to help
scripting.

The ``-o`` option takes a comma-separated list of output fields.
If the value of the option starts with the character ``+``, the new
fields will be added to the default list. This allows to quickly
see the default list plus a few other fields, instead of retyping
the entire list of fields.

The available fields and their meaning are:

name
    the group name

uuid
    the group's UUID

node_cnt
    the number of nodes in the node group

node_list
    the list of nodes that belong to this group

pinst_cnt
    the number of primary instances in the group (i.e., the number of
    primary instances nodes in this group have)

pinst_list
    the list of primary instances in the group

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
ctime
    the creation time of the group; note that this field contains spaces
    and as such it's harder to parse

    if this attribute is not present (e.g. when upgrading from older
    versions), then "N/A" will be shown instead

mtime
    the last modification time of the group; note that this field
    contains spaces and as such it's harder to parse

serial_no
    the so called 'serial number' of the group; this is a numeric field
    that is incremented each time the node is modified, and it can be
    used to detect modifications

100 101
If no group names are given, then all groups are included. Otherwise,
only the named groups will be listed.
102 103 104 105 106 107 108

RENAME
~~~~~~

| **rename** {*oldname*} {*newname*}

Renames a given group from *oldname* to *newname*.