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