Statistics
| Branch: | Tag: | Revision:

root / man / gnt-network.rst @ d89f8b5f

History | View | Annotate | Download (4.2 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
| [--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
| [--reserved-ips=*RESERVEDIPS*]
57
| [--network6=*NETWORK6*]
58
| [--gateway6=*GATEWAY6*]
59
| [--mac-prefix=*MACPREFIX*]
60
| [--network-type=*NETWORKTYPE*]
61
| {*network*}
62

    
63
Modifies parameters from the network.
64

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

    
68
REMOVE
69
~~~~~~
70

    
71
| **remove** {*network*}
72

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

    
75
LIST
76
~~~~
77

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

    
81
Lists all existing networks in the cluster.
82

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

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

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

    
97
The available fields and their meaning are:
98

    
99
name
100
    the group name
101

    
102
group_count
103
    the number of nodegroups connected to the network
104

    
105
group_list
106
    the list of nodegroups connected to the network
107

    
108
inst_cnt
109
    the number of instances use the network
110

    
111
inst_list
112
    the list of instances that at least one of their NICs is assigned
113
    to the network
114

    
115
external_reservations
116
    the IPs that cannot be assigned to an instance
117

    
118
free_count
119
    how many IPs have left in the pool
120

    
121
gateway
122
    the networks gateway
123

    
124
map
125
    a nice text depiction of the available/reserved IPs in the network
126

    
127
reserved_count
128
    how many IPs have been reserved so far in the network
129

    
130
network6
131
    the ipv6 prefix of the network
132

    
133
gateway6
134
    the ipv6 gateway of the network
135

    
136
mac_prefix
137
    the mac_prefix of the network (if a NIC is assigned to the network it
138
    it gets the mac_prefix of the network)
139

    
140
network_type
141
    the type of the network (public, private)
142

    
143
If no group names are given, then all groups are included. Otherwise,
144
only the named groups will be listed.
145

    
146
LIST-FIELDS
147
~~~~~~~~~~~
148

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

    
151
List available fields for networks.
152

    
153
RENAME
154
~~~~~~
155

    
156
| **rename** {*oldname*} {*newname*}
157

    
158
Renames a given network from *oldname* to *newname*. NOT implemeted yet
159

    
160
INFO
161
~~~~
162

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

    
165
Displays information about a given network.
166

    
167
CONNECT
168
~~~~~~~
169
| **connect** {*network*} {*group*} {*mode*} {*link*}
170

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

    
175
DISCONNECT
176
~~~~~~~~~~
177
| **disconnect** {*network*} {*group*}
178

    
179
Disconnect a network to a nodegroup. This is possible only if no instance 
180
is using the network.