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.

  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     add_install_client(1M)      command      (see
     install_scripts(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.

  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 will be used.

  Keywords - All Platforms
     The following keywords apply to both SPARC and IA platforms.

  Name Service, Domain Name, Name Server
     Naming-related keywords are as follows:

     name_service=NIS,NIS+,LDAP,DNS,NONE

     For the NIS and NIS+ keywords, the options are:

     domain_name=domain_name
     name_server=hostname(ip_address)

     The following is an example NIS entry:

     name_service=NIS
     {domain_name=west.arp.com name_server=timber(129.221.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:

     domain_name=domain_name; name_server=ip_address, ... ;
     search=domain_name, ...

     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:

     name_service=DNS
     {domain_name=west.arp.com
     name_server=10.0.1.10,10.0.1.20
     search=arp.com,east.arp.com}

     For LDAP, the syntax is:

     domain_name=domain_name;
     profile=profile_name;
     profile_server=ip_address;
     proxy_dn="proxy_bind_dn";
     proxy_password=password

     The proxy_dn and proxy_password keywords  are  optional.  If
     proxy_dn  is  used,  the  value  must  be enclosed in double
     quotes.

     The following is an example LDAP entry:

     name_service=LDAP
     {domain_name=west.arp.com
     profile=default
     profile_server=129.221.2.1
     proxy_dn="cn=proxyagent,ou=profile,dc=west,dc=arp,dc=com"
     proxy_password=password}

     Choose only one  value  for  name_service.  Include  either,
     both,  or  neither  of  the domain_name and name_server key-
     words, as needed. If no keywords are used,  omit  the  curly
     braces.

  Network Interface, Hostname, IP address, Netmask,  DHCP,  IPv6,
     Default Route
     Network-related keywords are as follows:

     network_interface=NONE, PRIMARY, value

     If you are using DHCP, the options  for  PRIMARY  and  value
     are:

     dhcp; protocol_ipv6=yes_or_no

     For example:

     network_interface=primary {dhcp protocol_ipv6=yes}

     If you are not using DHCP, the options for PRIMARY and value
     are:

     hostname=host_name;
     ip_address=ip_address;
     netmask=netmask;
     protocol_ipv6=yes_or_no
     default_route=ip_address (IPv4 address only)|none

     For example:

     network_interface=le0
     {hostname=feron
     ip_address=129.222.2.7
     netmask=255.255.0.0
     protocol_ipv6=no
     default_route=129.222.2.1}

     Choose only one value  for  network_interface.  Include  any
     combination  or  none  of the hostname, ip_address, netmask,
     and default_route keywords, as needed. If you do not use any
     of these keywords, omit the curly braces.

     protocol_ipv6 and default_route are  optional;  you  do  not
     need  to specify them. default_route accepts an IPv4 address
     or the value none.

  Root Password
     The root password keyword is root_password. Possible  values
     are encrypted from /etc/shadow. Syntax is:

     root_password=encrypted_password

  Security Policy
     The security-related keyword is security_policy. It has  the
     following syntax:

     security_policy=kerberos, NONE

     The kerberos keyword has the following options:

     {default_realm=FQDN admin_server=FQDN kdc=FQDN1, FQDN2, FQDN3}

     where FQDN is a fully qualified domain name. An  example  of
     the security_policy keyword is as follows:

     security_policy=kerberos {default_realm=Yoursite.COM
     admin_server=krbadmin.Yoursite.COM
     kdc=kdc1.Yoursite.COM, kdc2.Yoursite.COM}

     You can list a maximum of  three  key  distribution  centers
     (KDCs)  for  a  security_policy  keyword.  At  least  one is
     required.

   Language in Which to Display the Install Program
     The system-location keyword is  system_locale.  It  has  the
     following syntax:

     system_locale=locale

     where locale is /usr/lib/locale.

  Terminal Type
     The terminal keyword is terminal. It has the following  syn-
     tax:

     terminal=terminal_type

     where      terminal_type      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/*.

  Date and Time
     The time server keyword is timeserver. It has the  following
     syntax:

     timeserver=localhost
     timeserver=hostname
     timeserver=ip_address

     If you specify localhost as the time  server,  the  system's
     time  is  assumed to be correct. If you specify the hostname
     or ip_address, if you are not running a name service,  of  a
     system, that system's time is used to set the time.

  Keywords - x86 Platform
     The following keywords apply only to IA 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=monitor_type

     Keyboard language, keyboard layout
           The keyboard-language keyword is keyboard. The  syntax
           is:

     keyboard=keyboard_language {layout=value}

     Graphics card, color depth, display resolution, screen size
           The display-related keywords are display, size, depth,
           and resolution. The syntax is:

     display=graphics_card {size=screen_size
     depth=color_depth resolution=screen_resolution}

     Pointing device, number of buttons, IRQ level
           The mouse-related keywords are pointer, nbuttons,  and
           irq.

     pointer=pointing_device {nbuttons=number_buttons
     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  created  by using a custom
     JumpStart profile.

     system_locale=en_US
     timezone=US/Central
     timeserver=localhost
     terminal=sun-cmd
     name_service=NIS {domain_name=marquee.central.sun.com
                       name_server=connor(129.152.112.3)}
     root_password=m4QPOWNY
     system_locale=C
     security_policy=kerberos
         {default_realm=Yoursite.COM
          admin_server=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
     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, system_locale, for  displaying  the  rest  of  the
     Solaris installation program.

     keyboard=ATKBD {layout=US-English}
     display=ati {size=15-inch}
     pointer=MS-S
     timezone=US/Central
     timeserver=connor
     terminal=AT386
     name_service=NIS {domain_name=marquee.central.sun.com
                       name_server=connor(129.152.112.3)}
     root_password=URFUni9
     security_policy=none


SEE ALSO

     install_scripts(1M), kdmconfig(1M), sysidtool(1M)

     Solaris 9 9/04 Installation Guide


Man(1) output converted with man2html