Statistics
| Branch: | Tag: | Revision:

root / man / gnt-network.rst @ 1a9eb17e

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