share/man/man8/in.rdisc.8

   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 8 "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(8)
  27 includes the functionality provided by \fBin.rdisc\fR.
  28 .sp
  29 .LP
  30 \fBin.rdisc\fR implements the \fBICMP\fR router discovery protocol. The first
  31 form of the command is used on hosts and the second form is used on routers.
  32 .sp
  33 .LP
  34 \fBin.rdisc\fR can be invoked in either the first form (host mode) or second
  35 form (router mode).
  36 .sp
  37 .LP
  38 On a host, \fBin.rdisc\fR populates the network routing tables with default
  39 routes. On a router, advertises the router to all the hosts.
  40 .sp
  41 .LP
  42 \fBin.rdisc\fR is managed by the service management facility (SMF), by means of
  43 the service identifier:
  44 .sp
  45 .in +2
  46 .nf
  47 svc:/network/routing/rdisc:default
  48 .fi
  49 .in -2
  50 .sp
  51
  52 .SS "Host (First Form)"
  53 .sp
  54 .LP
  55 On a host, \fBin.rdisc\fR listens on the \fBALL_HOSTS\fR (224.0.0.1) multicast
  56 address for \fBROUTER_ADVERTISE\fR messages from routers. The received messages
  57 are handled by first ignoring those listed router addresses with which the host
  58 does not share a network. Among the remaining addresses, the ones with the
  59 highest preference are selected as default routers and a default route is
  60 entered in the kernel routing table for each one of them.
  61 .sp
  62 .LP
  63 Optionally, \fBin.rdisc\fR can avoid waiting for routers to announce themselves
  64 by sending out a few \fBROUTER_SOLICITATION\fR messages to the
  65 \fBALL_ROUTERS\fR (224.0.0.2) multicast address when it is started.
  66 .sp
  67 .LP
  68 A timer is associated with each router address. The address will no longer be
  69 considered for inclusion in the routing tables if the timer expires before a
  70 new \fIadvertise\fR message is received from the router. The address will also
  71 be excluded from consideration if the host receives an \fIadvertise\fR message
  72 with the preference being maximally negative or with a lifetime of zero.
  73 .SS "Router (Second Form)"
  74 .sp
  75 .LP
  76 When \fBin.rdisc\fR is started on a router, it uses the \fBSIOCGIFCONF\fR
  77 \fBioctl\fR(2) to find the interfaces configured into the system and it starts
  78 listening on the \fBALL_ROUTERS\fR multicast address on all the interfaces that
  79 support multicast. It sends out \fIadvertise\fR messages to the \fBALL_HOSTS\fR
  80 multicast address advertising all its \fBIP\fR addresses. A few initial
  81 \fIadvertise\fR messages are sent out during the first 30 seconds and after
  82 that it will transmit \fIadvertise\fR messages approximately every 600 seconds.
  83 .sp
  84 .LP
  85 When \fBin.rdisc\fR receives a \fIsolicitation\fR message, it sends an
  86 \fIadvertise\fR message to the host that sent the \fIsolicitation\fR message.
  87 .sp
  88 .LP
  89 When \fBin.rdisc\fR is terminated by a signal, it sends out an \fIadvertise\fR
  90 message with the preference being maximally negative.
  91 .SH OPTIONS
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fB-a\fR\fR
  96 .ad
  97 .RS 17n
  98 Accept all routers independent of the preference they have in their
  99 \fIadvertise\fR messages. Normally, \fBin.rdisc\fR only accepts (and enters in
 100 the kernel routing tables) the router or routers with the highest preference.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fB-f\fR\fR
 107 .ad
 108 .RS 17n
 109 Run \fBin.rdisc\fR forever even if no routers are found. Normally,
 110 \fBin.rdisc\fR gives up if it has not received any \fIadvertise\fR message
 111 after soliciting three times, in which case it exits with a non-zero exit code.
 112 If \fB-f\fR is not specified in the first form then \fB-s\fR must be specified.
 113 For SMF execution, this option is required.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB-r\fR\fR
 120 .ad
 121 .RS 17n
 122 Act as a router, rather than a host.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fB-s\fR\fR
 129 .ad
 130 .RS 17n
 131 Send three \fIsolicitation\fR messages initially to quickly discover the
 132 routers when the system is booted. When \fB-s\fR is specified, \fBin.rdisc\fR
 133 exits with a non-zero exit code if it can not find any routers. This can be
 134 overridden with the \fB-f\fR option. This option is not compatible with SMF
 135 execution and is not supported for the \fBrdisc\fR service.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fB-p\fR \fIpreference\fR\fR
 142 .ad
 143 .RS 17n
 144 Set the preference transmitted in the \fIsolicitation\fR messages. The default
 145 is zero.
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fB-T\fR \fIinterval\fR\fR
 152 .ad
 153 .RS 17n
 154 Set the interval between transmitting the \fIadvertise\fR messages. The default
 155 time is 600 seconds.
 156 .RE
 157
 158 .SH SEE ALSO
 159 .sp
 160 .LP
 161 \fBin.routed\fR(8), \fBsvcadm\fR(8), \fBioctl\fR(2),
 162 \fBgateways\fR(4), \fBattributes\fR(5), \fBsmf\fR(5), \fBicmp\fR(7P),
 163 \fBinet\fR(7P)
 164 .sp
 165 .LP
 166 Deering, S.E., editor, \fIICMP Router Discovery Messages\fR, \fBRFC\fR 1256,
 167 Network Information Center, SRI International, Menlo Park, California,
 168 September 1991.