File Formats sysidcfg(4)
NAME
sysidcfg - system identification configuration file
DESCRIPTION
When a diskless client boots for the first time or a system
installs over the network, the booting software tries to
obtain configuration information about the system, such as
the system's root password or name service, from, first, a
sysidcfg file and then the name service databases. If the
booting software cannot find the information, it prompts the
user for it. Like the name service databases, the sysidcfg
file can be used to avoid the user prompts and provide a
totally hands-off booting process.
The sysidcfg file preconfigures information through a set of
keywords. You can specify one or more of the keywords to
preconfigure as much information as you want. Each set of
systems (one or more) that has unique configuration informa-
tion must have its own sysidcfg file. For example, you can
use the same sysidcfg file to preconfigure the time zone for
multiple systems if you want all the systems to have the
same time zone configured. However, if you want to precon-
figure a different root password for each of those systems,
then each system would need its own sysidcfg file.
If a syntax error (such as an invalid keyword) is detected
when reading the sysidcfg file, an error message that notes
the position in the file where the error was found is sent
to the console. Under such a condition, the file is not
used.
Where To Put the sysidcfg File
The sysidcfg file can reside on a shared NFS network direc-
tory or the root directory on a UFS or PCFS diskette in the
system's diskette drive. If you put the sysidcfg file on a
shared NFS network directory, you have to use the -p option
of the addinstallclient(1M) command (see
installscripts(1M)) to specify where the system being
installed can find the sysidcfg file. If you put the
sysidcfg file on a diskette, you need to make sure the
diskette is in the system's diskette drive when the system
boots (on x86 systems, the sysidcfg file should reside on
the Solaris Device Configuration Assistant diskette).
Only one sysidcfg file can reside in a directory or
diskette. If you are creating more than one sysidcfg file,
they must reside in different directories or diskettes.
SunOS 5.11 Last change: 12 May 2008 1
File Formats sysidcfg(4)
Keyword Syntax Rules
The following rules apply to the keywords in a sysidcfg
file:
o Keywords can be in any order
o Keywords are not case-sensitive
o Keyword values can be optionally enclosed in single
(') or double (") quotes
o Only the first instance of a keyword is valid; if
you specify the same keyword more than once, the
first keyword specified is used. The
networkinterface keyword is exempt from this rule.
Keywords - All Platforms
The following keywords apply to both SPARC and x86 plat-
forms.
Name Service, Domain Name, Name Server
Naming-related keywords are as follows:
nameservice=NIS,NIS],LDAP,DNS,NONE
For the NIS and NIS] keywords, the options are:
domainname=domainname
nameserver=hostname(ipaddress)
The following is an example NIS entry:
nameservice=NIS
{domainname=west.arp.com nameserver=timber(172.16.2.1)}
For NIS], the example is identical to the one above, except
for the replacement of the keyword NIS by NIS].
For DNS, the syntax is:
domainname=domainname; nameserver=ipaddress, ... ;
search=domainname, ...
SunOS 5.11 Last change: 12 May 2008 2
File Formats sysidcfg(4)
You can have a maximum of three IP addresses and six domain
names. The total length of a search entry cannot exceed 250
characters. The following is an example DNS entry:
nameservice=DNS
{domainname=west.arp.com
nameserver=10.0.1.10,10.0.1.20
search=arp.com,east.arp.com}
For LDAP, the syntax is:
domainname=domainname;
profile=profilename;
profileserver=ipaddress;
proxydn="proxybinddn";
proxypassword=password
The proxydn and proxypassword keywords are optional. If
proxydn is used, the value must be enclosed in double
quotes.
The following is an example LDAP entry:
nameservice=LDAP
{domainname=west.arp.com
profile=default
profileserver=172.16.2.1
proxydn="cn=proxyagent,ou=profile,dc=west,dc=arp,dc=com"
proxypassword=password}
Choose only one value for nameservice. Include either,
both, or neither of the domainname and nameserver key-
words, as needed. If no keywords are used, omit the curly
braces.
NFS version 4 Default Domain Name
There is only one keyword for specifying the NFSv4 default
domain name:
nfs4domain=dynamic, value
where value must be a fully qualified domain name, as per
RFC1033 and RFC1035 recommendations. The reserved value
SunOS 5.11 Last change: 12 May 2008 3
File Formats sysidcfg(4)
dynamic suppresses the front-end installation prompt. At the
same time, use of dynamic enables the NFSv4 domain to be
derived dynamically, at run time, based on naming service
configuration.
For example:
nfs4domain=example.com
...hard codes the value used by the nfsmapid(1M) daemon to
be example.com. In contrast, the following example shows how
to set the nfs4domain variable to the reserved keyword
dynamic:
nfs4domain=dynamic
The preceding example enables the nfsmapid(1M) daemon to
derive the domain from the system's configured naming ser-
vices, as prescribed in the System Administration Guide:
Network Services.
Network Interface, Hostname, IP address, Netmask, DHCP, Default
Route
Network-related keywords are as follows:
networkinterface=NONE, PRIMARY, value
where value is a name of a network interface, for example,
eri0 or hme0.
For the NONE keyword, the options are:
hostname=hostname
For example,
networkinterface=NONE {hostname=feron}
For the PRIMARY and value keywords, the options are:
SunOS 5.11 Last change: 12 May 2008 4
File Formats sysidcfg(4)
primary (used only with multiple networkinterface lines)
dhcp
hostname=hostname
ipaddress=ipaddress
netmask=netmask
protocolipv6=yes no
defaultroute=ipaddress (IPv4 address only)
If you are using the dhcp option, the only other option you
can specify is protocolipv6. For example:
networkinterface=PRIMARY {dhcp protocolipv6=yes}
If you are not using DHCP, you can specify any combination
of the other keywords as needed. If you do not use any of
the keywords, omit the curly braces.
networkinterface=eri0 {hostname=feron
ipaddress=172.16.2.7
netmask=255.255.255.0
protocolipv6=no
defaultroute=172.16.2.1}
Multiple Network Interfaces
If you have multiple network interfaces on your system, you
can configure them all in the sysidcfg file by defining mul-
tiple networkinterface keywords. If you specify multiple
networkinterface keywords, you cannot use NONE or PRIMARY
for values. You must specify interface names for all of the
values. To specify the primary interface, use the primary
option value.
For example,
networkinterface=eri0 {primary
hostname=feron
ipaddress=172.16.2.7
netmask=255.255.255.0
protocolipv6=no
defaultroute=172.16.2.1}
networkinterface=eri1 {hostname=feron-b
ipaddress=172.16.3.8
netmask=255.255.255.0
protocolipv6=no
defaultroute=172.16.3.1}
SunOS 5.11 Last change: 12 May 2008 5
File Formats sysidcfg(4)
Root Password
The root password keyword is rootpassword. Possible values
are encrypted from /etc/shadow. Syntax is:
rootpassword=encryptedpassword
Security Policy
The security-related keyword is securitypolicy. It has the
following syntax:
securitypolicy=kerberos, NONE
The kerberos keyword has the following options:
{defaultrealm=FQDN adminserver=FQDN kdc=FQDN1, FQDN2, FQDN3}
where FQDN is a fully qualified domain name. An example of
the securitypolicy keyword is as follows:
securitypolicy=kerberos {defaultrealm=Yoursite.COM
adminserver=krbadmin.Yoursite.COM
kdc=kdc1.Yoursite.COM, kdc2.Yoursite.COM}
You can list a maximum of three key distribution centers
(KDCs) for a securitypolicy keyword. At least one is
required.
Language in Which to Display the Install Program
The system-location keyword is systemlocale. It has the
following syntax:
systemlocale=locale
where locale is /usr/lib/locale.
Terminal Type
The terminal keyword is terminal. It has the following syn-
tax:
terminal=terminaltype
SunOS 5.11 Last change: 12 May 2008 6
File Formats sysidcfg(4)
where terminaltype is a value from
/usr/share/lib/terminfo/*.
Timezone Information
The timezone keyword is timezone. It has the following syn-
tax:
timezone=timezone
where timezone is a value from /usr/share/lib/zoneinfo/*or,
where timezone is an offset-from-GMT style quoted timezone.
Refer to environ(5) for information on quoted timezones. An
example of a quoted timezone is: timezone="]8".
Date and Time
The time server keyword is timeserver. It has the following
syntax:
timeserver=localhost
timeserver=hostname
timeserver=ipaddress
If you specify localhost as the time server, the system's
time is assumed to be correct. If you specify the hostname
or ipaddress, if you are not running a name service, of a
system, that system's time is used to set the time.
Keyboard Layout
The keyboard keyword is keyboard. It has the following syn-
tax:
keyboard=keyboardlayout
The valid keyboardlayout strings are defined in the
/usr/share/lib/keytables/type6/kbdlayouts file.
x86 Platform Keywords
The following keywords apply only to x86 platforms. For all
these keywords, use kdmconfig -d to create or append to the
sysidcfg file. See kdmconfig(1M).
Monitor type
The monitor-related keyword is monitor. The syntax is:
monitor=monitortype
SunOS 5.11 Last change: 12 May 2008 7
File Formats sysidcfg(4)
Graphics card, color depth, display resolution, screen size
The display-related keywords are display, size, depth,
and resolution. The syntax is:
display=graphicscard {size=screensize
depth=colordepth resolution=screenresolution}
Pointing device, number of buttons, IRQ level
The mouse-related keywords are pointer, nbuttons, and
irq.
pointer=pointingdevice {nbuttons=numberbuttons
irq=value}
EXAMPLES
Example 1 Sample sysidcfg files
The following example is a sysidcfg file for a group of
SPARC systems to install over the network. The host names,
IP addresses, and netmask of these systems have been precon-
figured by editing the name service. Because all the system
configuration information has been preconfigured, an
automated installation can be achieved by using this
sysidcfg file in conjunction with a custom JumpStart pro-
file.
keyboard=US-English
systemlocale=enUS
timezone=US/Central
timeserver=localhost
terminal=sun-cmd
nameservice=NIS {domainname=marquee.central.example.com
nameserver=connor(172.16.112.3)}
rootpassword=m4QPOWNY
systemlocale=C
securitypolicy=kerberos
{defaultrealm=Yoursite.COM
adminserver=krbadmin.Yoursite.COM
kdc=kdc1.Yoursite.COM, kdc2.Yoursite.COM}
The following example is a sysidcfg file created for a group
of x86 systems to install over the network that all have the
SunOS 5.11 Last change: 12 May 2008 8
File Formats sysidcfg(4)
same keyboard, graphics cards, and pointing devices. The
device information (keyboard, display, and pointer) was cap-
tured from running kdmconfig -d. See kdmconfig(1M). In this
example, users would see only the prompt to select a
language, systemlocale, for displaying the rest of the
Solaris installation program.
keyboard=US-English
display=ati {size=15-inch}
pointer=MS-S
timezone=US/Central
timeserver=connor
terminal=AT386
nameservice=NIS {domainname=marquee.central.example.com
nameserver=connor(172.16.112.3)}
rootpassword=URFUni9
securitypolicy=none
SEE ALSO
installscripts(1M), kdmconfig(1M), nfsmapid(1M),
sysidtool(1M), environ(5)
Solaris Express Installation Guide: Basic Installations
SunOS 5.11 Last change: 12 May 2008 9
|
