root / man / gnt-network.rst @ e37f47d3
History | View | Annotate | Download (5.3 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 | a04cc7a4 | Apollon Oikonomopoulos | ``--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 | a04cc7a4 | Apollon Oikonomopoulos | Lists all existing networks in the cluster. |
83 | a04cc7a4 | Apollon Oikonomopoulos | |
84 | a04cc7a4 | Apollon Oikonomopoulos | The ``--no-headers`` option will skip the initial header line. The |
85 | a04cc7a4 | Apollon Oikonomopoulos | ``--separator`` option takes an argument which denotes what will be |
86 | a04cc7a4 | Apollon Oikonomopoulos | used between the output fields. Both these options are to help |
87 | a04cc7a4 | Apollon Oikonomopoulos | scripting. |
88 | a04cc7a4 | Apollon Oikonomopoulos | |
89 | a04cc7a4 | Apollon Oikonomopoulos | The ``-v`` option activates verbose mode, which changes the display of |
90 | a04cc7a4 | Apollon Oikonomopoulos | special field states (see **ganeti(7)**). |
91 | a04cc7a4 | Apollon Oikonomopoulos | |
92 | a04cc7a4 | Apollon Oikonomopoulos | The ``-o`` option takes a comma-separated list of output fields. |
93 | a04cc7a4 | Apollon Oikonomopoulos | If the value of the option starts with the character ``+``, the new |
94 | a04cc7a4 | Apollon Oikonomopoulos | fields will be added to the default list. This allows to quickly |
95 | a04cc7a4 | Apollon Oikonomopoulos | see the default list plus a few other fields, instead of retyping |
96 | a04cc7a4 | Apollon Oikonomopoulos | the entire list of fields. |
97 | a04cc7a4 | Apollon Oikonomopoulos | |
98 | a04cc7a4 | Apollon Oikonomopoulos | The available fields and their meaning are: |
99 | a04cc7a4 | Apollon Oikonomopoulos | |
100 | a04cc7a4 | Apollon Oikonomopoulos | name |
101 | a04cc7a4 | Apollon Oikonomopoulos | the group name |
102 | a04cc7a4 | Apollon Oikonomopoulos | |
103 | a04cc7a4 | Apollon Oikonomopoulos | group_count |
104 | a04cc7a4 | Apollon Oikonomopoulos | the number of nodegroups connected to the network |
105 | a04cc7a4 | Apollon Oikonomopoulos | |
106 | a04cc7a4 | Apollon Oikonomopoulos | group_list |
107 | a04cc7a4 | Apollon Oikonomopoulos | the list of nodegroups connected to the network |
108 | a04cc7a4 | Apollon Oikonomopoulos | |
109 | a04cc7a4 | Apollon Oikonomopoulos | inst_cnt |
110 | a04cc7a4 | Apollon Oikonomopoulos | the number of instances use the network |
111 | a04cc7a4 | Apollon Oikonomopoulos | |
112 | a04cc7a4 | Apollon Oikonomopoulos | inst_list |
113 | a04cc7a4 | Apollon Oikonomopoulos | the list of instances that at least one of their NICs is assigned |
114 | a04cc7a4 | Apollon Oikonomopoulos | to the network |
115 | a04cc7a4 | Apollon Oikonomopoulos | |
116 | a04cc7a4 | Apollon Oikonomopoulos | external_reservations |
117 | a04cc7a4 | Apollon Oikonomopoulos | the IPs that cannot be assigned to an instance |
118 | a04cc7a4 | Apollon Oikonomopoulos | |
119 | a04cc7a4 | Apollon Oikonomopoulos | free_count |
120 | a04cc7a4 | Apollon Oikonomopoulos | how many IPs have left in the pool |
121 | a04cc7a4 | Apollon Oikonomopoulos | |
122 | a04cc7a4 | Apollon Oikonomopoulos | gateway |
123 | a04cc7a4 | Apollon Oikonomopoulos | the networks gateway |
124 | a04cc7a4 | Apollon Oikonomopoulos | |
125 | a04cc7a4 | Apollon Oikonomopoulos | map |
126 | a04cc7a4 | Apollon Oikonomopoulos | a nice text depiction of the available/reserved IPs in the network |
127 | a04cc7a4 | Apollon Oikonomopoulos | |
128 | a04cc7a4 | Apollon Oikonomopoulos | reserved_count |
129 | a04cc7a4 | Apollon Oikonomopoulos | how many IPs have been reserved so far in the network |
130 | a04cc7a4 | Apollon Oikonomopoulos | |
131 | a04cc7a4 | Apollon Oikonomopoulos | network6 |
132 | a04cc7a4 | Apollon Oikonomopoulos | the ipv6 prefix of the network |
133 | a04cc7a4 | Apollon Oikonomopoulos | |
134 | a04cc7a4 | Apollon Oikonomopoulos | gateway6 |
135 | a04cc7a4 | Apollon Oikonomopoulos | the ipv6 gateway of the network |
136 | a04cc7a4 | Apollon Oikonomopoulos | |
137 | a04cc7a4 | Apollon Oikonomopoulos | mac_prefix |
138 | a04cc7a4 | Apollon Oikonomopoulos | the mac_prefix of the network (if a NIC is assigned to the network it |
139 | a04cc7a4 | Apollon Oikonomopoulos | it gets the mac_prefix of the network) |
140 | a04cc7a4 | Apollon Oikonomopoulos | |
141 | a04cc7a4 | Apollon Oikonomopoulos | network_type |
142 | a04cc7a4 | Apollon Oikonomopoulos | the type of the network (public, private) |
143 | a04cc7a4 | Apollon Oikonomopoulos | |
144 | a04cc7a4 | Apollon Oikonomopoulos | If no group names are given, then all groups are included. Otherwise, |
145 | a04cc7a4 | Apollon Oikonomopoulos | only the named groups will be listed. |
146 | a04cc7a4 | Apollon Oikonomopoulos | |
147 | a04cc7a4 | Apollon Oikonomopoulos | LIST-FIELDS |
148 | a04cc7a4 | Apollon Oikonomopoulos | ~~~~~~~~~~~ |
149 | a04cc7a4 | Apollon Oikonomopoulos | |
150 | a04cc7a4 | Apollon Oikonomopoulos | **list-fields** [field...] |
151 | a04cc7a4 | Apollon Oikonomopoulos | |
152 | a04cc7a4 | Apollon Oikonomopoulos | List available fields for networks. |
153 | a04cc7a4 | Apollon Oikonomopoulos | |
154 | a04cc7a4 | Apollon Oikonomopoulos | RENAME |
155 | a04cc7a4 | Apollon Oikonomopoulos | ~~~~~~ |
156 | a04cc7a4 | Apollon Oikonomopoulos | |
157 | a04cc7a4 | Apollon Oikonomopoulos | | **rename** {*oldname*} {*newname*} |
158 | a04cc7a4 | Apollon Oikonomopoulos | |
159 | a04cc7a4 | Apollon Oikonomopoulos | Renames a given network from *oldname* to *newname*. NOT implemeted yet |
160 | a04cc7a4 | Apollon Oikonomopoulos | |
161 | 6e8091f9 | Dimitris Aragiorgis | TAGS |
162 | 6e8091f9 | Dimitris Aragiorgis | ~~~ |
163 | 6e8091f9 | Dimitris Aragiorgis | |
164 | 6e8091f9 | Dimitris Aragiorgis | ADD-TAGS |
165 | 6e8091f9 | Dimitris Aragiorgis | ^^^^^^^^ |
166 | 6e8091f9 | Dimitris Aragiorgis | |
167 | 6e8091f9 | Dimitris Aragiorgis | **add-tags** [\--from *file*] {*networkname*} {*tag*...} |
168 | 6e8091f9 | Dimitris Aragiorgis | |
169 | 6e8091f9 | Dimitris Aragiorgis | Add tags to the given network. If any of the tags contains invalid |
170 | 6e8091f9 | Dimitris Aragiorgis | characters, the entire operation will abort. |
171 | 6e8091f9 | Dimitris Aragiorgis | |
172 | 6e8091f9 | Dimitris Aragiorgis | If the ``--from`` option is given, the list of tags will be extended |
173 | 6e8091f9 | Dimitris Aragiorgis | with the contents of that file (each line becomes a tag). In this case, |
174 | 6e8091f9 | Dimitris Aragiorgis | there is not need to pass tags on the command line (if you do, both |
175 | 6e8091f9 | Dimitris Aragiorgis | sources will be used). A file name of ``-`` will be interpreted as |
176 | 6e8091f9 | Dimitris Aragiorgis | stdin. |
177 | 6e8091f9 | Dimitris Aragiorgis | |
178 | 6e8091f9 | Dimitris Aragiorgis | LIST-TAGS |
179 | 6e8091f9 | Dimitris Aragiorgis | ^^^^^^^^^ |
180 | 6e8091f9 | Dimitris Aragiorgis | |
181 | 6e8091f9 | Dimitris Aragiorgis | **list-tags** {*networkname*} |
182 | 6e8091f9 | Dimitris Aragiorgis | |
183 | 6e8091f9 | Dimitris Aragiorgis | List the tags of the given network. |
184 | 6e8091f9 | Dimitris Aragiorgis | |
185 | 6e8091f9 | Dimitris Aragiorgis | REMOVE-TAGS |
186 | 6e8091f9 | Dimitris Aragiorgis | ^^^^^^^^^^^ |
187 | 6e8091f9 | Dimitris Aragiorgis | |
188 | 6e8091f9 | Dimitris Aragiorgis | **remove-tags** [\--from *file*] {*networkname*} {*tag*...} |
189 | 6e8091f9 | Dimitris Aragiorgis | |
190 | 6e8091f9 | Dimitris Aragiorgis | Remove tags from the given network. If any of the tags are not |
191 | 6e8091f9 | Dimitris Aragiorgis | existing on the network, the entire operation will abort. |
192 | 6e8091f9 | Dimitris Aragiorgis | |
193 | 6e8091f9 | Dimitris Aragiorgis | If the ``--from`` option is given, the list of tags to be removed will |
194 | 6e8091f9 | Dimitris Aragiorgis | be extended with the contents of that file (each line becomes a tag). In |
195 | 6e8091f9 | Dimitris Aragiorgis | this case, there is not need to pass tags on the command line (if you |
196 | 6e8091f9 | Dimitris Aragiorgis | do, tags from both sources will be removed). A file name of ``-`` will |
197 | 6e8091f9 | Dimitris Aragiorgis | be interpreted as stdin. |
198 | 6e8091f9 | Dimitris Aragiorgis | |
199 | 6e8091f9 | Dimitris Aragiorgis | |
200 | a04cc7a4 | Apollon Oikonomopoulos | INFO |
201 | a04cc7a4 | Apollon Oikonomopoulos | ~~~~ |
202 | a04cc7a4 | Apollon Oikonomopoulos | |
203 | a04cc7a4 | Apollon Oikonomopoulos | | **info** [network...] |
204 | a04cc7a4 | Apollon Oikonomopoulos | |
205 | a04cc7a4 | Apollon Oikonomopoulos | Displays information about a given network. |
206 | a04cc7a4 | Apollon Oikonomopoulos | |
207 | a04cc7a4 | Apollon Oikonomopoulos | CONNECT |
208 | a04cc7a4 | Apollon Oikonomopoulos | ~~~~~~~ |
209 | a04cc7a4 | Apollon Oikonomopoulos | | **connect** {*network*} {*group*} {*mode*} {*link*} |
210 | a04cc7a4 | Apollon Oikonomopoulos | |
211 | a04cc7a4 | Apollon Oikonomopoulos | Connect a network to a given nodegroup with the netparams (*mode*, *link*). |
212 | a04cc7a4 | Apollon Oikonomopoulos | Every nic will inherit those netparams if assigned in a network. |
213 | a04cc7a4 | Apollon Oikonomopoulos | *group* can be ``all`` if you want to connect to all existing nodegroups |
214 | a04cc7a4 | Apollon Oikonomopoulos | |
215 | a04cc7a4 | Apollon Oikonomopoulos | DISCONNECT |
216 | a04cc7a4 | Apollon Oikonomopoulos | ~~~~~~~~~~ |
217 | a04cc7a4 | Apollon Oikonomopoulos | | **disconnect** {*network*} {*group*} |
218 | a04cc7a4 | Apollon Oikonomopoulos | |
219 | a04cc7a4 | Apollon Oikonomopoulos | Disconnect a network to a nodegroup. This is possible only if no instance |
220 | a04cc7a4 | Apollon Oikonomopoulos | is using the network. |