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