openSolaris 2008 - <tt>wanboot.conf</tt> File Parameters and Syntax - Solaris Express Installation Guide: Network-Based Installations

`wanboot.conf` File Parameters and Syntax

The wanboot.conf file is a plain-text configuration file that the WAN boot installation programs use to perform a WAN installation. The following programs and files use the information included in the wanboot.conf file to install the client machine.

wanboot-cgi program
WAN boot file system
WAN boot miniroot

Save the wanboot.conf file in the appropriate client subdirectory in the /etc/netboot hierarchy on the WAN boot server. For information on how to define the scope of your WAN boot installation with the /etc/netboot hierarchy, see Creating the /etc/netboot Hierarchy on the WAN Boot Server.

You specify information in the wanboot.conf file by listing parameters with associated values in the following format.

parameter=value

Parameter entries cannot span lines. You can include comments in the file by preceding the comments with the # character.

For detailed information about the wanboot.conf file, see the man page wanboot.conf(4).

You must set the following parameters in the wanboot.conf file.

boot_file=wanboot-path

This parameter specifies the path to the wanboot program. The value is a path relative to the document root directory on the WAN boot server.

boot_file=/wanboot/wanboot.s10_sparc

root_server=wanbootCGI-URL/wanboot-cgi

This parameter specifies the URL of the wanboot-cgi program on the WAN boot server.

Use an HTTP URL if you are performing a WAN boot installation without client or server authentication.
```
root_server=https://www.example.com/cgi-bin/wanboot-cgi
```
Use an HTTPS URL if you are performing a WAN boot installation with server authentication, or server and client authentication.
```
root_server=https://www.example.com/cgi-bin/wanboot-cgi
```

root_file=miniroot-path

This parameter specifies the path to the WAN boot miniroot on the WAN boot server. The value is a path relative to the document root directory on the WAN boot server.

root_file=/miniroot/miniroot.s10_sparc

signature_type=sha1 | empty

This parameter specifies the type of hashing key to use to check the integrity of the data and files that are transmitted.

For WAN boot installations that use a hashing key to protect the wanboot program, set this value to sha1.
```
signature_type=sha1
```
For insecure WAN installations that do not use a hashing key, leave this value blank.
```
signature_type=
```

encryption_type=3des | aes | empty

This parameter specifies the type of encryption to use to encrypt the wanboot program and WAN boot file system.

For WAN boot installations that use HTTPS, set this value to 3des or aes to match the key formats you use. You must also set the signature_type keyword value to sha1.
```
encryption_type=3des
```
or
```
encryption_type=aes
```
For an insecure WAN boot installations that do not use encryption key, leave this value blank.
```
encryption_type=
```

server_authentication=yes | no

This parameter specifies if the server should be authenticated during the WAN boot installation.

For WAN boot installations with server authentication or server and client authentication, set this value to yes. You must also set the value of signature_type to sha1, encryption_type to 3des or aes, and the URL of root_server to an HTTPS value.
```
server_authentication=yes
```
For insecure WAN boot installations that do not use server authentication or server and client authentication, set this value to no. You can also leave the value blank.
```
server_authentication=no
```

client_authentication=yes | no

This parameter specifies if the client should be authenticated during a WAN boot installation.

For WAN boot installations with server and client authentication, set this value to yes. You must also set the value of signature_type to sha1, encryption_type to 3des or aes, and the URL of root_server to an HTTPS value.
```
client_authentication=yes
```
For WAN boot installations that do not use client authentication, set this value to no. You can also leave the value blank.
```
client_authentication=no
```

resolve_hosts=hostname | empty

This parameter specifies additional hosts that need to be resolved for the wanboot-cgi program during the installation.

Set the value to the host names of systems that are not specified previously in the wanboot.conf file or in a client certificate.

If all the required hosts are listed in the wanboot.conf file or the client certificate, leave this value blank.
```
resolve_hosts=
```
If specific hosts are not listed in the wanboot.conf file or the client certificate, set the value to these host names.
```
resolve_hosts=seahag,matters
```

boot_logger=bootlog-cgi-path | empty

This parameter specifies the URL to the bootlog-cgi script on the logging server.

To record boot or installation log messages on a dedicated logging server, set the value to the URL of the bootlog-cgi script on the logging server.
```
boot_logger=https://www.example.com/cgi-bin/bootlog-cgi
```
To display boot and installation messages on the client console, leave this value blank.
```
boot_logger=
```

system_conf=system.conf | custom-system-conf

This parameter specifies the path to the system configuration file that includes the location of sysidcfg and custom JumpStart files.

Set the value to the path to the sysidcfg and custom JumpStart files on the web server.

system_conf=sys.conf

wanboot.conf File Parameters and Syntax

`wanboot.conf` File Parameters and Syntax