Revision c0288228
b/man/gnt-network.rst | ||
---|---|---|
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 |
| [--add-reserved-ips=*RESERVEDIPS*] |
|
30 |
| [--network6=*NETWORK6*] |
|
31 |
| [--gateway6=*GATEWAY6*] |
|
32 |
| [--mac-prefix=*MACPREFIX*] |
|
33 |
| [--network-type=*NETWORKTYPE*] |
|
34 |
| {*network*} |
|
35 |
|
|
36 |
Creates a new network with the given name. The network will be unused |
|
37 |
initially. To connect it to a node group, use ``gnt-network connect``. |
|
38 |
``--network`` option is mandatory. All other are optional. |
|
39 |
|
|
40 |
The ``--network`` option allows you to specify the network in a CIDR notation. |
|
41 |
|
|
42 |
The ``--gateway`` option allows you to specify the default gateway for this |
|
43 |
network. |
|
44 |
|
|
45 |
The ``--network-type`` can be none, private or public. |
|
46 |
|
|
47 |
IPv6 semantics can be assigned to the network via the ``--network6`` and |
|
48 |
``--gateway6`` options. IP pool is meaningless for ipv6 so those two values |
|
49 |
can be used for EUI64 generation from a NIC's mac value. |
|
50 |
|
|
51 |
MODIFY |
|
52 |
~~~~~~ |
|
53 |
|
|
54 |
| **modify** |
|
55 |
| [--gateway=*GATEWAY*] |
|
56 |
| [--add-reserved-ips=*RESERVEDIPS*] |
|
57 |
| [--remove-reserved-ips=*RESERVEDIPS*] |
|
58 |
| [--network6=*NETWORK6*] |
|
59 |
| [--gateway6=*GATEWAY6*] |
|
60 |
| [--mac-prefix=*MACPREFIX*] |
|
61 |
| [--network-type=*NETWORKTYPE*] |
|
62 |
| {*network*} |
|
63 |
|
|
64 |
Modifies parameters from the network. |
|
65 |
|
|
66 |
Unable to modify network (ip range). Create a new network if you want to do |
|
67 |
so. All other options are documented in the **add** command above. |
|
68 |
|
|
69 |
REMOVE |
|
70 |
~~~~~~ |
|
71 |
|
|
72 |
| **remove** {*network*} |
|
73 |
|
|
74 |
Deletes the indicated network, which must be not connected to any node group. |
|
75 |
|
|
76 |
LIST |
|
77 |
~~~~ |
|
78 |
|
|
79 |
| **list** [--no-headers] [--separator=*SEPARATOR*] [-v] |
|
80 |
| [-o *[+]FIELD,...*] [network...] |
|
81 |
|
|
82 |
Lists all existing networks in the cluster. |
|
83 |
|
|
84 |
The ``--no-headers`` option will skip the initial header line. The |
|
85 |
``--separator`` option takes an argument which denotes what will be |
|
86 |
used between the output fields. Both these options are to help |
|
87 |
scripting. |
|
88 |
|
|
89 |
The ``-v`` option activates verbose mode, which changes the display of |
|
90 |
special field states (see **ganeti(7)**). |
|
91 |
|
|
92 |
The ``-o`` option takes a comma-separated list of output fields. |
|
93 |
If the value of the option starts with the character ``+``, the new |
|
94 |
fields will be added to the default list. This allows to quickly |
|
95 |
see the default list plus a few other fields, instead of retyping |
|
96 |
the entire list of fields. |
|
97 |
|
|
98 |
The available fields and their meaning are: |
|
99 |
|
|
100 |
name |
|
101 |
the group name |
|
102 |
|
|
103 |
group_count |
|
104 |
the number of nodegroups connected to the network |
|
105 |
|
|
106 |
group_list |
|
107 |
the list of nodegroups connected to the network |
|
108 |
|
|
109 |
inst_cnt |
|
110 |
the number of instances use the network |
|
111 |
|
|
112 |
inst_list |
|
113 |
the list of instances that at least one of their NICs is assigned |
|
114 |
to the network |
|
115 |
|
|
116 |
external_reservations |
|
117 |
the IPs that cannot be assigned to an instance |
|
118 |
|
|
119 |
free_count |
|
120 |
how many IPs have left in the pool |
|
121 |
|
|
122 |
gateway |
|
123 |
the networks gateway |
|
124 |
|
|
125 |
map |
|
126 |
a nice text depiction of the available/reserved IPs in the network |
|
127 |
|
|
128 |
reserved_count |
|
129 |
how many IPs have been reserved so far in the network |
|
130 |
|
|
131 |
network6 |
|
132 |
the ipv6 prefix of the network |
|
133 |
|
|
134 |
gateway6 |
|
135 |
the ipv6 gateway of the network |
|
136 |
|
|
137 |
mac_prefix |
|
138 |
the mac_prefix of the network (if a NIC is assigned to the network it |
|
139 |
it gets the mac_prefix of the network) |
|
140 |
|
|
141 |
network_type |
|
142 |
the type of the network (public, private) |
|
143 |
|
|
144 |
If no group names are given, then all groups are included. Otherwise, |
|
145 |
only the named groups will be listed. |
|
146 |
|
|
147 |
LIST-FIELDS |
|
148 |
~~~~~~~~~~~ |
|
149 |
|
|
150 |
**list-fields** [field...] |
|
151 |
|
|
152 |
List available fields for networks. |
|
153 |
|
|
154 |
RENAME |
|
155 |
~~~~~~ |
|
156 |
|
|
157 |
| **rename** {*oldname*} {*newname*} |
|
158 |
|
|
159 |
Renames a given network from *oldname* to *newname*. NOT implemeted yet |
|
160 |
|
|
161 |
INFO |
|
162 |
~~~~ |
|
163 |
|
|
164 |
| **info** [network...] |
|
165 |
|
|
166 |
Displays information about a given network. |
|
167 |
|
|
168 |
CONNECT |
|
169 |
~~~~~~~ |
|
170 |
| **connect** {*network*} {*group*} {*mode*} {*link*} |
|
171 |
|
|
172 |
Connect a network to a given nodegroup with the netparams (*mode*, *link*). |
|
173 |
Every nic will inherit those netparams if assigned in a network. |
|
174 |
*group* can be ``all`` if you want to connect to all existing nodegroups |
|
175 |
|
|
176 |
DISCONNECT |
|
177 |
~~~~~~~~~~ |
|
178 |
| **disconnect** {*network*} {*group*} |
|
179 |
|
|
180 |
Disconnect a network to a nodegroup. This is possible only if no instance |
|
181 |
is using the network. |
Also available in: Unified diff