usr/src/man/man1m/6to4relay.1m

   1 '\" te
   2 .\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH 6TO4RELAY 1M "Nov 19, 2002"
   7 .SH NAME
   8 6to4relay \- administer configuration for 6to4 relay router communication
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/6to4relay\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/sbin/6to4relay\fR [\fB-e\fR] [\fB-a\fR \fIaddr\fR]
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fB/usr/sbin/6to4relay\fR [\fB-d\fR]
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fB/usr/sbin/6to4relay\fR [\fB-h\fR]
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fB6to4relay\fR command is used to configure 6to4 relay router
  34 communication. Relay router communication support is enabled by setting the
  35 value of a variable that stores an IPv4 address within the \fBtun\fR module.
  36 This variable is global to all tunnels and defines the policy for communication
  37 with relay routers. By default, the address is set to \fBINADDR_ANY\fR
  38 (\fB0.0.0.0\fR), and the kernel interprets the value to indicate that support
  39 for relay router communication is disabled. Otherwise, support is enabled, and
  40 the specified address is used as the IPv4 destination address when packets
  41 destined for native IPv6 (non-6to4) hosts are sent through the 6to4 tunnel
  42 interface. The \fB6to4relay\fR command uses a project private ioctl to set the
  43 variable.
  44 .sp
  45 .LP
  46 \fB6to4relay\fR used without any options outputs the current, in-kernel,
  47 configuration status. Use the \fB-a\fR option to send packets to a specific
  48 relay router's \fBunicast\fR address instead of the default \fBanycast\fR
  49 address. The address specified with the \fB-a\fR option does not specify the
  50 policy for receiving traffic from relay routers. The source relay router on a
  51 received packet is non-deterministic, since a different relay router may be
  52 chosen for each sending native IPv6 end-point.
  53 .sp
  54 .LP
  55 Configuration changes made by using the \fB6to4relay\fR are not persistent
  56 across reboot. The changes will persist in the kernel only until you take the
  57 tunnel down
  58 .SH OPTIONS
  59 .sp
  60 .LP
  61 The \fB6to4relay\fR command supports the following options:
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fB-a\fR \fIaddr\fR\fR
  66 .ad
  67 .RS 11n
  68 Use the specified address, \fIaddr\fR.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-e\fR\fR
  75 .ad
  76 .RS 11n
  77 Enable support for relay router. Use \fB-a\fR \fIaddr\fR if it is specified.
  78 Otherwise, use the default \fBanycast\fR address, 192.88.99.1.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB-d\fR\fR
  85 .ad
  86 .RS 11n
  87 Disable support for the relay router.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fB-h\fR\fR
  94 .ad
  95 .RS 11n
  96 Help
  97 .RE
  98
  99 .SH OPERANDS
 100 .sp
 101 .LP
 102 The following operands are supported:
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fIaddr\fR\fR
 107 .ad
 108 .RS 8n
 109 A specific relay router's unicast address. \fIaddr\fR must be specified as a
 110 dotted decimal representation of an IPv4 address. Otherwise, an error will
 111 occur, and the command will fail.
 112 .RE
 113
 114 .SH EXAMPLES
 115 .LP
 116 \fBExample 1 \fRPrinting the In-Kernel Configuration Status
 117 .sp
 118 .LP
 119 Use \fB/usr/sbin/6to4relay\fR without any options to print the in-kernel
 120 configuration status.
 121
 122 .sp
 123 .in +2
 124 .nf
 125 example# \fB/usr/sbin/6to4relay\fR
 126 .fi
 127 .in -2
 128 .sp
 129
 130 .sp
 131 .LP
 132 If 6to4 relay router communication is disabled, the administrator will see the
 133 following message:
 134
 135 .sp
 136 .in +2
 137 .nf
 138 6to4relay: 6to4 Relay Router communication support is disabled.
 139 .fi
 140 .in -2
 141 .sp
 142
 143 .sp
 144 .LP
 145 If 6to4 router communication is enabled, the user will see this message:
 146 .sp
 147 .in +2
 148 .nf
 149 6to4relay: 6to4 Relay Router communication support is enabled.
 150 IPv4 destination address of Relay Router = 192.88.99.1
 151 .fi
 152 .in -2
 153 .sp
 154
 155 .SH EXIT STATUS
 156 .sp
 157 .LP
 158 The following exit values are returned:
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fB0\fR \fR
 163 .ad
 164 .RS 6n
 165 Successful completion.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB>\fB0\fR\fR
 172 .ad
 173 .RS 6n
 174 An error occurred.
 175 .RE
 176
 177 .SH FILES
 178 .sp
 179 .ne 2
 180 .na
 181 \fB\fB/usr/sbin/6to4relay\fR \fR
 182 .ad
 183 .RS 24n
 184 The default installation root
 185 .RE
 186
 187 .SH SEE ALSO
 188 .sp
 189 .LP
 190 \fBifconfig\fR(1M), \fBattributes\fR(5)
 191 .sp
 192 .LP
 193 Huitema, C. \fIRFC 3068, An Anycast Prefix for 6to4 Relay Routers\fR. Network
 194 Working Group. June, 2001.
 195 .sp
 196 .LP
 197 Carpenter, B. and Moore, K. \fIRFC 3056, Connection of IPv6 Domains via IPv4
 198 Clouds\fR. Network Working Group. February, 2001.
 199 .SH DIAGNOSTICS
 200 .sp
 201 .LP
 202 The \fB6to4relay\fR reports the following messages:
 203 .sp
 204 .in +2
 205 .nf
 206 6to4relay: input (0.0.0.0) is not a valid IPv4 unicast address
 207 .fi
 208 .in -2
 209 .sp
 210
 211 .RS +4
 212 \fBExample: \fR
 213 .sp
 214 .LP
 215 The following example provides an incorrect unicast address.
 216 .sp
 217 .in +2
 218 .nf
 219 example# \fB6to4relay -e -a 0.0.0.0\fR
 220 .fi
 221 .in -2
 222 .sp
 223 \fBDescription: \fR
 224 .sp
 225 .LP
 226 The address specified with the \fB-a\fR option must be a valid unicast address.
 227 .RE
 228
 229 .sp
 230 .in +2
 231 .nf
 232 6to4relay: option requires an argument -a
 233 usage:
 234     6to4relay
 235     6to4relay -e [-a <addr>]
 236     6to4relay -d
 237     6to4relay -h
 238 .fi
 239 .in -2
 240 .sp
 241
 242 .RS +4
 243 \fBExample: \fR
 244 .sp
 245 .LP
 246 The following example does not include an argument for the \fB-a\fR option.
 247 .sp
 248 .in +2
 249 .nf
 250 example# \fB6to4relay -e -a \fR
 251 .fi
 252 .in -2
 253 .sp
 254 \fBDescription: \fR
 255 .sp
 256 .LP
 257 The \fB-a\fR option requires an argument.
 258 .RE
 259
 260 .sp
 261 .in +2
 262 .nf
 263 usage:
 264     6to4relay
 265     6to4relay -e [-a <addr>]
 266     6to4relay -d
 267     6to4relay -h
 268 .fi
 269 .in -2
 270 .sp
 271
 272 .RS +4
 273 \fBExample: \fR
 274 .sp
 275 .LP
 276 The following example specifies options that are not permitted.
 277 .sp
 278 .in +2
 279 .nf
 280 example# \fB6to4relay -e -d\fR
 281 .fi
 282 .in -2
 283 .sp
 284 \fBDescription: \fR
 285 .sp
 286 .LP
 287 The options specified are not permitted. A usage message is output to the
 288 screen.
 289 .RE
 290
 291 .sp
 292 .in +2
 293 .nf
 294 usage:
 295     6to4relay
 296     6to4relay -e [-a <addr>]
 297     6to4relay -d
 298     6to4relay -h
 299 .fi
 300 .in -2
 301 .sp
 302
 303 .RS +4
 304 \fBExample: \fR
 305 .sp
 306 .LP
 307 The following example specifies the \fB-a\fR option without specifying the
 308 \fB-e\fR option.
 309 .sp
 310 .in +2
 311 .nf
 312 example# \fB6to4relay -a 1.2.3.4\fR
 313 .fi
 314 .in -2
 315 .sp
 316 \fBDescription: \fR
 317 .sp
 318 .LP
 319 The \fB-e\fR option is required in conjunction with the \fB-a\fR option. A
 320 usage message is output to the screen.
 321 .RE
 322
 323 .sp
 324 .in +2
 325 .nf
 326 6to4relay: ioctl (I_STR) : Invalid argument
 327 .fi
 328 .in -2
 329 .sp
 330
 331 .RS +4
 332 \fBExample: \fR
 333 .sp
 334 .LP
 335 The following example specifies an invalid address.
 336 .sp
 337 .in +2
 338 .nf
 339 example# \fB6to4relay -e -a 239.255.255.255\fR
 340 .fi
 341 .in -2
 342 .sp
 343 \fBDescription: \fR
 344 .sp
 345 .LP
 346 The address specified with the \fB-a\fR option must not be a class d
 347 \fIaddr\fR.
 348 .RE
 349