1sysidcfg(4) File Formats sysidcfg(4)
2
6 sysidcfg - system identification configuration file
7
9 When a diskless client boots for the first time or a system installs
10 over the network, the booting software tries to obtain configuration
11 information about the system, such as the system's root password or
12 name service, from, first, a sysidcfg file and then the name service
13 databases. If the booting software cannot find the information, it
14 prompts the user for it. Like the name service databases, the sysidcfg
15 file can be used to avoid the user prompts and provide a totally hands-
16 off booting process.
17 The sysidcfg file preconfigures information through a set of keywords.
20 You can specify one or more of the keywords to preconfigure as much
21 information as you want. Each set of systems (one or more) that has
22 unique configuration information must have its own sysidcfg file. For
23 example, you can use the same sysidcfg file to preconfigure the time
24 zone for multiple systems if you want all the systems to have the same
25 time zone configured. However, if you want to preconfigure a different
26 root password for each of those systems, then each system would need
27 its own sysidcfg file.
28 If a syntax error (such as an invalid keyword) is detected when reading
31 the sysidcfg file, an error message that notes the position in the file
32 where the error was found is sent to the console. Under such a condi‐
33 tion, the file is not used.
34 Where To Put the sysidcfg File
36 The sysidcfg file can reside on a shared NFS network directory or the
37 root directory on a UFS or PCFS diskette in the system's diskette
38 drive. If you put the sysidcfg file on a shared NFS network directory,
39 you have to use the -p option of the add_install_client(1M) command
40 (see install_scripts(1M)) to specify where the system being installed
41 can find the sysidcfg file. If you put the sysidcfg file on a diskette,
42 you need to make sure the diskette is in the system's diskette drive
43 when the system boots (on x86 systems, the sysidcfg file should reside
44 on the Solaris Device Configuration Assistant diskette).
45 Only one sysidcfg file can reside in a directory or diskette. If you
48 are creating more than one sysidcfg file, they must reside in different
49 directories or diskettes.
50 Keyword Syntax Rules
52 The following rules apply to the keywords in a sysidcfg file:
53 o Keywords can be in any order
55 o Keywords are not case-sensitive
57 o Keyword values can be optionally enclosed in single (') or
59 double (") quotes
60 o Only the first instance of a keyword is valid; if you spec‐
62 ify the same keyword more than once, the first keyword spec‐
63 ified is used. The network_interface keyword is exempt from
64 this rule.
65 Keywords - All Platforms
67 The following keywords apply to both SPARC and x86 platforms.
68 Name Service, Domain Name, Name Server
70 Naming-related keywords are as follows:
71 name_service=NIS,NIS+,LDAP,DNS,NONE
73 For the NIS and NIS+ keywords, the options are:
77 domain_name=domain_name
79 name_server=hostname(ip_address)
80 The following is an example NIS entry:
84 name_service=NIS
86 {domain_name=west.arp.com name_server=timber(172.16.2.1)}
87 For NIS+, the example is identical to the one above, except for the
91 replacement of the keyword NIS by NIS+.
92 For DNS, the syntax is:
95 domain_name=domain_name; name_server=ip_address, ... ;
97 search=domain_name, ...
98 You can have a maximum of three IP addresses and six domain names. The
102 total length of a search entry cannot exceed 250 characters. The fol‐
103 lowing is an example DNS entry:
104 name_service=DNS
106 {domain_name=west.arp.com
107 name_server=10.0.1.10,10.0.1.20
108 search=arp.com,east.arp.com}
109 For LDAP, the syntax is:
113 domain_name=domain_name;
115 profile=profile_name;
116 profile_server=ip_address;
117 proxy_dn="proxy_bind_dn";
118 proxy_password=password
119 The proxy_dn and proxy_password keywords are optional. If proxy_dn is
123 used, the value must be enclosed in double quotes.
124 The following is an example LDAP entry:
127 name_service=LDAP
129 {domain_name=west.arp.com
130 profile=default
131 profile_server=172.16.2.1
132 proxy_dn="cn=proxyagent,ou=profile,dc=west,dc=arp,dc=com"
133 proxy_password=password}
134 Choose only one value for name_service. Include either, both, or nei‐
138 ther of the domain_name and name_server keywords, as needed. If no key‐
139 words are used, omit the curly braces.
140 NFS version 4 Default Domain Name
142 There is only one keyword for specifying the NFSv4 default domain name:
143 nfs4_domain=dynamic, value
145 where value must be a fully qualified domain name, as per RFC1033 and
149 RFC1035 recommendations. The reserved value dynamic suppresses the
150 front-end installation prompt. At the same time, use of dynamic enables
151 the NFSv4 domain to be derived dynamically, at run time, based on nam‐
152 ing service configuration.
153 For example:
156 nfs4_domain=example.com
158 ...hard codes the value used by the nfsmapid(1M) daemon to be exam‐
162 ple.com. In contrast, the following example shows how to set the
163 nfs4_domain variable to the reserved keyword dynamic:
164 nfs4_domain=dynamic
166 The preceding example enables the nfsmapid(1M) daemon to derive the
170 domain from the system's configured naming services, as prescribed in
171 the System Administration Guide: Network Services.
172 Network Interface, Hostname, IP address, Netmask, DHCP, Default Route
174 Network-related keywords are as follows:
175 network_interface=NONE, PRIMARY, value
177 where value is a name of a network interface, for example, eri0 or
181 hme0.
182 For the NONE keyword, the options are:
185 hostname=hostname
187 For example,
191 network_interface=NONE {hostname=feron}
193 For the PRIMARY and value keywords, the options are:
197 primary (used only with multiple network_interface lines)
199 dhcp
200 hostname=hostname
201 ip_address=ip_address
202 netmask=netmask
203 protocol_ipv6=yes | no
204 default_route=ip_address (IPv4 address only)
205 If you are using the dhcp option, the only other option you can specify
209 is protocol_ipv6. For example:
210 network_interface=PRIMARY {dhcp protocol_ipv6=yes}
212 If you are not using DHCP, you can specify any combination of the other
216 keywords as needed. If you do not use any of the keywords, omit the
217 curly braces.
218 network_interface=eri0 {hostname=feron
220 ip_address=172.16.2.7
221 netmask=255.255.255.0
222 protocol_ipv6=no
223 default_route=172.16.2.1}
224 Multiple Network Interfaces
227 If you have multiple network interfaces on your system, you can config‐
228 ure them all in the sysidcfg file by defining multiple network_inter‐
229 face keywords. If you specify multiple network_interface keywords, you
230 cannot use NONE or PRIMARY for values. You must specify interface names
231 for all of the values. To specify the primary interface, use the pri‐
232 mary option value.
233 For example,
236 network_interface=eri0 {primary
238 hostname=feron
239 ip_address=172.16.2.7
240 netmask=255.255.255.0
241 protocol_ipv6=no
242 default_route=172.16.2.1}
243 network_interface=eri1 {hostname=feron-b
245 ip_address=172.16.3.8
246 netmask=255.255.255.0
247 protocol_ipv6=no
248 default_route=172.16.3.1}
249 Root Password
252 The root password keyword is root_password. Possible values are
253 encrypted from /etc/shadow. Syntax is:
254 root_password=encrypted_password
256 Security Policy
259 The security—related keyword is security_policy. It has the following
260 syntax:
261 security_policy=kerberos, NONE
263 The kerberos keyword has the following options:
267 {default_realm=FQDN admin_server=FQDN kdc=FQDN1, FQDN2, FQDN3}
269 where FQDN is a fully qualified domain name. An example of the secu‐
273 rity_policy keyword is as follows:
274 security_policy=kerberos {default_realm=Yoursite.COM
276 admin_server=krbadmin.Yoursite.COM
277 kdc=kdc1.Yoursite.COM, kdc2.Yoursite.COM}
278 You can list a maximum of three key distribution centers (KDCs) for a
282 security_policy keyword. At least one is required.
283 Language in Which to Display the Install Program
285 The system-location keyword is system_locale. It has the following syn‐
286 tax:
287 system_locale=locale
289 where locale is /usr/lib/locale.
293 Terminal Type
295 The terminal keyword is terminal. It has the following syntax:
296 terminal=terminal_type
298 where terminal_type is a value from /usr/share/lib/terminfo/*.
302 Timezone Information
304 The timezone keyword is timezone. It has the following syntax:
305 timezone=timezone
307 where timezone is a value from /usr/share/lib/zoneinfo/*or, where time‐
311 zone is an offset-from-GMT style quoted timezone. Refer to environ(5)
312 for information on quoted timezones. An example of a quoted timezone
313 is: timezone="<GMT+8>+8".
314 Date and Time
316 The time server keyword is timeserver. It has the following syntax:
317 timeserver=localhost
319 timeserver=hostname
320 timeserver=ip_address
321 If you specify localhost as the time server, the system's time is
325 assumed to be correct. If you specify the hostname or ip_address, if
326 you are not running a name service, of a system, that system's time is
327 used to set the time.
328 Keyboard Layout
330 The keyboard keyword is keyboard. It has the following syntax:
331 keyboard=keyboard_layout
333 The valid keyboard_layout strings are defined in the
337 /usr/share/lib/keytables/type_6/kbd_layouts file.
338
340 Example 1 Sample sysidcfg files
341 The following example is a sysidcfg file for a group of SPARC systems
344 to install over the network. The host names, IP addresses, and netmask
345 of these systems have been preconfigured by editing the name service.
346 Because all the system configuration information has been preconfig‐
347 ured, an automated installation can be achieved by using this sysidcfg
348 file in conjunction with a custom JumpStart profile.
349 keyboard=US-English
352 system_locale=en_US
353 timezone=US/Central
354 timeserver=localhost
355 terminal=sun-cmd
356 name_service=NIS {domain_name=marquee.central.example.com
357 name_server=connor(172.16.112.3)}
358 root_password=m4QPOWNY
359 system_locale=C
360 security_policy=kerberos
361 {default_realm=Yoursite.COM
362 admin_server=krbadmin.Yoursite.COM
363 kdc=kdc1.Yoursite.COM, kdc2.Yoursite.COM}
364 The following example is a sysidcfg file created for a group of x86
368 systems to install over the network that all have the same keyboard,
369 graphics cards, and pointing devices. In this example, users would see
370 only the prompt to select a language, system_locale, for displaying the
371 rest of the Solaris installation program.
372 keyboard=US-English
375 display=ati {size=15-inch}
376 pointer=MS-S
377 timezone=US/Central
378 timeserver=connor
379 terminal=AT386
380 name_service=NIS {domain_name=marquee.central.example.com
381 name_server=connor(172.16.112.3)}
382 root_password=URFUni9
383 security_policy=none
384
387 install_scripts(1M), nfsmapid(1M), sysidtool(1M), environ(5)
388 Solaris Express Installation Guide: Basic Installations
391SunOS 5.11 23 Jun 2009 sysidcfg(4)