root / man / gnt-network.rst @ c8b96be4
History | View | Annotate | Download (5.1 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 and |
18 |
administration in the Ganeti system. Each instance NIC can be connected |
19 |
to a network via the ``network`` NIC parameter. See **gnt-instance**\(8) |
20 |
for more details. |
21 |
|
22 |
COMMANDS |
23 |
-------- |
24 |
|
25 |
ADD |
26 |
~~~ |
27 |
|
28 |
| **add** |
29 |
| [--network=*NETWORK*] |
30 |
| [--gateway=*GATEWAY*] |
31 |
| [--add-reserved-ips=*RESERVEDIPS*] |
32 |
| [--network6=*NETWORK6*] |
33 |
| [--gateway6=*GATEWAY6*] |
34 |
| [--mac-prefix=*MACPREFIX*] |
35 |
| [--network-type=*NETWORKTYPE*] |
36 |
| [--submit] |
37 |
| {*network*} |
38 |
|
39 |
Creates a new network with the given name. The network will be unused |
40 |
initially. To connect it to a node group, use ``gnt-network connect``. |
41 |
``--network`` option is mandatory. All other are optional. |
42 |
|
43 |
The ``--network`` option allows you to specify the network in a CIDR |
44 |
notation. |
45 |
|
46 |
The ``--gateway`` option allows you to specify the default gateway for |
47 |
this network. |
48 |
|
49 |
The ``--network-type`` can be none, private or public. |
50 |
|
51 |
IPv6 semantics can be assigned to the network via the ``--network6`` and |
52 |
``--gateway6`` options. IP pool is meaningless for IPV6 so those two |
53 |
values can be used for EUI64 generation from a NIC's MAC address. |
54 |
|
55 |
Note that a when connecting a network to a node group (see below) you |
56 |
can specify also the NIC mode and link that will be used by instances on |
57 |
that group to physically connect to this network. This allows the system |
58 |
to work even if the parameters (eg. the VLAN number) change between |
59 |
groups. |
60 |
|
61 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
62 |
options. |
63 |
|
64 |
MODIFY |
65 |
~~~~~~ |
66 |
|
67 |
| **modify** |
68 |
| [--gateway=*GATEWAY*] |
69 |
| [--add-reserved-ips=*RESERVEDIPS*] |
70 |
| [--remove-reserved-ips=*RESERVEDIPS*] |
71 |
| [--network6=*NETWORK6*] |
72 |
| [--gateway6=*GATEWAY6*] |
73 |
| [--mac-prefix=*MACPREFIX*] |
74 |
| [--network-type=*NETWORKTYPE*] |
75 |
| [--submit] |
76 |
| {*network*} |
77 |
|
78 |
Modifies parameters from the network. |
79 |
|
80 |
Unable to modify network (IP address range). Create a new network if you |
81 |
want to do so. All other options are documented in the **add** command |
82 |
above. |
83 |
|
84 |
See **ganeti**\(7) for a description of ``--submit`` and other common |
85 |
options. |
86 |
|
87 |
REMOVE |
88 |
~~~~~~ |
89 |
|
90 |
| **remove** [--submit] {*network*} |
91 |
|
92 |
Deletes the indicated network, which must be not connected to any node group. |
93 |
|
94 |
See **ganeti**\(7) for a description of ``--submit`` and other common options. |
95 |
|
96 |
LIST |
97 |
~~~~ |
98 |
|
99 |
| **list** [--no-headers] [--separator=*SEPARATOR*] [-v] |
100 |
| [-o *[+]FIELD,...*] [network...] |
101 |
|
102 |
Lists all existing networks in the cluster. If no group names are given, |
103 |
then all groups are included. Otherwise, only the named groups will be |
104 |
listed. |
105 |
|
106 |
The ``--no-headers`` option will skip the initial header line. The |
107 |
``--separator`` option takes an argument which denotes what will be used |
108 |
between the output fields. Both these options are to help scripting. |
109 |
|
110 |
The ``-v`` option activates verbose mode, which changes the display of |
111 |
special field states (see **ganeti**\(7)). |
112 |
|
113 |
The ``-o`` option takes a comma-separated list of output fields. If the |
114 |
value of the option starts with the character ``+``, the new fields will |
115 |
be added to the default list. This allows to quickly see the default |
116 |
list plus a few other fields, instead of retyping the entire list of |
117 |
fields. |
118 |
|
119 |
The available fields and their meaning are: |
120 |
|
121 |
@QUERY_FIELDS_NETWORK@ |
122 |
|
123 |
LIST-FIELDS |
124 |
~~~~~~~~~~~ |
125 |
|
126 |
**list-fields** [field...] |
127 |
|
128 |
List available fields for networks. |
129 |
|
130 |
INFO |
131 |
~~~~ |
132 |
|
133 |
| **info** [network...] |
134 |
|
135 |
Displays information about a given network. |
136 |
|
137 |
CONNECT |
138 |
~~~~~~~ |
139 |
|
140 |
| **connect** {*network*} {*mode*} {*link*} [*groups*...] |
141 |
|
142 |
Connect a network to given node groups (all if not specified) with the |
143 |
network parameters *mode* and *link*. Every network interface will |
144 |
inherit those parameters if assigned in a network. |
145 |
|
146 |
DISCONNECT |
147 |
~~~~~~~~~~ |
148 |
|
149 |
| **disconnect** {*network*} [*groups*...] |
150 |
|
151 |
Disconnect a network from given node groups (all if not specified). This |
152 |
is possible only if no instance is using the network. |
153 |
|
154 |
|
155 |
Tags |
156 |
~~~~ |
157 |
|
158 |
ADD-TAGS |
159 |
^^^^^^^^ |
160 |
|
161 |
**add-tags** [\--from *file*] {*networkname*} {*tag*...} |
162 |
|
163 |
Add tags to the given network. If any of the tags contains invalid |
164 |
characters, the entire operation will abort. |
165 |
|
166 |
If the ``--from`` option is given, the list of tags will be extended |
167 |
with the contents of that file (each line becomes a tag). In this case, |
168 |
there is not need to pass tags on the command line (if you do, both |
169 |
sources will be used). A file name of ``-`` will be interpreted as |
170 |
stdin. |
171 |
|
172 |
LIST-TAGS |
173 |
^^^^^^^^^ |
174 |
|
175 |
**list-tags** {*networkname*} |
176 |
|
177 |
List the tags of the given network. |
178 |
|
179 |
REMOVE-TAGS |
180 |
^^^^^^^^^^^ |
181 |
|
182 |
**remove-tags** [\--from *file*] {*networkname*} {*tag*...} |
183 |
|
184 |
Remove tags from the given network. If any of the tags are not existing |
185 |
on the network, the entire operation will abort. |
186 |
|
187 |
If the ``--from`` option is given, the list of tags to be removed will |
188 |
be extended with the contents of that file (each line becomes a tag). In |
189 |
this case, there is not need to pass tags on the command line (if you |
190 |
do, tags from both sources will be removed). A file name of ``-`` will |
191 |
be interpreted as stdin. |
192 |
|
193 |
.. vim: set textwidth=72 : |
194 |
.. Local Variables: |
195 |
.. mode: rst |
196 |
.. fill-column: 72 |
197 |
.. End: |