usr/src/man/man1m/in.rdisc.1m

   1 '\" te
   2 .\" Copyright (c) 2004 Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH IN.RDISC 1M "Nov 9, 2006"
   8 .SH NAME
   9 in.rdisc, rdisc \- network router discovery daemon
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/sbin/in.rdisc\fR  [\fB-a\fR] [\fB-f\fR] [\fB-s\fR] [\fIsend-address\fR] [\fIreceive-address\fR]
  14 .fi
  15
  16 .LP
  17 .nf
  18 \fB/usr/sbin/in.rdisc\fR  \fB-r\fR [\fB-p\fR \fIpreference\fR] [\fB-T\fR \fIinterval\fR]
  19  [\fIsend-address\fR] [\fIreceive-address\fR]
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 \fBin.rdisc\fR remains part of the software distribution of the Solaris
  26 Operating Environment. It is, however, not used by default. \fBin.routed\fR(1M)
  27 includes the functionality provided by \fBin.rdisc\fR. See \fBrouteadm\fR(1M)
  28 for details of how to specify the IPV4 routing daemon.
  29 .sp
  30 .LP
  31 \fBin.rdisc\fR implements the \fBICMP\fR router discovery protocol. The first
  32 form of the command is used on hosts and the second form is used on routers.
  33 .sp
  34 .LP
  35 \fBin.rdisc\fR can be invoked in either the first form (host mode) or second
  36 form (router mode).
  37 .sp
  38 .LP
  39 On a host, \fBin.rdisc\fR populates the network routing tables with default
  40 routes. On a router, advertises the router to all the hosts.
  41 .sp
  42 .LP
  43 \fBin.rdisc\fR is managed by the service management facility (SMF), by means of
  44 the service identifier:
  45 .sp
  46 .in +2
  47 .nf
  48 svc:/network/routing/rdisc:default
  49 .fi
  50 .in -2
  51 .sp
  52
  53 .SS "Host (First Form)"
  54 .sp
  55 .LP
  56 On a host, \fBin.rdisc\fR listens on the \fBALL_HOSTS\fR (224.0.0.1) multicast
  57 address for \fBROUTER_ADVERTISE\fR messages from routers. The received messages
  58 are handled by first ignoring those listed router addresses with which the host
  59 does not share a network. Among the remaining addresses, the ones with the
  60 highest preference are selected as default routers and a default route is
  61 entered in the kernel routing table for each one of them.
  62 .sp
  63 .LP
  64 Optionally, \fBin.rdisc\fR can avoid waiting for routers to announce themselves
  65 by sending out a few \fBROUTER_SOLICITATION\fR messages to the
  66 \fBALL_ROUTERS\fR (224.0.0.2) multicast address when it is started.
  67 .sp
  68 .LP
  69 A timer is associated with each router address. The address will no longer be
  70 considered for inclusion in the routing tables if the timer expires before a
  71 new \fIadvertise\fR message is received from the router. The address will also
  72 be excluded from consideration if the host receives an \fIadvertise\fR message
  73 with the preference being maximally negative or with a lifetime of zero.
  74 .SS "Router (Second Form)"
  75 .sp
  76 .LP
  77 When \fBin.rdisc\fR is started on a router, it uses the \fBSIOCGIFCONF\fR
  78 \fBioctl\fR(2) to find the interfaces configured into the system and it starts
  79 listening on the \fBALL_ROUTERS\fR multicast address on all the interfaces that
  80 support multicast. It sends out \fIadvertise\fR messages to the \fBALL_HOSTS\fR
  81 multicast address advertising all its \fBIP\fR addresses. A few initial
  82 \fIadvertise\fR messages are sent out during the first 30 seconds and after
  83 that it will transmit \fIadvertise\fR messages approximately every 600 seconds.
  84 .sp
  85 .LP
  86 When \fBin.rdisc\fR receives a \fIsolicitation\fR message, it sends an
  87 \fIadvertise\fR message to the host that sent the \fIsolicitation\fR message.
  88 .sp
  89 .LP
  90 When \fBin.rdisc\fR is terminated by a signal, it sends out an \fIadvertise\fR
  91 message with the preference being maximally negative.
  92 .SH OPTIONS
  93 .sp
  94 .LP
  95 Supported options and equivalent SMF service properties are listed below. SMF
  96 service properties are set using a command of the form:
  97 .sp
  98 .in +2
  99 .nf
 100 # \fBrouteadm -m rdisc:default \fIkey\fR=\fIvalue\fR\fR
 101 .fi
 102 .in -2
 103 .sp
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fB-a\fR\fR
 109 .ad
 110 .RS 17n
 111 Accept all routers independent of the preference they have in their
 112 \fIadvertise\fR messages. Normally, \fBin.rdisc\fR only accepts (and enters in
 113 the kernel routing tables) the router or routers with the highest preference.
 114 Use of this option is equivalent to setting the \fBaccept_all\fR property to
 115 true.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fB-f\fR\fR
 122 .ad
 123 .RS 17n
 124 Run \fBin.rdisc\fR forever even if no routers are found. Normally,
 125 \fBin.rdisc\fR gives up if it has not received any \fIadvertise\fR message
 126 after soliciting three times, in which case it exits with a non-zero exit code.
 127 If \fB-f\fR is not specified in the first form then \fB-s\fR must be specified.
 128 For SMF execution, this option is required.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fB-r\fR\fR
 135 .ad
 136 .RS 17n
 137 Act as a router, rather than a host. Use of this option is equivalent to
 138 setting the \fBact_as_router\fR property to true.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fB-s\fR\fR
 145 .ad
 146 .RS 17n
 147 Send three \fIsolicitation\fR messages initially to quickly discover the
 148 routers when the system is booted. When \fB-s\fR is specified, \fBin.rdisc\fR
 149 exits with a non-zero exit code if it can not find any routers. This can be
 150 overridden with the \fB-f\fR option. This option is not compatible with SMF
 151 execution and is not supported for the \fBrdisc\fR service.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB-p\fR \fIpreference\fR\fR
 158 .ad
 159 .RS 17n
 160 Set the preference transmitted in the \fIsolicitation\fR messages. The default
 161 is zero. Use of this option is equivalent to setting the \fBpreference\fR
 162 property.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fB-T\fR \fIinterval\fR\fR
 169 .ad
 170 .RS 17n
 171 Set the interval between transmitting the \fIadvertise\fR messages. The default
 172 time is 600 seconds. Use of this option is equivalent to setting the
 173 \fBtransmit_interval\fR property.
 174 .RE
 175
 176 .sp
 177 .LP
 178 The \fBsend-address\fR and \fBreceive-address\fR daemon options  can be set by
 179 means of the \fBsend_address\fR and \fBreceive_address\fR properties.
 180 .SH SEE ALSO
 181 .sp
 182 .LP
 183 \fBin.routed\fR(1M), \fBrouteadm\fR(1M), \fBsvcadm\fR(1M), \fBioctl\fR(2),
 184 \fBgateways\fR(4), \fBattributes\fR(5), \fBsmf\fR(5), \fBicmp\fR(7P),
 185 \fBinet\fR(7P)
 186 .sp
 187 .LP
 188 Deering, S.E., editor, \fIICMP Router Discovery Messages\fR, \fBRFC\fR 1256,
 189 Network Information Center, SRI International, Menlo Park, California,
 190 September 1991.