Statistics
| Branch: | Tag: | Revision:

root / man / gnt-network.rst @ e23cb7ca

History | View | Annotate | Download (4.7 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
18
administration 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
42
notation.
43

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

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

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

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

    
56
MODIFY
57
~~~~~~
58

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

    
70
Modifies parameters from the network.
71

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

    
76
See **ganeti(7)** for a description of ``--submit`` and other common
77
options.
78

    
79
REMOVE
80
~~~~~~
81

    
82
| **remove** [--submit] {*network*}
83

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

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

    
88
LIST
89
~~~~
90

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

    
94
Lists all existing networks in the cluster. If no group names are given,
95
then all groups are included. Otherwise, only the named groups will be
96
listed.
97

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

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

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

    
111
The available fields and their meaning are:
112

    
113
@QUERY_FIELDS_NETWORK@
114

    
115
LIST-FIELDS
116
~~~~~~~~~~~
117

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

    
120
List available fields for networks.
121

    
122
TAGS
123
~~~
124

    
125
ADD-TAGS
126
^^^^^^^^
127

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

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

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

    
139
LIST-TAGS
140
^^^^^^^^^
141

    
142
**list-tags** {*networkname*}
143

    
144
List the tags of the given network.
145

    
146
REMOVE-TAGS
147
^^^^^^^^^^^
148

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

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

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

    
160

    
161
INFO
162
~~~~
163

    
164
| **info** [network...]
165

    
166
Displays information about a given network.
167

    
168
CONNECT
169
~~~~~~~
170

    
171
| **connect** {*network*} {*mode*} {*link*} [*groups*...]
172

    
173
Connect a network to given node groups (all if not specified) with the
174
network parameters *mode* and *link*. Every network interface will
175
inherit those parameters if assigned in a network.
176

    
177
DISCONNECT
178
~~~~~~~~~~
179

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

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

    
185
.. vim: set textwidth=72 :
186
.. Local Variables:
187
.. mode: rst
188
.. fill-column: 72
189
.. End: