293 useradd/del/mod should be ZFS-aware
[illumos-gate.git] / usr / src / man / man1m / nwamd.1m
blobf27b26213247a56ae1547516769aef69eddbcda9
1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH NWAMD 1M "Nov 24, 2008"
7 .SH NAME
8 nwamd \- network auto-magic daemon
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/lib/inet/nwamd\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 \fBnwamd\fR is a system daemon to manage network interfaces.
19 .sp
20 .LP
21 This daemon is started automatically and should not be invoked directly. It
22 does not constitute a programming interface.
23 .SS "Operation"
24 .sp
25 .LP
26 Whether this daemon is enabled or not depends on your installation medium. To
27 check from within the GNOME desktop environment, double click on the "Network
28 Manager" icon to open the "Connection Properties" window. If "Configure network
29 automatically" is checked, then auto-magic mode is enabled. To check from the
30 command line, enter the following:
31 .sp
32 .in +2
33 .nf
34 % \fBsvcs svc:/network/physical\fR
35 .fi
36 .in -2
37 .sp
39 .sp
40 .LP
41 Two instances will be listed, one online and the other disabled. If the "nwam"
42 instance is online, then this daemon is running.
43 .sp
44 .LP
45 To switch between manual and auto-magic mode, you can use the Network Monitor
46 applet available within the GNOME desktop environment. You can also switch
47 manually from the command line by entering:
48 .sp
49 .in +2
50 .nf
51 % \fBsvcadm disable svc:/network/physical:default\fR
52 % \fBsvcadm enable svc:/network/physical:nwam\fR
53 .fi
54 .in -2
55 .sp
57 .sp
58 .LP
59 To go from auto-magic mode to manual mode:
60 .sp
61 .in +2
62 .nf
63 % \fBsvcadm disable svc:/network/physical:nwam\fR
64 % \fBsvcadm enable svc:/network/physical:default\fR
65 .fi
66 .in -2
67 .sp
69 .sp
70 .LP
71 When switching modes like this, keep in mind that all network interfaces will
72 be brought down then back up. Therefore, if a different \fBIP\fR address is
73 configured in this process, existing applications and sessions might be
74 disrupted.
75 .sp
76 .LP
77 There is a limitation that only one link is active at a time in auto-magic
78 mode. This mode is not recommended for machines that use more than one link at
79 a time. For machines with wired and wireless links, wired link are preferred by
80 default, although this can be adjusted from the GNOME NWAM Manager menu
81 (right-click on the icon), or from the command line, by editing the plain text
82 file  \fB/etc/nwam/llp\fR.  For the latter (hand-editing) procedure, the first
83 instance of a link in  \fB/etc/nwam/llp\fR sets the priority of that link.
84 Subsequent instances of that link set parameters associated with the interface
85 on that link.
86 .sp
87 .LP
88 The \fB/etc/nwam/llp\fR interface is volatile and might  change in a future
89 release.
90 .SS "Static IP Addresses"
91 .sp
92 .LP
93 A static IP address can be configured by changing the line in the
94 \fB/etc/nwam/llp\fR file that contains an interface name and the name of the
95 method for obtaining an IP address. It might look like:
96 .sp
97 .in +2
98 .nf
99 nge0    dhcp
101 .in -2
106 Change this line to one that looks like:
108 .in +2
110 nge0    static  \fII\fR1.\fII\fR2.\fII\fR3.\fII\fR4/\fIP\fR
112 .in -2
117 \&...where the I's are the digits of the IPv4 address and the \fIP\fR is an
118 optional prefix. If the prefix is not provided, it is derived, using classful
119 assumptions.
120 .SS "Configuring IPv6"
123 IPv6 is configured by default on a link. It can also be explicitly added in the
124 \fB/etc/nwam/llp\fR file by providing a line that contains an interface name
125 and the string \fBipv6\fR. It might look like:
127 .in +2
129 nge0    ipv6
131 .in -2
136 If IPv6 should not be plumbed on a given link, a \fBnoipv6\fR entry should be
137 created in the \fB/etc/nwam/llp\fR file for that link. It might look like:
139 .in +2
141 nge0 noipv6
143 .in -2
148 An optional static IPv6 address can be provided on the same line, immediately
149 after the \fBipv6\fR token. Whether you provide a static address or not, IPv6
150 will use DHCPv6 or stateless address configuration, as directed by the local
151 network configuration.
152 .SS "PROFILES"
155 All interfaces listed in this section are volatile and may change in a future
156 release. They are documented here so that those wishing to experiment with this
157 may do so.
160 Profiles are a mechanism for making multiple related changes to the system
161 configuration after \fBIP\fR service is available.
164 There is no direct support for the profiles yet, but a "roll your own"
165 mechanism is provided for now. Once an interface is brought up and an \fBIP\fR
166 address is configured for it, the daemon looks for the file
167 \fB/etc/nwam/ulp/check-conditions\fR. If this file exists and is executable, it
168 is run. This should print a single line of output, which is the name of the
169 profile that the user wishes to activate based on the current conditions. If
170 such a line is read successfully (\fIfoo\fR in this example), then
171 \fB/etc/nwam/ulp/foo/bringup\fR is executed. Likewise, when the interface gets
172 torn down for whatever reason, \fB/etc/nwam/ulp/foo/teardown\fR is executed.
173 The "bringup" and "teardown" scripts are invoked via \fBpfexec\fR(1) with
174 default basic privileges. Samples for each of these scripts can be found at:
175 .RS +4
177 .ie t \(bu
178 .el o
179 http://opensolaris.org/os/project/nwam/prototype/check-conditions
181 .RS +4
183 .ie t \(bu
184 .el o
185 http://opensolaris.org/os/project/nwam/prototype/bringup
187 .RS +4
189 .ie t \(bu
190 .el o
191 http://opensolaris.org/os/project/nwam/prototype/teardown
193 .SS "Wireless"
196 If no wired link is available, a scan for wireless \fBLAN\fRs is done, and the
197 resulting list offered via a \fBGUI\fR popup window prompts the console user to
198 select a preference. If a successful connection is made, the \fBWLAN\fR in
199 question is stored in the plain text file \fB/etc/nwam/known_wifi_nets\fR and
200 the daemon may connect to any \fBWLAN\fR in that list without prompting the
201 user again. If a user wishes to add other preferences or revoke existing ones,
202 he can do so by bringing up the NWAM Manager menu with right-click on the icon,
203 and then selecting "Manage Favorite Wireless Networks...". A user can also edit
204 the \fBknown_wifi_nets\fR file directly. This interface is volatile and might
205 change in a future release.
206 .SH ATTRIBUTES
209 See \fBattributes\fR(5) for descriptions of the following attributes:
214 box;
215 c | c
216 l | l .
217 ATTRIBUTE TYPE  ATTRIBUTE VALUE
219 Interface Stability     Volatile
222 .SH SEE ALSO
225 \fBsvcs\fR(1), \fBsvcadm\fR(1M), \fBattributes\fR(5), \fBsmf\fR(5)
228 See also \fBnwam-manager(1M)\fR, available in the JDS/GNOME man page
229 collection.
230 .SH NOTES
233 The networking service is managed by the service management facility,
234 \fBsmf\fR(5), under the service identifier:
236 .in +2
238 svc:/network/physical
240 .in -2
245 Administrative actions on this service, such as enabling, disabling, or
246 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
247 status can be queried using the \fBsvcs\fR(1) command.