6324 Add an `ndp' tool for manipulating the neighbors table
[illumos-gate.git] / usr / src / man / man1m / netstrategy.1m
blob5c3dbe8cebee3edaf7a0089a036e65541da96b30
1 '\" te
2 .\" Copyright (c) 2006, 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 NETSTRATEGY 1M "May 5, 2007"
7 .SH NAME
8 netstrategy \- return network configuration information
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/sbin/netstrategy\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBnetstrategy\fR command determines the network configuration strategy in
19 use on a system and returns information in a form that is easily consumable by
20 a script. The command returns three tokens:
21 .sp
22 .in +2
23 .nf
24 \fI<root filesystem type>\fR \fI<primary interface>\fR \fI<network config strategy>\fR
25 .fi
26 .in -2
27 .sp
29 .sp
30 .LP
31 These tokens are described as follows:
32 .sp
33 .ne 2
34 .na
35 \fB\fI<root filesystem type>\fR\fR
36 .ad
37 .sp .6
38 .RS 4n
39 Type of filesystem that contains the bootable kernel, as would be specified in
40 the \fIfstype\fR column of the \fBmnttab\fR(4).
41 .RE
43 .sp
44 .ne 2
45 .na
46 \fB\fI<primary interface>\fR\fR
47 .ad
48 .sp .6
49 .RS 4n
50 Name of the primary network interface.  For a diskless machine, this is the
51 interface used to load the kernel.
52 .RE
54 .sp
55 .ne 2
56 .na
57 \fB\fI<network config strategy>\fR\fR
58 .ad
59 .sp .6
60 .RS 4n
61 The means by which a system obtains its IP address for booting. This can be one
62 of \fBrarp\fR, \fBdhcp\fR, or \fBnone\fR.
63 .RE
65 .sp
66 .LP
67 The \fBnetstrategy\fR command is not intended for use on a command line.
68 .SH OPTIONS
69 .sp
70 .LP
71 The \fBnetstrategy\fR command has no options.
72 .SH EXIT STATUS
73 .sp
74 .ne 2
75 .na
76 \fB\fB0\fR\fR
77 .ad
78 .RS 7n
79 Success.
80 .RE
82 .sp
83 .ne 2
84 .na
85 \fB\fB!=0\fR\fR
86 .ad
87 .RS 7n
88 An error occurred.
89 .RE
91 .SH ATTRIBUTES
92 .sp
93 .LP
94 See \fBattributes\fR(5) for descriptions of the following attributes:
95 .sp
97 .sp
98 .TS
99 box;
100 c | c
101 l | l .
102 ATTRIBUTE TYPE  ATTRIBUTE VALUE
104 Interface Stability     Evolving
107 .SH SEE ALSO
110 \fBifconfig\fR(1M), \fBmnttab\fR(4), \fBattributes\fR(5)