Statistics
| Branch: | Tag: | Revision:

root / man / gnt-network.rst @ be862db9

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