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