usr/src/man/man1m/ndd.1m

   1 '\" te
   2 .\" Copyright (C) 2007, 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 NDD 1M "Mar 13, 2009"
   7 .SH NAME
   8 ndd \- get and set driver configuration parameters
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBndd\fR [\fB-set\fR] \fIdriver\fR \fIparameter\fR [\fIvalue\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBndd\fR gets and sets selected configuration parameters in some kernel
  19 drivers. Currently, \fBndd\fR only supports the drivers that implement the
  20 \fBTCP/IP\fR Internet protocol family. Each driver chooses which parameters to
  21 make visible using \fBndd\fR. Since these parameters are usually tightly
  22 coupled to the implementation, they are likely to change from release to
  23 release. Some parameters may be read-only.
  24 .sp
  25 .LP
  26 If the \fB-set\fR option is omitted, \fBndd\fR queries the named \fIdriver\fR,
  27 retrieves the value associated with the specified \fIparameter\fR, and prints
  28 it. If the \fB-set\fR option is given, \fBndd\fR passes \fIvalue\fR, which must
  29 be specified, down to the named \fIdriver\fR which assigns it to the named
  30 \fIparameter\fR.
  31 .sp
  32 .LP
  33 By convention, drivers that support \fBndd\fR also support a special read-only
  34 \fIparameter\fR named ``\fB?\fR'' which can be used to list the parameters
  35 supported by the driver.
  36 .SH EXAMPLES
  37 .LP
  38 \fBExample 1 \fRGetting Parameters Supported By The TCP Driver
  39 .sp
  40 .LP
  41 To see which parameters are supported by the TCP driver, use the following
  42 command:
  43
  44 .sp
  45 .in +2
  46 .nf
  47 example% \fBndd /dev/tcp \e?\fR
  48 .fi
  49 .in -2
  50 .sp
  51
  52 .sp
  53 .LP
  54 The parameter name ``\fB?\fR'' may need to be escaped with a backslash to
  55 prevent its being interpreted as a shell meta character.
  56
  57 .sp
  58 .LP
  59 The following command sets the value of the parameter \fIip_forwarding\fR in
  60 the dual stack IP driver to zero. This disables IPv4 packet forwarding.
  61
  62 .sp
  63 .in +2
  64 .nf
  65 example% \fBndd -set /dev/ip ip_forwarding 0\fR
  66 .fi
  67 .in -2
  68 .sp
  69
  70 .sp
  71 .LP
  72 Similarly, in order to disable IPv6 packet forwarding, the value of parameter
  73 \fIip6_forwarding\fR
  74
  75 .sp
  76 .in +2
  77 .nf
  78 example% \fBndd -set /dev/ip ip6_forwarding 0\fR
  79 .fi
  80 .in -2
  81 .sp
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBnca\fR(1), \fBdladm\fR(1M), \fBioctl\fR(2), \fBattributes\fR(5),
  87 \fBarp\fR(7P), \fBip\fR(7P), \fBip6\fR(7P), \fBtcp\fR(7P), \fBudp\fR(7P)
  88 .SH NOTES
  89 .sp
  90 .LP
  91 The parameters supported by each driver may change from release to release.
  92 Like programs that read \fB/dev/kmem\fR, user programs or shell scripts that
  93 execute \fBndd\fR should be prepared for parameter names to change.
  94 .sp
  95 .LP
  96 The \fBioctl()\fR command that \fBndd\fR uses to communicate with drivers is
  97 likely to change in a future release. User programs should avoid making
  98 dependencies on it.
  99 .sp
 100 .LP
 101 The use of \fBndd\fR to administer Layer 2 (Data Link layer) drivers is
 102 strongly discouraged as this capability is to be obsoleted in a future release,
 103 replaced by \fBdladm\fR(1M). Please refer to the driver-specific man page in
 104 section 7D of the SunOS man pages.
 105 .sp
 106 .LP
 107 The meanings of many \fBndd\fR parameters make sense only if you understand how
 108 the driver is implemented.
 109 .sp
 110 .LP
 111 If a TCP driver sends a report that is truncated, it could be because that
 112 driver uses \fBndd\fR for transporting  the report. \fBndd\fR imposes a 64K
 113 limit on such reports.