Minor documentations fixed to gnt-node man page
[ganeti-local] / man / gnt-network.rst
index 0579ba0..3d71663 100644 (file)
@@ -14,8 +14,18 @@ Synopsis
 DESCRIPTION
 -----------
 
-The **gnt-network** command is used for network definition
-administration in the Ganeti system.
+The **gnt-network** command is used for network definition and
+administration in the Ganeti system. Each instance NIC can be connected
+to a network via the ``network`` NIC parameter. See **gnt-instance**\(8)
+for more details.
+
+BUGS
+----
+
+The ``hail`` iallocator hasn't been updated to take networks into
+account in Ganeti 2.7. The only way to guarantee that it works correctly
+is having your networks connected to all nodegroups. This will be fixed
+in a future version.
 
 COMMANDS
 --------
@@ -24,14 +34,14 @@ ADD
 ~~~
 
 | **add**
-| [--network=*NETWORK*]
-| [--gateway=*GATEWAY*]
-| [--add-reserved-ips=*RESERVEDIPS*]
-| [--network6=*NETWORK6*]
-| [--gateway6=*GATEWAY6*]
-| [--mac-prefix=*MACPREFIX*]
-| [--network-type=*NETWORKTYPE*]
-| [--submit]
+| [\--network=*NETWORK*]
+| [\--gateway=*GATEWAY*]
+| [\--add-reserved-ips=*RESERVEDIPS*]
+| [\--network6=*NETWORK6*]
+| [\--gateway6=*GATEWAY6*]
+| [\--mac-prefix=*MACPREFIX*]
+| [\--submit] [\--print-job-id]
+| [\--no-conflicts-check]
 | {*network*}
 
 Creates a new network with the given name. The network will be unused
@@ -44,27 +54,33 @@ notation.
 The ``--gateway`` option allows you to specify the default gateway for
 this network.
 
-The ``--network-type`` can be none, private or public.
-
 IPv6 semantics can be assigned to the network via the ``--network6`` and
 ``--gateway6`` options. IP pool is meaningless for IPV6 so those two
 values can be used for EUI64 generation from a NIC's MAC address.
 
-See **ganeti(7)** for a description of ``--submit`` and other common
+The ``--no-conflicts-check`` option can be used to skip the check for
+conflicting IP addresses.
+
+Note that a when connecting a network to a node group (see below) you
+can specify also the NIC mode and link that will be used by instances on
+that group to physically connect to this network. This allows the system
+to work even if the parameters (eg. the VLAN number) change between
+groups.
+
+See **ganeti**\(7) for a description of ``--submit`` and other common
 options.
 
 MODIFY
 ~~~~~~
 
 | **modify**
-| [--gateway=*GATEWAY*]
-| [--add-reserved-ips=*RESERVEDIPS*]
-| [--remove-reserved-ips=*RESERVEDIPS*]
-| [--network6=*NETWORK6*]
-| [--gateway6=*GATEWAY6*]
-| [--mac-prefix=*MACPREFIX*]
-| [--network-type=*NETWORKTYPE*]
-| [--submit]
+| [\--gateway=*GATEWAY*]
+| [\--add-reserved-ips=*RESERVEDIPS*]
+| [\--remove-reserved-ips=*RESERVEDIPS*]
+| [\--network6=*NETWORK6*]
+| [\--gateway6=*GATEWAY6*]
+| [\--mac-prefix=*MACPREFIX*]
+| [\--submit] [\--print-job-id]
 | {*network*}
 
 Modifies parameters from the network.
@@ -73,22 +89,22 @@ Unable to modify network (IP address range). Create a new network if you
 want to do so. All other options are documented in the **add** command
 above.
 
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
 options.
 
 REMOVE
 ~~~~~~
 
-| **remove** [--submit] {*network*}
+| **remove** [\--submit] [\--print-job-id] {*network*}
 
 Deletes the indicated network, which must be not connected to any node group.
 
-See **ganeti(7)** for a description of ``--submit`` and other common options.
+See **ganeti**\(7) for a description of ``--submit`` and other common options.
 
 LIST
 ~~~~
 
-| **list** [--no-headers] [--separator=*SEPARATOR*] [-v]
+| **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
 | [-o *[+]FIELD,...*] [network...]
 
 Lists all existing networks in the cluster. If no group names are given,
@@ -100,7 +116,7 @@ The ``--no-headers`` option will skip the initial header line. The
 between the output fields. Both these options are to help scripting.
 
 The ``-v`` option activates verbose mode, which changes the display of
-special field states (see **ganeti(7)**).
+special field states (see **ganeti**\(7)).
 
 The ``-o`` option takes a comma-separated list of output fields. If the
 value of the option starts with the character ``+``, the new fields will
@@ -129,12 +145,17 @@ Displays information about a given network.
 CONNECT
 ~~~~~~~
 
-| **connect** {*network*} {*mode*} {*link*} [*groups*...]
+| **connect**
+| [\--no-conflicts-check]
+| {*network*} {*mode*} {*link*} [*groups*...]
 
 Connect a network to given node groups (all if not specified) with the
 network parameters *mode* and *link*. Every network interface will
 inherit those parameters if assigned in a network.
 
+The ``--no-conflicts-check`` option can be used to skip the check for
+conflicting IP addresses.
+
 DISCONNECT
 ~~~~~~~~~~