Solaris 10 sysidcfg: Hands-Off System Identification for JumpStart, Network and Zone Installs

Solaris Admin Series, part 17. Previous: part 16, Solaris 10 Software Groups. Related: part 14, Installing Solaris 10 on SPARC and part 15, Installing Solaris 10 on x86 (the identification screens this file answers), part 12, Solaris Hostname, Time Zone, Locale and Keyboard (changing identity on a running system), part 13, Solaris Serial Console Access (choosing the right terminal type) and part 11, Solaris Run Levels and Init States.

Every Solaris 10 install, and every reboot after sys-unconfig, runs the sysidtool programs that ask who the machine is: language, terminal, network interface, host name, IP address, name service, NFSv4 domain, Kerberos, time zone, root password and, on later updates, Auto Registration. Answering those screens by hand once is fine. Answering them on twenty servers, or on a box in a data center you cannot see, is not. The sysidcfg file answers them in advance. This post covers every keyword that matters, where the installer looks for the file, how to build one per host, how to test it without reinstalling, and why a “hands-off” install still stops and asks a question.

Applies to: Oracle Solaris 10 only (examples from 1/13, Update 11, SPARC and x86). Solaris 11 removed sysidcfg, sysidtool and sys-unconfig and replaced them with SMF system configuration (SC) profiles; see the Solaris 11 callout near the end.

What sysidcfg does and does not do

  • It does answer the system identification questions asked by sysidtool (sysidnet, sysidns, sysidsys, sysidroot, sysidkbd, sysidnfs4 and friends) during an install and after sys-unconfig.
  • It does not answer the install questions: disk layout, UFS or ZFS root, software group, packages. Those come from a JumpStart profile (next part). With sysidcfg alone, an interactive install skips the identity screens and then waits at the installer’s own screens.
  • It is read once. After identification completes, editing the file changes nothing; the running system is managed with the commands from part 12, Solaris Hostname, Time Zone, Locale and Keyboard.
  • The file must be named exactly sysidcfg, and only one can exist per directory or diskette. One host-specific file per directory is the normal layout.

Prerequisites

  • A Solaris 10 install source: DVD/ISO for local installs, or an install server built with setup_install_server for network installs (the JumpStart server itself is covered in part 18).
  • For each target: host name, interface name as Solaris will see it (e1000g0, igb0, bge0, nxge0, vnet0 on an LDoms guest), IP address, netmask, default router, DNS/NIS/LDAP details, time zone and the root password hash.
  • An existing Solaris 10 system (or any machine with OpenSSL) to generate the password hash.
  • For network installs: the target’s MAC address and the platform group (sun4u, sun4v or i86pc).

The keywords

Syntax rules from the Oracle installation guide: independent keywords may appear in any order; keywords are not case sensitive; dependent keywords go inside curly braces {} after their independent keyword; values may be quoted; and every keyword except network_interface may appear only once (if you repeat one, only the first instance is used).

KeywordAnswersExample valueNotes
system_localeInstall and desktop languageC, en_US.UTF-8Valid values are directories in /usr/lib/locale. C is the safe server default.
terminalConsole terminal typevt100, xterm, xterms, sun-cmd, sun-colorAny entry under /usr/share/lib/terminfo. Use vt100 or xterm on serial consoles and ILOM/LDoms consoles.
network_interfaceInterface, host name, IP, netmask, router, DHCP, IPv6e1000g0 {primary hostname=... }Repeat once per interface. PRIMARY (first up non-loopback interface) only for single-interface files. none for no networking.
name_serviceDNS, NIS, NIS+, LDAP or noneDNS {domain_name=... name_server=... search=...}Overrides any name service set up through site.xml.
nfs4_domainNFSv4 domaindynamic or example.comSince 8/07. Replaces the old set_nfs4_domain script.
security_policyKerberos client setupNONE or kerberos {...}One to three KDCs.
root_passwordRoot passwordEncrypted string as in /etc/shadowNever plain text.
timezoneTime zoneUS/Central, America/ChicagoPath relative to /usr/share/lib/zoneinfo.
timeserverWhere to get the datelocalhost or a host/IPSets the date once during identification. It does not configure NTP.
service_profileSecure by Default network serviceslimited_net or openInitial installs only. Absent means no change.
keyboardKeyboard layoutUS-English, GermanValid strings are in /usr/share/lib/keytables/type_6/kbd_layouts. Arrived around 10/08; needed for non-self-identifying keyboards (all PS/2).
auto_regAuto Registration / OCMdisable, none, anon, noproxy, allSince 9/10. Missing on 9/10 or later means a prompt during a “hands-off” install.

network_interface in detail

Static single interface, the most common server case:

network_interface=e1000g0 {primary
                           hostname=web01
                           ip_address=192.168.10.21
                           netmask=255.255.255.0
                           default_route=192.168.10.1
                           protocol_ipv6=no}

DHCP on one interface, or a second static interface that must not get its own default route:

network_interface=e1000g0 {primary dhcp protocol_ipv6=no}

network_interface=e1000g0 {primary
                           hostname=db01
                           ip_address=192.168.10.31
                           netmask=255.255.255.0
                           default_route=192.168.10.1
                           protocol_ipv6=no}
network_interface=e1000g1 {hostname=db01-bkp
                           ip_address=10.20.0.31
                           netmask=255.255.255.0
                           default_route=NONE
                           protocol_ipv6=no}
  • protocol_ipv6 must be present for an unattended install, and must be no for WAN boot.
  • If you omit default_route, the installer tries ICMP router discovery and prompts if it finds nothing. Set it explicitly, or NONE on secondary interfaces.
  • PRIMARY means “the first up, non-loopback interface in ifconfig order”. Do not use it when the file configures more than one interface; name the interface and add the primary flag instead.
  • The interface name is the driver name plus instance as the install miniroot sees it. A server with both onboard bge and add-in e1000g ports, or a re-cabled box, can surprise you; check /etc/path_to_inst or the ok prompt device tree first (part 4, Solaris /devices, /dev and /etc/path_to_inst).

name_service variants

name_service=NONE

name_service=DNS {domain_name=example.com
                  name_server=192.168.10.53,192.168.11.53
                  search=example.com,corp.example.com}

name_service=NIS {domain_name=nis.example.com
                  name_server=nis1(192.168.10.40)}

name_service=LDAP {domain_name=example.com
                   profile=default
                   profile_server=192.168.10.45
                   proxy_dn="cn=proxyagent,ou=profile,dc=example,dc=com"
                   proxy_password=proxypw}

DNS takes up to three name servers and up to six search domains. NIS and NIS+ want hostname(IP) for the server. The LDAP proxy_dn must be in double quotes, and proxy_password is plain text, which is one more reason to protect the file. With DNS, the installer writes /etc/resolv.conf and an nsswitch.conf based on /etc/nsswitch.dns, so hosts: files dns is in place on first boot.

security_policy, service_profile and auto_reg

security_policy=kerberos {default_realm=EXAMPLE.COM
                          admin_server=kdc1.example.com
                          kdc=kdc1.example.com,kdc2.example.com}
service_profile=limited_net
auto_reg=disable

Set security_policy=NONE if the host is not a Kerberos client; leaving the keyword out produces the Kerberos question. Kerberos realms are case sensitive, and the KDC itself is a separate project (see Set Up an MIT Kerberos KDC). service_profile=limited_net applies the same Secure by Default profile as netservices limited: every network service except SSH is disabled or bound to local requests only (see part 16, Solaris 10 Software Groups, for why this pairs well with a small software group). auto_reg takes disable (OCM in disconnected mode), none (anonymous, no proxy), anon (anonymous with proxy settings), noproxy or all (registration with My Oracle Support credentials). Credential and proxy passwords inside auto_reg are plain text, so most sites use auto_reg=disable and keep credentials out of the file entirely.

Step 1: Generate the root password hash

root_password takes the encrypted string exactly as it would appear in the second field of /etc/shadow. The simplest source is a Solaris 10 system you already trust: set the wanted password on a throwaway account and copy the hash.

# useradd -m -d /export/home/tmphash tmphash
# passwd tmphash
New Password:
Re-enter new Password:
passwd: password successfully changed for tmphash
# grep '^tmphash:' /etc/shadow | cut -d: -f2
$5$Xk3pQ9aZ$P1r0mQ8bE7sJxv6Fh2Tn0cYdL4wKuA9Rz3eSgN1oVj5
# userdel -r tmphash

The prefix depends on CRYPT_DEFAULT in /etc/security/policy.conf on that system (__unix__ gives a 13-character DES string, 1 gives $1$ MD5, 5/6 give SHA-256/SHA-512 on updates that ship them). Whatever you use, the target release must support it in /etc/security/crypt.conf; the hash is copied verbatim, never re-encrypted. Off-Solaris, OpenSSL can produce a BSD-MD5 hash that every Solaris 10 update understands:

$ openssl passwd -1
Password:
Verifying - Password:
$1$hR7vPq2N$0bW9yXcK4fJmTq1sLe8Uz.

There is no shell expansion in sysidcfg, so the $ characters need no escaping. The traditional DES form only uses the first 8 characters of the password; prefer $5$/$6$ from a 1/13 system or $1$ when older updates are involved. (The hashes above are illustrative; generate your own.)

Step 2: Write a complete per-host file

Keep a template and one directory per host. Every question has an answer here, so nothing should be asked:

# mkdir -p /export/config/web01
# vi /export/config/web01/sysidcfg
# cat /export/config/web01/sysidcfg
system_locale=C
terminal=vt100
keyboard=US-English
timezone=US/Central
timeserver=localhost
network_interface=e1000g0 {primary
                           hostname=web01
                           ip_address=192.168.10.21
                           netmask=255.255.255.0
                           default_route=192.168.10.1
                           protocol_ipv6=no}
name_service=DNS {domain_name=example.com
                  name_server=192.168.10.53,192.168.11.53
                  search=example.com}
nfs4_domain=dynamic
security_policy=NONE
root_password=$5$Xk3pQ9aZ$P1r0mQ8bE7sJxv6Fh2Tn0cYdL4wKuA9Rz3eSgN1oVj5
service_profile=limited_net
auto_reg=disable
  • Use a Unix editor or run dos2unix; carriage returns from Windows editors end up inside values (vt100\r is not a terminal type), and the result is the very prompt you were trying to avoid.
  • timeserver=localhost trusts the hardware clock. If you name a host instead, sysidtool reads the date from that host’s RFC 868 time service once; NTP is configured separately after install.
  • timezone accepts the US/Central style and Olson names like America/Chicago; both resolve to files under /usr/share/lib/zoneinfo.
  • Lock the directory down: chmod 700 /export/config/web01 on the server side and share it read-only to the install network only. A shadow hash is still crackable offline.
# chmod 700 /export/config/web01 ; chmod 400 /export/config/web01/sysidcfg
# share -F nfs -o ro=@192.168.10.0/24,anon=0 /export/config
# share | grep config
-               /export/config   ro=@192.168.10.0/24,anon=0   ""

anon=0 is needed because the installing client mounts as root before it has any identity. Add the share line to /etc/dfs/dfstab (or let add_install_client do it) so it survives a reboot of the install server.

Step 3: Put the file where the installer looks

LocationHow the client finds itTypical use
NFS directoryadd_install_client -p server:/path writes sysid_config= into /etc/bootparams (SPARC boot net) or the SsysidCF DHCP option (x86 PXE, DHCP clients)JumpStart and network installs
UFS or PCFS disketteRoot directory of the floppy; for JumpStart from floppy, the profile disketteStand-alone and VM installs
HTTP/HTTPS serverDocument root of the WAN boot web serverWAN boot (protocol_ipv6=no required)
/etc/sysidcfg on an installed system or zoneRead by sysidtool at the next unconfigured bootsys-unconfig re-identification, zones

Network install with add_install_client -p

Run add_install_client from the Tools directory of the install image on the install server. -c points at the JumpStart directory with rules.ok and profiles, -p at the directory that contains the host’s sysidcfg:

# cd /export/install/s10u11-sparc/Solaris_10/Tools
# ./add_install_client -e 0:14:4f:a8:2c:10 \
    -s jsserver:/export/install/s10u11-sparc \
    -c jsserver:/export/jumpstart \
    -p jsserver:/export/config/web01 \
    web01 sun4v
Adding Ethernet number for web01 to /etc/ethers
...
updating /etc/bootparams   (output trimmed)
# grep '^web01' /etc/bootparams
web01  root=jsserver:/export/install/s10u11-sparc/Solaris_10/Tools/Boot install=jsserver:/export/install/s10u11-sparc boottype=:in sysid_config=jsserver:/export/config/web01 install_config=jsserver:/export/jumpstart rootopts=:rsize=8192

The -p value is a directory; the client looks for a file named sysidcfg inside it. The client host name must resolve on the install server (/etc/hosts or the name service) for the bootparams and RARP side to work. Many sites point -p and -c at the same JumpStart directory when every client shares one file; per-host values need per-host directories. On SPARC the client then boots with:

{0} ok boot net - install

x86 PXE clients and SPARC boot net:dhcp clients get the same location from the DHCP vendor options that add_install_client -d prints (SsysidCF for sysidcfg, SjumpsCF for the JumpStart directory). The DHCP and WAN boot paths get their own post (part 21).

Diskette for local DVD installs and VMs

Floppies are gone from hardware but not from hypervisors. The installer checks a diskette for sysidcfg during identification, so a 1.44 MB image attached to a VirtualBox or KVM guest works. Build it on Linux:

$ mkfs.msdos -C sysid.img 1440
mkfs.fat 4.2 (2021-01-31)
$ mcopy -i sysid.img sysidcfg ::/sysidcfg
$ mdir -i sysid.img ::/
 Volume in drive : has no label
 Volume Serial Number is 2D4E-91A0
Directory for ::/

sysidcfg       541 2026-11-19  14:40
        1 file              541 bytes

Or on an existing Solaris 10 box with a lofi device:

# mkfile 1440k /var/tmp/sysid.img
# lofiadm -a /var/tmp/sysid.img
/dev/lofi/1
# mkfs -F pcfs -o fat=12,nofdisk,size=2880 /dev/rlofi/1
Construct a new FAT file system on /dev/rlofi/1: (y/n)? y
# mount -F pcfs /dev/lofi/1 /mnt
# cp /export/config/web01/sysidcfg /mnt/ && umount /mnt && lofiadm -d /dev/lofi/1

Step 4: Watch identification on the console

A successful network install shows where the file came from. If you see “Using sysid configuration file” and then no identification screens, the file was found and complete:

Configuring devices.
Using RPC Bootparams for network configuration information.
Attempting to configure interface e1000g0...
Configured interface e1000g0
Beginning system identification...
Searching for configuration file(s)...
Using sysid configuration file 192.168.10.5:/export/config/web01/sysidcfg
Search complete.
Discovering additional network configuration...
Completing system identification...
Starting remote procedure call (RPC) services: done.
System identification complete.
Starting Solaris installation program...
Searching for JumpStart directory...
Using rules.ok from 192.168.10.5:/export/jumpstart.

If a screen appears anyway, it names the missing or rejected answer: the Kerberos screen means security_policy, “Configure Time Zone” means timezone, the IPv6 question means protocol_ipv6, and so on. Note it, answer it by hand (or abort), and fix the file before the next client.

Step 5: Test a file without reinstalling (sys-unconfig)

You do not need a full install to prove a sysidcfg works. On a spare Solaris 10 VM or a test zone, sys-unconfig wipes the identity and halts; at the next boot sysidtool runs again and reads /etc/sysidcfg if it exists. Never do this on a production host: it removes the host name, network configuration, name service setup, time zone and the root password.

# cp /var/tmp/web01-sysidcfg /etc/sysidcfg
# chmod 400 /etc/sysidcfg
# sys-unconfig
                        WARNING

This program will unconfigure your system.  It will cause it
to revert to a "blank" system - it will not have a name or know
about other systems or networks.

This program will also halt the system.

Do you want to continue (y/n) ? y

sys-unconfig creates /etc/.UNCONFIGURED, which is what triggers sysidtool on the next boot (boot at the ok prompt, or the GRUB default on x86; see part 11, Solaris Run Levels and Init States). Watch the console: no questions means every keyword was accepted. Afterwards remove /etc/sysidcfg so the root hash and any LDAP or Oracle credentials do not stay on disk.

For zones, the same file goes into the zone’s root before its first boot, which makes a fast test bed:

# zoneadm -z z1 install
# cat > /zones/z1/root/etc/sysidcfg <<'EOF'
system_locale=C
terminal=xterm
network_interface=NONE {hostname=z1}
security_policy=NONE
name_service=NONE
nfs4_domain=dynamic
timezone=US/Central
root_password=$5$Xk3pQ9aZ$P1r0mQ8bE7sJxv6Fh2Tn0cYdL4wKuA9Rz3eSgN1oVj5
auto_reg=disable
EOF
# zoneadm -z z1 boot
# zlogin -C z1

In a shared-IP zone the address comes from zonecfg, so network_interface=NONE {hostname=z1} only sets the name. Zones get their own posts later in the series.

Verification

After first boot, check that every keyword landed where expected:

# hostname ; cat /etc/nodename
web01
web01
# cat /etc/hostname.e1000g0 /etc/defaultrouter
web01
192.168.10.1
# grep web01 /etc/inet/hosts ; cat /etc/inet/netmasks | grep -v '^#'
192.168.10.21   web01   loghost
192.168.10.0    255.255.255.0
# cat /etc/resolv.conf ; grep '^hosts' /etc/nsswitch.conf
domain example.com
nameserver 192.168.10.53
nameserver 192.168.11.53
search example.com
hosts:      files dns
# grep -E '^(TZ|LANG)' /etc/default/init
TZ=US/Central
LANG=C
# grep '^NFSMAPID_DOMAIN' /etc/default/nfs
# svcprop -p config/local_only network/rpc/bind
true
# svcs -a | grep -E 'telnet|ftp|rlogin'
disabled       14:52:07 svc:/network/telnet:default
disabled       14:52:07 svc:/network/ftp:default
disabled       14:52:07 svc:/network/login:rlogin
# ls -l /etc/.UNCONFIGURED
/etc/.UNCONFIGURED: No such file or directory
  • NFSMAPID_DOMAIN stays commented with nfs4_domain=dynamic; with a named domain it is set.
  • rpc/bind local_only=true and disabled telnet/ftp/rlogin confirm service_profile=limited_net.
  • Log in as root with the intended password on the console before closing the change; an unusable hash shows up only here.
  • Install-time logs are in /var/sadm/system/logs/ (sysidtool.log where present, plus install_log).

Troubleshooting: why a hands-off install still asks questions

Prompt you seeUsual causeFix
Every identification screenFile not found: wrong -p path, file not named sysidcfg, NFS share missing or not anon=0, diskette not attachedCheck /etc/bootparams and share; mount the path from another client
Network interface / host nameInterface name wrong for this hardware, or PRIMARY with several interfacesUse the real driver instance; name each interface
IPv6 questionprotocol_ipv6 missingAdd protocol_ipv6=no (required for WAN boot)
Default routerdefault_route missing and no router discovery answerSet it, or NONE on secondaries
Name service screensTypo in name_service or dependent keywords; NIS server not in name(IP) formCompare against the syntax above
NFSv4 domainnfs4_domain missingnfs4_domain=dynamic
Kerberossecurity_policy missingsecurity_policy=NONE or a full Kerberos block
Root passwordKeyword missing or hash unusablePaste the full shadow field; check crypt.conf on the target release
Auto Registration / OCMauto_reg missing on 9/10 or laterauto_reg=disable
Keyboard layoutPS/2 or non-self-identifying keyboard, invalid layout namekeyboard=US-English from kbd_layouts
Time and datetimeserver host not answering the time servicetimeserver=localhost and fix NTP later
Disk and software screens after identificationNo JumpStart profile matched; sysidcfg does not answer themAdd -c, rules.ok and a profile (part 18)
  • Duplicate keywords: only the first one counts, so an old name_service=NONE left at the top silently wins over the DNS block you added at the bottom.
  • An unbalanced { or } makes the rest of the file unusable. Keep dependent keywords neatly indented and count braces.
  • name_service overwrites whatever a site.xml SMF profile configured. If you use both, let one own name services.
  • Old Solaris 9 x86 keywords such as monitor, display and pointer belonged to kdmconfig and are not needed on Solaris 10 x86.
  • Serial consoles: set terminal=vt100 or xterm; sun-cmd on a serial line gives garbage screens if anything is ever asked (part 13, Solaris Serial Console Access).

Solaris 11: SC profiles replace sysidcfg

Solaris 11 has no sysidcfg, no sysidtool and no sys-unconfig. Identity lives in SMF properties, and the hands-off answer file is an XML system configuration (SC) profile:

TaskSolaris 10Solaris 11.4
Answer filesysidcfg (keyword=value)SC profile (SMF XML)
Create itText editorsysconfig create-profile -o /var/tmp/sc.xml (runs the interactive screens and saves the answers)
Network installadd_install_client -pinstalladm create-profile -n svc -f sc.xml on the Automated Installer server
Zones/zonepath/root/etc/sysidcfgzoneadm -z z1 install -c sc.xml
Re-identify a hostsys-unconfigsysconfig unconfigure / sysconfig configure -c sc.xml
Migraten/ajs2ai converts rules, profiles and sysidcfg to AI manifests and SC profiles

The AI and SC profile posts later in the series cover this end to end, including sysconfig create-profile for hands-off installs.

What’s next in the Solaris Admin Series

Next up: setting up a JumpStart server with setup_install_server, add_install_client and the rules and profile files, where this sysidcfg and the software group choices from part 16, Solaris 10 Software Groups, combine into a truly unattended install. Catch up with part 15, Installing Solaris 10 on x86, part 14, Installing Solaris 10 on SPARC and part 12, Solaris Hostname, Time Zone, Locale and Keyboard.

Official references: Oracle Solaris 10 1/13 Installation Guide: Network-Based Installations (Chapter 2, Preconfiguring With the sysidcfg File and sysidcfg File Keywords), Installation Guide: JumpStart Installations and Planning for Installation and Upgrade (Planning Network Security) in the Oracle Solaris 10 1/13 Information Library; Installing Oracle Solaris 11.4 Systems (system configuration profiles); and the man pages for sysidcfg(4), sysidtool(1M), sys-unconfig(1M), add_install_client(1M), netservices(1M), crypt.conf(4), policy.conf(4) and sysconfig(1M).

Leave a Reply

Your email address will not be published. Required fields are marked *