xref: /onnv-gate/usr/src/cmd/cmd-inet/etc/wanboot.conf.sample (revision 0:68f95e015346)
1*0Sstevel@tonic-gate#
2*0Sstevel@tonic-gate# Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
3*0Sstevel@tonic-gate# Use is subject to license terms.
4*0Sstevel@tonic-gate#
5*0Sstevel@tonic-gate# CDDL HEADER START
6*0Sstevel@tonic-gate#
7*0Sstevel@tonic-gate# The contents of this file are subject to the terms of the
8*0Sstevel@tonic-gate# Common Development and Distribution License, Version 1.0 only
9*0Sstevel@tonic-gate# (the "License").  You may not use this file except in compliance
10*0Sstevel@tonic-gate# with the License.
11*0Sstevel@tonic-gate#
12*0Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
13*0Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
14*0Sstevel@tonic-gate# See the License for the specific language governing permissions
15*0Sstevel@tonic-gate# and limitations under the License.
16*0Sstevel@tonic-gate#
17*0Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
18*0Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
19*0Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
20*0Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
21*0Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
22*0Sstevel@tonic-gate#
23*0Sstevel@tonic-gate# CDDL HEADER END
24*0Sstevel@tonic-gate#
25*0Sstevel@tonic-gate# ident	"%Z%%M%	%I%	%E% SMI"
26*0Sstevel@tonic-gate
27*0Sstevel@tonic-gate####################################################################
28*0Sstevel@tonic-gate# wanboot.conf(4): boot configuration file.
29*0Sstevel@tonic-gate#
30*0Sstevel@tonic-gate# Please consult wanboot.conf(4) for further information.  Note that
31*0Sstevel@tonic-gate# this interface is "Evolving" as defined by attributes(5).
32*0Sstevel@tonic-gate#
33*0Sstevel@tonic-gate# Anything after a '#' is comment.  Values may be quoted (e.g. "val").
34*0Sstevel@tonic-gate#
35*0Sstevel@tonic-gate# <empty> means there is no value, i.e. null.  The absence of any
36*0Sstevel@tonic-gate# parameter implies that it takes a default value (<empty> unless
37*0Sstevel@tonic-gate# otherwise specified).
38*0Sstevel@tonic-gate#
39*0Sstevel@tonic-gate# <url> is of the form http://... or https://...
40*0Sstevel@tonic-gate####################################################################
41*0Sstevel@tonic-gate
42*0Sstevel@tonic-gate# The path of the bootstrap file (within htdocs) which is served up
43*0Sstevel@tonic-gate# by wanboot-cgi(bootfile).
44*0Sstevel@tonic-gate#
45*0Sstevel@tonic-gateboot_file=/bootfiles/wanboot	# <absolute pathname>
46*0Sstevel@tonic-gate
47*0Sstevel@tonic-gate# These are used by wanboot-cgi(bootfile|bootfs|rootfs) to determine
48*0Sstevel@tonic-gate# whether boot_file or the bootfs is to be sent encrypted/signed, or
49*0Sstevel@tonic-gate# root_file is to be sent signed; the client must be setup with the
50*0Sstevel@tonic-gate# corresponding encryption/signature key(s) (which cannot be auto-
51*0Sstevel@tonic-gate# matically verified).
52*0Sstevel@tonic-gate#
53*0Sstevel@tonic-gate# If an encryption_type is specified then a signature_type must also
54*0Sstevel@tonic-gate# be specified.
55*0Sstevel@tonic-gate#
56*0Sstevel@tonic-gateencryption_type=3des		# 3des | aes | <empty>
57*0Sstevel@tonic-gatesignature_type=sha1		# sha1 | <empty>
58*0Sstevel@tonic-gate
59*0Sstevel@tonic-gate# This is used by wanboot-cgi(bootfs) and wanboot to determine whether
60*0Sstevel@tonic-gate# server authentication should be requested during SSL connection
61*0Sstevel@tonic-gate# setup.
62*0Sstevel@tonic-gate#
63*0Sstevel@tonic-gateserver_authentication=yes	# yes | no
64*0Sstevel@tonic-gate
65*0Sstevel@tonic-gate# This is used by wanboot-cgi(bootfs) and wanboot to determine whether
66*0Sstevel@tonic-gate# client authentication should be requested during SSL connection
67*0Sstevel@tonic-gate# setup.  If client_authentication is "yes", then server_authentication
68*0Sstevel@tonic-gate# must also be "yes".
69*0Sstevel@tonic-gate#
70*0Sstevel@tonic-gateclient_authentication=yes	# yes | no
71*0Sstevel@tonic-gate
72*0Sstevel@tonic-gate# wanboot-cgi(bootfs) will construct a hosts file which resolves any
73*0Sstevel@tonic-gate# hostnames specified in any of the URLs in the wanboot.conf file,
74*0Sstevel@tonic-gate# plus those found in certificates, etc.  The following parameter
75*0Sstevel@tonic-gate# may be used to add additional mappings to the hosts file.
76*0Sstevel@tonic-gate#
77*0Sstevel@tonic-gateresolve_hosts=			# <hostname>[,<hostname>*] | <empty>
78*0Sstevel@tonic-gate
79*0Sstevel@tonic-gate# This is used to specify the URL of wanboot-cgi on the server on which
80*0Sstevel@tonic-gate# the root_file exists, and used by wanboot to obtain the root server's
81*0Sstevel@tonic-gate# URL; wanboot substitutes root_file for the pathname part of the URL.
82*0Sstevel@tonic-gate# If the schema is http://... then the root_file will be signed if there
83*0Sstevel@tonic-gate# is a non-empty signature_type.  If server_authentication is "yes", the
84*0Sstevel@tonic-gate# schema must be https://...; otherwise it must be http://...
85*0Sstevel@tonic-gate#
86*0Sstevel@tonic-gateroot_server=https://host:port/cgi-bin/wanboot-cgi	# <url> | <empty>
87*0Sstevel@tonic-gate
88*0Sstevel@tonic-gate# This is used by wanboot-cgi(rootfs) to locate the path of the
89*0Sstevel@tonic-gate# rootfs image (within htdocs) on the root_server.
90*0Sstevel@tonic-gate#
91*0Sstevel@tonic-gateroot_file=/rootimages/miniroot	# <absolute pathname> | <empty>
92*0Sstevel@tonic-gate
93*0Sstevel@tonic-gate# This is used by wanboot to determine the URL of the bootserver
94*0Sstevel@tonic-gate# (and whether bootlog traffic should be sent using http or https),
95*0Sstevel@tonic-gate# or whether it should simply be sent to the console.
96*0Sstevel@tonic-gate#
97*0Sstevel@tonic-gateboot_logger=			# <url> | <empty>
98*0Sstevel@tonic-gate
99*0Sstevel@tonic-gate# This is used by the system startup scripts. If set, it should
100*0Sstevel@tonic-gate# point to a file that contains name value pairs to be used at
101*0Sstevel@tonic-gate# start up time. For example, this file may be used to provide
102*0Sstevel@tonic-gate# install the values for sysidcfg and jumpscfg.
103*0Sstevel@tonic-gate#
104*0Sstevel@tonic-gatesystem_conf=system.conf
105