Statistics
| Branch: | Tag: | Revision:

root / man / gnt-network.rst @ f709cbca

History | View | Annotate | Download (3.4 kB)

1
gnt-network(8) Ganeti | Version @GANETI_VERSION@
2
================================================
3

    
4
Name
5
----
6

    
7
gnt-network - Ganeti network administration
8

    
9
Synopsis
10
--------
11

    
12
**gnt-network** {command} [arguments...]
13

    
14
DESCRIPTION
15
-----------
16

    
17
The **gnt-network** command is used for network definition administration
18
in the Ganeti system.
19

    
20
COMMANDS
21
--------
22

    
23
ADD
24
~~~
25

    
26
| **add**
27
| [--network=*NETWORK*]
28
| [--gateway=*GATEWAY*]
29
| {*network*}
30

    
31
Creates a new network with the given name. The network will be unused
32
initially. To connect it to a node group, use ``gnt-network connect``.
33

    
34
The ``--network`` option allows you to specify the network in a CIDR notation.
35

    
36
The ``--gateway`` option allows you to specify the default gateway for this
37
network.
38

    
39
MODIFY
40
~~~~~~
41

    
42
| **modify**
43
| [--node-parameters=*NDPARAMS*]
44
| [--alloc-policy=*POLICY*]
45
| {*group*}
46

    
47
Modifies some parameters from the node group.
48

    
49
The ``--node-parameters`` and ``--alloc-policy`` optiosn are documented
50
in the **add** command above.
51

    
52
REMOVE
53
~~~~~~
54

    
55
| **remove** {*group*}
56

    
57
Deletes the indicated node group, which must be empty. There must always be at
58
least one group, so the last group cannot be removed.
59

    
60
LIST
61
~~~~
62

    
63
| **list** [--no-headers] [--separator=*SEPARATOR*] [-v]
64
| [-o *[+]FIELD,...*] [network...]
65

    
66
Lists all existing node groups in the cluster.
67

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

    
73
The ``-v`` option activates verbose mode, which changes the display of
74
special field states (see **ganeti(7)**).
75

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

    
82
The available fields and their meaning are:
83

    
84
name
85
    the group name
86

    
87
uuid
88
    the group's UUID
89

    
90
node_cnt
91
    the number of nodes in the node group
92

    
93
node_list
94
    the list of nodes that belong to this group
95

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

    
100
pinst_list
101
    the list of primary instances in the group
102

    
103
alloc_policy
104
    the current allocation policy for the group
105

    
106
ctime
107
    the creation time of the group; note that this field contains spaces
108
    and as such it's harder to parse
109

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

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

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

    
122
If no group names are given, then all groups are included. Otherwise,
123
only the named groups will be listed.
124

    
125
LIST-FIELDS
126
~~~~~~~~~~~
127

    
128
**list-fields** [field...]
129

    
130
List available fields for node groups.
131

    
132
RENAME
133
~~~~~~
134

    
135
| **rename** {*oldname*} {*newname*}
136

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

    
139
INFO
140
~~~~
141

    
142
| **info** [network...]
143

    
144
Displays information about a given network.
145

    
146
CONNECT
147
~~~~~~~
148
| **connect** {*network*} {*group*} {*link*}
149

    
150
Connect a network to a given nodegroup's link.
151

    
152
DISCONNECT
153
~~~~~~~~~~
154
| **disconnect** {*network*} {*group*}