320 lines
8.1 KiB
Groff
320 lines
8.1 KiB
Groff
.\"
|
|
.\" Copyright (c) 2001-2003
|
|
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" Author: Hartmut Brandt <harti@FreeBSD.org>
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd August 11, 2003
|
|
.Dt ATMCONFIG 8
|
|
.Os
|
|
.Sh NAME
|
|
.Nm atmconfig
|
|
.Nd "ATM configuration tool"
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl htv
|
|
.Op Ar command Op Ar sub-command Op ...
|
|
.Op Ar options
|
|
.Op Ar arg ...
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
tool is used to configure the Netgraph ATM network sub-system.
|
|
.Pp
|
|
The command line of
|
|
.Nm
|
|
generally consists of common options followed by a command string, optionally
|
|
followed by sub-command strings, optional command specific options and
|
|
command specific arguments.
|
|
Commands and sub-commands as well as command
|
|
specific options may be abbreviated as
|
|
long as there is only one match possible.
|
|
.Ss Common Options
|
|
The following common options change the overall behaviour of
|
|
.Nm :
|
|
.Bl -tag -width indent
|
|
.It Fl h
|
|
Print a very short usage info and exit.
|
|
.It Fl t
|
|
Several show-type commands output a header and then several lines
|
|
of information.
|
|
If this option is given, the header is omitted, simplifying the parsing
|
|
of the output.
|
|
.It Fl v
|
|
Be more verbose.
|
|
.El
|
|
.Ss Obtaining Help
|
|
The
|
|
.Ic help
|
|
command has a number of useful sub-commands.
|
|
.Pp
|
|
To get general help use:
|
|
.D1 Nm Ic help
|
|
.Pp
|
|
To get a list of available commands use:
|
|
.D1 Nm Ic help Cm commands
|
|
.Pp
|
|
To get a list of available sub-commands use:
|
|
.D1 Nm Ic help Ar command
|
|
.Pp
|
|
or (if there are deeper levels of sub-commands):
|
|
.D1 Nm Ic help Ar command sub-command ...
|
|
.Pp
|
|
To get a list of options and arguments for a command use:
|
|
.D1 Nm Ic help Ar command sub-command ...
|
|
(given that there are no further sub-command levels).
|
|
.Pp
|
|
To get a list of common options use:
|
|
.D1 Nm Ic help Cm options
|
|
.Ss The Ic diag Ss Command
|
|
The
|
|
.Ic diag
|
|
command allows the inspection of the ATM interfaces on the local host
|
|
and the modification of device parameters.
|
|
Sub-commands are:
|
|
.Cm list
|
|
(print a list of interfaces),
|
|
.Cm config
|
|
(print hardware configuration),
|
|
.Cm phy
|
|
(access PHY chip),
|
|
.Cm stats
|
|
(print statistics) and
|
|
.Cm vcc
|
|
(print list of VCCs).
|
|
.Bl -tag -width indent
|
|
.\"----------------------------------------
|
|
.It Nm Ic diag Cm list
|
|
This sub-command lists all ATM interfaces in the system.
|
|
It takes no options or arguments.
|
|
.\"----------------------------------------
|
|
.It Xo
|
|
.Nm Ic diag Cm config
|
|
.Op Fl atm
|
|
.Op Fl hardware
|
|
.Op Ar device ...
|
|
.Xc
|
|
This command prints the configuration of ATM interfaces.
|
|
If no
|
|
.Ar device
|
|
is given, all devices are listed, otherwise only the specified devices.
|
|
The option
|
|
.Fl atm
|
|
instructs the command to print ATM layer configuration parameters like
|
|
the number of VCI and VPI bits, whereas the
|
|
.Fl hardware
|
|
option requests card specific information like the vendor or the serial
|
|
number.
|
|
If none of the options is given, the defaults is to assume
|
|
.Fl atm .
|
|
.\"----------------------------------------
|
|
.It Xo
|
|
.Nm Ic diag Cm phy print
|
|
.Op Fl numeric
|
|
.Ar device
|
|
.Xc
|
|
This command prints the PHY registers in a (potential)
|
|
human comprehensible format.
|
|
If
|
|
.Fl numeric
|
|
is given, the format is hex bytes.
|
|
Otherwise, textual representation will be printed.
|
|
.\"----------------------------------------
|
|
.It Nm Ic diag Cm phy show Op Ar device ...
|
|
This sub-command prints static information about the PHY device used
|
|
in the ATM card like the type of the PHY and the media.
|
|
.\"----------------------------------------
|
|
.It Xo
|
|
.Nm Ic diag Cm phy set
|
|
.Ar device
|
|
.Ar reg
|
|
.Ar mask
|
|
.Ar val
|
|
.Xc
|
|
This sub-command allows one to change bits in PHY registers.
|
|
This should be used with great care.
|
|
The bits of the given PHY chip register for which the corresponding bit in
|
|
.Ar mask
|
|
is one are set to the values of the corresponding bits in
|
|
.Ar val .
|
|
All register bits that have a zero in
|
|
.Ar mask
|
|
are written back with their original value.
|
|
.\"----------------------------------------
|
|
.It Xo
|
|
.Nm Ic diag Cm phy stats
|
|
.Op Fl clear
|
|
.Ar device
|
|
.Xc
|
|
Print the PHY statistics for the given
|
|
.Ar device .
|
|
When the optional
|
|
.Fl clear
|
|
is given, the statistics are cleared atomically.
|
|
.\"----------------------------------------
|
|
.It Xo
|
|
.Nm Ic diag Cm vcc
|
|
.Op Fl abr
|
|
.Op Fl channel
|
|
.Op Fl traffic
|
|
.Op Ar device
|
|
.Xc
|
|
Retrieve the list of currently active channels on either all
|
|
or the specified interfaces.
|
|
For each channel, the following information is printed depending
|
|
on the options (default is
|
|
.Fl channel ) .
|
|
.Bl -tag -width ".Fl traffic"
|
|
.It Fl abr
|
|
Print ABR specific traffic parameters: ICR, TBE, NRM, TRM, ADTF, RIF, RDF,
|
|
CDF.
|
|
.It Fl channel
|
|
Print basic information: VPI, VCI, AAL, traffic type, MTU and flags.
|
|
.It Fl traffic
|
|
Print traffic parameters: PCR, SCR, MBS, MCR.
|
|
.El
|
|
.\"----------------------------------------
|
|
.It Nm Ic diag Cm stats Ar device
|
|
Print driver specific statistics.
|
|
.El
|
|
.Ss The Ic natm Ss Command
|
|
The
|
|
.Ic natm
|
|
command is used to change
|
|
.Xr natmip 4
|
|
routes on the local host.
|
|
The sub-commands for the routing table are:
|
|
.Cm add
|
|
(to add a new route),
|
|
.Cm delete
|
|
(to delete an existing route) and
|
|
.Cm show
|
|
(to print the currently installed NATM routes).
|
|
.Pp
|
|
.Bl -tag -width indent -compact
|
|
.\"----------------------------------------
|
|
.It Xo
|
|
.Nm Ic natm Cm add
|
|
.Ar dest
|
|
.Ar device
|
|
.Ar vpi
|
|
.Ar vci
|
|
.Ar encaps
|
|
.Xc
|
|
.It Xo
|
|
.Nm Ic natm Cm add
|
|
.Ar dest
|
|
.Ar device
|
|
.Ar vpi
|
|
.Ar vci
|
|
.Ar encaps
|
|
.Cm ubr Op Ar pcr
|
|
.Xc
|
|
.It Xo
|
|
.Nm Ic natm Cm add
|
|
.Ar dest
|
|
.Ar device
|
|
.Ar vpi
|
|
.Ar vci
|
|
.Ar encaps
|
|
.Cm cbr Ar pcr
|
|
.Xc
|
|
.It Xo
|
|
.Nm Ic natm Cm add
|
|
.Ar dest
|
|
.Ar device
|
|
.Ar vpi
|
|
.Ar vci
|
|
.Ar encaps
|
|
.Cm vbr Ar pcr scr mbs
|
|
.Xc
|
|
.It Xo
|
|
.Nm Ic natm Cm add
|
|
.Ar dest
|
|
.Ar device
|
|
.Ar vpi
|
|
.Ar vci
|
|
.Ar encaps
|
|
.Cm abr Ar pcr mcr icr tbe nrm trm adtf rif rdf cdf
|
|
.Xc
|
|
Add a new route to the routing table.
|
|
The destination address (the address
|
|
on the other end of the link) is given in
|
|
.Ar dest .
|
|
The
|
|
.Ar device ,
|
|
.Ar vpi
|
|
and
|
|
.Ar vci
|
|
arguments
|
|
are the name of the ATM device and the VPI and VCI values for the link.
|
|
The
|
|
.Ar encaps
|
|
argument
|
|
may be either
|
|
.Cm AAL5
|
|
or
|
|
.Cm LLC/SNAP
|
|
both of which specify AAL5 encapsulation, the first one without additional
|
|
encapsulation, the second one with LLC/SNAP headers.
|
|
The first two forms of the command add an UBR (unspecified bit rate) channel,
|
|
where the second form allows the optional specification of a peak cell
|
|
rate (PCR).
|
|
The third form adds a CBR (constant bit rate) channel where a PCR
|
|
must be given.
|
|
The fourth form adds a VBR (variable bit rate) channel.
|
|
The arguments are the peak cell rate, the sustainable cell rate and the
|
|
maximum bursts size.
|
|
The last form of the command adds an ABR (available bit rate) channel.
|
|
.\"----------------------------------------
|
|
.Pp
|
|
.It Nm Ic natm Cm delete Ar dest
|
|
.It Xo
|
|
.Nm Ic natm Cm delete
|
|
.Ar device
|
|
.Ar vpi
|
|
.Ar vci
|
|
.Xc
|
|
This commands deletes an NATM route.
|
|
The route may be specified either by the destination address or
|
|
by the
|
|
.Ar device , vpi
|
|
and
|
|
.Ar vci
|
|
triple.
|
|
.\"----------------------------------------
|
|
.Pp
|
|
.It Nm Ic natm Cm show
|
|
List all NATM routes.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr natm 4 ,
|
|
.Xr natmip 4 ,
|
|
.Xr atm 8
|
|
.Sh AUTHORS
|
|
.An Hartmut Brandt Aq harti@FreeBSD.org
|