Statistics
| Branch: | Tag: | Revision:

root / man / gnt-network.rst @ ee93aa8a

History | View | Annotate | Download (4.6 kB)

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 administration
18
in the Ganeti system.
19

    
20
COMMANDS
21
--------
22

    
23
ADD
24
~~~
25

    
26
| **add**
27
| [--network=*NETWORK*]
28
| [--gateway=*GATEWAY*]
29
| [--add-reserved-ips=*RESERVEDIPS*]
30
| [--network6=*NETWORK6*]
31
| [--gateway6=*GATEWAY6*]
32
| [--mac-prefix=*MACPREFIX*]
33
| [--network-type=*NETWORKTYPE*]
34
| [--submit]
35
| {*network*}
36

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

    
41
The ``--network`` option allows you to specify the network in a CIDR notation.
42

    
43
The ``--gateway`` option allows you to specify the default gateway for this
44
network.
45

    
46
The ``--network-type`` can be none, private or public.
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 values
50
can be used for EUI64 generation from a NIC's MAC address.
51

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

    
54
MODIFY
55
~~~~~~
56

    
57
| **modify**
58
| [--gateway=*GATEWAY*]
59
| [--add-reserved-ips=*RESERVEDIPS*]
60
| [--remove-reserved-ips=*RESERVEDIPS*]
61
| [--network6=*NETWORK6*]
62
| [--gateway6=*GATEWAY6*]
63
| [--mac-prefix=*MACPREFIX*]
64
| [--network-type=*NETWORKTYPE*]
65
| [--submit]
66
| {*network*}
67

    
68
Modifies parameters from the network.
69

    
70
Unable to modify network (IP address range). Create a new network if you want
71
to do so. All other options are documented in the **add** command above.
72

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

    
75
REMOVE
76
~~~~~~
77

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

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

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

    
84
LIST
85
~~~~
86

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

    
90
Lists all existing networks in the cluster. If no group names are given, then
91
all groups are included. Otherwise, only the named groups will be listed.
92

    
93
The ``--no-headers`` option will skip the initial header line. The
94
``--separator`` option takes an argument which denotes what will be
95
used between the output fields. Both these options are to help
96
scripting.
97

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

    
101
The ``-o`` option takes a comma-separated list of output fields.
102
If the value of the option starts with the character ``+``, the new
103
fields will be added to the default list. This allows to quickly
104
see the default list plus a few other fields, instead of retyping
105
the entire list of fields.
106

    
107
The available fields and their meaning are:
108

    
109
@QUERY_FIELDS_NETWORK@
110

    
111
LIST-FIELDS
112
~~~~~~~~~~~
113

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

    
116
List available fields for networks.
117

    
118
TAGS
119
~~~
120

    
121
ADD-TAGS
122
^^^^^^^^
123

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

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

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

    
135
LIST-TAGS
136
^^^^^^^^^
137

    
138
**list-tags** {*networkname*}
139

    
140
List the tags of the given network.
141

    
142
REMOVE-TAGS
143
^^^^^^^^^^^
144

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

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

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

    
156

    
157
INFO
158
~~~~
159

    
160
| **info** [network...]
161

    
162
Displays information about a given network.
163

    
164
CONNECT
165
~~~~~~~
166

    
167
| **connect** {*network*} {*mode*} {*link*} [*groups*...]
168

    
169
Connect a network to given node groups (all if not specified) with the network
170
parameters *mode* and *link*. Every network interface will inherit those
171
parameters if assigned in a network.
172

    
173
DISCONNECT
174
~~~~~~~~~~
175

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

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