sbin/atm/atmconfig/atmconfig.8

   1 .\"
   2 .\" Copyright (c) 2001-2003
   3 .\"     Fraunhofer Institute for Open Communication Systems (FhG Fokus).
   4 .\"     All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" Author: Hartmut Brandt <harti@FreeBSD.org>
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd August 11, 2003
  32 .Dt ATMCONFIG 8
  33 .Os
  34 .Sh NAME
  35 .Nm atmconfig
  36 .Nd "ATM configuration tool"
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl htv
  40 .Op Ar command Op Ar sub-command Op ...
  41 .Op Ar options
  42 .Op Ar arg ...
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 tool is used to configure the Netgraph ATM network sub-system.
  47 .Pp
  48 The command line of
  49 .Nm
  50 generally consists of common options followed by a command string, optionally
  51 followed by sub-command strings, optional command specific options and
  52 command specific arguments.
  53 Commands and sub-commands as well as command
  54 specific options may be abbreviated as
  55 long as there is only one match possible.
  56 .Ss Common Options
  57 The following common options change the overall behaviour of
  58 .Nm :
  59 .Bl -tag -width indent
  60 .It Fl h
  61 Print a very short usage info and exit.
  62 .It Fl t
  63 Several show-type commands output a header and then several lines
  64 of information.
  65 If this option is given, the header is omitted, simplifying the parsing
  66 of the output.
  67 .It Fl v
  68 Be more verbose.
  69 .El
  70 .Ss Obtaining Help
  71 The
  72 .Ic help
  73 command has a number of useful sub-commands.
  74 .Pp
  75 To get general help use:
  76 .D1 Nm Ic help
  77 .Pp
  78 To get a list of available commands use:
  79 .D1 Nm Ic help Cm commands
  80 .Pp
  81 To get a list of available sub-commands use:
  82 .D1 Nm Ic help Ar command
  83 .Pp
  84 or (if there are deeper levels of sub-commands):
  85 .D1 Nm Ic help Ar command sub-command ...
  86 .Pp
  87 To get a list of options and arguments for a command use:
  88 .D1 Nm Ic help Ar command sub-command ...
  89 (given that there are no further sub-command levels).
  90 .Pp
  91 To get a list of common options use:
  92 .D1 Nm Ic help Cm options
  93 .Ss The Ic diag Ss Command
  94 The
  95 .Ic diag
  96 command allows the inspection of the ATM interfaces on the local host
  97 and the modification of device parameters.
  98 Sub-commands are:
  99 .Cm list
 100 (print a list of interfaces),
 101 .Cm config
 102 (print hardware configuration),
 103 .Cm phy
 104 (access PHY chip),
 105 .Cm stats
 106 (print statistics) and
 107 .Cm vcc
 108 (print list of VCCs).
 109 .Bl -tag -width indent
 110 .\"----------------------------------------
 111 .It Nm Ic diag Cm list
 112 This sub-command lists all ATM interfaces in the system.
 113 It takes no options or arguments.
 114 .\"----------------------------------------
 115 .It Xo
 116 .Nm Ic diag Cm config
 117 .Op Fl atm
 118 .Op Fl hardware
 119 .Op Ar device ...
 120 .Xc
 121 This command prints the configuration of ATM interfaces.
 122 If no
 123 .Ar device
 124 is given, all devices are listed, otherwise only the specified devices.
 125 The option
 126 .Fl atm
 127 instructs the command to print ATM layer configuration parameters like
 128 the number of VCI and VPI bits, whereas the
 129 .Fl hardware
 130 option requests card specific information like the vendor or the serial
 131 number.
 132 If none of the options is given, the defaults is to assume
 133 .Fl atm .
 134 .\"----------------------------------------
 135 .It Xo
 136 .Nm Ic diag Cm phy print
 137 .Op Fl numeric
 138 .Ar device
 139 .Xc
 140 This command prints the PHY registers in a (potential)
 141 human comprehensible format.
 142 If
 143 .Fl numeric
 144 is given, the format is hex bytes.
 145 Otherwise, textual representation will be printed.
 146 .\"----------------------------------------
 147 .It Nm Ic diag Cm phy show Op Ar device ...
 148 This sub-command prints static information about the PHY device used
 149 in the ATM card like the type of the PHY and the media.
 150 .\"----------------------------------------
 151 .It Xo
 152 .Nm Ic diag Cm phy set
 153 .Ar device
 154 .Ar reg
 155 .Ar mask
 156 .Ar val
 157 .Xc
 158 This sub-command allows one to change bits in PHY registers.
 159 This should be used with great care.
 160 The bits of the given PHY chip register for which the corresponding bit in
 161 .Ar mask
 162 is one are set to the values of the corresponding bits in
 163 .Ar val .
 164 All register bits that have a zero in
 165 .Ar mask
 166 are written back with their original value.
 167 .\"----------------------------------------
 168 .It Xo
 169 .Nm Ic diag Cm phy stats
 170 .Op Fl clear
 171 .Ar device
 172 .Xc
 173 Print the PHY statistics for the given
 174 .Ar device .
 175 When the optional
 176 .Fl clear
 177 is given, the statistics are cleared atomically.
 178 .\"----------------------------------------
 179 .It Xo
 180 .Nm Ic diag Cm vcc
 181 .Op Fl abr
 182 .Op Fl channel
 183 .Op Fl traffic
 184 .Op Ar device
 185 .Xc
 186 Retrieve the list of currently active channels on either all
 187 or the specified interfaces.
 188 For each channel, the following information is printed depending
 189 on the options (default is
 190 .Fl channel ) .
 191 .Bl -tag -width ".Fl traffic"
 192 .It Fl abr
 193 Print ABR specific traffic parameters: ICR, TBE, NRM, TRM, ADTF, RIF, RDF,
 194 CDF.
 195 .It Fl channel
 196 Print basic information: VPI, VCI, AAL, traffic type, MTU and flags.
 197 .It Fl traffic
 198 Print traffic parameters: PCR, SCR, MBS, MCR.
 199 .El
 200 .\"----------------------------------------
 201 .It Nm Ic diag Cm stats Ar device
 202 Print driver specific statistics.
 203 .El
 204 .Ss The Ic natm Ss Command
 205 The
 206 .Ic natm
 207 command is used to change
 208 .Xr natmip 4
 209 routes on the local host.
 210 The sub-commands for the routing table are:
 211 .Cm add
 212 (to add a new route),
 213 .Cm delete
 214 (to delete an existing route) and
 215 .Cm show
 216 (to print the currently installed NATM routes).
 217 .Pp
 218 .Bl -tag -width indent -compact
 219 .\"----------------------------------------
 220 .It Xo
 221 .Nm Ic natm Cm add
 222 .Ar dest
 223 .Ar device
 224 .Ar vpi
 225 .Ar vci
 226 .Ar encaps
 227 .Xc
 228 .It Xo
 229 .Nm Ic natm Cm add
 230 .Ar dest
 231 .Ar device
 232 .Ar vpi
 233 .Ar vci
 234 .Ar encaps
 235 .Cm ubr Op Ar pcr
 236 .Xc
 237 .It Xo
 238 .Nm Ic natm Cm add
 239 .Ar dest
 240 .Ar device
 241 .Ar vpi
 242 .Ar vci
 243 .Ar encaps
 244 .Cm cbr Ar pcr
 245 .Xc
 246 .It Xo
 247 .Nm Ic natm Cm add
 248 .Ar dest
 249 .Ar device
 250 .Ar vpi
 251 .Ar vci
 252 .Ar encaps
 253 .Cm vbr Ar pcr scr mbs
 254 .Xc
 255 .It Xo
 256 .Nm Ic natm Cm add
 257 .Ar dest
 258 .Ar device
 259 .Ar vpi
 260 .Ar vci
 261 .Ar encaps
 262 .Cm abr Ar pcr mcr icr tbe nrm trm adtf rif rdf cdf
 263 .Xc
 264 Add a new route to the routing table.
 265 The destination address (the address
 266 on the other end of the link) is given in
 267 .Ar dest .
 268 The
 269 .Ar device ,
 270 .Ar vpi
 271 and
 272 .Ar vci
 273 arguments
 274 are the name of the ATM device and the VPI and VCI values for the link.
 275 The
 276 .Ar encaps
 277 argument
 278 may be either
 279 .Cm AAL5
 280 or
 281 .Cm LLC/SNAP
 282 both of which specify AAL5 encapsulation, the first one without additional
 283 encapsulation, the second one with LLC/SNAP headers.
 284 The first two forms of the command add an UBR (unspecified bit rate) channel,
 285 where the second form allows the optional specification of a peak cell
 286 rate (PCR).
 287 The third form adds a CBR (constant bit rate) channel where a PCR
 288 must be given.
 289 The fourth form adds a VBR (variable bit rate) channel.
 290 The arguments are the peak cell rate, the sustainable cell rate and the
 291 maximum bursts size.
 292 The last form of the command adds an ABR (available bit rate) channel.
 293 .\"----------------------------------------
 294 .Pp
 295 .It Nm Ic natm Cm delete Ar dest
 296 .It Xo
 297 .Nm Ic natm Cm delete
 298 .Ar device
 299 .Ar vpi
 300 .Ar vci
 301 .Xc
 302 This commands deletes an NATM route.
 303 The route may be specified either by the destination address or
 304 by the
 305 .Ar device , vpi
 306 and
 307 .Ar vci
 308 triple.
 309 .\"----------------------------------------
 310 .Pp
 311 .It Nm Ic natm Cm show
 312 List all NATM routes.
 313 .El
 314 .Sh SEE ALSO
 315 .Xr natm 4 ,
 316 .Xr natmip 4 ,
 317 .Xr atm 8
 318 .Sh AUTHORS
 319 .An Hartmut Brandt Aq harti@FreeBSD.org