xref: /illumos-gate/usr/src/lib/libslp/etc/slp.conf.example (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
17c478bd9Sstevel@tonic-gate#
27c478bd9Sstevel@tonic-gate# CDDL HEADER START
37c478bd9Sstevel@tonic-gate#
47c478bd9Sstevel@tonic-gate# The contents of this file are subject to the terms of the
57c478bd9Sstevel@tonic-gate# Common Development and Distribution License, Version 1.0 only
67c478bd9Sstevel@tonic-gate# (the "License").  You may not use this file except in compliance
77c478bd9Sstevel@tonic-gate# with the License.
87c478bd9Sstevel@tonic-gate#
97c478bd9Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
107c478bd9Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
117c478bd9Sstevel@tonic-gate# See the License for the specific language governing permissions
127c478bd9Sstevel@tonic-gate# and limitations under the License.
137c478bd9Sstevel@tonic-gate#
147c478bd9Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
157c478bd9Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
167c478bd9Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
177c478bd9Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
187c478bd9Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
197c478bd9Sstevel@tonic-gate#
207c478bd9Sstevel@tonic-gate# CDDL HEADER END
217c478bd9Sstevel@tonic-gate#
227c478bd9Sstevel@tonic-gate# Copyright 1999 Sun Microsystems, Inc.  All rights reserved.
237c478bd9Sstevel@tonic-gate# Use is subject to license terms.
247c478bd9Sstevel@tonic-gate#
257c478bd9Sstevel@tonic-gate
267c478bd9Sstevel@tonic-gate#
277c478bd9Sstevel@tonic-gate# Example configuration file for SLP. This file lists and explains
287c478bd9Sstevel@tonic-gate# each property you can set for SLP. No properties are acutally set,
297c478bd9Sstevel@tonic-gate# so uncomment and edit any properties you wish to change. The
30*bbf21555SRichard Lowe# file /etc/inet/slp.conf must exist in order for slpd(8) to start,
317c478bd9Sstevel@tonic-gate# so copy this file to /etc/inet/slp.conf to enable SLP. See
32*bbf21555SRichard Lowe# slp.conf(5), slpd(8), or RFC 2614 for more information.
337c478bd9Sstevel@tonic-gate#
347c478bd9Sstevel@tonic-gate
357c478bd9Sstevel@tonic-gate# Specifies if slpd should act as a DA. Default is false.
367c478bd9Sstevel@tonic-gate#
377c478bd9Sstevel@tonic-gate# net.slp.isDA=true
387c478bd9Sstevel@tonic-gate#
397c478bd9Sstevel@tonic-gate
407c478bd9Sstevel@tonic-gate# Static scope configuration
417c478bd9Sstevel@tonic-gate#
427c478bd9Sstevel@tonic-gate# Determines the set of scopes which this SA or DA supports. These scopes
437c478bd9Sstevel@tonic-gate# will also be included in the list returned from a find scopes query.
447c478bd9Sstevel@tonic-gate# This example simply sets the property to the default:
457c478bd9Sstevel@tonic-gate# net.slp.useScopes=default
467c478bd9Sstevel@tonic-gate#
477c478bd9Sstevel@tonic-gate# This example sets the property to a site-specific list:
487c478bd9Sstevel@tonic-gate# net.slp.useScopes=building17,building18,admin
497c478bd9Sstevel@tonic-gate#
507c478bd9Sstevel@tonic-gate
517c478bd9Sstevel@tonic-gate# Static DA Configuration
527c478bd9Sstevel@tonic-gate#
537c478bd9Sstevel@tonic-gate# Forces UAs and SAs to use a set of DAs.
547c478bd9Sstevel@tonic-gate#
557c478bd9Sstevel@tonic-gate# This example specifies two DAs:
567c478bd9Sstevel@tonic-gate# net.slp.DAAddresses=192.168.1.20,192.168.2.20
577c478bd9Sstevel@tonic-gate#
587c478bd9Sstevel@tonic-gate
597c478bd9Sstevel@tonic-gate# Serialized Proxy Registrations
607c478bd9Sstevel@tonic-gate#
617c478bd9Sstevel@tonic-gate# Specifies a file containing a set of registrations to be processed
627c478bd9Sstevel@tonic-gate# when slpd starts up, written as an URL.
637c478bd9Sstevel@tonic-gate# To load a proxy-registration file at /etc/inet/slpd.reg:
647c478bd9Sstevel@tonic-gate# net.slp.serializedRegURL=file:/etc/inet/slpd.reg
657c478bd9Sstevel@tonic-gate#
667c478bd9Sstevel@tonic-gate
677c478bd9Sstevel@tonic-gate# Tracing and Logging
687c478bd9Sstevel@tonic-gate#
697c478bd9Sstevel@tonic-gate# By default, all tracing and logging is disabled.
707c478bd9Sstevel@tonic-gate#
717c478bd9Sstevel@tonic-gate# Display messages about traffic with DAs:
727c478bd9Sstevel@tonic-gate# net.slp.traceDATraffic=true
737c478bd9Sstevel@tonic-gate#
747c478bd9Sstevel@tonic-gate# Display details about SLP messages:
757c478bd9Sstevel@tonic-gate# net.slp.traceMsg=true
767c478bd9Sstevel@tonic-gate#
777c478bd9Sstevel@tonic-gate# Display details whenever a message is dropped:
787c478bd9Sstevel@tonic-gate# net.slp.traceDrop=true
797c478bd9Sstevel@tonic-gate#
807c478bd9Sstevel@tonic-gate# Dump service table upon registration or deregistration:
817c478bd9Sstevel@tonic-gate# net.slp.traceReg=true
827c478bd9Sstevel@tonic-gate#
837c478bd9Sstevel@tonic-gate
847c478bd9Sstevel@tonic-gate#
857c478bd9Sstevel@tonic-gate# Set this property to change the default DA Heartbeat (10800 seconds).
867c478bd9Sstevel@tonic-gate# This example sets it to 7200 seconds (two hours):
877c478bd9Sstevel@tonic-gate# net.slp.DAHeartBeat=7200
887c478bd9Sstevel@tonic-gate#
897c478bd9Sstevel@tonic-gate
907c478bd9Sstevel@tonic-gate#
917c478bd9Sstevel@tonic-gate# Use this property to configure special attributes for DAs; these
927c478bd9Sstevel@tonic-gate# will be included in the attrs field in a DAAdvert. Currently
937c478bd9Sstevel@tonic-gate# the only useful property is min-refresh-interval, which allows
947c478bd9Sstevel@tonic-gate# you to set the minimum interval for which a DA will accept
957c478bd9Sstevel@tonic-gate# registration refreshes. This example sets the minimum interval
967c478bd9Sstevel@tonic-gate# to 3 hours (10800 seconds):
977c478bd9Sstevel@tonic-gate# net.slp.DAAttributes=(min-refresh-interval=10800)
987c478bd9Sstevel@tonic-gate#
997c478bd9Sstevel@tonic-gate
1007c478bd9Sstevel@tonic-gate#
1017c478bd9Sstevel@tonic-gate# Use this property to configure special attributes for SAs; these
1027c478bd9Sstevel@tonic-gate# will be included in the attrs field in a SAAdvert. This example
1037c478bd9Sstevel@tonic-gate# sets the attribute "special-features" to "none":
1047c478bd9Sstevel@tonic-gate# net.slp.SAAttributes=(special-features=none)
1057c478bd9Sstevel@tonic-gate#
1067c478bd9Sstevel@tonic-gate
1077c478bd9Sstevel@tonic-gate#
1087c478bd9Sstevel@tonic-gate# Force SLP agents to use broadcast only (instead of the default multicast):
1097c478bd9Sstevel@tonic-gate# net.slp.isBroadcastOnly=true
1107c478bd9Sstevel@tonic-gate#
1117c478bd9Sstevel@tonic-gate
1127c478bd9Sstevel@tonic-gate#
1137c478bd9Sstevel@tonic-gate# Disable passive DA detection. Default is enabled.
1147c478bd9Sstevel@tonic-gate# net.slp.passiveDADetection=false
1157c478bd9Sstevel@tonic-gate#
1167c478bd9Sstevel@tonic-gate
1177c478bd9Sstevel@tonic-gate#
1187c478bd9Sstevel@tonic-gate# Change the multicast time-to-live (TTL). Default is 255. This example
1197c478bd9Sstevel@tonic-gate# limits SLP multicast to the local subnet only:
1207c478bd9Sstevel@tonic-gate# net.slp.multicastTTL=1
1217c478bd9Sstevel@tonic-gate#
1227c478bd9Sstevel@tonic-gate
1237c478bd9Sstevel@tonic-gate#
1247c478bd9Sstevel@tonic-gate# Set this property to change the default interval between DA discoveries.
1257c478bd9Sstevel@tonic-gate# Default is 900 seconds (15 minutes). This example changes it to 2 minutes
1267c478bd9Sstevel@tonic-gate# (at the risk of increasing network congestion):
1277c478bd9Sstevel@tonic-gate# net.slp.DAActiveDiscoveryInterval=120
1287c478bd9Sstevel@tonic-gate#
1297c478bd9Sstevel@tonic-gate
1307c478bd9Sstevel@tonic-gate#
1317c478bd9Sstevel@tonic-gate# Set this property to change the maximum amount of time to wait until
1327c478bd9Sstevel@tonic-gate# multicast convergance completes. Default is 15000 ms (15 seconds). This
1337c478bd9Sstevel@tonic-gate# example changes it to 20000 ms (20 seconds), which may be desirable on
1347c478bd9Sstevel@tonic-gate# congested networks with many SAs:
1357c478bd9Sstevel@tonic-gate# net.slp.multicastMaximumWait=20000
1367c478bd9Sstevel@tonic-gate#
1377c478bd9Sstevel@tonic-gate
1387c478bd9Sstevel@tonic-gate#
1397c478bd9Sstevel@tonic-gate# Set this property to control the intervals used in multicast convergance.
1407c478bd9Sstevel@tonic-gate# The default is 3000,3000,3000,3000,3000 (all 3 seconds). The following
1417c478bd9Sstevel@tonic-gate# example reduces the initial intervals, which may be increase responsiveness
1427c478bd9Sstevel@tonic-gate# on fast networks:
1437c478bd9Sstevel@tonic-gate# net.slp.multicastTimeouts=1000,1250,1500,2000,4000
1447c478bd9Sstevel@tonic-gate#
1457c478bd9Sstevel@tonic-gate# This example sets it to an aggressively short value; this may be useful
1467c478bd9Sstevel@tonic-gate# for increased responsiveness on fast, reliable networks:
1477c478bd9Sstevel@tonic-gate# net.slp.multicastTimeouts=1000
1487c478bd9Sstevel@tonic-gate
1497c478bd9Sstevel@tonic-gate#
1507c478bd9Sstevel@tonic-gate# This property works in a manner similar to net.slp.multicastTimeouts,
1517c478bd9Sstevel@tonic-gate# but acts on DA discovery multicast convergance instead. Default is
1527c478bd9Sstevel@tonic-gate# 2000,2000,2000,2000,3000,4000. This example increases the intervals,
1537c478bd9Sstevel@tonic-gate# which may help to discovery DAs which are slow, heavily loaded, or on
1547c478bd9Sstevel@tonic-gate# congested networks:
1557c478bd9Sstevel@tonic-gate# net.slp.DADiscoveryTimeouts=3000,3000,4000,4000,4000,4000
1567c478bd9Sstevel@tonic-gate#
1577c478bd9Sstevel@tonic-gate
1587c478bd9Sstevel@tonic-gate#
1597c478bd9Sstevel@tonic-gate# This property controls the retransmission intervals used for datagram
1607c478bd9Sstevel@tonic-gate# unicast. Default is 3000,3000,3000. This example decreases the
1617c478bd9Sstevel@tonic-gate# intervals for more aggressive retransmission, to 2 seconds:
1627c478bd9Sstevel@tonic-gate# net.slp.datagramTimeouts=2000,2000,2000
1637c478bd9Sstevel@tonic-gate#
1647c478bd9Sstevel@tonic-gate
1657c478bd9Sstevel@tonic-gate#
1667c478bd9Sstevel@tonic-gate# Set this property to change the maximum random wait bound (used with
1677c478bd9Sstevel@tonic-gate# initial DA discovery, for instance). Default is 1000 ms (1 second).
1687c478bd9Sstevel@tonic-gate# This example changes it to 2 seconds:
1697c478bd9Sstevel@tonic-gate# net.slp.randomWaitBound=2000
1707c478bd9Sstevel@tonic-gate#
1717c478bd9Sstevel@tonic-gate
1727c478bd9Sstevel@tonic-gate#
1737c478bd9Sstevel@tonic-gate# Change this property to change the maximum size of any datagram to
1747c478bd9Sstevel@tonic-gate# send (MTU), in bytes. Default is 1400. This example changes it to
1757c478bd9Sstevel@tonic-gate# 1500 bytes:
1767c478bd9Sstevel@tonic-gate# net.slp.MTU=1500
1777c478bd9Sstevel@tonic-gate#
1787c478bd9Sstevel@tonic-gate
1797c478bd9Sstevel@tonic-gate#
1807c478bd9Sstevel@tonic-gate# Set this property to restrict SLP to specific interfaces. Default is
1817c478bd9Sstevel@tonic-gate# empty, which causes SLP to use the the default interface.
1827c478bd9Sstevel@tonic-gate#
1837c478bd9Sstevel@tonic-gate# net.slp.interfaces=192.168.1.5,192.168.3.5
1847c478bd9Sstevel@tonic-gate#
1857c478bd9Sstevel@tonic-gate
1867c478bd9Sstevel@tonic-gate#
1877c478bd9Sstevel@tonic-gate# This property specifies the language tag to use for all messages.
1887c478bd9Sstevel@tonic-gate# Default is "en". This example changes it to "de":
1897c478bd9Sstevel@tonic-gate# net.slp.locale=de
1907c478bd9Sstevel@tonic-gate#
1917c478bd9Sstevel@tonic-gate
1927c478bd9Sstevel@tonic-gate#
1937c478bd9Sstevel@tonic-gate# Set this property to limit the total number of results for any
1947c478bd9Sstevel@tonic-gate# SLP query. Default is all results (-1). This example limits it
1957c478bd9Sstevel@tonic-gate# to 100:
1967c478bd9Sstevel@tonic-gate# net.slp.maxResults=100
1977c478bd9Sstevel@tonic-gate#
1987c478bd9Sstevel@tonic-gate
1997c478bd9Sstevel@tonic-gate#
2007c478bd9Sstevel@tonic-gate# A type hint will be used if an agent needs to discover scopes with
2017c478bd9Sstevel@tonic-gate# service agent solicitations. If the type hint is set, only service
2027c478bd9Sstevel@tonic-gate# agents which support those types will respond. In effect, this poses
2037c478bd9Sstevel@tonic-gate# the query: "find me all scopes which contain these service types."
2047c478bd9Sstevel@tonic-gate#
2057c478bd9Sstevel@tonic-gate# This sets the type hint to service:foo and service:bar:
2067c478bd9Sstevel@tonic-gate# net.slp.typeHint=service:foo,service:bar
2077c478bd9Sstevel@tonic-gate#
208