Lucent Technologies DEFINITY Enterprise Communications Server Release 6 CallVisor PC ASAI Instructions Manual

							OA&M
Issue  3  May 1998
2-21
asai_ver(1)
Name
asai_ver — Print ASAI product and software version information
Synopsis
asai_ver
Description
ASAI product information is printed to stdout. This includes the name, date and 
version of the ASAI product.
Exit Codes
If there are no errors, the exit code is 0. Otherwise, the exit code is set to 1 to 
indicate an error.
Files
/usr/adm/asai/asai.Name
/usr/adm/asai/asai.Date
See Also
asai.Date(4)
asai.Name(4) 
						

							OA&M
2-22Issue  3  May 1998 
boot.bin(4)
Name
boot.bin — IPCI Board Bootstrap Loader Program File
Description
This data file, containing the IPCI Bootstrap Loader Program, is downloaded to 
the IPCI board by ipci_on. When this program is started, it is used to load the 
ISDN software onto the board.
Files
/usr/adm/isdn/boot.bin
See Also
ipci_on(1)
pcisdn.bin(4) 
						

							OA&M
Issue  3  May 1998
2-23
cmd(7)
Name
cmd(7) — LAN GATEWAY Streams Module Communication File
Description
The cmd file allows communication between certain OA&M commands and the 
LAN GATEWAY streams module.
This device is meant to be used by OA&M delivered commands and not by 
customer commands.
NOTE:
This file has the same major device number as the LAN GATEWAY 
admin(7) and the signal(7) files.
Files
/dev/esai/cmd
See Also
admin(7)
signal(7) 
						

							OA&M
2-24Issue  3  May 1998 
command(7)
Name
command — IPCI Streams Device Driver Communication File
Description
The command file allows communication between certain OA&M commands and 
the IPCI streams device driver. The IPCI streams device driver communicates 
with the IPCI board and with software on the board.
This device is meant to be used by OA&M delivered commands and not by 
customer commands.
Notes
This file has the same major device number as admin(7) and the signal(7) files.
Files
/dev/isdn/ipci/command
See Also
admin(7)
signal(7) 
						

							OA&M
Issue  3  May 1998
2-25
esai_alarm(1)
Name
esai_alarm — Turn on or off isdn_bri maintenance alarming
Synopsis
 esai_alarm -a|d [-b1...-b8] [-t0...-tn] [-e] [-?] 
Description
esai_alarm
Uses the suspend and resume routines to turn on or off the ASAI BRI port alarms 
associated with the link specified.
-a
Activates alarming
-d
Deactivates alarming
-b
Specifies the link, where =1...8, has sent the message 
-t
Sets the time-out to n seconds, where =0...n. Default is -t3
-e
Displays the exit codes list shown below
-?
Displays the terse help message 
						

							OA&M
2-26Issue  3  May 1998 
Exit Codes
If esai_alarm fails, one of the following exit codes is returned: 
 0 = The alarm condition was changed per request
-1 =  Failure due to inadequate memory
-2 =  Open stream failure
-3 =  Failure to send message to link
-4 =  Failure to receive messages from link
-5 =  time-out while waiting to receive a message
-6 =  Layer 1 is down (could not attempt reset)
-7 =  Layer 2 failed to recover from reset
-8 =  State machine transitioning, try again 
						

							OA&M
Issue  3  May 1998
2-27
esai_trace(1)
Name
esai_trace — Trace LAN Gateway (ESAI) ASAI messages
Synopsis
esai_trace
Description
esai_trace is a general-purpose diagnostic tool. Its output is the actual ASAI 
message traffic to and from the ASAI-E LAN Gateway board. The message trace 
has the following general format:
       
The following table explains the format.
Received messages (those coming from the ECS) usually have uplink in the 
function field.
Transmitted messages (those going to the ASAI-E board and then the ECS) 
usually have a mnemonic function, for example, downlink.
Table 2-1. Format of esai_trace-Generated ESAI Device Driver Messages
Mnemonic Description Example
 message time stamp number 15273
 name of module generating the 
entryESAI
QP
Klog
 name of function handling the 
messageuplink
 /
 starting byte number 0
12
 message traffic has the value 
MSG_TRACE in this field. Only 
message traffic is useful.MSG_TRACE
 link number 1
 GVI message contents in hex 96 1c 09 91 
						

							OA&M
2-28Issue  3  May 1998 
The function name is separated from the starting byte number by a slash ( / ).
The starting-byte number indicates the byte number of the beginning (left most) 
byte of the hex field. The first line of a message has a byte number of 0. The 
second line has a number greater than zero (usually 12) and so forth for each 
additional line of the same message. The next message will have a byte number 
of 0 for the first line.
The diagnostic field indicates the purpose of the entry. Only trace entries with a 
diagnostic field value of MSG_TRACE are useful.
The driver QP frequently writes diagnostic messages. These messages are 
normal and can be ignored. Periodically, the kernel-reporting mechanism klog 
also writes entries. These can also be ignored.
Examples
>esai_trace > trace.in &
Turn on trace and send the output to the file 
trace.in.
tail trace.in
Display the end of the trace.in file. A heartbeat was sent to the ECS using the 
command asai_test. Output similar to the following is generated:
15273 ESAI downlink /0 MSG_TRACE[1]: 08 02 00 02 64 96 1c 09 91
15273 ESAI downlink /12 MSG_TRACE: a1 06 02 01 03 02 01 b3 00 00 00 00
15273 ESAI uplink /0 MSG_TRACE: 08 02 00 02 64 96 1c 09 91
15273 ESAI uplink /12 MSG_TRACE: a1 06 02 01 03 02 01 b3 00 00 00 00
15273 QP qp_rsrv/515 freeing unrecognized message of size 0x2
15273 QP qp_rsrv/516 msg[0]=0x8, msg[1]=0x1
Bugs
The kernel mechanism used by the device driver does not guarantee message 
order or integrity. Therefore, a sequence number is placed on each message by 
the ESAI device driver to allow detection of missing or out-of-order messages.
Turning on the message trace facility causes an additional system load. 
Sometimes the load is significant.
Files
/usr/adm/isdn/bin/esai_trace
/usr/adm/isdn/bin/asai_trace
See Also
asai_trace(1) 
						

							OA&M
Issue  3  May 1998
2-29
ipci(4)
Name
ipci — Pump and start administration for all IPCI boards
Synopsis
ipci
Description
ipci is a shell script that starts the ipci administration daemon process, 
ipci_admin (1) located in /etc/idrc.d.
Operation
The ASAI program is executed once per machine boot in the multiuser init level 
 of 2. The name of the log file (asai_log) is changed to old_asai_log. The 
administration daemon [asai_admin(1)] is then started. When this is done, the 
standard error device is defined as /dev/console for ipci_admin (1).
Exit Codes
If pumping the board(s) is successful, 0 is returned as the exit code. Otherwise, 1 
is returned.
Files
/usr/adm/asai/asai_log 
/dev/isdn/ipci/admin
/dev/asai/asai
/dev/isdn/ipci/command
/dev/isdn/ipci/signal01
/dev/isdn/ipci/signal02
/dev/isdn/ipci/signal03
/dev/isdn/ipci/signal04
See Also
admin(7)
asai(7)
asai_admin(1)
asai_log(4)
command(7)
ipci_admin(1)
ipci_on(1)
signal(7) 
						

							OA&M
2-30Issue  3  May 1998 
ipci_admin(1)
Name
ipci_admin — Administer admin and signal files
Synopsis
ipci_admin
Description
 ipci_admin sets up the protocol stack for signal device files and logs messages 
received from the admin(7) stream.
Operation
The ipci_admin program is executed once per machine boot. It is started by the 
ipci(4) script and becomes a daemon process.
This program has two tasks.
nTo add the necessary module(s) into the signal(7) streams that carry ISDN 
D channel signaling or control information. In the case of CallVisor PC LAN 
GATEWAY (ESAI) links, ipci_admin adds the necessary modules to 
send and receive the same information over TCP/IP to and from the LAN 
GATEWAY circuit pack (MAPD) in the DEFINITY ECS.
In the case of CallVisor LAN GATEWAY links, the ipci_admin daemon 
has the responsibility of initiating the connection from the CallVisor PC 
adjunct to the MAPD over the LAN. The connection is attempted 
immediately on start-up and if not successful, the daemon will try four times 
at 10-second intervals and every two minutes after that to connect to the 
MAPD.
nTo receive status information from both the IPCI streams device driver and 
the ESAI driver module via the admin(7) stream. This information is logged 
in the log file [asai_log(4)]. (The device driver sends three types of 
information to ipci_admin. One type contains a status/error number that 
is converted to a corresponding ASCII message and placed into the
asai_log file. The log_msgs(4) file is used to convert this number to 
the ASCII message. The sent type is ASCII information, of many different 
formats and byte lengths. The third type indicates boards that have been 
successfully pumped. This information is meant to be used for software 
debugging.)
nTo receive and send requests and replies (via semaphores and message 
queues) from the various LAN GATEWAY OA&M commands.
If a nonrecoverable error condition occurs within the process, a message is 
produced and this program exits. Otherwise, this program waits for data from the