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