You can specify a set of keywords in the sysidcfg file to preconfigure a system.
You must create a unique sysidcfg file for every system that requires different configuration information. You can use the same sysidcfg file to preconfigure the time zone on a set of systems if you want all the systems to be assigned the same time zone. However, if you want to preconfigure a different root (superuser) password for each of those systems, you need to create a unique sysidcfg file for each system.
You can place the sysidcfg file in one of the following:
A UFS or PCFS diskette – Place the sysidcfg file in the root (/) directory on the diskette.
A HTTP or HTTPS server – If you want to perform a wide area network (WAN) boot installation, place the sysidcfg file in the document root directory of the web server.
You can place only one sysidcfg file in a directory or on a diskette. If you are creating more than one sysidcfg file, you must place each file in a different directory or on a different diskette.
The following sections describe the components of the sysidcfg file. Refer to this information when creating a new sysidcfg file. A sample of the sysidcfg file is located in the /install-dir-path/Solaris_10.1/Tools directory. Instead of creating a new file, you can copy this file to use and customize for your installation environment.
You can use two types of keywords in the sysidcfg file: independent and dependent. Dependent keywords are guaranteed to be unique only within independent keywords. A dependent keyword exists only when it is identified with its associated independent keyword.
Syntax Rule |
Example |
|
---|---|---|
Independent keywords can be listed in any order. |
|
|
Keywords are not case-sensitive. |
|
|
Enclose all dependent keywords in braces ({}) to tie them to their associated independent keyword. |
|
|
You can optionally enclose values in single (`) or double quotation marks (“). |
|
The following table lists the keywords that you can use to configure system information in the sysidcfg file.
Table 1–3 sysidcfg Configuration Information and Keyword Examples
Configuration Information |
Keyword |
---|---|
Network interface, host name, Internet Protocol (IP) address, netmask, DHCP, IPv6 |
network_interface |
root (superuser) password |
root_password |
Security policy |
security_policy |
Language in which to display the installation program and desktop |
system_locale |
Terminal type |
terminal |
Time zone |
timezone |
Date and time |
timeserver |
Monitor type |
monitor |
Keyboard language, keyboard layout |
keyboard |
Graphics card, screen size, color depth, display resolution |
display |
Pointing device, number of buttons, IRQ level |
pointer |
The following sections describe the keywords that you can use in the sysidcfg file.
Use the network_interface keyword to perform the following tasks:
Specify a host name.
Specify an IP address.
Specify a netmask value.
Use DHCP to configure the network interface.
Enable IPv6 on the network interface.
The following sections describe how to use the network_interface keyword to configure system interfaces.
To turn off networking for a system, set the network_interface value to none. For example:
network_interface=none |
You can use the network_interface keyword to configure a single interface in the following ways.
With DHCP – You can use a DHCP server on your network to configure the network interface. For more information about how to use a DHCP server during your installation, see Preconfiguring System Configuration Information With the DHCP Service (Task Map).
To use the DHCP server to configure a single interface on the system, use the following syntax for the network_interface keyword:
network_interface=PRIMARY or value {dhcp protocol_ipv6=yes-or-no} |
Instructs the installation program to configure the first up, non-loopback interface that is found on the system. The order is the same order that is displayed with the ifconfig command. If no interfaces are up, then the first non-loopback interface is used. If no non-loopback interfaces are found, then the system is nonnetworked.
Do not use the PRIMARY keyword value if you want to configure multiple interfaces.
Instructs the installation program to configure a specific interface, such as hme0 or eri1.
Instructs the installation program to configure the system to either use IPv6 or to not use IPv6.
Without DHCP – If you do not want to use DHCP to configure the network interface, you can specify the configuration information in the sysidcfg file. To instruct the installation program to configure a single interface on the system without using DHCP, use the following syntax:
network_interface=PRIMARY or value {hostname=host-name default_route=ip-address ip_address=ip-address netmask=netmask protocol_ipv6=yes-or-no} |
Instructs the installation program to configure the first up, non-loopback interface that is found on the system. The order is the same as the order that is displayed with the ifconfig command. If no interfaces are up, then the first non-loopback interface is used. If no non-loopback interfaces are found, then the system is notnetworked.
Do not use the PRIMARY keyword value if you want to configure multiple interfaces.
Instructs the installation program to configure a specific interface, such as hme0 or eri1.
(Optional) Specifies the host name of the system.
(Optional) Specifies the IP address of the default router. If you want the installation program to detect the router by using the ICMP router discovery protocol, omit this keyword.
If the installation program cannot detect the router, you are prompted for the router information during the installation.
(Optional) Specifies the IP address of the system.
(Optional) Specifies the netmask value for the system.
(Optional) Instructs the installation program either to configure the system to either use IPv6 or to not use IPv6.
To perform an unattended custom JumpStart installation, you must specify a value for the protocol_ipv6 keyword.
Include any combination or none of the hostname, ip_address, and netmask keywords, as needed. If you do not use any of these keywords, omit the braces ({}).
The following example shows how to instruct the installation program to DHCP to configure the eri0 network interface. IPv6 support is not enabled.
network_interface=eri0 {dhcp protocol_ipv6=no} |
The following example shows how to configure the eri0 interface with the following settings:
The host name is set to host1.
The IP address is set to 172.31.88.100.
The netmask is set to 255.255.255.0.
IPv6 support is not enabled on the interface.
network_interface=eri0 {hostname=host1 ip_address=172.31.88.100 netmask=255.255.255.0 protocol_ipv6=no} |
You can configure multiple network interfaces in your sysidcfg file. For each interface that you want to configure, include a network_interface keyword entry in the sysidcfg file.
You can use the network_interface keyword to configure multiple interfaces in the following ways:
With DHCP – You can use a DHCP server on your network to configure the network interface. For more information about how to use a DHCP server during your installation, see Preconfiguring System Configuration Information With the DHCP Service (Task Map).
To use the DHCP server to configure a network interface on the system, use the following syntax for the network_interface keyword.
network_interface=value {PRIMARY dhcp protocol_ipv6=yes-or-no} |
Instructs the installation program to configure a specific interface, such as hme0 or eri1.
(Optional) Specifies value as the primary interface.
Instructs the installation program to configure the system either to use IPv6 or to not use IPv6.
Without DHCP – If you do not want to use DHCP to configure the network interface, you can specify the configuration information in the sysidcfg file. To instruct the installation program to configure multiple interfaces without using DHCP, use the following syntax.
network_interface=value {PRIMARY hostname=host-name default_route=ip-address or NONE ip_address=ip-address netmask=netmask protocol_ipv6=yes-or-no} |
Instructs the installation program to configure a specific interface, such as hme0 or eri1.
(Optional) Specifies value as the primary interface.
(Optional) Specifies the host name of the system.
(Optional) Specifies the IP address of the default router. If you want the installation program to detect the router by using the ICMP router discovery protocol, omit this keyword.
If you configure multiple interfaces in the sysidcfg file, set default_route=NONE for each secondary interface that does not use a static default route.
If the installation program cannot detect the router, you are prompted for the router information during installation.
(Optional) Specifies the IP address of the system.
(Optional) Specifies the netmask value for the system.
(Optional) Instructs the installation program to configure the system either to use IPv6 or to not use IPv6.
To perform an unattended custom JumpStart installation, you must specify a value for the protocol_ipv6 keyword.
Include any combination or none of the hostname, ip_address, and netmask keywords, as needed. If you do not use any of these keywords, omit the braces ({}).
In the same sysidcfg file, you can use DHCP to configure certain interfaces, while also specifying the configuration information for other interfaces in the sysidcfg file.
In the following example, the network interfaces eri0 and eri1 are configured in the following way:
eri0 is configured by using the DHCP server. IPv6 support is not enabled on eri0.
eri1 is the primary network interface. The host name is set to host1, and the IP address is set to 172.31.88.100. The netmask is set to 255.255.255.0. IPv6 support is not enabled on eri1.
network_interface=eri0 {dhcp protocol_ipv6=no} network_interface=eri1 {primary hostname=host1 ip_address=172.31.88.100 netmask=255.255.255.0 protocol_ipv6=no} |
You can specify the root (superuser) password to the system in the sysidcfg file. To specify the root (superuser) password, use the root_password keyword with the following syntax:
root_password=encrypted-password |
encrypted-password is the encrypted password as it appears in the /etc/shadow file.
You can use the security_policy keyword in your sysidcfg file to configure your system to use the Kerberos network authentication protocol. If you want to configure the system to use Kerberos, use the following syntax:
security_policy=kerberos {default_realm=FQDN admin_server=FQDN kdc=FQDN1, FQDN2, FQDN3} |
FQDN specifies the fully qualified domain name of the Kerberos default realm, the administration server, and key distribution center (KDC). You must specify at least one, but no more than three, key distribution centers.
If you do not want to set the security policy for the system, set security_policy=NONE.
For more information about the Kerberos network authentication protocol, see Part VI, Kerberos Service, in System Administration Guide: Security Services.
The following example configures the system to use Kerberos with the following information:
The Kerberos default realm is example.COM.
The Kerberos administration server is krbadmin.example.COM.
The two key distribution centers are kdc1.example.COM and kdc2.example.COM.
security_policy=kerberos {default_realm=example.COM admin_server=krbadmin.example.COM kdc=kdc1.example.COM, kdc2.example.COM} |
You can use the system_locale keyword to specify the language in which to display the installation program and desktop. Use the following syntax to specify a locale:
system_locale=locale |
locale specifies the language that you want the system to use to display the installation panels and screens. For a list of valid locale values, see the /usr/lib/locale directory or the International Language Environments Guide.
You can use the terminal keyword to specify the terminal type for the system. Use the following syntax to specify the terminal type:
terminal=terminal_type |
terminal_type specifies the terminal type for the system. For a list of valid terminal types, see the subdirectories in the /usr/share/lib/terminfo directory.
You can set the time zone for the system with the timezone keyword. Use the following syntax:
timezone=timezone |
The timezone keyword specifies the time zone value for the system. The directories and files in the /usr/share/lib/zoneinfo directory provide the valid time zone values. The timezone value is the name of the path relative to the /usr/share/lib/zoneinfo directory. You can also specify any valid Olson time zone.
In the following example, the system time zone is set to mountain standard time in the United States.
timezone=US/Mountain |
The installation program configures the system to use the time zone information in /usr/share/lib/zoneinfo/US/Mountain.
You can use the timeserver keyword to specify the system that sets the date and time on the system you want to install.
Do not set timeserver=host-name or ip-address if you are running a name service.
Choose one of the following methods to set the timeserver keyword:
To configure the system to serve as its own time server, set timeserver=localhost. If you specify localhost as the time server, the system's time is assumed to be correct.
To specify another system as the time server, specify either the host name or the IP address of the time server with the timeserver keyword. Use the following syntax:
timeserver=host-name or ip-address |
where host-name is the host name of the time server system, and ip-address specifies the IP address of the time server.
You can configure monitor information with the monitor keyword. Use the following syntax with the monitor keyword:
monitor=monitor-type |
To set the value for the monitor keyword, run the kdmconfig -d command on the system that you want to install. Copy the line of output that includes the monitor keyword, and include this line in the sysidcfg file.
You can configure the keyboard language and layout information with the keyboard keyword. Use the following syntax with the keyboard keyword:
keyboard=keyboard-language {layout=value} |
To set the value for the keyboard keyword, run the kdmconfig -d command on the system you want to install. Copy the line of output that includes the keyboard keyword, and include this line in the sysidcfg file.
You can configure the following information with the display keyword:
Graphics card
Screen size
Color depth
Display resolution
Use the following syntax with the display keyword:
display=graphics_card {size=screen_size depth=color_depth resolution=screen_resolution} |
To set the appropriate values for the display keyword, run the kdmconfig -d command on the system you want to install. Copy the line of output that includes the display keyword, and include this line in the sysidcfg file.
You can configure the following mouse information with the pointer keyword:
Pointing device
Number of buttons
IRQ level
Use the following syntax with the pointer keyword:
pointer=pointing-device {nbuttons=number-buttons irq=value} |
To set the value for the pointer keyword, run the kdmconfig -d command on the system that you want to install. Copy the line of output that includes the pointer keyword, and include this line in the sysidcfg file.
For more information about all of these keywords, see the kdmconfig(1M) man page.
The Solaris OS installation programs require you to provide configuration information about a system, such as peripheral devices, host name, IP address, and name service (if applicable). Before the installation tools prompt you for this configuration information, the tools check for this information in the sysidcfg file and then in the name services databases (if applicable). When the Solaris installation program or the custom JumpStart installation program detects preconfigured system information in the sysidcfg file, you are not prompted to enter this information manually, which saves on time and resources. For example, if you have several systems, and you do not want a time zone prompt displayed every time you install the Solaris OS, you can specify the time zone in the sysidcfg file.
For more information about the sysidcfg file, see the sysidcfg(4) man page.
Using a text editor, create a file named sysidcfg.
Type the keywords that you want to include in the sysidcfg configuration file. See Preconfiguring With the sysidcfg File for guidelines and syntax to use.
Save the sysidcfg file.
If you create more than one sysidcfg file, you must save each file in a separate directory or on a separate diskette.
Make the sysidcfg file available to clients through either of the following:
A shared NFS file system. Use the add_install_client command with the -p option to set up the system to install from the network.
The root (/) directory on a UFS diskette or PCFS diskette.
The following example shows a sysidcfg file for a group of systems that use the same type of keyboard, graphics cards, and pointing devices information. If the sysidcfg file in this example were used, you would be prompted to select a language (system_locale) before the installation could proceed.
The device information (keyboard, display, and pointer) was obtained by running the kdmconfig command with the -d option. See the kdmconfig(1M) man page for more information.
keyboard=ATKBD {layout=US-English} display=ati {size=15-inch} pointer=MS-S timezone=US/Central timeserver=timehost1 terminal=ibm-pc name_service=NIS {domain_name=marquee.central.example.com name_server=nmsvr2(172.25.112.3)} root_password=URFUni9 |
If you plan to use the sysidcfg file in an installation over the network, you need to set up an installation server and add the system as an installation client. For more information, see Preparing to Install the Solaris Operating System on IBM BladeCenter Servers (Task Map) and Preconfiguring With the sysidcfg File.
If you plan to use the sysidcfg file in a custom JumpStart installation, you need to create a profile and a rules.ok file. See How To Create a rules File.