Statistics
| Branch: | Tag: | Revision:

root / man / gnt-network.rst @ d6f3a69d

History | View | Annotate | Download (4.5 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
| {*network*}
35

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

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

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

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

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

    
51
MODIFY
52
~~~~~~
53

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

    
64
Modifies parameters from the network.
65

    
66
Unable to modify network (ip range). Create a new network if you want to do
67
so. All other options are documented in the **add** command above.
68

    
69
REMOVE
70
~~~~~~
71

    
72
| **remove** {*network*}
73

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

    
76
LIST
77
~~~~
78

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

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

    
85
The ``--no-headers`` option will skip the initial header line. The
86
``--separator`` option takes an argument which denotes what will be
87
used between the output fields. Both these options are to help
88
scripting.
89

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

    
93
The ``-o`` option takes a comma-separated list of output fields.
94
If the value of the option starts with the character ``+``, the new
95
fields will be added to the default list. This allows to quickly
96
see the default list plus a few other fields, instead of retyping
97
the entire list of fields.
98

    
99
The available fields and their meaning are:
100

    
101
@QUERY_FIELDS_NETWORK@
102

    
103
LIST-FIELDS
104
~~~~~~~~~~~
105

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

    
108
List available fields for networks.
109

    
110
RENAME
111
~~~~~~
112

    
113
| **rename** {*oldname*} {*newname*}
114

    
115
Renames a given network from *oldname* to *newname*. NOT implemeted yet
116

    
117
TAGS
118
~~~
119

    
120
ADD-TAGS
121
^^^^^^^^
122

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

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

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

    
134
LIST-TAGS
135
^^^^^^^^^
136

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

    
139
List the tags of the given network.
140

    
141
REMOVE-TAGS
142
^^^^^^^^^^^
143

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

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

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

    
155

    
156
INFO
157
~~~~
158

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

    
161
Displays information about a given network.
162

    
163
CONNECT
164
~~~~~~~
165
| **connect** {*network*} {*group*} {*mode*} {*link*}
166

    
167
Connect a network to a given nodegroup with the netparams (*mode*, *link*).
168
Every nic will inherit those netparams if assigned in a network.
169
*group* can be ``all`` if you want to connect to all existing nodegroups
170

    
171
DISCONNECT
172
~~~~~~~~~~
173
| **disconnect** {*network*} {*group*}
174

    
175
Disconnect a network to a nodegroup. This is possible only if no instance
176
is using the network.