share/man/man8/ndp.8

   1 .\"
   2 .\" This file and its contents are supplied under the terms of the
   3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4 .\" You may only use this file in accordance with the terms of version
   5 .\" 1.0 of the CDDL.
   6 .\"
   7 .\" A full copy of the text of the CDDL should have accompanied this
   8 .\" source.  A copy of the CDDL is also available via the Internet at
   9 .\" http://www.illumos.org/license/CDDL.
  10 .\"
  11 .\"
  12 .\" Copyright (c) 2015, Joyent, Inc.  All rights reserved.
  13 .\"
  14 .Dd Sep 02, 2015
  15 .Dt NDP 8
  16 .Os
  17 .Sh NAME
  18 .Nm ndp
  19 .Nd manipulate IPv6 Neighbor Discovery Protocol mappings
  20 .Sh SYNOPSIS
  21 .Nm
  22 .Op Fl n
  23 .Fl a
  24 .Nm
  25 .Op Fl n
  26 .Fl A Ar period
  27 .Nm
  28 .Op Fl n
  29 .Op Fl i Ar iface
  30 .Ar hostname
  31 .Nm
  32 .Op Fl n
  33 .Op Fl i Ar iface
  34 .Fl d Ar hostname
  35 .Nm
  36 .Op Fl n
  37 .Op Fl i Ar iface
  38 .Fl f Ar filename
  39 .Nm
  40 .Op Fl n
  41 .Op Fl i Ar iface
  42 .Fl s Ar hostname lladdr
  43 .Op Cm temp
  44 .Op Cm any
  45 .Op Cm router
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 command displays and modifies the IPv6-to-MAC address translation
  50 tables used by the Neighbor Discovery Protocol
  51 .Po see Xr ndp 7P Pc .
  52 .Pp
  53 Given just a hostname,
  54 .Nm
  55 will display the current entry.
  56 Note that when getting, setting or deleting, if a hostname refers to multiple
  57 IPv6 addresses, the operation will apply to all of them.
  58 .Pp
  59 The NDP translation tables can be modified with
  60 .Fl d ,
  61 .Fl s ,
  62 or
  63 .Fl f .
  64 These flags can only be used when
  65 .Nm
  66 is given the
  67 .Sy PRIV_SYS_NET_CONFIG
  68 privilege.
  69 See
  70 .Xr privileges 5
  71 for further information.
  72 .Pp
  73 Note that NDP entries for IPMP (IP Network Multipathing) data and
  74 test addresses are managed by the kernel and therefore cannot be
  75 modified or deleted.
  76 .Sh OPTIONS
  77 .Bl -tag -width 6m
  78 .It Fl a
  79 Display all NDP entries.
  80 Entries can be one of several types:
  81 .Bl -tag -offset indent -width 7n
  82 .It Sy dynamic
  83 This is a normal NDP mapping and will eventually expire.
  84 This is the most common type of mapping for non-local addresses that will be
  85 displayed.
  86 .It Sy local
  87 The IPv6 address is local to the machine.
  88 .It Sy other
  89 The mapping is a multicast or broadcast address, or the system is acting
  90 as proxy for the address.
  91 .It Sy static
  92 The mapping is static and will not be removed from the machine over time.
  93 .El
  94 .Pp
  95 Entries also exist in one of the following states:
  96 .Bl -tag -offset indent -width 12m
  97 .It Sy INCOMPLETE
  98 Address resolution is in progress
  99 .It Sy REACHABLE
 100 This address has recently been reachable
 101 .It Sy STALE
 102 This address may be unreachable
 103 .It Sy DELAY
 104 Waiting to send out reachability probes
 105 .It Sy PROBE
 106 Sending out probes for the address
 107 .It Sy UNREACHABLE
 108 The address is unreachable, and will be deleted
 109 .It Sy UNKNOWN
 110 The state of the entry is unknown
 111 .El
 112 .Pp
 113 Using the
 114 .Fl a
 115 flag is equivalent to:
 116 .sp
 117 .Dl # netstat -p -f inet6
 118 .sp
 119 If
 120 .Fl n
 121 is passed to
 122 .Nm ,
 123 then it will be passed along to
 124 .Nm netstat .
 125 .It Fl A
 126 Display all NDP entries every
 127 .Ar period
 128 seconds.
 129 .It Fl d
 130 Delete NDP mappings for the host called
 131 .Ar hostname .
 132 .It Fl f
 133 Read in the lines from
 134 .Ar filename
 135 and use each one to set a mapping.
 136 The syntax of each line is the same as the arguments to
 137 .Fl s .
 138 Lines beginning with `#' will be ignored.
 139 .It Fl i
 140 By default,
 141 .Nm
 142 will use the routing table to determine the appropriate interface to place the
 143 mapping on.
 144 This flag allows forcing a specific interface
 145 .Ar iface .
 146 This argument will be ignored when using the
 147 .Fl a
 148 or
 149 .Fl A
 150 flags.
 151 .It Fl n
 152 Disable the default translation of numeric IP addresses to host names when
 153 printing.
 154 .It Fl s
 155 Add or update an NDP mapping, and set the desired properties for the entry.
 156 The list of flags should be the full set of flags desired on the entry, i.e.,
 157 not listing a flag will remove it if it already exists.
 158 The following flags can be used:
 159 .Bl -tag -offset indent -width Ds
 160 .It Cm temp
 161 The entry should be temporary and eventually expire like a normal NDP
 162 entry.
 163 By default, all entries created with the
 164 .Nm
 165 command are static, and will not be deleted.
 166 To make a static entry temporary, it should be deleted and recreated with the
 167 .Cm temp
 168 flag.
 169 .It Cm any
 170 The address should be treated like an anycast address.
 171 This will prevent the system from sending Neighbor Advertisements with the
 172 Override flag.
 173 .It Cm router
 174 The address should be treated like a router address.
 175 This cause the system to send Neighbor Advertisements with the Router flag.
 176 .El
 177 .El
 178 .Sh EXAMPLES
 179 .Ss Example 1: Setting a mapping
 180 To create a temporary mapping for an address:
 181 .Bd -literal -offset indent
 182 # ndp -s fd00::1 90:b8:d0:4b:c7:3b temp
 183 .Ed
 184 .Ss Example 2: Getting a mapping
 185 An entry can be fetched via its IP address:
 186 .Bd -literal -offset indent
 187 # ndp fd00::1
 188 fd00::1 (fd00::1) at 90:b8:d0:4b:c7:3b temp
 189 .Ed
 190 .sp
 191 Or via a name that resolves to that address:
 192 .Bd -literal -offset indent
 193 # echo fd00::1 epicac >> /etc/hosts
 194 # echo fd00::2 epicac >> /etc/hosts
 195 # ndp epicac
 196 fd00::1 (epicac) at 90:b8:d0:4b:c7:3b temp
 197 fd00::2 (epicac) -- no entry
 198 .Ed
 199 .Ss Example 3: Deleting a mapping
 200 An entry can be removed with the
 201 .Fl d
 202 flag:
 203 .Bd -literal -offset indent
 204 # ndp -d fd00::1
 205 .Ed
 206 .sp
 207 Attempting to remove it again will print an error message:
 208 .Bd -literal -offset indent
 209 # ndp -d fd00::1
 210 ndp: No entry for fd00::1
 211 .Ed
 212 .Sh STABILITY
 213 The command line options for this command are stable, but the output format
 214 and diagnostic messages are not.
 215 .Sh SEE ALSO
 216 .Xr arp 8 ,
 217 .Xr ifconfig 8 ,
 218 .Xr netstat 8 ,
 219 .Xr attributes 5 ,
 220 .Xr privileges 5 ,
 221 .Xr ndp 7P