NAME

atmconfig − Configures the ATM subsystem

SYNOPSIS

/usr/sbin/atmconfig {up | down | status} driver=driver_name

/usr/sbin/atmconfig vclist [driver=driver_name]
      [short] [long]

/usr/sbin/atmconfig +pvc driver=driver_name
      converge=name vpi=vpi_value vci=vci_value
      [selector=selector_value]

/usr/sbin/atmconfig {-pvc | -vc} {driver=driver_name
      vpi=vpi_value vci=vci_value } | vcid=VC_identifier

/usr/sbin/atmconfig +esi driver=driver_name
      addr=ESI_value

/usr/sbin/atmconfig -esi driver=driver_name
      addr=ESI_value | esi=esi_number

/usr/sbin/atmconfig {+vfc | -vfc} driver=driver_name

/usr/sbin/atmconfig source [file=filename]

/usr/sbin/atmconfig wait state=up|down|oos
      driver=driver_name

FLAGS

upInstructs the driver specified in the driver=driver_name argument to initiate contact with the network;  the driver is not necessarily online when the command returns.  Use the status command to determine the driver’s actual state. 

downInstructs the driver specified in the driver=driver_name argument to disconnect from the network, releasing all virtual circuits (VCs) in an orderly manner, unregistering all Endpoint System Identifiers (ESIs), and taking down the interface.  No new connections can be made while the interface is being taken down.  When this command returns, the system has started a shutdown procedure that can take several minutes. 

If this command is issued twice, the driver will be taken off line immediately without releasing VCs or ESIs; the protocol timers for the VCs will expire. 

statusReports the current status of the driver specified in the driver=driver_name argument.  The interface can be in the following states:

DOWNThe interface is off line. 

UPThe interface is online and is synchronized with the switch. 

DISCONNECTED
The driver is UP, but currently does not have a live connection to the switch.

GOING DOWN
The interface is UP, but is in the process of shutting down.

vclistLists the currently active VCs.  Each active VC is listed along with its state, its local VC identifier (a unique value used to identify the VC locally), the Virtual Path Identifier (VPI) and Virtual Channel Identifier (VCI), and the remote address.  If you use this command without any arguments, a short form listing is displayed. 

+pvc arguments
Creates and enables a new Permanent Virtual Circuit (PVC) and attaches it to a convergence module specified in the converge=name argument.  The PVC does not have to be enabled on the switch, but should be as the system may attempt to send data as soon as it recognizes the new PVC. 

-pvc | -vc
Destroys an existing PVC (-pvc) or VC (-vc).  The PVC or VC is disconnected from the convergence module to which it was attached and its resources deallocated.  At this point, all data received for the PVC’s or VC’s VCI is discarded.  If you specify the VC identifier, you can obtain this value by using the vclist command. 

+esi | -esi
Configures (+esi) an ESI on or removes (-esi) an ESI from the system.  The new ESI is registered with the system and with the local switch.  This results in one or more (depending on the number of address prefixes assigned by the switch) ATM addresses being created. 

When an ESI is removed, it is unregistered with the system and the local switch.  This results in one or more ATM addresses getting distroyed.  This also causes any VCs that currently use these addresses to be released. 

+vfc | -vfc
Enables (+vfc) or disables (-vfc) vendor-specific flow control on the interface specified by the driver=driver_name argument.  The specified interface must support this type of flow control. 

sourceProcesses batch commands in the /etc/atm.conf file.  If the file=filename argument is provided, batch commands are processed from the specified file. 

waitInstructs batch files to suspend execution until the driver specified in the driver=driver_name argument is either up, down, out-of-service (oos). 

DESCRIPTION

The atmconfig command configures ATM networking and displays information about the ATM networks.  The command only controls the base ATM modules; it does not control specific device drivers, convergence modules, or signalling protocols. 

The atmconfig command is used to enable and disable device drivers, create and destroy permanent virtual circuits (PVCs), destroy switched virtual circuits (SVCs), and create and destroy Endpoint System Identifiers (ESIs).  It is also used to display the currently active VCs and driver status, and to batch process configuration files. 

The format of the atmconfig command is always the command name followed by a single command, followed by optional arguments.  Each atmconfig command takes a different set of arguments.  Arguments are specified as follows:      argument_name=argument_value

Arguments can appear in any order after the command.  All required arguments must be specified. 

Arguments

driver=driver_name
Specifies a specific driver or network interface.  This is used with those commands that perform operations that relate to individual interfaces, such as manipulating VCs.  driver_name is the name of the driver as it registered with the system, followed by the unit number.  For example "lta0" for DGLTA unit 0. 

converge=name
Specifies the name of a convergence module.  name is the name (case insensitive) that the convergence module used when it registered with the system.  A convergence module is an interface module that interfaces a specific protocol or protocols to ATM.  For example, "converge=atmip" for the IP to ATM (RFC 1577) convergence module. 

vpi=vpi_value
Specifies a VPI value to be used in looking up or creating a VC.  Any VPI value which is valid on the interface and network may be specified.

vci=vci_value
Specifies a VCI value to be used in looking up or creating a VC.  Any VCI value which is valid on the interface and network may be specified.

vcid=VC_identifier
Specifies the local VC identifier which uniquely identifies a VC on the local system (amoung all interfaces).  This value has local significance only and is used as a shorthand for referencing a VC.  The VCid can be obtained from the VC listing command.  This can be used in place of the VPI/VCI when specifying an existing VC.

addr=ESI_value
Specifies the ESI part of an ATM address.  ESI_value can be a series of hexidecimal digits or the name that appears in the /etc/atmhosts file.  Any ESI value is permitted. It is up the the signalling protocol to accept or reject the value.  For UNI 3.0, only six-byte ESIs are valid.  A full UNI 3.0 address can be registered by specifying a 19-byte ESI (prefix plus ESI) in cases where the switch does not support dynamic address registration. 

file=file_name
Specifies the path name of a file to be used as alternate input for a command.  The path name is relative to the current working directory and should be a full path name.

state=up | down | oos
Specifies the interface state for which to test.  This argument is used in commands that check the state of an interface.  up checks for the interface being enabled and in contact with the switch.  down checks for the interface being disabled and out of contact with the switch. oos checks for the interface being enabled but not in contact with the switch (for example, the switch is down or the connection to the switch is broken). 

Batch Files

Typically, you establish the system configuration only once.  After that, you have some method by which this configuration is applied on every system boot.  For ATM, this is accomplished using batch files. 

Batch files are plain text files that contain commands atmconfig executes as if they were typed on the command line, except the atmconfig command name is not specified.  All the commands and arguments that are available for command line execution are available in batch execution.  Each line contains exactly one command or is a comment, beginning with a number sign (#).  The atmconfig command will process entries in batch files sequentially, one line at a time, until the end of the file is reached.  If any command fails, execution stops and atmconfig exits. 

If the source command appears in a batch file, the specified batch file is processed and the processing of the current file is resumed at the next line.  If a sourced batch file generates an error, atmconfig exits. 

In addition to the atmconfig commands available from the command line, batch files can contain the following commands:

print arg...
Prints the arguments to the screen (standard out).

sleep [time]
Suspends execution for the specified number of seconds. If the time argument is not supplied, the sleep period is 1 second. 

run program_name [arg...]
Runs the specified program with the supplied arguments; the full path name for the program should be used.  The atmconfig command runs the program as a separate process and waits for the program to exit before continuing to the next line in the batch file.  If the program exits with a status of other than 0, atmconfig exits, printing the program’s exit status. 

runb program_name [arg...]
Runs the specified program in background.  The atmconfig command does not wait for the program to exit before continuing to the next line of the batch file.  The exit status of the program is ignored. 

FILES

/etc/atm.conf
Default configuration batch file

/etc/atmhosts
ATM address-to-host name mappings

RELATED INFORMATION

Files: atm.conf(4), atmhosts(4)