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 COMMANDS
  23 --------
  24
  25 ADD
  26 ~~~
  27
  28 | **add**
  29 | [\--network=*NETWORK*]
  30 | [\--gateway=*GATEWAY*]
  31 | [\--add-reserved-ips=*RESERVEDIPS*]
  32 | [\--network6=*NETWORK6*]
  33 | [\--gateway6=*GATEWAY6*]
  34 | [\--mac-prefix=*MACPREFIX*]
  35 | [\--submit]
  36 | {*network*}
  37
  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.
  41
  42 The ``--network`` option allows you to specify the network in a CIDR
  43 notation.
  44
  45 The ``--gateway`` option allows you to specify the default gateway for
  46 this network.
  47
  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.
  51
  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
  56 groups.
  57
  58 See **ganeti**\(7) for a description of ``--submit`` and other common
  59 options.
  60
  61 MODIFY
  62 ~~~~~~
  63
  64 | **modify**
  65 | [\--gateway=*GATEWAY*]
  66 | [\--add-reserved-ips=*RESERVEDIPS*]
  67 | [\--remove-reserved-ips=*RESERVEDIPS*]
  68 | [\--network6=*NETWORK6*]
  69 | [\--gateway6=*GATEWAY6*]
  70 | [\--mac-prefix=*MACPREFIX*]
  71 | [\--submit]
  72 | {*network*}
  73
  74 Modifies parameters from the network.
  75
  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
  78 above.
  79
  80 See **ganeti**\(7) for a description of ``--submit`` and other common
  81 options.
  82
  83 REMOVE
  84 ~~~~~~
  85
  86 | **remove** [\--submit] {*network*}
  87
  88 Deletes the indicated network, which must be not connected to any node group.
  89
  90 See **ganeti**\(7) for a description of ``--submit`` and other common options.
  91
  92 LIST
  93 ~~~~
  94
  95 | **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
  96 | [-o *[+]FIELD,...*] [network...]
  97
  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
 100 listed.
 101
 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.
 105
 106 The ``-v`` option activates verbose mode, which changes the display of
 107 special field states (see **ganeti**\(7)).
 108
 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
 113 fields.
 114
 115 The available fields and their meaning are:
 116
 117 @QUERY_FIELDS_NETWORK@
 118
 119 LIST-FIELDS
 120 ~~~~~~~~~~~
 121
 122 **list-fields** [field...]
 123
 124 List available fields for networks.
 125
 126 INFO
 127 ~~~~
 128
 129 | **info** [network...]
 130
 131 Displays information about a given network.
 132
 133 CONNECT
 134 ~~~~~~~
 135
 136 | **connect** {*network*} {*mode*} {*link*} [*groups*...]
 137
 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.
 141
 142 DISCONNECT
 143 ~~~~~~~~~~
 144
 145 | **disconnect** {*network*} [*groups*...]
 146
 147 Disconnect a network from given node groups (all if not specified). This
 148 is possible only if no instance is using the network.
 149
 150
 151 Tags
 152 ~~~~
 153
 154 ADD-TAGS
 155 ^^^^^^^^
 156
 157 **add-tags** [\--from *file*] {*networkname*} {*tag*...}
 158
 159 Add tags to the given network. If any of the tags contains invalid
 160 characters, the entire operation will abort.
 161
 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
 166 stdin.
 167
 168 LIST-TAGS
 169 ^^^^^^^^^
 170
 171 **list-tags** {*networkname*}
 172
 173 List the tags of the given network.
 174
 175 REMOVE-TAGS
 176 ^^^^^^^^^^^
 177
 178 **remove-tags** [\--from *file*] {*networkname*} {*tag*...}
 179
 180 Remove tags from the given network. If any of the tags are not existing
 181 on the network, the entire operation will abort.
 182
 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.
 188
 189 .. vim: set textwidth=72 :
 190 .. Local Variables:
 191 .. mode: rst
 192 .. fill-column: 72
 193 .. End: