NAME

atmsig − Allows the configuration and management of the UNI signaling module

SYNOPSIS

/usr/sbin/atmsig command arguments

FLAGS

This section is organized by the tasks you can perform with the atmsig command.  Each task subsection provides the atmsig command syntax and the arguments to use to complete the tasks. 

Enabling Signaling on an ATM Interface

Syntax:

atmsig up driver=driver_name [ilmi state=on|off
        [vci=vci# vpi=vpi# vc_options]]
   [sig vci=vci# vpi=vpi# vc_options]
   [timers [qsaal [qsaal_timers=value ...]
        q93b [q93b_timers=value ...]]]
   [account [state=on|off]]
   [trace [state=on|off]]
   [version [uni=3.0|3.1]]
   [wait]

upEnables signaling on the interface specified by the next argument.  The default VC used for signaling is VPI 0 and VCI 5. 

driver=driver_name
Specifies the interface.  This argument can appear anywhere on the command line.  The vc_options are described following this argument list. 

ilmi state=on|off vci=vci# vpi=vpi# vc_options
Enables (on) and disables (off) ILMI on the interface.  Specify a VCI number and VPI number, if you do not want to use the default. 

sig vci=vci# vpi=vpi# vc_options
Enables signaling on a VC other than the default.  Specify a VCI number and VPI number, if you do not want to use the default.  The vc_options are described following this argument list. 

timers [qsaal [qsaal_timers=value] q93b [q93b_timers=value]]
Specifies that the Q.SAAL or Q.93B timer values are to be modified. See "Modifying ATM Timer Values" for a description of timers.

account [state=on|off]
Enables (on) and disables (off) accounting information for a virtual circuit (VC).  By default, accounting is enabled. 

trace [state=on|off]
Enables (on) and disables (off) signaling packet tracing for the interface. 

version [uni=3.0|3.1]
Specifies the signaling version to use on the interface. The default is UNI3.0.

waitForces the command to wait until an address is registered with the switch and signaling is actually up on the interface. 

The following arguments specify the traffic contract parameters (vc_options), which describe the characteristics of the cell stream transferred over the PVC.  These parameters are defined in the ATM Forum User-Network Interface (UNI) Specification.  When setting up PVCs on the network, use the same traffic parameters when configuring the PVC on switches and the other end system. 

mtu=value

fmtu=value

bmtu=value
Specifies the maximum packet size that can be transmitted and received (mtu), transmitted (fmtu), or received (bmtu) on the PVC.  You can specify one value for both transmitted and received packets, or specify a value for transmitted and received packets separately.  If none of the mtu arguments are specified, a default value is set. 

qos=class

fqos=class

bqos=class
Specifies the quality of service requested in both (qos), the forward/outgoing (fqos), or backward/incoming (bqos) directions.  You can specify one value for both directions, or specify a value for forward and backward directions separately.  The class parameter specifies the quality of service required to meet a given service class’s performance objectives.  Valid qos_class values and example service classes are as follows:

NONEUnspecified (Best Effort). This is the default. 

AConnection oriented constant bit rate traffic with source/destination timing relationships. 

BConnection oriented variable bit rate traffic with source/destination timing relationships. 

CConnection oriented variable bit rate traffic with no timing relationships. 

DConnectionless variable bit rate traffic with no timing relationships. 

XUndefined bit rate traffic. 

YAvailable bit rate traffic. 

Local significance of quality of service is not fully implemented. 

+tagging | -tagging

+ftagging | -ftagging

+btagging | -btagging
Specifies if the traffic cells congestion bits are to be set/cleared on both (+tagging/-tagging), on outgoing (+ftagging/-ftagging), or on incoming (+btagging/-btagging) directions.  You can specify both directions, or specify the forward and backward directions separately.  By default, tagging is not set. 

Local significance of tagging is not fully implemented. 

+bei | -bei
Specifies that the best effort indicator be set (+bei) or cleared (-bei).  The best effort indicator is used with quality of service class NONE, and applies to both directions. 

By default, the best effort indicator is set. 

peak0=rate

fpeak0=rate

bpeak0=rate
Specifies, in cells per second, an upper bound on the PVC’s CLP 0 cell stream in both directions (peak0), in the outgoing direction (fpeak0), or in the incoming direction (bpeak0).  You can specify one rate for both directions, or specify a rate for outgoing and incoming directions separately.  By default, the CLP 0 peak cell rate is set to a minimum value. 

Peak cell rates only apply to adapters which support CBR and cell pacing. 

peak1=rate

fpeak1=rate

bpeak1=rate
Specifies an upper bound (in cells per second) on the PVC’s CLP 0+1 cell stream in both directions (peak1), in the outgoing direction (fpeak1), or in the incoming direction (bpeak1).  You can specify one rate for both directions, or specify a rate for outgoing and incoming directions separately.  By default, the CLP 0+1 peak cell rate is set to a minimum value. 

Peak cell rates only apply to adapters that support CBR and cell pacing. 

bbtraffic=NONE|CBR|pacing
Specifies the Broadband Bearer Capability Traffic Type.  For PVCs, specifying either CBR or pacing causes cells in the PVC’s traffic stream to be inserted into the network at the rate specified in the peak1 argument.  By default, bbtraffic is set to NONE. 

The CBR and pacing options only apply to adapters that support these modes. 

bbclass=NONE|A|C|X
Specifies the Broadband Bearer Capability Class of Bearer (BCOB).  By default, bbclass is set to NONE. 

bbtiming=NONE|req|notreq
Specifies the Broadband Bearer Capability Timing Requirements.  By default, bbtiming is set to NONE. 

Local significance of timing is not fully implemented. 

+bbclipping | -bbclipping
Specifies the Cell Loss Priority (CLP) of the PVC’s traffic cell stream. The +bbclipping argument indicates that the cells should be treated with low priority and should be dropped, if needed, during periods of congestion (CLP 0).  The -bbclipping argument indicates that the cells should be treated with high priority and should not be dropped during periods of congestion (CLP 1). 

By default, clipping is not set.  Local significance of clipping is not fully implemented. 

For example, the following command disables ILMI, enables packet tracing, and brings signaling up using VCI 100 and VPI 0 on interface lta0. 

atmsig up driver=lta0 ilmi state=off trace state=on sig \
vci=100 vpi=0

Disabling Signaling on an ATM Interface

Syntax:

atmsig down driver=driver_name

downDisables signaling on the driver_name interface.  If you disable the interface using the atmconfig command, signaling on that interface is also disabled.  You must enable signaling again using the up flag. 

driver=driver_name
Specifies the interface.  This argument can appear anywhere on the command line.

Enabling and Disabling ILMI on an ATM Interface

Syntax:

atmsig ilmi driver=driver_name [state=on|off] [vci=vci# vpi=vpi#]

ilmiSpecifies Interim Local Management Interface (ILMI).  If no options are specified, atmsig displays whether ILMI is enabled. 

driver=driver_name
Specifies the interface.  This argument can appear anywhere on the command line.

state=[on|off]
Enables (on) or disables (off) ILMI.  By default, ILMI is enabled on Virtual Path Identifier (VPI) 0 and Virtual Channel Identifier (VCI) 16 when signaling is enabled on that interface. 

vci=vci#
Specifies a VCI number, if you do not want to use the default.

vpi=vpi#
Specifies a VPI number, if you do not want to use the default.

Displaying ATM Interface Signaling State

Syntax:

atmsig state|status driver=driver_name [ilmi qsaal q93b]

state|status
Displays the state of Q.93B, Q.SAAL, and ILMI on an interface. The state and status result in the same behavior.  If no options are specified, atmsig displays the state of Q.93B, Q.SAAL, and ILMI, and whether tracing and accounting are enabled. 

driver=driver_name
Specifies the interface.  This argument can appear anywhere on the command line.

ilmiSpecifies ILMI. 

qsaalSpecifies Q.SAAL.  Q.SAAL is a generic name used to describe the transport layer for Q.93B. 

q93bSpecifies Q.93B.  Q.93B is a generic name for the signaling protocol employed at the User-Network Interface (UNI) of an ATM network. 

Displaying ATM Interface Signaling Statistics

Syntax:

atmsig stats driver=driver_name [qsaal q93b zero]

statsDisplays statistics for an interface.  If no options are specified, the statistics of Q.93B and Q.SAAL are displayed. 

driver=driver_name
Specifies the interface.  This argument can appear anywhere on the command line.

qsaalSpecifies Q.SAAL statistics. 

q93bSpecifies Q.93B statistics. 

zeroClears the counters after they are read and displayed. 

Modifying ATM Signaling Timer Values

Syntax:

atmsig timers driver=driver_name [qsaal
    [qsaal_timers=value ...] q93b [q93b_timers=value ...]]

timers Specifies that the timer values are to be modified for the interface specified by the next argument.  You must modify timer values before the signaling module is brought up on a specific interface.  If the interface is already running, disable the signaling module on the interface before setting the timer values.  If the driver on that interface is down, the timer values cannot be modified. 

driver=driver_name
Specifies the interface.  This argument can appear anywhere on the command line.

qsaalSpecifies Q.SAAL timers.  If no timer options are specified, atmsig displays the timers and their values. 

qsaal_timers=value ...
Sets a qsaal_timer to value (in seconds).  For 4.5 seconds, use the value 4.5; for 800 milliseconds, use the value .8.   You can specify multiple timers and values, delimited by a space.  The following table shows the Q.SAAL timers that can be modified:

Timer	Description
tcc	Connection control timer
tka	Keep alive timer
tnr	No response timer
tpl	Poll timer
tid	Idle timer (For UNI 3.1 only)

q93bSpecifies Q.93B timer.  If no timer options are specified, atmsig displays the timers and their values. 

q93b_timer=value ...
Sets a q93b_timer to value (in seconds).  You can specify multiple timers and values, delimited by a space.  The following table shows the Q.93B timers that can be modified:

Timer	Description
t303	T303 timer
t308	T308 timer
t309	T309 timer
t310	T310 timer
t313	T313 timer
t316	T316 timer
t322	T322 timer
t398	T398 timer
t399	T399 timer

For example, to set the T303 timer of Q.93B and the connection control timer of Q.SAAL on interface lta0 to 5 seconds and 790 milliseconds and 105 milliseconds, respectively, use the following command:

atmsig timer driver=lta0 qsaal tcc=0.105 q93b t303=5.790

Enabling ATM Signaling Packet Tracing

Syntax:

atmsig trace driver=driver_name [state=on|off] [read] [raw]

traceSpecifies signaling packet tracing on the interface specified by the next argument.  If no options are specified, atmsig displays whether packet tracing is enabled. 

driver=driver_name
Specifies the interface.  This argument can appear anywhere on the command line.

state=on|off
Enables (on) and disables (off) signaling packing tracing.  Once packet tracing is enabled, only the last 24 packets transmitted and received are cached. 

readReads the packets.  Reading UNI signaling packets during connection establishment and tear down phases might be helpful for debugging purposes. 

For example, the following command enables packet tracing and reads the incoming and outgoing packets:

atmsig trace driver=lta0 state=on read

All incoming packets are marked with the string ’------->’ and all out going packets are marked with the string ’<--------’.  All message types are not currently supported.  If a message type cannot be interpreted, the raw bytes are displayed. 

rawReads the data as it is received and displays the raw, hexadecimal data.  The data is not translated into packets. 

Decoding ATM Signaling Messages

Syntax:

atmsig decode [file=filename]

file=filename
Specifies an alternative file that contains signaling messages.  By default, the atmsig command expects to read a file named uni3 in the directory from which the command is invoked. 

This command enables you to decode UNI 3.0 signaling messages from a file that you create.  If atmsig cannot decode the message, the raw bytes are displayed. 

The file containing the message bytes (hexadecimal values) must adhere to the following guidelines:

       •Each message must start with the protocol discriminator 09 (hexadecimal). 

       •Each message sequence must be separated by a new line, without any characters or spaces in the line. 

       •If all message bytes consist of both nibbles (for example, a value of 9 represented as 09 hexadecimal), spaces are not required between each byte. 

       •If some message bytes consist of a single nibbles (for example, a value of 9 represented as 9 hexadecimal), spaces are required between each byte. 

For example, the following is a valid file containing two ATM signaling messages.  Although all message bytes consist of both nibbles, spaces are included in the example for readability only.  Note: The line after the first message is a new line that does not contain any spaces. 

09 03 80 00 02 02 80 00 09 5a 80 00 05 88 00 00
00 21
09 03 80 00 02 07 80 00 0f 58 80 00 0b 05 8c 23
e4 81 23 e4 83 01 84 00

The output of the atmsig decode command for the preceding file is as follows:

Message #1 :
Protocol Discriminator:        09
Call Reference                 (03 80)
Value:                         0002 [2]
Message Length:                0009 [9]
Message Type:                 CALL PROCEEDING          (02 80)
        Connection Id                  (5a 80)
        Length :                       0005 [5]
        Octet 5 (VPAS & P/E):          88
        VPI:                           0000 [0]
        VCI:                           0021 [33]
Message #2 :
Protocol Discriminator:        09
Call Reference                 (03 80)
Value:                         0002 [2]
Message Length:                000f [15]
Message Type:                 CONNECT                  (07 80)
        AAL Parameters                 (58 80)
        Length :                       000b [11]
        AAL Type :                     05
        FSDU:                          23e4 [9188]
        BSDU:                          23e4 [9188]
        Mode Id:                       01
        SSCS Type:                     00

Displaying and Setting the ATM Signaling Version

Syntax:

atmsig version driver=driver_name [uni=3.0|3.1]

versionDisplays or sets the signaling version to use on an interface.  If no version number is specified, atmsig displays the version number.  The default is UNI3.0. 

driver=driver_name
Specifies the interface.  This argument can appear anywhere on the command line.

Enabling and Disabling VC Accounting Information

Syntax:

atmsig account driver=driver_name [state=on|off]

accountSpecifies accounting information for virtual circuits (VCs).  If specified with no arguments, it displays whether accounting is enabled for all VCs. 

driver=driver_name
Specifies the interface.  This argument can appear anywhere on the command line.

state=on|off
Enables (on) and disables (off) accounting information for all VCs.  By default, accounting is enabled.  If accounting is enabled, the source address, the destination address, and the duration of the connection is printed on the console when a VC is released. 

DESCRIPTION

The atmsig command configures ATM UNI signaling on the end system.  It also displays state information about the signaling module, and can be used to disable and enable the ILMI and signaling. The various timer values and statistics for the signaling transport (Q.SAAL) and the signaling protocol (Q.93B) can be read and modified. 

The signaling module is associated with a specified interface at all times, which is identified by the driver name.  If the interface is disabled, the signaling module is also disabled.  The signaling module must be enabled again when the interface is brought back on line. 

RELATED INFORMATION

Commands: atmconfig(8)

Files: atm.conf(4)

Asynchronous Transfer Mode