gnt-network.rst 4.62 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
gnt-network(8) Ganeti | Version @GANETI_VERSION@
================================================

Name
----

gnt-network - Ganeti network administration

Synopsis
--------

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

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

The **gnt-network** command is used for network definition administration
in the Ganeti system.

COMMANDS
--------

ADD
~~~

| **add**
| [--network=*NETWORK*]
| [--gateway=*GATEWAY*]
| [--add-reserved-ips=*RESERVEDIPS*]
| [--network6=*NETWORK6*]
| [--gateway6=*GATEWAY6*]
| [--mac-prefix=*MACPREFIX*]
| [--network-type=*NETWORKTYPE*]
34
| [--submit]
35 36 37 38 39 40 41 42 43 44 45 46 47 48
| {*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.

The ``--network`` option allows you to specify the network in a CIDR 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
49
``--gateway6`` options. IP pool is meaningless for IPV6 so those two values
50 51 52
can be used for EUI64 generation from a NIC's MAC address.

See **ganeti(7)** for a description of ``--submit`` and other common options.
53 54 55 56 57 58 59 60 61 62 63 64

MODIFY
~~~~~~

| **modify**
| [--gateway=*GATEWAY*]
| [--add-reserved-ips=*RESERVEDIPS*]
| [--remove-reserved-ips=*RESERVEDIPS*]
| [--network6=*NETWORK6*]
| [--gateway6=*GATEWAY6*]
| [--mac-prefix=*MACPREFIX*]
| [--network-type=*NETWORKTYPE*]
65
| [--submit]
66 67 68 69
| {*network*}

Modifies parameters from the network.

70 71 72 73
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 options.
74 75 76 77

REMOVE
~~~~~~

78
| **remove** [--submit] {*network*}
79 80 81

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

82 83
See **ganeti(7)** for a description of ``--submit`` and other common options.

84 85 86 87 88 89
LIST
~~~~

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

90 91
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.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108

The ``--no-headers`` option will skip the initial header line. The
``--separator`` option takes an argument which denotes what will be
used 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)**).

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.

The available fields and their meaning are:

109
@QUERY_FIELDS_NETWORK@
110 111 112 113 114 115 116 117

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

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

List available fields for networks.

118 119 120 121 122 123 124 125 126 127 128 129 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 155 156
TAGS
~~~

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*...}

Remove tags from the given network. If any of the tags are not
existing on the network, the entire operation will abort.

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.


157 158 159 160 161 162 163 164 165 166
INFO
~~~~

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

Displays information about a given network.

CONNECT
~~~~~~~

167 168 169 170 171
| **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.
172 173 174 175

DISCONNECT
~~~~~~~~~~

176 177 178 179
| **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.