1 gnt-network(8) Ganeti | Version @GANETI_VERSION@
2 ================================================
7 gnt-network - Ganeti network administration
12 **gnt-network** {command} [arguments...]
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)
29 | [\--network=*NETWORK*]
30 | [\--gateway=*GATEWAY*]
31 | [\--add-reserved-ips=*RESERVEDIPS*]
32 | [\--network6=*NETWORK6*]
33 | [\--gateway6=*GATEWAY6*]
34 | [\--mac-prefix=*MACPREFIX*]
38 Creates a new network with the given name. The network will be unused
39 initially. To connect it to a node group, use ``gnt-network connect``.
40 ``--network`` option is mandatory. All other are optional.
42 The ``--network`` option allows you to specify the network in a CIDR
45 The ``--gateway`` option allows you to specify the default gateway for
48 IPv6 semantics can be assigned to the network via the ``--network6`` and
49 ``--gateway6`` options. IP pool is meaningless for IPV6 so those two
50 values can be used for EUI64 generation from a NIC's MAC address.
52 Note that a when connecting a network to a node group (see below) you
53 can specify also the NIC mode and link that will be used by instances on
54 that group to physically connect to this network. This allows the system
55 to work even if the parameters (eg. the VLAN number) change between
58 See **ganeti**\(7) for a description of ``--submit`` and other common
65 | [\--gateway=*GATEWAY*]
66 | [\--add-reserved-ips=*RESERVEDIPS*]
67 | [\--remove-reserved-ips=*RESERVEDIPS*]
68 | [\--network6=*NETWORK6*]
69 | [\--gateway6=*GATEWAY6*]
70 | [\--mac-prefix=*MACPREFIX*]
74 Modifies parameters from the network.
76 Unable to modify network (IP address range). Create a new network if you
77 want to do so. All other options are documented in the **add** command
80 See **ganeti**\(7) for a description of ``--submit`` and other common
86 | **remove** [\--submit] {*network*}
88 Deletes the indicated network, which must be not connected to any node group.
90 See **ganeti**\(7) for a description of ``--submit`` and other common options.
95 | **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
96 | [-o *[+]FIELD,...*] [network...]
98 Lists all existing networks in the cluster. If no group names are given,
99 then all groups are included. Otherwise, only the named groups will be
102 The ``--no-headers`` option will skip the initial header line. The
103 ``--separator`` option takes an argument which denotes what will be used
104 between the output fields. Both these options are to help scripting.
106 The ``-v`` option activates verbose mode, which changes the display of
107 special field states (see **ganeti**\(7)).
109 The ``-o`` option takes a comma-separated list of output fields. If the
110 value of the option starts with the character ``+``, the new fields will
111 be added to the default list. This allows to quickly see the default
112 list plus a few other fields, instead of retyping the entire list of
115 The available fields and their meaning are:
117 @QUERY_FIELDS_NETWORK@
122 **list-fields** [field...]
124 List available fields for networks.
129 | **info** [network...]
131 Displays information about a given network.
136 | **connect** {*network*} {*mode*} {*link*} [*groups*...]
138 Connect a network to given node groups (all if not specified) with the
139 network parameters *mode* and *link*. Every network interface will
140 inherit those parameters if assigned in a network.
145 | **disconnect** {*network*} [*groups*...]
147 Disconnect a network from given node groups (all if not specified). This
148 is possible only if no instance is using the network.
157 **add-tags** [\--from *file*] {*networkname*} {*tag*...}
159 Add tags to the given network. If any of the tags contains invalid
160 characters, the entire operation will abort.
162 If the ``--from`` option is given, the list of tags will be extended
163 with the contents of that file (each line becomes a tag). In this case,
164 there is not need to pass tags on the command line (if you do, both
165 sources will be used). A file name of ``-`` will be interpreted as
171 **list-tags** {*networkname*}
173 List the tags of the given network.
178 **remove-tags** [\--from *file*] {*networkname*} {*tag*...}
180 Remove tags from the given network. If any of the tags are not existing
181 on the network, the entire operation will abort.
183 If the ``--from`` option is given, the list of tags to be removed will
184 be extended with the contents of that file (each line becomes a tag). In
185 this case, there is not need to pass tags on the command line (if you
186 do, tags from both sources will be removed). A file name of ``-`` will
187 be interpreted as stdin.
189 .. vim: set textwidth=72 :