Added some line breaks in BOOTPROTO section.
[opensuse:chkpnts-sysconfig.git] / doc / ifcfg-vlan.5
1 .\" Process this file with
2 .\" groff -man -Tascii foo.1
3 .\"
4 .TH IFCFG-VLAN 5 "August 2004" "sysconfig" "Network configuration"
5 .\" ...
6
7 .SH NAME
8 ifcfg-vlan \- virtual LAN interface configuration
9 .SH SYNOPSIS
10 .B /etc/sysconfig/network/ifcfg-vlan*
11
12 .SH Virtual LANs (802.1q)
13 To setup a vlan interface you need a configuration file that contains at
14 least the mandatory
15 .TP
16 .B ETHERDEVICE 
17 variable with the real interface used for the virtual LAN.
18
19 .PP
20 Further, it may contain the optional
21 .TP
22 .B VLAN_ID
23 variable that specifies the VLAN ID.
24
25 .PP
26 By default and when the \fBVLAN_ID\fR variable is \fInot\fR set, the
27 number at the end of the interface name is the VLAN ID.
28
29 Preferably the interface name and the configuration file follow the
30 VLAN interface name scheme (type), that is either:
31 .RS
32 .PD 0
33 .P
34 ifcfg-\fBvlan\fR<\fBVLAN-ID\fR> (e.g. ifcfg-\fIvlan42\fR)
35
36 or
37
38 .P
39 ifcfg-\fBname\fR.<\fBVLAN-ID\fR> (e.g. ifcfg-\fIeth0.42\fR)
40 .PD
41 .RE
42
43 The VLAN-ID can be also 0-padded (e.g. ifcfg-vlan0042 or ifcfg-eth0.0042).
44
45 Also in case of custom names, trailing digits are interpreted as VLAN-ID
46 by default (e.g. ifcfg-dmz42). When \fBVLAN_ID\fR is set in the config,
47 the interface name have any name (e.g. ifcfg-foobar).
48
49 Note: The drawback of custom interface names and VLAN_ID usage is,
50 that a rename of the interface is required and that they violate
51 the name scheme.
52
53 .PP
54 The real interface will be set UP automatically and doesn't need a config
55 file in case of a physical interface. But without a config file YaST will
56 consider this interface as unused, if will not follow hotplug events and
57 you're unable to apply any settings, e.g. ETHTOOL_OPTIONS. To avoid that,
58 provide an config file with at least STARTMODE='auto'.
59
60 The rest of the VLAN interface IP and routes configuration do not differ
61 from ordinary interfaces. See also \fIman\ ifcfg\fR and \fIman\ routes\fR
62 for details.
63
64 .SH EXAMPLES
65 .TP
66 Sets up \fIvlan3\fR vlan interface on top of \fBeth0\fR:
67
68 .I ifcfg-vlan3
69 .nf
70    STARTMODE='auto'
71    ETHERDEVICE='\fBeth0\fR'
72    IPADDR='192.168.3.27/24'
73 .fi
74
75 .TP
76 Sets up \fIeth0.3\fR vlan interface on top of \fBeth0\fR:
77
78 .I ifcfg-eth0.3
79 .nf
80    STARTMODE='auto'
81    ETHERDEVICE='\fBeth0\fR'
82    IPADDR='192.168.3.27/24'
83 .fi
84
85 .TP
86 Sets up \fIlan1\fR vlan interface with ID \fB42\fR on top of \fBeth0\fR:
87
88 .I ifcfg-lan1
89 .nf
90    STARTMODE='auto'
91    ETHERDEVICE='\fBeth0\fR'
92    VLAN_ID='\fB42\fR'
93    IPADDR='192.168.3.27/24'
94 .fi
95
96 .SH BUGS
97 Please report bugs at <http://www.suse.de/feedback>
98 .SH AUTHOR
99 .nf
100 Christian Zoz <zoz@suse.de>
101 Michal Svec <msvec@suse.cz>
102 Bjoern Jacke
103 Mads Martin Joergensen <mmj@suse.de>
104 Michal Ludvig <mludvig@suse.cz>
105 Marius Tomaschewski <mt@suse.de>
106 .fi
107 .SH "SEE ALSO"
108 .BR routes (5),
109 .BR ifcfg (5),
110 .BR ifup (8).