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