gnt-network.rst 5.12 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
gnt-network(8) Ganeti | Version @GANETI_VERSION@
================================================

Name
----

gnt-network - Ganeti network administration

Synopsis
--------

**gnt-network** {command} [arguments...]

DESCRIPTION
-----------

Guido Trotter's avatar
Guido Trotter committed
17 18 19 20
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.
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

COMMANDS
--------

ADD
~~~

| **add**
| [--network=*NETWORK*]
| [--gateway=*GATEWAY*]
| [--add-reserved-ips=*RESERVEDIPS*]
| [--network6=*NETWORK6*]
| [--gateway6=*GATEWAY6*]
| [--mac-prefix=*MACPREFIX*]
| [--network-type=*NETWORKTYPE*]
36
| [--submit]
37 38 39 40 41 42
| {*network*}

Creates a new network with the given name. The network will be unused
initially. To connect it to a node group, use ``gnt-network connect``.
``--network`` option is mandatory. All other are optional.

43 44
The ``--network`` option allows you to specify the network in a CIDR
notation.
45

46 47
The ``--gateway`` option allows you to specify the default gateway for
this network.
48 49 50 51

The ``--network-type`` can be none, private or public.

IPv6 semantics can be assigned to the network via the ``--network6`` and
52 53
``--gateway6`` options. IP pool is meaningless for IPV6 so those two
values can be used for EUI64 generation from a NIC's MAC address.
54

Guido Trotter's avatar
Guido Trotter committed
55 56 57 58 59 60
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.

61
See **ganeti**\(7) for a description of ``--submit`` and other common
62
options.
63 64 65 66 67 68 69 70 71 72 73 74

MODIFY
~~~~~~

| **modify**
| [--gateway=*GATEWAY*]
| [--add-reserved-ips=*RESERVEDIPS*]
| [--remove-reserved-ips=*RESERVEDIPS*]
| [--network6=*NETWORK6*]
| [--gateway6=*GATEWAY6*]
| [--mac-prefix=*MACPREFIX*]
| [--network-type=*NETWORKTYPE*]
75
| [--submit]
76 77 78 79
| {*network*}

Modifies parameters from the network.

80 81 82
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.
83

84
See **ganeti**\(7) for a description of ``--submit`` and other common
85
options.
86 87 88 89

REMOVE
~~~~~~

90
| **remove** [--submit] {*network*}
91 92 93

Deletes the indicated network, which must be not connected to any node group.

94
See **ganeti**\(7) for a description of ``--submit`` and other common options.
95

96 97 98 99 100 101
LIST
~~~~

| **list** [--no-headers] [--separator=*SEPARATOR*] [-v]
| [-o *[+]FIELD,...*] [network...]

102 103 104
Lists all existing networks in the cluster. If no group names are given,
then all groups are included. Otherwise, only the named groups will be
listed.
105 106

The ``--no-headers`` option will skip the initial header line. The
107 108
``--separator`` option takes an argument which denotes what will be used
between the output fields. Both these options are to help scripting.
109 110

The ``-v`` option activates verbose mode, which changes the display of
111
special field states (see **ganeti**\(7)).
112

113 114 115 116 117
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
be added to the default list. This allows to quickly see the default
list plus a few other fields, instead of retyping the entire list of
fields.
118 119 120

The available fields and their meaning are:

121
@QUERY_FIELDS_NETWORK@
122 123 124 125 126 127 128 129

LIST-FIELDS
~~~~~~~~~~~

**list-fields** [field...]

List available fields for networks.

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
INFO
~~~~

| **info** [network...]

Displays information about a given network.

CONNECT
~~~~~~~

| **connect** {*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.

DISCONNECT
~~~~~~~~~~

| **disconnect** {*network*} [*groups*...]

Disconnect a network from given node groups (all if not specified). This
is possible only if no instance is using the network.


155 156
Tags
~~~~
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183

ADD-TAGS
^^^^^^^^

**add-tags** [\--from *file*] {*networkname*} {*tag*...}

Add tags to the given network. If any of the tags contains invalid
characters, the entire operation will abort.

If the ``--from`` option is given, the list of tags will be extended
with the contents of that file (each line becomes a tag). In this case,
there is not need to pass tags on the command line (if you do, both
sources will be used). A file name of ``-`` will be interpreted as
stdin.

LIST-TAGS
^^^^^^^^^

**list-tags** {*networkname*}

List the tags of the given network.

REMOVE-TAGS
^^^^^^^^^^^

**remove-tags** [\--from *file*] {*networkname*} {*tag*...}

184 185
Remove tags from the given network. If any of the tags are not existing
on the network, the entire operation will abort.
186 187 188 189 190 191 192

If the ``--from`` option is given, the list of tags to be removed will
be extended with the contents of that file (each line becomes a tag). In
this case, there is not need to pass tags on the command line (if you
do, tags from both sources will be removed). A file name of ``-`` will
be interpreted as stdin.

193 194 195 196 197
.. vim: set textwidth=72 :
.. Local Variables:
.. mode: rst
.. fill-column: 72
.. End: