Statistics
| Branch: | Tag: | Revision:

root / man / gnt-network.rst @ ee93aa8a

History | View | Annotate | Download (4.6 kB)

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