ndp.tproj/ndp.8

   1 .\" Copyright (c) 2012-2013 Apple Inc. All rights reserved.
   2 .\"
   3 .\" @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   4 .\"
   5 .\" This file contains Original Code and/or Modifications of Original Code
   6 .\" as defined in and that are subject to the Apple Public Source License
   7 .\" Version 2.0 (the 'License'). You may not use this file except in
   8 .\" compliance with the License. The rights granted to you under the License
   9 .\" may not be used to create, or enable the creation or redistribution of,
  10 .\" unlawful or unlicensed copies of an Apple operating system, or to
  11 .\" circumvent, violate, or enable the circumvention or violation of, any
  12 .\" terms of an Apple operating system software license agreement.
  13 .\"
  14 .\" Please obtain a copy of the License at
  15 .\" http://www.opensource.apple.com/apsl/ and read it before using this file.
  16 .\"
  17 .\" The Original Code and all software distributed under the License are
  18 .\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  19 .\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  20 .\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  21 .\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  22 .\" Please see the License for the specific language governing rights and
  23 .\" limitations under the License.
  24 .\"
  25 .\" @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  26 .\"
  27 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
  28 .\" All rights reserved.
  29 .\"
  30 .\" Redistribution and use in source and binary forms, with or without
  31 .\" modification, are permitted provided that the following conditions
  32 .\" are met:
  33 .\" 1. Redistributions of source code must retain the above copyright
  34 .\"    notice, this list of conditions and the following disclaimer.
  35 .\" 2. Redistributions in binary form must reproduce the above copyright
  36 .\"    notice, this list of conditions and the following disclaimer in the
  37 .\"    documentation and/or other materials provided with the distribution.
  38 .\" 3. Neither the name of the project nor the names of its contributors
  39 .\"    may be used to endorse or promote products derived from this software
  40 .\"    without specific prior written permission.
  41 .\"
  42 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  43 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  46 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52 .\" SUCH DAMAGE.
  53 .\"
  54 .Dd May 17, 1998
  55 .Dt NDP 8
  56 .Os
  57 .\"
  58 .Sh NAME
  59 .Nm ndp
  60 .Nd control/diagnose IPv6 neighbor discovery protocol
  61 .\"
  62 .Sh SYNOPSIS
  63 .Nm
  64 .Fl a
  65 .Op Fl lnt
  66 .Nm
  67 .Fl A Ar wait
  68 .Op Fl nt
  69 .Nm
  70 .Fl c
  71 .Op Fl nt
  72 .Nm
  73 .Fl d
  74 .Op Fl nt
  75 .Ar hostname
  76 .Nm
  77 .Fl f
  78 .Op Fl nt
  79 .Ar filename
  80 .Nm
  81 .Fl H
  82 .Nm
  83 .Fl I
  84 .Op Cm delete | Ar interface
  85 .Nm
  86 .Fl i
  87 .Ar interface
  88 .Op Ar flags...
  89 .Nm
  90 .Fl p
  91 .Nm
  92 .Fl P
  93 .Nm
  94 .Fl r
  95 .Nm
  96 .Fl R
  97 .Nm
  98 .Fl s
  99 .Op Fl nt
 100 .Ar nodename
 101 .Ar ether_addr
 102 .Op Li temp
 103 .Op Li proxy
 104 .\"
 105 .Sh DESCRIPTION
 106 The
 107 .Nm
 108 command manipulates the address mapping table
 109 used by Neighbor Discovery Protocol (NDP).
 110 .Bl -tag -width Ds
 111 .It Fl a
 112 Dump the currently existing NDP entries.
 113 .It Fl A Ar wait
 114 Repeat
 115 .Fl a
 116 (dump NDP entries)
 117 every
 118 .Ar wait
 119 seconds.
 120 .It Fl c
 121 Erase all the NDP entries.
 122 .It Fl d
 123 Delete specified NDP entry.
 124 .It Fl f
 125 Parse the file specified by
 126 .Ar filename .
 127 .It Fl H
 128 Harmonize consistency between the routing table and the default router
 129 list; install the top entry of the list into the kernel routing table.
 130 .It Fl I Op Cm delete | Ar interface
 131 Shows or specifies the default interface used as the default route when
 132 there is no default router.
 133 If no argument is given to the option,
 134 the current default interface will be shown.
 135 If an
 136 .Ar interface
 137 is specified, the interface will be used as the default.
 138 If a special keyword
 139 .Ic delete
 140 is specified, the current default interface will be deleted from the kernel.
 141 .It Fl i Ar interface Op Ar flags...
 142 View ND information for the specified interface.
 143 If additional arguments
 144 .Ar flags
 145 are given,
 146 .Nm
 147 sets or clears the specified flags for the interface.
 148 Possible flags are as follows.
 149 All of the flags can begin with the
 150 special character
 151 .Ql - ,
 152 which means the flag should be cleared.
 153 .\"
 154 .Bl -tag -width Ds -compact
 155 .It Xo
 156 .Ic nud
 157 .Xc
 158 turn on or off NUD (Neighbor Unreachability Detection) on the
 159 interface.
 160 NUD is usually turned on by default.
 161 .It Xo
 162 .Ic disabled
 163 .Xc
 164 IPv6 can be disabled separately from other network protocols. This flag can be
 165 turned on automatically when Duplicate Address Detection (DAD) indicates that
 166 another device on the network is using the same link-local address.
 167 .It Xo
 168 .Ic proxy_prefixes
 169 .Xc
 170 the interface is enabled to proxy neighbor discovery for global scope prefixes
 171 matching those on link at other interfaces.
 172 .It Xo
 173 .Ic ignore_na
 174 .Xc
 175 ignore neighbor advertisements received on this interface.
 176 .It Xo
 177 .Ic insecure
 178 do not use cryptographically generated addresses (CGA) on this interface.
 179 .Xc
 180 .El
 181 .It Fl l
 182 Show link-layer reachability information.
 183 .It Fl n
 184 Do not try to resolve numeric address to hostname.
 185 .It Fl p
 186 Show prefix list.
 187 .It Fl P
 188 Flush all the entries in the prefix list.
 189 .It Fl r
 190 Show default router list.
 191 .It Fl R
 192 Flush all the entries in the default router list.
 193 .It Fl s
 194 Register an NDP entry for a node.
 195 The entry will be permanent unless the word
 196 .Li temp
 197 is given in the command.
 198 If the word
 199 .Li proxy
 200 is given, this system will act as an proxy NDP server,
 201 responding to requests for
 202 .Ar hostname
 203 even though the host address is not its own.
 204 .It Fl t
 205 Print timestamp on each entries,
 206 to make it possible to merge output with
 207 .Xr tcpdump 1 .
 208 Most useful when used with
 209 .Fl A .
 210 .It Fl x
 211 Show extended link-layer reachability information in addition to that shown by
 212 the
 213 .Fl l
 214 flag.
 215 .It Fl w
 216 Show the cryptographically generated address (CGA) parameters for the node.
 217 .El
 218 .\"
 219 .Sh RETURN VALUES
 220 The
 221 .Nm
 222 command will exit with 0 on success, and non-zero on errors.
 223 .\"
 224 .Sh SEE ALSO
 225 .Xr arp 8
 226 .\"
 227 .Sh HISTORY
 228 The
 229 .Nm
 230 command first appeared in WIDE Hydrangea IPv6 protocol stack kit.
 231 .\"
 232 .\" .Sh BUGS
 233 .\" (to be written)