10.1 Introduction

10.2 Sample ss7load Script for Windows NT/Windows 2000

10.3 Sample ss7load Script for UNIX Systems

10.1 Introduction

The SS7 distribution CD-ROM contains a sample script, ss7load, for downloading the SS7 software and configuration files to the TX board(s) for each operating system. The ss7load utility may be found in the following locations

Windows NT/Windows 2000:	\nms\tx\bin\ss7load.bat
UnixWare and Solaris:	/opt/nmstx/bin/ss7load

:

The sample script takes a single parameter, the board number, which is required On some operating systems this may default to board 1 if omitted). The following example shows the output of ss7load when run on Windows NT or
Windows 2000:

prompt> ss7load 1
CPMODEL V1.0: Copyright 1998, NMS Communications
Board #1 is a TX2000
Loading: E.0 TX2000 Kernel (c)1996-1997 NMS Communications, Inc. 2/10/97
Loading: diag2000 Version C.1.0 12/10/97
Loading:            
Loading: inf Version C.4.0 12/10/97
Loading: mvip Version A.1.0 12/10/97
Loading: t1e1mgr Version A.1.0 12/10/97
Loading: mtp Version B.3.0 01/14/98
mtp2cfg: sample MTP2 configuration application version B.1.0 Jan 14 1998
mtp3cfg: sample MTP3 configuration application version B.3.0 Jan 14 1998

The exact contents of the ss7load script varies by operating system, but the basic functions executed by ss7load are as follows (the order is significant):

1. A utility program is executed to determine the model number of the board so that the correct operating system kernel may be downloaded. For PCI and Compact PCI boards, the kernel exists on flash.
   The txflash utility is used to reset PCI and Compact PCI boards. If the version of the operating system on the TX board's flash memory does not match the version installed on the host system, the txflash utility automatically updates the board's flash image before resetting the board.

2. The operating system kernel and related utility software modules are downloaded using the cplot loader utility.

3. The mvip and t1e1mgr tasks are downloaded to the board. These tasks enable use of the MVIP switching and T1/E1 configuration/control APIs. If your system does not use these APIs, these commands may be removed from ss7load.

4. The SS7 MTP layer task (mtp.lot) is downloaded to the board. This task must be downloaded before any of the other SS7 software layers. This is the only required SS7 module.

5. Any optional SS7 layers which have been manually enabled are downloaded to the board.

6. The mtp2cfg (optional) and mtp3cfg (required) utilities are executed to download the MTP configuration to the MTP task. Again, the MTP layers must be configured before any of the other SS7 layers.

7. Any optional SS7 configuration utilities which have been enabled are executed to download their respective configurations to the appropriate SS7 layer task. Again, the order shown in the ss7load file should be maintained.

By default, the sample ss7load script installed with the SS7 MTP package downloads only the MTP software and configuration to the board. The commands to load and configure the other SS7 software layers (ISUP, TUP, SCCP, and TCAP) are present, but commented out.

Note: If you use any of these optional software layers, you must edit the ss7load script to enable the download and configuration of the applicable layers.

You may also want to modify the script to change the file and/or path names of the SS7 configuration files as you modify the sample configuration files to meet your system needs.

The following examples show the ss7load scripts for Windows NT/Windows 2000 and UNIX systems, respectively.

10.2 Sample ss7load Script for Windows NT/Windows 2000

@echo off
REM
REM  Choose redundant or standalone path/file names for configuration files
REM
set TXMODE=standalone
REM set TXMODE=redundant
REM
set TXUTIL=\nms\tx\bin
set TXCP=\nms\tx\cp
set TXCONFIG=\nms\tx\config\%TXMODE%\ansi
set BRD=1
if not "%1"=="" set BRD=%1
REM
REM              TX Series COMMUNICATIONS PROCESSOR BOOT FILE
REM
REM
REM Execute this file to boot/configure a TX Series Communications Processor
REM
REM
REM Get the model number
%TXUTIL%\cpmodel -b %BRD%
if errorlevel 3220 goto boot3220
if errorlevel 3210 goto boot3210
if errorlevel 3000 goto boot3000
if errorlevel 2000 goto boot2000
echo ERROR! Check board number
goto end

:boot3220
%TXUTIL%\txflash -s %TXCP%\cpk3220.bin -b %BRD%
if errorlevel 1 goto failedload
set TXTYPE=3220
goto loadsw

:boot3210
%TXUTIL%\txflash -s %TXCP%\cpk3210.bin -b %BRD%
if errorlevel 1 goto failedload
set TXTYPE=3210
goto loadsw

:boot3000
%TXUTIL%\cplot -c %BRD% -f %TXCP%\cpk3000.lo -k -a -u ss7
if errorlevel 1 goto failedload
set TXTYPE=3000
goto loadsw

:boot2000
%TXUTIL%\cplot -c %BRD% -f %TXCP%\cpk2000.lo -k -a -u ss7
if errorlevel 1 goto failedload
set TXTYPE=2000
goto loadsw

:failedload
echo ERROR! Kernel failed to load.  Check IRQ and I/O address settings.
goto end

:loadsw
REM
%TXUTIL%\cplot -c %BRD% -f %TXCP%\diag%TXTYPE%.lot   -n diag    -p 2  -a
%TXUTIL%\cplot -c %BRD% -f %TXCONFIG%\TDMcp%BRD%.bin -g tdm
%TXUTIL%\cplot -c %BRD% -f %TXCP%\debug.lot          -n debug   -p 3  -a
%TXUTIL%\cplot -c %BRD% -f %TXCP%\arp.lot            -n arp     -p 17 -a
%TXUTIL%\cplot -c %BRD% -f %TXCP%\inf.lot            -n inf     -p 16 -a
REM
REM download the MVIP and T1/E1 manager tasks to enable use
REM of the MVIP and T1/E1 host APIs; NOTE: if you do not
REM use either of these APIs, remove the following 2 lines.
REM
%TXUTIL%\cplot -c %BRD% -f %TXCP%\mvip.lot           -n mvip    -p 4  -a
%TXUTIL%\cplot -c %BRD% -f %TXCP%\t1e1mgr.lot        -n t1e1mgr -p 15 -a
REM
REM To enable packet tracing in the ISUP or TUP layer, make the following
REM command active to download the ETP trace collector on the board.
REM
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\etp.lot        -n etp     -p 14 -a
REM
REM Load TXMON
REM
REM ****** IMPORTANT NOTE: *******
REM For convenience we are loading TXMON only in redundant mode.  This is
REM convenient because MTP will detect the lack of TXMON and will auto-
REM matically enter standalone mode and attempt to bring up links, without
REM application intervention.  NOTE HOWEVER, TXMON can be used as a health
REM monitor for a single board application in standalone mode.  In this case
REM the MTP will remain in a Starting state until an application (eg. RMG),
REM using the HMI API, specifically sets the mode to Standalone. In other
REM words links will not automatically try to align if TXMON is loaded.
REM
if "%TXMODE%"== "standalone" goto notxmon
%TXUTIL%\cplot -c %BRD% -f %TXCP%\txmon.lot          -n txmon   -p 9 -a
:notxmon
REM
REM Load MTP3 task
REM
%TXUTIL%\cplot -c %BRD% -f %TXCP%\mtp.lot         -n mtp    -p 10 -a -s 12000
REM
REM Enable the following downloads for SS7 layers you do use
REM
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\sccp.lot       -n sccp    -p 11  -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\isup.lot       -n isup    -p 12  -s 40960 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\tup.lot        -n tup     -p 12  -s 40960 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\tcap.lot       -n tcap    -p 13  -a
REM
REM
REM ISUP only: Enable the download of the ISUP database required for your configuration.
REM
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\itublue.lot       -n itublue  -p 5 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\ituwhite.lot      -n ituwhite -p 5 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\q767.lot          -n q767     -p 5 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\ansi88.lot        -n ansi88   -p 5 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\ansi92.lot        -n ansi92   -p 5 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\ansi95.lot        -n ansi95   -p 5 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\itu97.lot         -n itu97    -p 5 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\etsiv2.lot        -n etsiv2   -p 5 -a
rem %TXUTIL%\cplot -c %BRD% -f %TXCP%\etsiv3.lot        -n etsiv3   -p 5 -a
REM
REM Configure SS7 MTP2, MTP3, ISUP, TUP & SCCP - enable these commands
REM for any SS7 layers you do use
REM
REM NOTE: Level 2 configurability is now available.  However,
REM       level 2 configuration is not strictly necessary.  The defaults
REM       will work for most installations.
REM
%TXUTIL%\mtp2cfg -b %BRD% -f %TXCONFIG%\MTP3cp%BRD%.cfg
%TXUTIL%\mtp3cfg -b %BRD% -f %TXCONFIG%\MTP3cp%BRD%.cfg
if "%TXMODE%"== "standalone" goto stdalncfg
rem
rem  Load redundant configuration files - note that both boards in redundant
rem  pair use the same configuration file
rem
rem %TXUTIL%\sccpcfg -b %BRD% -f %TXCONFIG%\SCCP.cfg
rem %TXUTIL%\isupcfg -b %BRD% -f %TXCONFIG%\ISUP.cfg
rem %TXUTIL%\tupcfg  -b %BRD% -f %TXCONFIG%\TUP.cfg
rem %TXUTIL%\tcapcfg -b %BRD% -f %TXCONFIG%\TCAP.cfg
goto end
:stdalncfg
rem
rem  Load standalone configuration files - note that each board in a standalone
rem  configuration gets a configuration file unique to that board
rem



rem %TXUTIL%\sccpcfg -b %BRD% -f %TXCONFIG%\SCCPcp%BRD%.cfg
rem %TXUTIL%\isupcfg -b %BRD% -f %TXCONFIG%\ISUPcp%BRD%.cfg
rem %TXUTIL%\tupcfg  -b %BRD% -f %TXCONFIG%\TUPcp%BRD%.cfg
rem %TXUTIL%\tcapcfg -b %BRD% -f %TXCONFIG%\TCAPcp%BRD%.cfg
:end
set TXMODE=
set TXUTIL=
set TXCP=
set TXCONFIG=

10.3 Sample ss7load Script for UNIX Systems

#!/bin/ksh
#*****************************************************************************
# File:  ss7load
# Objective: Reset board, clear driver stats, load CPK/OS and
#  related tasks, and configure SS7
# Project: SS7 Redundancy. Version 3.5
#
#*****************************************************************************

#*****************************************************************************
# Check args - Get the board number
case $# in
 0)
  BRD=1
  ;;
 1)
  BRD=$1
  ;;
 *)
         echo "Usage: ss7load <board#>"
         exit 1
esac

#
if [ -z "$TXUTIL" ]
then
 TXUTIL=/opt/nmstx/bin
fi
if [ -z "$TXBASE" ]
then
 TXBASE=/opt/nmstx/cp
fi
if [ -z "$TXMODE" ]
then
 TXMODE=standalone
fi
if [ -z "$TXCONFIG" ]
then
 TXCONFIG=/opt/nmstx/etc/$TXMODE/ansi
fi

# Clear driver statistics
$TXUTIL/cputil -b$BRD -C

#**************************************************************************
# get board type
#
# NOTE: On UNIX the board type is determined
#       so that you do not need to edit this portion of
#       the script as the documentation might indicate
#

BOARDTYPE=\Q$TXUTIL/cpmodel -b$BRD | tail -1 | cut -d' ' -f5\Q

case $BOARDTYPE in
 TX3220)
  CPK=""
  DIAG="diag3220.lot"
                FLASH="cpk3220.bin"
  ;;
 TX3210)
  CPK=""
  DIAG="diag3210.lot"
                FLASH="cpk3210.bin"
  ;;
 TX3000)
  CPK="cpk3000.lo"
  DIAG="diag3000.lot"
  ;;
 TX2000)
  CPK="cpk2000.lo"
  DIAG="diag2000.lot"
  ;;
 *)
  echo "Board $BRD not available"
  exit 1
  ;;
esac

#**************************************************************************
# load CPK/OS and related tasks
#
if [ ! -z "$CPK" ]
then
 $TXUTIL/cplot -c $BRD -f $TXBASE/$CPK -k -u ss7 -a









 # Make sure kernel load was successful
        if [ $? -ne 0 ]
        then
            echo "Kernel load failed, exiting $0 script"
            exit 1
        fi
else
        $TXUTIL/txflash -s $TXBASE/$FLASH -b$BRD
fi

#
# Load related tasks
#
$TXUTIL/cplot -c $BRD -f $TXBASE/$DIAG -n diag -p 2 -a
$TXUTIL/cplot -c $BRD -f $TXBASE/inf.lot -n inf -p 16  -a

#
# load TDM configuration - note: remove this line if you use
# serial (V.35) ports rather than T1/E1/MVIP
#
$TXUTIL/cplot -c $BRD -f $TXCONFIG/TDMcp${BRD}.bin -g tdm


#
# load the MVIP and T1/E1 manager tasks to enable use
# of the MVIP and T1/E1 host APIs. Note: if you do not
# use either of these APIs, remove the following two lines
#

$TXUTIL/cplot -c $BRD -f $TXBASE/mvip.lot -n mvip -p 4 -a
$TXUTIL/cplot -c $BRD -f $TXBASE/t1e1mgr.lot -n t1e1mgr -p 15 -a

#
# To use txdbg, you should uncomment the following line to
# load the debug task
#
#$TXUTIL/cplot -c $BRD -f $TXBASE/debug.lot -n debug -p 3 -a

#
# To enable packet tracing in the ISUP layer, make the following
# command active to load the ETP trace collector on the board
#
#$TXUTIL/cplot -c $BRD -f $TXBASE/etp.lot -n etp -p 14 -a

#
# Load the ARP and TX Monitor tasks
#
$TXUTIL/cplot -c $BRD -f $TXBASE/arp.lot -n arp -p 20 -a

#
# ***** IMPORTANT NOTE *****
# For convenience we are loading TXMON only in redundant mode. This is
# convenient because MTP will detect the lack of TXMON and will automatically
# enter standalone mode and attempt to bring up the links, without
# application intervention. NOTE HOWEVER, TXMON can be used as a health
# monitor for a single board application in standalone mode. In this case
# the MTP will remain in a Starting state until an application (ie. RMG),
# using the HMI API, specifically sets the mode to Standalone. In other
# words links will not automatically try to align if TXMON is loaded.
#
if [ $TXMODE = "redundant" ]
then
   $TXUTIL/cplot -c $BRD -f $TXBASE/txmon.lot -n txmon -p 12 -a
fi

#
# MTP and ISUP layers
#
$TXUTIL/cplot -c $BRD -f $TXBASE/mtp.lot -n mtp -p 10 -a -s 12000
#$TXUTIL/cplot -c $BRD -f $TXBASE/sccp.lot -n sccp -p 11 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/tcap.lot -n tcap -p 13 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/tup.lot  -n tup  -p 12 -a -s 40960
#$TXUTIL/cplot -c $BRD -f $TXBASE/isup.lot -n isup -p 12 -a -s 40960

#
# ISUP database - Exactly one of these must be enabled to use ISUP
#
#$TXUTIL/cplot -c $BRD -f $TXBASE/itublue.lot -n itublue -p 5 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/ituwhite.lot -n ituwhite -p 5 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/q767.lot -n q767 -p 5 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/ansi88.lot -n ansi88 -p 5 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/ansi92.lot -n ansi92 -p 5 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/ansi95.lot -n ansi95 -p 5 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/itu97.lot  -n itu97  -p 5 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/etsiv2.lot -n etsiv2 -p 5 -a
#$TXUTIL/cplot -c $BRD -f $TXBASE/etsiv3.lot -n etsiv3 -p 5 -a













#**************************************************************************
# Configure MTP2, MTP3, ISUP
#
if [ $TXMODE = "redundant" ]
then
$TXUTIL/mtp2cfg -b $BRD -f $TXCONFIG/MTP3cp${BRD}.cfg
$TXUTIL/mtp3cfg -b $BRD -f $TXCONFIG/MTP3cp${BRD}.cfg
#$TXUTIL/sccpcfg -b $BRD -f $TXCONFIG/SCCP.cfg
#$TXUTIL/tcapcfg -b $BRD -f $TXCONFIG/TCAP.cfg
#$TXUTIL/isupcfg -b $BRD -f $TXCONFIG/ISUP.cfg
#$TXUTIL/tupcfg  -b $BRD -f $TXCONFIG/TUP.cfg
else
$TXUTIL/mtp2cfg -b $BRD -f $TXCONFIG/MTP3cp${BRD}.cfg
$TXUTIL/mtp3cfg -b $BRD -f $TXCONFIG/MTP3cp${BRD}.cfg
#$TXUTIL/sccpcfg -b $BRD -f $TXCONFIG/SCCPcp${BRD}.cfg
#$TXUTIL/tcapcfg -b $BRD -f $TXCONFIG/TCAPcp${BRD}.cfg
#$TXUTIL/isupcfg -b $BRD -f $TXCONFIG/ISUPcp${BRD}.cfg
#$TXUTIL/tupcfg  -b $BRD -f $TXCONFIG/TUPcp${BRD}.cfg
fi

#
exit 0