usr/src/man/man4/bootparams.4

   1 '\" te
   2 .\" Copyright 2017 Peter Tribble
   3 .\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH BOOTPARAMS 4 "May 13, 2017"
   8 .SH NAME
   9 bootparams \- boot parameter data base
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/etc/bootparams\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .LP
  18 The \fBbootparams\fR file contains a list of client entries that diskless
  19 clients use for booting. Diskless booting clients retrieve this information by
  20 issuing requests to a server running the \fBrpc.bootparamd\fR(1M) program. The
  21 \fBbootparams\fR file may be used in conjunction with or in place of other
  22 sources for the \fBbootparams\fR information. See \fBnsswitch.conf\fR(4).
  23 .sp
  24 .LP
  25 For each client the file contains an entry with the client's name and a list of
  26 boot parameter values for that client. Each entry has the form:
  27 .sp
  28 .in +2
  29 .nf
  30 \fIclientname    keyword=value\fR...
  31 .fi
  32 .in -2
  33 .sp
  34
  35 .sp
  36 .LP
  37 The first item of each entry is the host name of the diskless client. You can
  38 use the asterisk ('*') character as a "wildcard" in place of the client name in
  39 a single entry. A wildcard entry applies to all clients for which there is not
  40 an entry that specifically names them.
  41 .sp
  42 .LP
  43 In a given entry, the host name or asterisk is followed by one or more
  44 whitespace characters and a series of keyword\(emvalue pairs separated by
  45 whitespace characters. There must not be any whitespace within a
  46 keyword\(emvalue pair.
  47 .sp
  48 .LP
  49 Each keyword\(emvalue pair has the syntax:
  50 .sp
  51 .in +2
  52 .nf
  53 \fIkeyword\fR\fB=\fR\fIvalue\fR
  54 .fi
  55 .in -2
  56 .sp
  57
  58 .sp
  59 .LP
  60 The preceding form breaks out further as:
  61 .sp
  62 .in +2
  63 .nf
  64 \fIkeyword\fR\fB=\fR\fIserver\fR\fB:\fR\fIvalue\fR
  65 .fi
  66 .in -2
  67 .sp
  68
  69 .sp
  70 .LP
  71 Where \fIserver\fR can be null and \fIvalue\fR can be a pathname.
  72 .sp
  73 .LP
  74 An example that includes a server is:
  75 .sp
  76 .in +2
  77 .nf
  78 client1 root=server1:/export/client1/root
  79 .fi
  80 .in -2
  81 .sp
  82
  83 .sp
  84 .LP
  85 An example where \fIserver\fR is null is:
  86 .sp
  87 .in +2
  88 .nf
  89 client1 rootopts=:vers2
  90 .fi
  91 .in -2
  92 .sp
  93
  94 .sp
  95 .LP
  96 A minor variation of the \fIkeyword=value\fR syntax is used for the
  97 \fBdomain\fR keyword. Unlike the forms shown above, this syntax does not use a
  98 colon. For example:
  99 .sp
 100 .in +2
 101 .nf
 102 client1 domain=bldg1.workco.com
 103 .fi
 104 .in -2
 105 .sp
 106
 107 .sp
 108 .LP
 109 Entries can span multiple lines. Use the backslash ('\e') character as the last
 110 character of a line to continue the entry to the following line. For
 111 multiple-line entries, you can split a line only in places where whitespace is
 112 allowed. For example, you can use a backslash to split the following entry
 113 between the end of the path (\fBroot\fR) and the keyword \fBdomain\fR:
 114 .sp
 115 .in +2
 116 .nf
 117 client1 root=server1:/export/client1/root domain=bldg1.workco.com
 118 .fi
 119 .in -2
 120 .sp
 121
 122 .sp
 123 .LP
 124 In entries that specify a server, \fIserver\fR is the name of the server that
 125 will provide the file or filesystem to the diskless client and \fIvalue\fR is
 126 the pathname of the exported file or filesystem on that server.
 127 .sp
 128 .LP
 129 In entries that use the \fBdomain\fR keyword, the domain name specified must be
 130 the client's domain name. The algorithm for determining a client's domain name
 131 is to first check for a \fBdomain\fR keyword in the client-specific entry and
 132 then in "wildcard" entry. If none is found, the server's domain name is used.
 133 .sp
 134 .LP
 135 For the JumpStart installation of machines that do not have video displays, use
 136 the \fBterm\fR keyword to identify the terminal type of the boot server.
 137 Terminal types are listed in \fB/usr/share/lib/terminfo\fR (see
 138 \fBterminfo\fR(4)).
 139 .sp
 140 .LP
 141 An entry with the \fBns\fR keyword associates a server (a name server) with,
 142 instead of a pathname, a specific name service (\fBNIS+\fR, \fBNIS\fR,
 143 \fBLDAP\fR, or \fBnone\fR) and, if that server is not on a local subnet, the
 144 netmask needed to reach it. For example:
 145 .sp
 146 .in +2
 147 .nf
 148 ns=hoot:nisplus(255.255.255.0)
 149 .fi
 150 .in -2
 151 .sp
 152
 153 .sp
 154 .LP
 155 An \fBns\fR entry forces \fBsysidtool\fR to use the specified name service.
 156 By default, \fBsysidtool\fR uses \fBNIS+\fR in preference to \fBNIS\fR or
 157 \fBLDAP\fR if it can find an \fBNIS+\fR server for the system's domain on the
 158 subnet. An \fBns\fR entry might be necessary if you are trying to set up a
 159 hands-off installation, or if the name server is on a different subnet, which
 160 is common with \fBNIS+\fR.
 161 .sp
 162 .LP
 163 If an \fBns\fR keyword is not used, \fBsysidtool\fR uses broadcast to attempt
 164 to bind to either a \fBNIS+\fR, \fBNIS\fR, or \fBLDAP\fR server. If a name
 165 server is not on the local subnet, which is possible for \fBNIS+\fR or
 166 \fBLDAP\fR, the bind will fail, automatic configuration of the name service
 167 will fail, and an interactive screen is displayed, prompting the user to
 168 specify the name service.
 169 .sp
 170 .LP
 171 The \fBns\fR keyword can be set in \fBadd_install_client\fR or by Host Manager.
 172 .SH EXAMPLES
 173 .LP
 174 \fBExample 1 \fRSample \fBbootparams\fR Entry
 175 .sp
 176 .LP
 177 Here is an example of an entry in the \fBbootparams\fR file:
 178
 179 .sp
 180 .in +2
 181 .nf
 182         client1 root=server1:/export/client1/root rootopts=:vers=2 \e
 183                 domain=bldg1.workco.com
 184         client2 root=server2:/export/client2/root ns=:nis
 185         client3 root=server2:/export/client3/root ns=watson:
 186         client4 root=server2:/export/client4/root \e
 187                 ns=mach:nisplus(255.255.255.0)
 188 .fi
 189 .in -2
 190 .sp
 191
 192 .LP
 193 \fBExample 2 \fRSample Entry for JumpStart
 194 .sp
 195 .LP
 196 The following is an example of an entry that might be used for the JumpStart
 197 installation of diskless clients that do not have displays.
 198
 199 .sp
 200 .in +2
 201 .nf
 202 mozart root=haydn:/export/install/sparc/os/latest/Solaris_9/boot \e
 203 install=haydn:/export/install/sparc/os/8.1/latest boottype=:in \e
 204 install_config=haydn:/usr/local/share/lib/jump-net \e
 205 ns=otis:nisplus(255.255.255.0) term=:xterms domain=eu.cte.work.com
 206 .fi
 207 .in -2
 208 .sp
 209
 210 .SH FILES
 211 .ne 2
 212 .na
 213 \fB\fB/etc/bootparams\fR\fR
 214 .ad
 215 .RS 19n
 216
 217 .RE
 218
 219 .SH SEE ALSO
 220 .LP
 221 \fBrpc.bootparamd\fR(1M), \fBnsswitch.conf\fR(4)
 222 .SH NOTES
 223 .LP
 224 The \fBNIS+\fR, \fBsysidtool\fR, and jumpstart facilities are not present in
 225 illumos. They are documented here solely for users who wish to use illumos as
 226 a jumpstart server for older Solaris releases.
 227 .sp
 228 .LP
 229 Solaris diskless clients use the keywords \fBroot\fR and \fBrootopts\fR to look
 230 up the pathname for the root filesystem and the mount options for the root
 231 filesystem, respectively. These are the only keywords meaningful for diskless
 232 booting clients. See \fBmount_ufs\fR(1M).