Svi User Guide

SVI Product Series SVI User Guide (2.
0)
4th January 2012 Document STD-1020 Version 2.7
Squire Technologies 2012 This document is the property of Squire Technologies. Information contained herein is confidential. This document, either in whole or in part, must not be reproduced or disclosed to others or used for purposes other than that for which it has been supplied, without Squire Technologies prior written permission, or, if any part hereof is furnished by virtue of a contract with a third party, as expressly authorised under that contract.
SVI User Guide

Squire Technologies, 64 High West Street, Dorchester, Dorset, DT1 1XA
Change History Date 04.12.07 14.05.08 21.05.08 30.05.08 28.07.08 03.03.09 07/05/10 04/01/12 Version 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 Description Initial Release of Version 2.0 OAM Interface Added Excel Routing Added 2003 details and Screenshots Added PRTG/SNMP Info Updated password advice and FTP server information Removed Excel Routing Updated password information Updated SNMP info to include Traps Author AC JW LB AC/JW JH AC LB JW
Squire Technologies Confidential
Part Number:STD-1020 Version / Date: 2.5 / 03/03/09 Author: A Cooper Page: 2/89
SVI User Guide

Table Of Contents
1 INTRODUCTION ........................................................................................ 8
1.1 SVI Product Range.................................................................................................................. 8 1.1.1 SVI_MG ............................................................................................................................ 8 1.1.2 SVI_MGC ......................................................................................................................... 8 1.1.3 SVI_MGC_SG .................................................................................................................. 8 1.1.4 SVI_SG ............................................................................................................................. 8 1.1.5 SVI_C4 ............................................................................................................................. 8 1.1.6 SVI_9220 .......................................................................................................................... 9 1.1.7 SVI_9225_SS .................................................................................................................... 9
SYSTEM OVERVIEW .............................................................................. 10

2.1.1 Operating System............................................................................................................. 10 2.1.2 Using Linux ..................................................................................................................... 10 2.1.2.1 Linux Help Pages ..................................................................................................... 10
2.2 Accessing The SVI. ................................................................................................................ 10 2.2.1 Directly Connecting To The SVI ...................................................................................... 10 2.2.2 Connecting Over IP.......................................................................................................... 11 2.2.2.1 Windows .................................................................................................................. 11 2.2.2.2 Setting up Putty ........................................................................................................ 11 2.2.2.3 Unix ......................................................................................................................... 12 2.2.3 Logging On ..................................................................................................................... 12 2.2.3.1 Changing Username and Password ........................................................................... 12 2.3 Managing IP Information ..................................................................................................... 13 2.3.1 Displaying Current IP Information ................................................................................... 13 2.3.2 Changing IP Address ....................................................................................................... 14 2.3.3 Apply Changed IP Address .............................................................................................. 15 2.4 Editing files with The Linux Editor ...................................................................................... 15 2.4.1 Brief Vi Overview ........................................................................................................... 16 2.5 Using GREP Command to Search Through Files ................................................................ 16
2.6 Managing Files ...................................................................................................................... 17 2.6.1 Linux Command Shell ..................................................................................................... 17 2.6.2 Using Windows For Remote Linux File Manager ............................................................. 17 2.6.2.1 Installing WinSCP .................................................................................................... 17 2.6.2.2 Connecting WinSCP to the SVI ................................................................................ 17 2.7 Copying Files from the SVI ................................................................................................... 19 2.7.1 Secure Copy (SCP) .......................................................................................................... 19 2.7.2 File Transfer Protocol (FTP) ............................................................................................ 19 2.8 Main SVI Files ....................................................................................................................... 19 2.8.1 Symbolic Links................................................................................................................ 19 2.8.2 GW Service Script ........................................................................................................... 20 2.8.3 Monitor Program ............................................................................................................. 20 2.8.3.1 Command Line Options ............................................................................................ 20 2.8.3.2 Configuration ........................................................................................................... 20
Squire Technologies Confidential Part Number:STD-1020 Version / Date: 2.5 / 03/03/09 Author: A Cooper Page: 3/89
SVI User Guide

2.8.4 SSWITCH Program ......................................................................................................... 20 2.8.4.1 Command Line Options ............................................................................................ 20 2.8.4.2 Configuration ........................................................................................................... 21 2.8.5 MGWAY Program........................................................................................................... 21 2.8.5.1 Command Line Options ............................................................................................ 21 2.8.5.2 Configuration ........................................................................................................... 21 2.8.6 Start OAM Session Helper Script ..................................................................................... 22 2.8.6.1 Command Line Options ............................................................................................ 22 2.8.7 Start Single OAM Session Helper Script .......................................................................... 22 2.8.7.1 Command Line Options ............................................................................................ 22 2.8.8 Tail A Log File in Real Time ........................................................................................... 22 2.8.8.1 Command Line Options ............................................................................................ 22 2.8.9 Open Current Logfile ....................................................................................................... 23 2.8.9.1 Command Line Options ............................................................................................ 23 2.9 SVI Operation ....................................................................................................................... 23 2.9.1 Automatically Starting The SVI on Power Up .................................................................. 23 2.9.1.1 Displaying Service Management List ........................................................................ 23 2.9.2 Manually Controlling The SVI ......................................................................................... 24 2.9.2.1 Starting The SVI ...................................................................................................... 24 2.9.2.2 Stopping The SVI ..................................................................................................... 24 2.9.2.3 Restarting The SVI ................................................................................................... 24 2.10 Licensing The SVI ............................................................................................................... 24 2.10.1 Full License ................................................................................................................... 24 2.10.1.1 Upgrading Full License........................................................................................... 24 2.10.2 Temporary License ........................................................................................................ 24 2.11 Showing License Information.............................................................................................. 25
SVI DATABASE ....................................................................................... 26

3.1.1 Database Structure ........................................................................................................... 26
4
4.1
CONFIGURATION ................................................................................... 28
Configuration Files................................................................................................................ 28
4.2 Handling Multiple Configuration Files ................................................................................. 28 4.2.1 Load Command ............................................................................................................... 28 4.2.2 Update Command ............................................................................................................ 28 4.3 Configuration file Syntax ...................................................................................................... 28 4.3.1 Comments ....................................................................................................................... 28 4.3.2 Defines ............................................................................................................................ 29 4.3.2.1 Allocating a Define .................................................................................................. 29 4.3.2.2 Unallocating a define ................................................................................................ 29 4.3.2.3 Conditional Defines .................................................................................................. 29 4.3.2.4 User defined Exiting with an Error............................................................................ 30 4.3.2.5 User defined Exiting of a Configuration File ............................................................. 30 4.3.2.6 System Define .......................................................................................................... 30 4.3.3 Configuring Resources ..................................................................................................... 31 4.3.3.1 Configuring Integer Values ....................................................................................... 31 4.3.4 Passing Variables Into Configuration Files ....................................................................... 32 4.3.4.1 Setting up the configuration file to handle variables .................................................. 33
SVI User Guide

4.3.5 4.3.6
Loading Configuration File Specifying The Variables From another Configuration File .... 33 The OAM Command ....................................................................................................... 33
OAM INTERFACE ................................................................................... 34
5.1 Administration of the OAM Interface .................................................................................. 34 5.1.1 Security Of The OAM IP Connection ............................................................................... 34 5.1.2 Firewall Access................................................................................................................ 34 5.1.3 Process OAM Port Assignment ........................................................................................ 34 5.1.3.1 Starting An OAM Session ........................................................................................ 36 5.1.4 Connecting to a Redundant Architecture........................................................................... 37 5.2 Using the OAM Interface ...................................................................................................... 38 5.2.1 Entering Commands......................................................................................................... 38 5.2.2 Getting Help .................................................................................................................... 38 5.2.3 Exiting An OAM Session ................................................................................................. 38 5.2.4 SVI Process Shutdown ..................................................................................................... 39 5.2.5 Running Multiple OAM Sessions ..................................................................................... 39 5.2.6 Clearing the Session Screen ............................................................................................. 40 5.2.7 Entering Multiple Commands On a Single Command Line ............................................... 40 5.2.7.1 Piped Method ........................................................................................................... 40 5.2.7.2 Parentheses Method .................................................................................................. 40 5.2.8 Automatically Repeating Commands................................................................................ 40 5.2.9 Full list of OAM Operations............................................................................................. 41 5.3 Data Persistence .................................................................................................................... 42 5.3.1 Persisting Data to the Configuration File .......................................................................... 42 5.3.2 Controlling The Persistence Of Data ................................................................................ 42 5.3.3 Managing The Persistence File......................................................................................... 42 5.4 Dual Redundant Operation ................................................................................................... 43 5.4.1 Persisting Configuration Files .......................................................................................... 43 5.5 Discovering Database Format ............................................................................................... 43 5.5.1 Syntax Command............................................................................................................. 43 5.5.1.1 Showing Systems Resources ..................................................................................... 43 5.5.1.2 Showing Number of Resources Instances .................................................................. 43 5.5.1.3 Showing a Resources Attributes .............................................................................. 44 5.5.1.4 Showing a Systems Resource Attributes Possible Values ......................................... 44 5.6 Displaying Database Information ......................................................................................... 44 5.6.1 Show Command .............................................................................................................. 44 5.6.1.1 Showing all of a Resources Attributes Values .......................................................... 44 5.6.1.2 Showing a Particular Attributes Value ..................................................................... 45 5.6.1.3 Showing Only Resources with Attributes of a Particular Value .................................. 45 5.6.1.4 Status Command ...................................................................................................... 46 5.6.1.5 Displaying Multiple Attribute Instances .................................................................... 47 5.6.1.6 Using the Repeat Command...................................................................................... 47 5.6.2 Configuring Through The OAM Interface ........................................................................ 48 5.6.2.1 Configure Command ................................................................................................ 48 5.6.3 Loading Configuration Files............................................................................................. 51 5.6.3.1 Load Command ........................................................................................................ 51 5.6.3.2 Update Command..................................................................................................... 51 5.6.4 Passing Variables Into Configuration Files ....................................................................... 52 5.6.4.1 Setting up the configuration file to handle variables .................................................. 52
SVI User Guide

5.6.5 Loading Configuration File Specifying The Variables On The OAM Interface .................. 52 5.6.6 Pre-Checking of Configuration Files. ............................................................................... 53 5.6.7 Configuring Managed Resources ...................................................................................... 53 5.6.7.1 Removing A Managed Resource ............................................................................... 53 5.7 Controlling SVI Resources .................................................................................................... 54 5.7.1 Taking A Resource Out of Service ................................................................................... 54 5.7.2 Bringing A Resource Into Service .................................................................................... 54 5.8 System Fault Investigation .................................................................................................... 54 5.8.1 OSI Model Layer Protocols .............................................................................................. 55 5.8.1.1 TDM ........................................................................................................................ 55 5.8.1.2 SIGTRAN ................................................................................................................ 55 5.8.1.3 VoIP ........................................................................................................................ 56 5.8.2 Discovering Resource Relationships................................................................................. 56 5.8.2.1 Parent Command ...................................................................................................... 56 5.8.2.2 ParentS Command .................................................................................................... 56 5.8.2.3 Children Command .................................................................................................. 57 5.8.2.4 ChildrenS Command ................................................................................................ 58 5.8.3 Capturing Change In Resource Status ............................................................................... 58 5.9 Customizing The OAM Interface.......................................................................................... 59 5.9.1 OAM Accounts................................................................................................................ 59 5.9.1.1 Setting up an OAM Account ..................................................................................... 59 5.9.1.2 Setting Up Multiple OAM Accounts ......................................................................... 60
6
6.1 6.2 6.3 6.4
LOG FILES .............................................................................................. 61

Log File Names ...................................................................................................................... 61 Controlling Log File Maximum size...................................................................................... 61 Managing Disk Space and System Performance .................................................................. 62 Displaying Real Time Log Output To Screen ....................................................................... 62
6.5 Log File Output ..................................................................................................................... 62 6.5.1 Inter task Protocol Messages ............................................................................................ 62 6.5.1.1 Filtering on Task ...................................................................................................... 63 6.5.1.2 Filtering on Message Discriminator .......................................................................... 64 6.5.1.3 Displaying A Messages Contents .............................................................................. 65 6.5.2 Task Information Message ............................................................................................... 66 6.5.3 Task Error Messages ........................................................................................................ 66 6.5.4 Trap Reports .................................................................................................................... 67 6.5.5 OAM Interface Usage Logging ........................................................................................ 67
7
7.1
PROTOCOL MONITORING AND TRACE CAPTURE............................. 68

Installing Wireshark ............................................................................................................. 68
7.2 Analysing Message Flows ...................................................................................................... 69 7.2.1 Capturing a PCAP File..................................................................................................... 69 7.2.2 Loading Into Wireshark ................................................................................................... 69 7.2.3 Filtering ........................................................................................................................... 69
SVI User Guide

7.2.3.1 7.2.3.2
Filtering On Protocol ................................................................................................ 69 Filtering on IP Address ............................................................................................. 69
8
8.1 8.2
BACKING UP THE SVI ............................................................................ 70

svi_backup ............................................................................................................................. 70 Restoring The Operating System .......................................................................................... 70
PROTECTING AND FIREWALLING THE SVI ........................................ 71
9.1 Installing iptables .................................................................................................................. 71 9.1.1 Downloading IPtables ...................................................................................................... 71 9.1.2 Installation ....................................................................................................................... 72 9.2 Configuring the firewall ........................................................................................................ 72 9.2.1 Creating Rules ................................................................................................................. 72 9.2.2 Removing IPTables.......................................................................................................... 75 9.3 Example Configuration ......................................................................................................... 75
10
10.1 10.2 10.3 10.4
SYSTEM MONITORING USING SNMP ................................................. 78

Setting up SNMP monitoring .............................................................................................. 78 Setting up the Attribute OID............................................................................................... 78 Inspecting OID Values ........................................................................................................ 78 SNMP Traps ........................................................................................................................ 80
10.5 Using Paessler PRTG SNMP Tool ...................................................................................... 80 10.5.1 Setting Up a Monitor...................................................................................................... 80 10.5.2 Setting Up Alarms.......................................................................................................... 85
SVI User Guide

INTRODUCTION
The SVI series of telecom equipment provide a wide range of functionality through a number of marketed branded products. These products use a number of core central software processes which when license and configured correctly will provide the required functionality required. All of the products have the same operation maintenance and administration functionality allowing for a single document to cover all of the SVI product range. 1.1 SVI PRODUCT RANGE
The SVI range of products are split into a number of defined products. Each product can be upgraded to inherit another products functionality or be upgraded to another product completely through licensing and configuration. For full details on the product range please visit www.squire-technologies.com 1.1.1 SVI_MG The SVI_MG (Media Gateway) provides a single unit providing full media gateway functionality supporting SS7 / ISDN / R2 / CAS conversion to VoIP. The SVI_MG terminates all bearer traffic. 1.1.2 SVI_MGC The SVI_MGC (Media Gateway Controller) provides the ability for third party gateways which are not SS7 compliant to provide a full SS7 interconnect for SS7 to VoIP conversion. The SVI_MGC supports SIGTRAN interconnect for SS7 signalling control and either MGCP or H.248 for media gateway control. 1.1.3 SVI_MGC_SG The SVI_MGC_SG (Media Gateway Controller with Integrated Signalling Gateway) provides TDM access for termination of the signalling links where the media gateway does not support any low layer SS7 termination. 1.1.4 SVI_SG The SVI_SG (Signalling Gateway) provides classic Signalling Gateway functionality whilst providing SS7 TDM backhaul termination over SIGTRAN. 1.1.5 SVI_C4 The SVI_C4 (Class 4 Soft Switch) provides comprehensive Class 4 SoftSwitch functionality within a VoIP network.
SVI User Guide

1.1.6 SVI_9220 The SVI_9220 provides comprehensive SS7 routing and translation functionality at each layer of the SS7 protocol stack with support for both TDM and SIGTRAN protocols as well as STP functionality. 1.1.7 SVI_9225_SS The SVI_9225_SS provides pure TDM conversion between SS7, ISDN and R2 protocols.
SVI User Guide

SYSTEM OVERVIEW
The following section describes the fundamental operating system interface into the SVI and information on any third party software tools which can be used to assist with operation of the SVI. 2.1.1 OPERATING SYSTEM The SVI uses Linux as an operating system. It generally uses the Red Hat distribution and has support for many kernel versions. All production items will be shipped on a recommended version of the kernel which has been through comprehensive internal testing to prove OS reliability and security. Squires will only generally upgrade the kernel version if advantageous advancements are made to the latest kernel version, if issues are identified in the production kernel or the production kernel become obsolete. Squire maintains a backup of all past Linux kernels which were authenticated by Squires and are freely available through Squires support. 2.1.2 USING LINUX If the user is not familiar with Linux there is an abundant resource of Linux usage on the web. Google provide a separate search facility for Linux this can be accessed via the web address www.google.com/linux . 2.1.2.1 Linux Help Pages Linux provides an inline help mechanism that provides help pages on given Linux commands. This help is called the man page system and can be accessed from a Linux Command Shell by using the command >man <command> 2.2 ACCESSING THE SVI.
The SVI can be accessed and managed by using a number of different methods 2.2.1 DIRECTLY CONNECTING TO THE SVI The SVI is provided with standard Monitor and keyboard access. Refer to the hardware guide for further details. Multiple Linux Command Line sessions can be run on the system each doing a different task. These can be accessed by pressing the <ALT><Fx> key where x is the number of the function key corresponding to the session number.
SVI User Guide

2.2.2 CONNECTING OVER IP The SVI can be connected to remotely over IP using the SSH (Secure Shell) protocol. The SVI is shipped with the following IP address as default. IP Attribute IP Address Netmask Broadcast SSH Port 2.2.2.1 Windows To connect to the SVI from a Windows machine a suitable Telnet /SSH client needs to be installed on the Windows machine. Squire recommends that Putty is used as this has been verified with the SVI. Putty can be downloaded at the following address http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html Download the putty-x.xx-installer.exe option from this page and install as instructed. 2.2.2.2 Setting up Putty When Putty is installed, run up Putty and the opening screen will be displayed. To connect to the SVI enter the IP address of the SVI in the Host Name window and choose the SSH Protocol radio button. Value 192.168.2.100 255.255.255.0 192.168.2.255 22
SVI User Guide

Before saving the session for future use, select from the Category Window on the left hand side the Window option. Set the lines of scroll back option to be 20000 or greater to provide a good history review. Return back to the Session Category and save the session by putting in an appropriate name in he Saved Session window and then click the Save button. To connect either double click the saved session or Load the save session and press the Open button. 2.2.2.3 Unix Any standard Telnet client program can be used that supports character mode. 2.2.3 LOGGING ON When connecting to the SVI either directly or over IP, the user will need to log on to gain access to the SVI. The SVI is shipped with the following factory default username and passwords. Enter the administrator username and password when prompted on the Command Shell. Usernames and passwords are case sensitive. Level Administrator Username root Password squireSVI
2.2.3.1 Changing Username and Password To maintain security within your system it is important to change the password from the factory default. It is vital to maintain these usernames and passwords as in the
SVI User Guide

event of loss of password information, the system may need a full install to allow for access to be restored. To change the password make sure you are logged in as root >passwd root On return you will be asked twice for the new password. If you are prompted with the error BAD PASSWORD: it is based on a dictionary word, this is informing you of a badly chosen password and can be ignored, although we do not recommend using dictionary words.
Changing a password
2.3
MANAGING IP INFORMATION
The IP address information can be managed directly from the command line. 2.3.1 DISPLAYING CURRENT IP INFORMATION To display the current IP settings of the SVI, use the following command >ifconfig
IP Interface IP Address MAC Address IP Mask
SVI User Guide

Displaying IP Address Information
To find the Default Gateway Address use the >route n

Default Gateway
Displaying Default Gateway
2.3.2 CHANGING IP ADDRESS The SVI is provided with a default IP address that will need to be changed to connect into any new network. The following describes how to change the IP address of the SVI. It is also important to change any fixed IP information that is contained within the SVI. To change the IP address of the SVI use the following command >netconfig This will provide you with a text base GUI to enter the new IP information. The Tab key is used to move from window to window in the GUI. At the first window select Yes. At the next window if DCHP is used select the Use dynamic IP configuration and press the space bar to select. If DCHP is not required, TAB through and enter in the relevant IP information.
SVI User Guide

When finished entering the data select the OK button. This will save the changes but will not apply the new IP address until the system is restarted 2.3.3 APPLY CHANGED IP ADDRESS To apply the new changes either restart the SVI or alternately you can apply in real time by entering into the command line >service network restart When entered all old IP connection to the old address will be disconnected including the SSH connection. The SVI will also need to be restarted if the IP address is applied in real time.
2.4
EDITING FILES WITH THE LINUX EDITOR
The log files can be edited directly on the SVI from the Linux command shell using the Vi editor.
SVI User Guide

There are two places where the functionality of Vi can be found one is from the man page which can be accessed from the command line typing >man vi Vi also has a help system which can be accessed from the vi front page by typing at the command line >vi and then following the help instructions. To edit a given file, type at the command line >vi file name and path 2.4.1 BRIEF VI OVERVIEW Vi has two main modes an edit mode and a command mode. When first opening a file Vi will display the file within the command mode. To edit the file enter the edit mode by pressing either the i key or insert key on the keyboard. To enter back into the command mode press the ESC key on the keyboard. Key i Insert :q! :wq delete Esc yy yny p dd dnd Cursor keys :/string :?string n Shift + g gg :n 2.5 Mode Command Command Edit Command Command Command Edit Edit Command Command Command Command Command Command Edit Command Command Command Command Command Command Description Enter edit mode Toggle between insert and replace in edit mode Exit without saving Save and Exit Delete a character Enter command mode Copy current line Copy n lines Paste Delete current line Delete n lines Cursor control Search down for string in file Search up for string in file Search for next Go to bottom of file Go to start of file Go to line n
USING GREP COMMAND TO SEARCH THROUGH FILES
The Linux OS comes with a powerful file search command that allows users to quickly search through text files. The Linux OS provides a comprehensive usage guide on GREP by using the man pages of GREP.
SVI User Guide

2.6
MANAGING FILES
2.6.1 LINUX COMMAND SHELL The Linux command shell provides standard functionality for file management through the command line. The following lists a number of commands that can be used. All of these commands can be investigated in detail by using the Linux man pages Function Directory Listing Detailed Listing Copy file Move file Delete file Delete directory Current Working Directory Change directory Make Directory Compress file Uncompress file Command ls ls -al cp <file name> <location> mv <file name> <location> rm <file name> rm rd <directory name> pwd cd mkdir <directory name> tar cvzf <name of compression file> <name of file> tar xvzf <name of compression file>
2.6.2 USING WINDOWS FOR REMOTE LINUX FILE MANAGER It is possible to fully manage the SVIs file management system from Windows using a third party remote management system. Squire recommends the use of WinSCP which is a freeware secure remote file management system. 2.6.2.1 Installing WinSCP Download from the WINSCP website (http://winscp.net/eng/download.php) the latest release. Follow the instructions provided to install on your Windows machine. 2.6.2.2 Connecting WinSCP to the SVI When running WINSCP for the first time, from the Session option enter in the SVIs details and either save these details to be used next time you want to log on or alternately Login immediately.
SVI User Guide

The user will be presented with the following screen, with the local Windows drive on the left and the remote SVIs drive on the right.
SVI User Guide

Files can be managed directly from the Windows machine by using standard Windows mouse techniques. Files can also be edited with the editors on the Windows machine by opening the files directly in the right hand screen. Files on the SVI can also be copied across from the SVI to the local machine and visa/versa. Care should be taken when copying Windows formatted files to a Linux system and visa versa as they are not always 100% compatible. Linux provides two commands to switch between the two formats dos2unix and unix2dos. 2.7 COPYING FILES FROM THE SVI
The Linux OS provides a number of ways to copy files off and onto the system. 2.7.1 SECURE COPY (SCP) SCP provides a secure transfer mechanism to transfer files to and from the SVI. Use the man pages for more details on the SCP command. 2.7.2 FILE TRANSFER PROTOCOL (FTP) The SVI provides an FTP client enabling the transfer of files to an FTP server. Use the man pages for more details on the FTP command. 2.8 MAIN SVI FILES
The SVI is delivered as a black box unit with only minor configuration changes required to get the unit running. The following section briefly describes the main SVI files that are required to run the SVI successfully providing the user some understanding of these main components. 2.8.1 SYMBOLIC LINKS Some of the programs, directories and files are symbolically linked to a reference name. This is useful when programs or files have versions within the name of the file allowing for multiple versions to be stored on the unit. When a particular version is required to be used a generic name can be assigned to it without changing all of the other places that reference this version. To inspect the symbolic links in a directory type ls al. The symbolic links will show up in Blue indicating where they are linked to. If the link is not present then this will be displayed with a red background. When upgrading ensure that all symbolic links are applied to the correct version. To remove an old link use the command rm f <link name>. To add a new link user the command ln sf <link name> <file name and path>
SVI User Guide

2.8.2 GW SERVICE SCRIPT

Name gw Symbolic Link No Type Version Service Script Location CFG File /etc/init.d
The gw service script controls the starting and stopping of the SVI service as well as setting up a number of environmental conditions. 2.8.3 MONITOR PROGRAM
Name monitor Symbolic Link Yes Type Version Program monitor.vx_x Location CFG File /home/squire processes
This program starts up the SVI processes and continuously monitors them. If one of the monitored processes fails for any reason the monitor program will restart all of the SVI processes. 2.8.3.1 Command Line Options The following specifies the command line options available on this process -c<File Name> (configuration) contains the configuration file name
2.8.3.2 Configuration The processes symbolic link points to one of three possible monitor configuration files. processes.single Process list for single standalone unit processes.pref Process list for dual plane redundant architecture on the preferred plane processes.npref Process list for dual plane redundant architecture on the non-preferred plane 2.8.4 SSWITCH PROGRAM
Type Version Program svi-ss.vx_x_x.os Location CFG File /home/squire Dbase.cfg
Name sswitch Symbolic Link Yes
The sswitch program provides the main SVI call processing engine. The optional OS field in the release version name is the overall operating system kernel that the program will run on. 2.8.4.1 Command Line Options The following specifies the command line options available on this process -h -v (help) prints out the command line options and exits (version) prints out the version and exits
SVI User Guide

-c<File Name> -s -p -n -l
(configuration) contains the configuration file name (stdout) When running in a command shell prints any debug to the screen. (parse) Parses the configuration file, printing to stdout (name) Specifies the name of the process (logfile) Sets the maximum size of the logfile in Bytes
2.8.4.2 Configuration The sswitch program is configured by the base program Dbase.cfg. For fast configuration and easy maintenance the SVI has a powerful configuration language allowing for multiple processes to share the same configuration file. The configuration of this process is defined in the configuration section of this document. 2.8.5 MGWAY PROGRAM
Name mgway Symbolic Link Yes Type Version Program mgway.hw.vx_x_x.os Location CFG File /home/squire Dbase.cfg
If the SVI has internal hardware components including TDM interface cards, VoIP cards, etc, this program provides the interface to these cards and connects to the sswitch process via SCTP and MGCP. 2.8.5.1 Command Line Options The following specifies the command line options available on this process -h -v -c<File Name> -s -p -n -l (help) prints out the command line options and exits (version) prints out the version and exits (configuration) contains the configuration file name (stdout) When running in a command shell prints any debug to the screen. (parse) Parses the configuration file, printing to stdout (name) Specifies the name of the process (logfile) Sets the maximum size of the logfile in Bytes
2.8.5.2 Configuration The mgway program is configured by the base program Dbase.cfg. For fast configuration and easy maintenance the SVI has a powerful configuration language allowing for multiple processes to share the same configuration file. The configuration of this process is defined in the configuration section of this document.
SVI User Guide

2.8.6
START OAM SESSION HELPER SCRIPT

No Type Version Helper Script Location CFG File /usr/bin
Name oam Symbolic Link
The OAM script provides a continuous OAM session into the SVI. 2.8.6.1 Command Line Options The command line options of the oam script are ss Connect to the SVI-SS OAM port mg Connect to the SVI-MG OAM port sec Connect to the SVI-SEC OAM port port <port number> Connect to the defined port number
2.8.7 START SINGLE OAM SESSION HELPER SCRIPT

Name tel Symbolic Link No Type Version Helper Script Location CFG File /usr/bin
The tel script provides a single OAM session into the SVI. 2.8.7.1 Command Line Options The command line options of the tel script are ss Connect to the SVI-SS OAM port mg Connect to the SVI-MG OAM port sec Connect to the SVI-SEC OAM port port <port number> Connect to the defined port number
2.8.8 TAIL A LOG FILE IN REAL TIME

Name tg Symbolic Link No Type Version Helper Script Location CFG File /usr/bin
The tg command tails the current log file in real time 2.8.8.1 Command Line Options The command line options of the tg script are ss mg sec Tail the SVI-SS log Gateway_dd-mm-yy Tail the SVI-MG log MG_dd-mm-yy Tail the SVI-SEC log Security_dd-mm-yy
SVI User Guide

2.8.9 OPEN CURRENT LOGFILE

Name vig Symbolic Link No Type Version Helper Script Location CFG File /usr/bin
The vig command opens the current log file in Vi 2.8.9.1 Command Line Options The command line options of the tg script are 2.9 ss mg sec Open the SVI-SS log Gateway_dd-mm-yy Open the SVI-MG log MG_dd-mm-yy Open the SVI-SEC log Security_dd-mm-yy
SVI OPERATION
The SVI processes are controlled by the Linux Operating System Service environment. This allows for multiple programs to be run simultaneously and monitored through a standard and simple command line environment. 2.9.1 AUTOMATICALLY STARTING THE SVI ON POWER UP The gw script is added to the service management system which automatically starts the SVI on power up. On delivery of the SVI the gw service script will be added as standard. 2.9.1.1 Displaying Service Management List To check if the gw service script is added to the service management list, type at the command line. >chkconfig --list
To remove the SVI gw service script from the service management list type at the command line >chkconfig --del gw
To add the SVI gw service script to the service management list type at the command line >chkconfig --add gw
SVI User Guide

2.9.2 MANUALLY CONTROLLING THE SVI The SVI can manually be controlled from the Linux command line using the service management command line options. 2.9.2.1 Starting The SVI If the SVI has stopped it can be started up by typing the following at the command line. >service gw start 2.9.2.2 Stopping The SVI If the SVI is running it can be stopped by typing the following at the command line. >service gw stop 2.9.2.3 Restarting The SVI If the SVI has stopped or is running it can be restarted by typing the following at the command line >service gw restart 2.10 LICENSING THE SVI The SVI is licensed through a software license key to only allow the functionality which has been purchased and to provide time limited access to the SVI for demonstration and evaluation purposes. There are two kinds of license a full and temporary license. 2.10.1 FULL LICENSE A full license is a perpetual license which provides instructions to the SVI to allow given functionality and bandwidth to the SVI. The license key is provided in a file called license.cfg which also contains details of the license. 2.10.1.1 Upgrading Full License If a new license has been purchased to increase the bandwidth of the SVI or add new functionality the new license.cfg should be placed in the /home/squire directory. To load the new license without taking down the SVI, the OAM interface can be used to load in the license.cfg file. Alternately if the SVI is restarted the new license will be applied. 2.10.2 TEMPORARY LICENSE The system may be provided with a temporary license for demonstration, evaluation or for credit purposes. This license resides on a remote license server which the SVI periodically connects to, to determine the functionality, bandwidth and duration of the local SVI. This authentication process is performed over RADIUS using UDP to the secure license server.
SVI User Guide

If the SVI can not access the authentication server within a 24 hour period or from start up the SVI will not complete any calls. It is important therefore if on a temporary license to ensure that the SVI has reliable access to the license server and no firewalls are blocking UDP transmission between the SVI and the License Server. 2.11 SHOWING LICENSE INFORMATION All license information can be obtained through the OAM interface inspecting the license resource for allocated functionality and bandwidth and the System resources attribute License Status for which license has been allocated and its current status.
SVI User Guide

SVI DATABASE
The SVI uses an internal memory based database that provides fast access, secure and reliable data storage for the SVI range of products.
Database SVI Cfg files
Database SVI Cfg files
Single or Worker Plane
Standby Plane
OAM
The above diagram provides an overview of the database mechanics. On start up of the SVI the Database is populated from the on board configuration files. During run time the SVI processes will up date in real time any data that needs to be stored in the database. The OAM interface connects directly into the database allowing it to interrogate the data held in the database and change the data if required either directly to the database or instructing the system to load or reload the configuration files. 3.1.1 DATABASE STRUCTURE The database organises its data into a fixed format of <resource> <instance> <attribute> <value>. This structure can be understood by comparing with a standard database model. A Resource is equivalent to a database table that contains a number of rows/records and columns. The resources attribute is the equivalent of a databases column. Within a database there are multiple rows of the same table which is the equivalent of a resources instance. The following shows a quick overview of a standard Database naming format and the SVI Database naming format.
SVI User Guide

Table x Table Row 1 y Row 2 Row Row 3 1 Row Row 4 2 Row Row 5 3 Row Row 6 4 Row Row 7 5 Row 6 Row 7
Column A Column A
Column B Column B
Column C Column C
Column D Column D
Standard Database Naming Convention
Resource x
Attribute A Attribute B Attribute C Attribute D Resource y Instance 1 Attribute A Attribute B Attribute C Attribute D Instance 2 Instance 1 Instance 3 Instance 2 Instance 4 Instance 3 Instance 5 Instance 4 Instance 6 Instance 5 Instance 7 Instance 6 Instance 7
SVI Database Naming Convention
SVI User Guide

CONFIGURATION
Squire Technologies provide a free pre-configuration service to all products supplied by Squire Technologies. If the customer takes advantage of this service the SVI will arrive with the configuration specified by the customer in the pre-installation checklist. If this service is not taken advantage of the SVI will be dispatched with a factory default configuration which will require minor configuration changes. This section provides an overview of the SVIs configuration capabilities but does not detail of the SVIs configuration 4.1 CONFIGURATION FILES
All configuration files that are provided with the SVI are arranged to make configuration and maintenance of the system simple and easy to manage. All configuration files are located in the /home/squire directory and can be edited by any standard ASCII based text editor. Changing a configuration file does not affect the system until it is loaded by the SVI. This can be loaded in real time by the OAM interface or from a restart. 4.2 HANDLING MULTIPLE CONFIGURATION FILES
To make management of configuration files easier the SVI allows for other configuration files to be loaded from within another configuration file. This allows for easily adding and subtracting configuration that is regularly changes like wholesale endpoints, VoIP customers, LCR, etc. 4.2.1 LOAD COMMAND The load command allows for a new configuration file to be specified within another configuration file. When loading a configuration file via this method all specified resources with in the configuration file will be created or over written. 4.2.2 UPDATE COMMAND The update command performs exactly the same functionality as the load command except it will only load the specified data into the resource if the resources state is NIU or Start. 4.3 CONFIGURATION FILE SYNTAX
4.3.1 COMMENTS The configuration file uses the * character to specify that the line of text following the * should be ignored by the parser.
SVI User Guide

4.3.2 DEFINES The SVI uses a comprehensive C flavour define syntax allowing for the configuration of variables that can be used as both a data holder and as a conditional expression. 4.3.2.1 Allocating a Define A define can either be defined as a conditional define to be used with the #ifdef (if defined) or #ifndef (if not defined) or, as a holder of a string to be used with in the configuration file or as both. To allocate a conditional define only the syntax is #define <define name> The define name must be unique and must not be a SVI command. To allocate a string to the define the following syntax is used #define <define name> <define string> This define can be used as a resource instance or an attribute value or copied to another define. The define contents can be changed at any point by redefining the define using the #define syntax. Once a define has been loaded through the configuration it will remain available through out the SVI session. For further details on using defines see the OAM section. 4.3.2.2 Unallocating a define To remove a define from the system the undefine command is used with the following syntax. #undef <define name> 4.3.2.3 Conditional Defines Conditional defines allow for sections of configuration files to only be read if a previous define name has been defined. There are two types of conditional defines #ifdef (if defined) and #ifndef (if not defined). The syntax for these two conditional defines are as follows
SVI User Guide

#ifdef <define name> Configuration commands #endif #ifndef <define name> Configuration commands #endif If the define name is defined the configuration commands between the #ifdef and #endif will be executed where the configuration commands between the #ifndef and #endif will not be executed. If the define name is not defined, the configuration between the #ifdef and #endif will not be executed where the configuration commands between the #ifndef and #endif will be executed. 4.3.2.3.1 Nesting Conditional Defines The conditional commands can be nested which allows for conditional commands to be located within the conditional configuration command section. 4.3.2.4 User defined Exiting with an Error The user can cause an error and exit the loading of the database and running of the SVI by using the #error command. #error <comment> The comment will be the error displayed within the log file. 4.3.2.5 User defined Exiting of a Configuration File The user can insert the #exit command to exit without an error from the current configuration file. This will stop processing any further configuration commands within the current configuration file. If the file is being loaded from another file only the current file will be exited from. 4.3.2.6 System Define When the SVI is run up, if the -n<name> command option is used on the command line when running an SVI process this name is available as a conditional define.
SVI User Guide

Example of using define commands
4.3.3 CONFIGURING RESOURCES The configure command allows the user to configure any resource. All of the fields of the configure command are mandatory. If any of the fields are entered incorrectly an error message will be displayed in the log file indicating if possible the correct options that can be entered for the field. <resource> <instance range> <attribute> <value range> 4.3.3.1 Configuring Integer Values There are a number of enhancements to enable mass configuration of attributes which contain an integer value. This section describes these. 4.3.3.1.1 Configuring a range of values To configure a range of values against a range of resources, a range syntax can be used <resource> <a-b> <attribute> <x-y> This will apply in sequential order to a-b the values x-y. If the number of instances with in the x-y range is less than then number of instances within the a-b range, when the x-y range has incremented to y, it will return to x and again increment up to y.
SVI User Guide

4.3.3.1.2 Using the divide rule It is possible to specify that the x-y range is divided by a specified integer by using the formula (d/x-y) in the value range field. This can be represented by the mathematical expression (x > y) / d. The following shows the syntax for applying this range <resource> <a-b> <attribute> <d/x-y> 4.3.3.1.3 Using the modulus rule It is possible to specify that the x-y range has a modulus applied to it by using the formula (m&x-y). This allows for a reduced cyclic value range to be applied over a larger instance range. The syntax for this operation is shown below <resource> <a-b> <attribute> <m&x-y>
Example of configuration commands
4.3.4 PASSING VARIABLES INTO CONFIGURATION FILES The SVI allows command line variables to be passed from a configuration file using the load or update command which can then be used within the configuration file without having to set multiple #defines up.
SVI User Guide

To do this the configuration file uses the $n define within the configuration file where n is a value from 1-x which specifies the command line instance which is added to either the load or update command. 4.3.4.1 Setting up the configuration file to handle variables The following shows a configuration file which has been edited to accept variables passed in on the command line
Example of a configuration template
4.3.5 LOADING CONFIGURATION FILE SPECIFYING THE VARIABLES FROM ANOTHER CONFIGURATION FILE To load the configuration file, either the load or update command can be used with the additions of the command line parameters in order as specified within the configuration file. Syntax: !load <name of configuration file> <$1> <$2> <$3> <$n> 4.3.6 THE OAM COMMAND To run OAM commands from a configuration file the ! character is used followed by the OAM command. This allows for batch filing of OAM commands allowing for batch running of common OAM commands from the OAM interface.
SVI User Guide

5
5.1
OAM INTERFACE
ADMINISTRATION OF THE OAM INTERFACE
The SVI OA&M interface uses the standard Telnet protocol over TCP-IP to provide a client-server connection which can be run locally on the same machine or remotely over a LAN or WAN connection. 5.1.1 SECURITY OF THE OAM IP CONNECTION As the SVI can be accessed remotely by IP it is not desirable to allow for the OAM access ports to be publicly available. To only allow for authorised personnel to connect to the SVI, access to the OAM interface is over a two hop mechanism. The first hop is to log into the unit using SSH (Secure shell). Once logged into the system use the system short cut oam <process name> to initiate the OAM session. 5.1.2 FIREWALL ACCESS To allow for remote access on SSH it is necessary that the well known SSH port 22 is opened on any access firewalls. 5.1.3 PROCESS OAM PORT ASSIGNMENT An SVI product may have multiple processes depending on the product purchased. Each of these products have their own OA&M interface which are accessed on the same IP Address using a different IP Port address as shown below
SVI User Guide

SVI OS
SVI-SS
15001 Telnet
16001 Telnet
SVI-MG
17001 Telnet
SVI-SEC
18001 Telnet
SVI-RTP
22 SSH
OAM Port Assignment
The processes access port and functional description is detailed in the following table Process Name SVI-SS Product Group All products Description Main service process containing all protocol and service functionality Standalone media gateway function providing low layer control of interface hardware Provides redundancy control in a dual plane architecture Provides RTP proxy service Configuration Shortcut file Dbase.cfg oam svi-ss IP Port 15001
SVIMG
SVIMGC-SG
Dbase.cfg
oam svi-mg
16001
SVISEC SVIRTP
All redundant products SVI-SS
Dbccure.cfg
oam svi-sec
17001
RtpRouter.cfg
oam svi-rtp
18001
The configuration of these ports are provided in the standard configuration files as stated in the above table.
SVI User Guide

The factory default resource used to setup the OAM access port is IP 0 as shown below.
Display of IP Resource 0 Setup for OAM Access Resource
5.1.3.1 Starting An OAM Session When the SSH session has connected a standard Linux Terminal Shell Window will be displayed. To start the OAM session from any directory, type oam <process name>. If the process name is not specified a connection will be made by default to the SVI-SS OAM interface.
Starting up OAM Session
If the SVI system is not running the OAM will continue to try to connect to it and display the message below
Attempting to connect to an OAM Session
If the above message is displayed check that the SVI is running.

SVI User Guide

When the OAM session connects to the SVI a Welcome screen is displayed
The Welcome screen provides information about the SVI process which is currently running. The SVI_SS indicates the name of the process, the release Version number is also displayed as well as the OAM interface version number OAM Control (x.x). The status of the SVI is also displayed at the end of this line as well as in the title bar of the OAM Session. Status Uninitialised Initialised Configured Running Wait Command Single / Redundant Both Both Both Single Redundant Definition System has failed and is shutting down System is loading database and coming into service System has loaded database file into memory System is operational System is waiting for security task to specify if the System is to go worker or standby. This plane is going worker This plane is going standby This plane is the worker plane This plane is the standby plane
Going Worker Going Standby Worker Standby
Redundant Redundant Redundant Redundant
5.1.4 CONNECTING TO A REDUNDANT ARCHITECTURE When a system is deployed in a dual plane redundant architecture, only the Worker planes OAM interface should be accessed to obtain correct database information.
SVI User Guide

192.168.2.101 Worker 192.168.2.110 VIP 192.168.2.102 Standby
Redundant Dual Plane Architecture
With the dual architecture there are 3 IP addresses, one static IP address on each of the planes and a Virtual IP Address (VIP) that is controlled only by the worker. The SVI allows the user to connect to the OAM interface on any of these IP addresses, however it is always best to connect on the VIP Address as you are always guaranteed to connect to the current worker plane. 5.2 USING THE OAM INTERFACE
The OAM Interface provides a standard MMI (Man Machine Interface) not unlike a standard UNIX terminal session. 5.2.1 ENTERING COMMANDS Commands are entered via the keyboard and executed when the return key is pressed. All standard editing keys can be used to position the cursor on the command line as well as using the up and down arrow keys to display previous commands entered in this session. 5.2.2 GETTING HELP To see a list of the available commands through the OAM Interface type help on the command line. A list of available commands and a brief description will be displayed to assist with using the OAM Interface. 5.2.3 EXITING AN OAM SESSION To exit the OAM session enter either quit or q at the command line. If the OAM session was initiated by the oam command then the user will then need to press CTRL C to exit to the UNIX terminal. If the CTRL C is not pressed then another OAM session will begin. If the tel command was used no other action is required to exit back to the terminal screen.
SVI User Guide

5.2.4 SVI PROCESS SHUTDOWN If the SVI process to which the OAM Session is connected to shuts down for any reason if the session was initiated by the oam the terminal will automatically try to start another session. If the tel command was used the session will automatically end and the user will need to manually restart another session. 5.2.5 RUNNING MULTIPLE OAM SESSIONS The SVI can handle multiple OAM sessions into the same SVI process. Each of these sessions is independent, allowing for multiple sessions to be run. Multiple sessions can be run from the same machine or from multiple different machines allowing more than one person to connect to the unit at the same time. The following diagram shows an example of a desktop with 4 sessions running providing the following unique information Statistic Information Status Information Database Inspection and Configuration Trap Capturing
SVI User Guide

5.2.6 CLEARING THE SESSION SCREEN Whilst running an OAM session the screen can be cleared by typing clear on the command line. 5.2.7 ENTERING MULTIPLE COMMANDS ON A SINGLE COMMAND LINE To assist with multiple command execution the OAM interface allows for multiple commands to be entered in a single command line. There are two methods to perform this the piped method and the parentheses method. The methods can be used together 5.2.7.1 Piped Method The piped method allows the user to type multiple commands on the same command line separating each command by the pipe character |. >command a | command b | command c 5.2.7.2 Parentheses Method The parentheses method separates out a command into a header command and sub commands using brackets and commas to separate the command. >command a (sub command x, sub command y, sub command z) For example to configure a resources attributes you would normally enter on the command line a command for each attribute as show below
Using the parentheses method this can all be executed in a single line as show below
These two methods can also be combined to quickly execute complex commands. This is especially useful in conjunction with the hot key defines and startup script to provide detailed system information. 5.2.8 AUTOMATICALLY REPEATING COMMANDS The SVI incorporates a repeat command that allows for a command to be executed once every x seconds indefinitely. This allows for the real time display of status and statistic information when incorporated with the multiple command methods.
SVI User Guide

Syntax: repeat x <command> The x specifies the interval in seconds that the command will be repeated. The following will stop the repeating of the command Syntax: repeat off Only one repeat session can be used per OAM Session. 5.2.9 FULL LIST OF OAM OPERATIONS This following table provides a detailed description of the commands available for use on the OAM interface. The following table gives a quick overview of these commands which are explained in more detail in this section Command
Help Show Show SNMP Show Date Show define Configure Status Syntax Take Oos Command Bring Ins Command Parent Command Children Command ParentS Command ChildrenS Command Trap Command Loadfile command Write Configuration Command Attribute command Clear Resources Log Define Undefine Open trace file Close trace file Details Persistence Control
Syntax
Help Show <resource> <instances> <attribute> <value> Show SNMP <resource> Show date Show define Config <resource> <instances> <attribute> <values> Status <resource> <instance> Syntax <resource> <instance> <attribute> <value> Take oos <resource> <instance> Bring ins <resource> <instance> Parent <resource> <instance> Children <resource> <instance> ParentS <resource> <instance> ChildrenS <resource> <instance> Trap on/off Loadfile <file path and name> Write config <file path and name> Att/Attribute <resource> <instances> <attribute> Clear Resources Log <string> #define <define> <string> #undef <define> Open trace <file path and name Close trace Details <start/stop> persistence
Description
Displays a list of available commands Displays the current settings of a resource within the system Shows a list of OID values assigned to the attributes for this resource Displays the systems current time and date Shows a list of the current system #defines loaded through the configuration files Configures a resources attribute Shows in colour coded tabular form the status of a range of instances of a resource Shows possible options and values for resource, instance, attributes and attribute values. Takes a resource out of service. Depending on the resource will depend on the action taken Returns a resource back into service. Depending on the resource will depend on the action taken Shows the status of the immediate parent of a resource Shows the status of the immediate child of a resource Shows the status of all parents of a resource Shows the status of all children of a resource Indicates if traps are to be displayed on this OAM session Loads a configuration file into the system Dumps the current configuration out to a file Shows in tabular form an attributes value for a range of resources. Clears the screen Displays name of resources which have at least one instance configured. Adds a string prefixed OAM DEBUG into the log file Adds a define to the SVI Removes a define from the SVI Opens a trace file of the OAM session Closes the trace file Displays the details on the SVI system Starts stops persistence
SVI User Guide

5.3
DATA PERSISTENCE
The SVI database is volatile memory which means that when the system is stopped or shutdown the database is wiped clean. When the system is restarted the database is reinitialised from the configuration files. Any data that is changed by the OAM interface directly and not stored in a configuration file will be lost when the system is stopped. 5.3.1 PERSISTING DATA TO THE CONFIGURATION FILE The SVI allows the user when configuring directly from an OAM session to persist any configuration changes to a file persist-(process name).cfg. This file is loaded at startup which should be included at the bottom of the file Dbase.cfg file. If persisting is required ensure that the following line is included at the end of the Dbase.cfg file Optfileload 0 persist-(process name).cfg The process name can be found out by typing on an OAM session command line >show system 0 name
In the example above the system name is SVI_SS therefore the file name will be persist-SVI_SS.cfg. 5.3.2 CONTROLLING THE PERSISTENCE OF DATA If persistence is always required the OAM resources Persist attribute can be set through the oam.cfg configuration file to be True for persisting data or False to not persist data. The ability to persist data through an OAM session is also possible by the following command option >start/stop persist 5.3.3 MANAGING THE PERSISTENCE FILE The persistence file will always overwrite any configuration which is set in the standard configuration files. It is important that the user does not forget when changing the standard configuration files to check that there is no conflict with this data in the persist configuration file.
SVI User Guide

5.4
DUAL REDUNDANT OPERATION
When running a dual redundant architecture the Worker planes database and configuration file are the master source for the systems configuration. When the standby plane comes into service, its database is synchronised from the master worker database and data filled from this database. Any subsequent changes to the master database made either by the SVI, OAM interface or loading configuration files will be automatically updated to the standby database. Therefore on a failover data is persisted across the two planes. 5.4.1 PERSISTING CONFIGURATION FILES To ensure complete data integrity across the dual plane architecture for all system start up scenarios, the configuration and persist files on both the worker and standby planes must be the same. To update all configuration from one plane to another plane use the following command on the UNIX terminal. >updatecfg 5.5 DISCOVERING DATABASE FORMAT
The SVI OAM provides the syntax command which allows the user to investigate the available resources, its attributes and the possible values of the attribute. 5.5.1 SYNTAX COMMAND Syntax: syntax <resource> <instance> <attribute> The Syntax command provides an interface to find the available resources, number of licensed instances of a resource, attributes of the resource and also values that a resource can take. 5.5.1.1 Showing Systems Resources To see a list of the available resources type the following at the command line >syntax This will display all available resources. 5.5.1.2 Showing Number of Resources Instances To see a list of the available resources type the following at the command line >syntax <resource> This will display the number of instances licensed for this resource.
SVI User Guide

5.5.1.3 Showing a Resources Attributes To see a list of the available resources attributes, type the following at the command line >syntax <resource> 0 This will display all available attributes for this resource. 5.5.1.4 Showing a Systems Resource Attributes Possible Values To see a list of a resource attributes possible values, type at the command line >syntax <resource> 0 <attribute> This will display all available resources. 5.6 DISPLAYING DATABASE INFORMATION
The OAM interface has a number of different ways of displaying configuration, status and statistical information. 5.6.1 SHOW COMMAND Syntax: show <resource> <instances> <attribute> <value> The show command allows for user to interrogate the current status and values of a resource and its attributes. The <instances> value can be either a unique number x, a range of numbers x-y or a or all for all instances of resources. The show command will only show resources whose status is not NIU and will only display attributes that are not set to a not used value. 5.6.1.1 Showing all of a Resources Attributes Values To show a specific resources attributes value type the following at the command line >show <resource> <instances>
SVI User Guide

Showing IP Resource Attribute Values
5.6.1.2 Showing a Particular Attributes Value To show a specific attributes value type the following at the command line >show <resource> <instance> <attribute>
Showing All Configured IP Port Values
5.6.1.3 Showing Only Resources with Attributes of a Particular Value The SVI OAM interface allows the user to only display attributes with a given value by the following command >show <resource> <instances> <attribute> <value> If the user wants to display all resources with an attribute value not set to a given value then the ! character is put in front of the value. >show <resource> <instances> <attribute> !<value>
SVI User Guide

Find Signalling Links on interface 0 and then signalling links not on interface 0
5.6.1.4 Status Command Syntax: Status <resource> <instance range> The status command allows the user to see in colour coded tabular form the status of a range of instances of the same resource. The table will automatically fit to the size of the OAM screen allowing the table to be resized by resizing the OAM screen.
Shows the status of a range of instances of a resource
To maintain a real time display of the status use this command in combination with the repeat command. 5.6.1.4.1 Out Of Service Status Meanings In general if a resource is INS (in service) or green the resource is in service, if it is not green the resource is not in service for one of a number of reasons. These out of service states allow for further investigation to help identify why the resource is out of service. The following table describes the possible status meanings. Status Niu Osc Meaning Colour Not In Use White Out Of Yellow Service Configured Description The resource is not currently loaded The resource is loaded and waiting for its parent to come into service so that the resource can be configured.
SVI User Guide

Oscp
Osf
Osfp
Osd
Osfd
Oos INS
Out Of Service Configured Pending Out Of Service Faulty Out Of Service Faulty Pending Out Of Service Dependant Out Of Service Faulty Dependant Out Of Service
Red
The resource is currently being configured
Red
Red
The resource is out of service and waiting for its parent to come into service before it will try to restart this resource The resource is trying to start up
Blue
The resources parent is not in service and as soon as it is in service this resource will return to service The resource is out of service due to an external fault, once this fault has been rectified the resource will return to service. The resource has been taken out of service by the OAM interface. The resource is in service.
Red
Green
5.6.1.5 Displaying Multiple Attribute Instances The attribute command allows for the user to display the value of a resource attribute for a range of instances. Syntax: attribute <resource> <instances> <attribute>.
Showing current incoming calls on a Hunt Group
This is particularly useful for displaying real time statistics if used with the repeat command. 5.6.1.6 Using the Repeat Command The repeat command enables a command line to be executed once every n seconds to provide a continual display update of information. This command is specifically useful for displaying in real time, status and statistical information. Syntax: repeat (seconds) command
SVI User Guide

Every 5 seconds this command will display the ASR of all hunt groups
Every time the command is repeated the rest of the OAM screen is cleared and the command re-executed. To stop the command being repeated type at the command line >repeat off 5.6.2 CONFIGURING THROUGH THE OAM INTERFACE The OAM interface allows the user to configure the SVI database in real time using the configure command. 5.6.2.1 Configure Command Syntax : Config <resource> <instances> <attribute> <value> The configure command allows the user to configure any resource. All of the fields of the configure command are mandatory. If any of the fields are entered incorrectly an error message will be displayed indicating if possible the correct options that can be entered for the field. 5.6.2.1.1 Applying Configuration Changes Each resource has a configuration type which indicates when a resources configuration change is applied to the system. The configuration type of the resource can be seen by typing >syntax at the command line. These types are Startup: This resource can only be configured at startup Managed: This resource can be configured at any time but for configuration changes to be applied the resource must be taken out of service and then brought back to a configured state (Start) to apply the changes. Realtime: As soon as a configuration change has been applied to a resource it will take effect immediately. 5.6.2.1.2 Adding New Resource Instance If a new managed resource is added via the OAM interface it must also be applied to the system before it will be brought into service. To do this use the Add Resource function as described in this document. 5.6.2.1.3 Configuring Integer Values There are a number of enhancements to enable mass configuration of attributes which contain an integer value. This section describes these.
SVI User Guide

5.6.2.1.3.1
Configuring a range of values
To configure a range of values against a range of resources, a range syntax can be used >config <resource> <a-b> <attribute> <x-y> This will apply in sequential order to a-b the values x-y. If the number of instances with in the x-y range is less than then number of instances within the a-b range, when the x-y range has incremented to y, it will return to x and again increment up to y. The following print out shows an example of applying a range.
Configuring a range of Circuit CICS
5.6.2.1.3.2
Using the divide rule
It is possible to specify that the x-y range is divided by a specified integer by using the formula (d/x-y) in the value range field. This can be represented by the mathematical expression (x > y) / d. The following shows the syntax for applying this range >config <resource> <a-b> <attribute> <d/x-y> The screen shot below shows an example of applying the divide rule
SVI User Guide

Assigning TDM Interfaces to a range of circuits using the divide rule
5.6.2.1.3.3
Using the modulus rule
It is possible to specify that the x-y range has a modulus applied to it by using the formula (m&x-y). This allows for a reduced cyclic value range to be applied over a larger instance range. The syntax for this operation is shown below >config <resource> <a-b> <attribute> <m&x-y>
Assigning TDM timeslots to a range of Circuits using the modulus method
5.6.2.1.4 Using Defines The SVI allows for the user to specify a variable that holds a string. These variables can be used within the configure command.
5.6.2.1.4.1 Showing Stored Defines
The show defines command lists all defines currently defined in the SVI. Syntax : show defines
5.6.2.1.4.2 Adding A Define
SVI User Guide

To add a define to the system the #define command is used. A define added through the OAM interface will not be stored on a restart. To permanently store define, the define needs to be added in a configuration file. Syntax : #defines <define> <string>
5.6.2.1.4.3 Removing A Define
To remove a define from the SVI the #undef command is used. Syntax : #defines <define> <string> 5.6.3 LOADING CONFIGURATION FILES The OAM interface allows for batch configuration to be loaded into the system from pre-written configuration files. On start up the SVI will load in the specified configuration files. The factory default configuration file is called Dbase.cfg. This also specifies a number of other configuration files that are loaded in on start up. These files and newly created files can be reloaded during run time from the OAM interface. Depending on the resource type (start up, managed or real time) will depend on which command is used to load in a configuration file. 5.6.3.1 Load Command Syntax: load <file name and path> The load command, loads and overwrites the specified resources attribute. This command should be used when either loading real time resources or adding new resources. 5.6.3.2 Update Command Syntax: update <file name and path> The update command will only load a resources attribute value if the status of the resource is NIU or Start. If an error is in the configuration file being loaded this will be reported to the OAM interface.
SVI User Guide

5.6.4 PASSING VARIABLES INTO CONFIGURATION FILES The SVI OAM interface allows for the user to pass command line variables into a configuration file which can then be used within the configuration file without having to set multiple #defines up. To do this the configuration file uses the $n define within the configuration file where n is a value from 1-x which specifies the command line instance which is added to either the load or update command. 5.6.4.1 Setting up the configuration file to handle variables The following shows a configuration file which has been edited to accept variables passed in on the command line
Example of a configuration template
5.6.5 LOADING CONFIGURATION FILE SPECIFYING THE VARIABLES ON THE OAM INTERFACE To load the configuration file, either the load or update command can be used with the additions of the command line parameters in order as specified within the configuration file. Syntax: load <name of configuration file> <$1> <$2> <$3> <$n> For example to load the above example the following could be entered
SVI User Guide

Loading a configuration template with command line parameters
Defines can be used within the command line parameters. 5.6.6 PRE-CHECKING OF CONFIGURATION FILES. To ensure that the syntax of the configuration file is correct the user can pre-parse the configuration file before it is loaded into the SVI through the OAM interface. To parse a configuration file before loading it type at the Linux Command Line >./sswitch c<configuration file name> -n<SVI name> -p Configuration file name is the name of the configuration file that is to be parsed SVI name, this can be found either from the command line specified in the file process or can be interrogated through the OAM interface by inspecting the name attribute of the system resource show system 0 name
5.6.7 CONFIGURING MANAGED RESOURCES Managed resources are resources which are brought into service by the SVIs maintenance module. Changing the resources attributes will not take affect until the changes are reapplied to the system. 5.6.7.1 Removing A Managed Resource To remove a resource the remove command is used. Syntax: remove <resource> <instance range> When a resource is removed from the system the resource is first stopped and then removed from the relevant process. The status of the resource is then set to NIU but none of the resources attribute values are changed. To re-use the resource if the status of the resource is changed to Start the resource will be displayed when interrogated. After any configuration changes, to restart the resource the add resource command is used to add the resource back into the system and to instruct the SVI to try to bring the resource back into service. Syntax: add resource <resource> <instance>
SVI User Guide

5.7
CONTROLLING SVI RESOURCES
Certain resources can be taken out of service and then returned to service manually. 5.7.1 TAKING A RESOURCE OUT OF SERVICE To take a resource out of service use the syntax Syntax: take oos <resource> <instance> 5.7.2 BRINGING A RESOURCE INTO SERVICE To bring a resource into service use the following syntax Syntax: bring ins <resource> <instance> The following table shows a list of resources that are affected by the take oos/bring ins commands
Resource Local Block
Process SVI-SS
Signalling Link SVI-SS Interface Datalink SVI-MG SVI-SS
Action Take Oos: Locally Block the SS7 circuit Bring Ins: Locally Unblock the SS7 circuit Take Oos: Manually stop the SS7 signalling link Bring Ins: Manually start the SS7 signalling link Take Oos: Manually stop the Layer 1 interface Bring Ins: Manually start the Layer 1 interface Take Oos: Manually stop the Q921 datalink Bring Ins: Manually bring in service the Q921 datalink
5.8
SYSTEM FAULT INVESTIGATION
To assist with debugging of the SVI to identify issues either internally or externally due to configuration, hardware or third party equipment failure, the SVI provides a number of commands to assist with identifying the exact problem. Most telephony protocols follow the OSI model as forming a hierarchical relationship between the different protocol layers. The SVI uses this hierarchical relationship to form parent-child relationships between the relevant resources that are abstracted to one of the model layers. The following table shows this modelling
SVI User Guide

5.8.1 OSI MODEL LAYER PROTOCOLS 5.8.1.1 TDM Layer # Name 7 Application SS7 Protocol Resource ISUP Circuit TUP Local Block IUP Remote Block ISDN Protocol Resource
6 5 4 3
Presentation Session Transport SCCP Network MTP-3
2 Datalink 1 Physical
MTP-2 MTP-1
SCCPDb Originating Point Linkset Destination Point Signalling Link Interface Card
Q931
Circuit
Q921 Layer 1
Datalink Interface Card
5.8.1.2 SIGTRAN Layer # Name 7 Application M2UA Protocol Resource ISUP Circuit TUP Local Block IUP Remote Block 6 Presentation MTPL3 Originating Point Linkset Destination Point 5 Session M2UA AS ASP 4 Transport SCTP SCTP 3 Network IP 2 Datalink Ethernet 1 Physical 802.x Layer IUA # Name Protocol Resource 7 Application 6 Presentation Q.931 Circuit 5 Session IUA AS ASP 4 Transport SCTP SCTP 3 Network IP 2 Datalink Ethernet 1 Physical 802.x M3UA Protocol Resource ISUP Circuit TUP Local Block IUP Remote Block
M3UA SCTP IP Ethernet 802.x
AS ASP SCTP
SVI User Guide

5.8.1.3 VoIP # 7 6 5 4 3 2 1 Layer Name Application Presentation Session Transport Network Datalink Physical Protocol SDP SIP UDP IP Ethernet 802.x SIP Resource Protocol H.245 H.225 TCP IP Ethernet 802.x H.323 Resource
VoIP Destination VoIP Stack IP NIC* NIC*
VoIP Destination VoIP Stack Datalink Interface Card
From these models unless the lower protocol is in service the upper layers will not come into service and if the lower layers fail then the corresponding upper layers will fail. 5.8.2 DISCOVERING RESOURCE RELATIONSHIPS The SVI provides two commands to discover the relationships of a resource to enable the quick identification of a fault within the system. 5.8.2.1 Parent Command The parent command lists all of the immediate resources that are the parent of this resource. Unless these resources are in service then the identified resource can not come into service. Syntax: parent <resource> <instance>
Showing immediate parents of local block resource
The above example shows the parents of the local block resource. When all three of the shown parents are in service the local block will attempt to come in service. If all parents of the resource are INS (in service) then the actual resource has failed to come into service. 5.8.2.2 ParentS Command The parents command differs from the parent command by continuing to print the parents parent relationship providing an overall view of the relationships. Syntax: parents <resource> <instance>
SVI User Guide

This command shows a cascade of the parents of this resource in an explorer style format using the > character to show the times removed of the resource from the entered resource. An example below shows the parent relationship tree of a circuit.
Showing entire parent hierarchical relationship of circuit resource
It can be seen that the circuit resource is not in service because the immediate parent the local block resource is not in service, which is not in service because the local blocks parent the destination point is also not in service. 5.8.2.3 Children Command The children command shows the immediate children of a resource. Syntax: children <resource> <instance> The following example shows how this command can be used to identify what resources are contained with in a given interface.
SVI User Guide

Showing children of interface 0
5.8.2.4 ChildrenS Command The childrens command extends the children command by displaying the children of the children. Syntax: childrens <resource> <instance> 5.8.3 CAPTURING CHANGE IN RESOURCE STATUS If a resource changes status it will output this to the OAM screen in real time as a Trap report. The trap reports have the following format [Date][Time][SVI Name] Trap: [Type] [Name] [Instance] Status [State] The capturing of traps can be controlled either by the Traps on/off command or by the OAM traps attribute which specifies if traps are to be captured by this session.
SVI User Guide

Showing Trap Capture
5.9
CUSTOMIZING THE OAM INTERFACE
5.9.1 OAM ACCOUNTS As already specified in this document the OAM interface uses a standard Telnet TCPIP server port listening on a pre-specified IP address which allows for multiple clients to be connected to the same OAM interface. It is also possible to setup multiple accounts which can each be customised to behave in a particular function. 5.9.1.1 Setting up an OAM Account The OAM resource is used in conjunction with an IP resource to setup an OAM account. The system is generally delivered with a factory default of a single OAM account setup, this configuration uses resource IP 0 and the OAM resource instance 0. These are generally configured in Dbase.cfg using the oam.cfg template. 5.9.1.1.1 Username Password. It is possible to secure the account by requiring a username and a password to logon to the account. To set the username and or password specify these fields against the OAM username and password resources. If no username or password is specified when connecting to the OAM IP port the user will be automatically logged in. 5.9.1.1.2 Short Cuts. The user can easily add short cut words to the OAM session allowing for much used complex commands to be reduced to a single word. Short cuts can only be added within a configuration file against the OAM resources shortcut attribute. Syntax: OAM <instance> shortcut <shortcut name> <shortcut command> Multiple shortcuts can be applied to the OAM account by configuring multiple shortcuts against the same OAM instance.
SVI User Guide

To inspect the shortcuts which have been setup against an OAM account inspect the OAM resource with the show command. The following shows two examples of shortcuts against an OAM account, the first one called status1 if typed on the command line would display continuously every 5 seconds the status of the specified resources. The second shortcut statistics shows a continual updating table of statistics from the routing criteria.
Showing an OAM Account Setup
5.9.1.1.3 Automatically Running a Command at Start up An account can be setup to automatically run a command line when the OAM session is initiated. This is particularly useful if an OAM account is used to just display status or statistic information allowing fast access to this information. To add a start command to an OAM account use the OAM resources Start Script. This can only be added by loading a configuration file and not directly by the OAM config command. Syntax: OAM <instance> Start Script <commands> 5.9.1.1.4 Controlling Capturing of Traps The account can be setup through the configuration file to indicate if the account should capture status traps when the session is running. This is via the OAM resources traps attribute. To turn on traps set this field to true and to turn off traps set this field to false. The capturing of traps can be controlled in real time by either using the traps on/off command or by configuring the OAM traps attribute. 5.9.1.2 Setting Up Multiple OAM Accounts To setup multiple OAM accounts setup multiple instances of IP and OAM accounts with the OAM IP attribute containing the value of the IP resource that this OAM account is associated to. The port address of the IP resource must also be unique.
SVI User Guide

LOG FILES
Each process within the SVI produces its own log file enabling the capture of logging information for debugging purposes. The log files are standard ASCII flat files that can be moved between different operating systems and edited using standard ASCII editors. 6.1 LOG FILE NAMES
All log files produced are date stamped to separate out a days logging for easier investigation. The format is shown below [filename]_dd-mm-yy The log file is always written in the same location as the process producing the logfile is located. The following table specifies the names of each process produced. Process Name SVI-SS SVI-MG SVI-SEC SVI-RTP SVI-MS Tomcat6 Product Group All products SVI-MGC-SG All redundant products SVI-SS All products All products Filename Gateway MG Security RTPRouter MS catalina Real time Shortcut tg tgw tgs tg svi-rtp tgg N/A
The primary log file to use to start all investigation or observation is the SVI-SS Gateway log file. 6.2 CONTROLLING LOG FILE MAXIMUM SIZE.
The SVI provides the ability to limit the size of a log file if required. To set the maximum size of the log file can either be by the command line option -l when starting the process or via the System Resources maxLogFile Attribute. The default setting for this attribute is 100MBytes When during a day session if a log file exceeds the maximum file setting it will be renamed using the format [filename]_dd-mm-yy.hh:mm:ss. A new standard log file will be created and used for any subsequent logging. This is not possible on the catalina.out file located in: /var/log/tomcat6/ It is required to monitor this file and remove when the file becomes too large. This can be done through the use of bash scripts.
SVI User Guide

6.3
MANAGING DISK SPACE AND SYSTEM PERFORMANCE
The operation of writing to the hard drive is one of the most processor hungry operations on any computer. The SVI is benchmarked to run without reduced functionality under full logging conditions, however unless detailed logging is required when running a production model minimum debug should be applied. Over time log files can build up and if left with detailed debug on, will fill the hard drive up. The SVI processes are protected from the hard disk being full but it is not advisable to run any system with a full hard drive. It is therefore important to periodically check that the hard disk is not filling up. If it is then the amount of active debug being outputted to the log file if not being used should be limited and any old log file should be deleted using the rm command or compressed using the tar command or archived to another system. 6.4 DISPLAYING REAL TIME LOG OUTPUT TO SCREEN
If the user requires to see in real time the log output the tg command can be used from the Linux command line to tail any log file. Syntax :tg <process name> If no process name is used the default is to display the Gateway log file. 6.5 LOG FILE OUTPUT
There are a number of distinct outputs to the log file these are Inter task Protocol Messages Task Information Messages Task Error Messages Trap reports OAM usage logging
All contents in the log files are time stamped 6.5.1 INTER TASK PROTOCOL MESSAGES The SVI operates in a standard message parsing environment where functional tasks pass messages via a central scheduler to another task.
SVI User Guide

Call Control
Protocol Protocol Stacks Protocol Stacks Stacks
Timer
Message Received Scheduler
Database
IP
Message Sent System Drivers Drivers Maintenance
The messages sent between the tasks contain different information depending on the operation which is required. The entire message set used to provide the SVI-SS is subdivided down into sub sets that are identified by discriminators. The SVI allows for the user to filter on a filtered message set being received and transmitted by a task filtered task. 6.5.1.1 Filtering on Task To add to the Debug resources task filter list the Debug resources task attribute is used to add a task to the list. This can either be achieved by the configuration file or through the OAM interface using the command >Debug 0 task <task> Multiple tasks can be added to the list. To clear the list use the following >Debug 0 task If the user wants to turn all tasks on irrespective of whats in the task list then the Debug resources tasks attribute is used. To filter all tasks on type >Debug 0 tasks on To only filter on the tasks which are defined in the task list make sure that the tasks attribute is set to off. The following table provides a list of relevant tasks that are used for general debugging. A full list of tasks can be shown by using the syntax command >syntax debug 0 task
SVI User Guide

Task
CallControl MEGACO MGCP H323 SIP ISUP IUP TUP Q931 MTPL3 SCTP SQL SCCP SCCPRTR TCAP
Description
Central call routing engine H.248 Protocol Stack MGCP Protocol Stack H323 Protocol Stack SIP Protocol Stack ISUP Protocol Stack IUP Protocol Stack TUP Protocol Stack ISDN Protocol Stack MTP-L3 Protocol Stack SCTP Protocol Stack SQL Interface SCCP Protocol Stack SCCP Router TCAP Protocol Stack
When to Use
For all call routing logging When debugging issues with a H.248 controlled media gateway When debugging issues with a MGCP controlled media gateway When debugging H323 call flow When debugging SIP call flow When debugging ISUP call flow When debugging IUP call flow When debugging TUP call flow When debugging ISDN call flow When debugging SS7 MTP L3 issues When debugging transfer of information across a SIGTRAN interface When debugging integration to an external SQL interface Used when debugging TCAP supplementary services Used when debugging SCCP routing functionality Used when debugging TCAP supplementary services
6.5.1.2 Filtering on Message Discriminator To add to the Debug resources discriminator filter list the Debug resources discriminator is used to add a discriminator to the list. This can either be achieved by the configuration file or through the OAM interface using the command >Debug 0 discriminator <discriminator> Multiple discriminators can be added to the list. To clear the list use the following >Debug 0 discriminator If the user wants to turn all discriminators on irrespective of whats in the discriminator list then the Debug resources discriminators attribute is used. To filter all discriminators on type >Debug 0 discriminators on To only filter on the discriminators which are defined in the discriminator list make sure that the discriminators attribute is set to off. The following table provides a list of relevant discriminators that are used for general debugging. A full list of discriminators can be shown by using the syntax command >syntax debug 0 discriminator Discriminator
DIS_IP
Description
TCP/UDP packets
When to Use
When debugging low level IP message passing
SVI User Guide

DIS_TIMER DIS_MNT DIS_CC_RX
DIS_CC_TX
DIS_MTP_RX DIS_MTP_TX DIS_Q931_RX DIS_Q931_TX DIS_SWITCH
Timer messages Resource control messages Incoming Call Control messages received from protocol stack Outgoing Call Control messages transmitted to protocol stack MTP L2 > L3 messages MTP L3 > L2 ISDN Q921 > Q931 ISDN Q931 > Q921 Bearer Channel Control messages Security Messages H.245 protocol Radius Messages TCAP Messages TCAP > SCCP TCAP Messages SCCP > TCAP
If timer observation is required When investigating resource control For all call routing investigations
For all call routing investigations
DIS_SEC DIS_H245 DIS_RAD DIS_TCAP_TX DIS_TCAP_RX
Used when investigating routing of SS7 messages Used when investigating routing of SS7 messages Used when investigating low layer ISDN protocol issues Used when investigating low layer ISDN protocol issues Used when investigating bearer channel setup between Call Control and Media Gateway Control Protocols Used when investigating security performance Used when investigating H323 Used when investigating interaction with Radius device Used when investigating TCAP supplementary message flow Used when investigating TCAP supplementary message flow
6.5.1.3 Displaying A Messages Contents A messages contents can also be displayed to the log file. The contents can either be displayed in a broken down English format or as a hexadecimal dump. To control the display of the messages contents in English use the following command >Debug 0 ies [on/off] To control the display of the messages contents as a hexadecimal dump use the following command > Debug 0 details [on/off]
SVI User Guide

Timestamp Direction
Tx: Sent From Task Tx: Sent To Task Rx: Received By Task
Message Discriminator Contents Message Message Length
6.5.2 TASK INFORMATION MESSAGE As well as displaying the messages transmitted to and from a task, the task will also display useful information about the reaction of the task to a message. To activate the task information filter in the appropriate task. 6.5.3 TASK ERROR MESSAGES If the SVI detects an error within a task it will automatically output an error message to the log indicating what the error may be. All internal errors will be prefixed with the word SQ_ERROR allowing for quick identification within the log file that the SVI has detected a possible issue. It is important that any administrator of the system reviews the log files to isolate any issues that may be occurring during normal operation.
Timestamp Task Procedure Line No. Comment
These errors are generally due to

Configuration Errors
SVI User Guide

Interconnect Errors Exception Capture Errors Protocol incompatibility errors.
6.5.4 TRAP REPORTS The change of status of resources can be captured to the log file. To activate this function the Debug resources traps file attribute is used. To control the display of traps to file use the following command >Debug 0 traps file [on/off]
Timestamp System Name Resource Type Resource Instance New Status
6.5.5 OAM INTERFACE USAGE LOGGING Any access to the SVI from the OAM interface and all subsequent input will be logged to the log file. This will show all OAM activity allowing for the system administrator to monitor OAM access to the system.
OAM Session Started IP Address OAM Requests
OAM Session Ended
SVI User Guide

PROTOCOL MONITORING AND TRACE CAPTURE
The SVI log file captures all internal messaging of the SVI allowing for internal investigation of protocol and routing. The SVI also provides the ability to capture all external protocols and display them for investigation using the Ethereal or Wireshark protocol analyser. This includes all SS7 and ISDN messaging which is passed internally on the SVI over SCTP which can be decoded by Wireshark. This freeware product is essential to all network engineers due to the high protocol support and functionality available to trace protocol content or synchronisation errors. The following shows a screen shot of a captured call showing the SS7, SIP and MGCP protocol flow.
7.1
INSTALLING WIRESHARK
Download the latest Wireshark analyser from the Wireshark website (http://www.wireshark.org) and install on your designated computer as directed. Install WinPCAP if prompted.
SVI User Guide

7.2
ANALYSING MESSAGE FLOWS
To capture and display the protocol message flow from the SVI is a two part exercise, firstly the information needs to be captured to a PCAP file that Wireshark can load and decode offline. 7.2.1 CAPTURING A PCAP FILE To capture a PCAP file the tcpdump program is used. For detailed information on tcpdump use the Linux man pages. To capture all IP packets that are transmitted to and from the SVI type the following from the Linux command shell. >tcpdump i any s 1500 w <PCAP file name.pcap> Due to the amount of data captured when running a PCAP trace large files can be produced if the trace is left running for a long period. Filtering can be applied to the PCAP file reducing the size of the final PCAP file. For information on filtering refer to the tcpdump man page. To stop capturing to the PCAP file press CTRL C to exit. The PCAP now either needs to be copied to the machine with Wireshark or can be open directly if using WINSCP on the same machine which is running Wireshark. 7.2.2 LOADING INTO WIRESHARK To load and display the file in Wireshark, run Wireshark and from the File > Open menu option open the PCAP file. Wireshark will now display all captured IP information. 7.2.3 FILTERING To only show the relevant protocol information required Wireshark provides a comprehensive filtering system. For a full description of Wiresharks filtering capabilities please refer to Wiresharks user documentation. 7.2.3.1 Filtering On Protocol A list of relevant protocols can be applied to the Filter window using the following syntax <Protocol A> OR <Protocol B> OR <Protocol C> OR <Protocol D> 7.2.3.2 Filtering on IP Address To filter on a given IP Address the following syntax is applied to the Filter window ip.addr = = <IP Address>
SVI User Guide

BACKING UP THE SVI
It is important to backup any changes made to the SVI to ensure that on the unlikely event of lose of any SVI files due to human or system failure they can be quickly recovered. The SVI is provided with a helper script that allows the user to fully backup and restore the SVI software and configuration files. 8.1
SVI_BACKUP
The script svi_backup is used to create full backups of the SVI system. It can then be used to fully or partially restore parts of the SVI system. The script resides in root / of the Linux OS system. Full information on the use of the svi_backup script can be found by using the man page, to access this help page enter on the command line >man svi_backup. 8.2 RESTORING THE OPERATING SYSTEM
In the unlikely event that the Operating System of the SVI needs to be fully installed the system must be reinstalled as specified in the appropriate Operating System Installation Guide. These guides can be found in the support area of the Squire Web site. If the Server is provided by Squire Technologies the Operating System installation disks are shipped with the product.
SVI User Guide

PROTECTING AND FIREWALLING THE SVI
Any computer system which is connected to a public IP network is under threat from a denial of service attack. It is important to ensure that only known IP addresses can have access to the system and that well formed passwords are maintained. The SVI is provided with an inbuilt firewall that prevents a large number of denial of service attacks only allowing known IP addresses to have access to the IP layers. This section explains how to set up a firewall on your SVI using the Linux IP tables. Please read through this section carefully before you start configuring your SVI. Please note that this is only a guide on how to set up a basic firewall on the SVI, and aims to get the reader familiar with iptables so they can configure the firewall to their needs. For more detailed information on iptables usage, please refer to the man page (you can look at this on the SVI by typing man iptables at the prompt). Squire Technologies recommend that you have an approved firewall set up on your network and this iptables firewall will only serve as an additional security measure to protect the SVI from certain types of attacks/unauthorised access. Also note that the SVI requires certain ports and IP address access to function normally and Squire Technologies will not be held responsible for any non-recommended changes you make which may result in limited access to these IP addresses and ports. 9.1 INSTALLING IPTABLES
To see if iptables is installed try the following command after logging onto the SVI:
iptables --version
If you see an output similar to the one below then you have iptables installed
iptables v1.2.7a
You can skip the next section if you have Iptables installed. 9.1.1 DOWNLOADING IPTABLES If iptables are not installed on your system you can download it from our FTP site http://ftp.squire-technologies.co.uk/. Please contact Support (support@squire-technologies.com) to obtain an FTP account. Using the graphical interface, log in to your account. Open the Releases directory, followed by the RPMs directory. Within the RPMs directory, check the file iptables-1.2.7a-2.i386.rpm.tgz, and click
Download.
SVI User Guide

Using WinSCP, transfer the file to your /misc/ directory. (Instructions for using WinSCP are detailed in section 2.6.2.)
Alternatively, you can use ftp directly through the SVI. The following table details the commands. Connecting to the FTP Server from the SVI Command Description ftp ftp.squire-technologies.co.uk This will open a ftp connection to the Squire ftp Server <user> Enter username
<password> cd Releases/RPMs get iptables-1.2.7a-2.i386.rpm.tgz
Enter Password Change current working directory to RPMs Copy the installation file for iptables If the file transfer is successful you will get a message similar to the one below:
226 File send OK.
9.1.2 INSTALLATION Once you have the install file copied onto the SVI, you will need to install it. In Linux you have to be logged on as root to be able to install applications. Installing IPtables Description Un-tar the tgz file to get the rpm file Installs the iptables package Checks to see if iptables is now installed. If you get an output similar to the one below then iptables is installed
iptables v1.2.7a
Command
tar -zxvf iptables-1.2.7a2.i386.rpm.tgz rpm iptables-1.2.7a-2.i386.rpm i iptables --version
9.2
CONFIGURING THE FIREWALL
Iptables is used to set up, maintain, and inspect the tables of IP packet filter rules in the Linux Operating System. This can be used for creating firewall rules to block out all suspect IP traffic. 9.2.1 CREATING RULES The best way to set up the firewall is to block all traffic and then open up ports to certain IP address as we need them. Please not that all commands are CASE SENSITIVE and there should be NO EXTRA SPACES when typing up these commands. STEP 1 Allow local loopback Command Description
SVI User Guide

iptables F
Flush all existing rules Allow all data from Local loopback (for inter-process communication of the SVI) iptables -A OUTPUT o lo -p all j ACCEPT Allow all data from Local loopback (for inter-process communication of the SVI) iptables -A INPUT -i eth0 -m state -state Allow all currently established ESTABLISHED,RELATED -j ACCEPT connections to continue. All iptables commands have immediate effect so be careful what you type in you could be locked out of the SVI if you are not careful.
iptables -A INPUT -i lo -p all -j ACCEPT
SVI User Guide

The next step is to allow incoming ssh connections for allowing remote access to the SVI STEP 2 Allowing ssh access. Command Description iptables -A INPUT -p tcp i eth0 --dport 22 Allows ssh connectivity from the -s <your remote IP Address>/32 -j ACCEPT given IP Address iptables -A INPUT p tcp i eth0 --dport 22 Allows ssh connectivity from -s 82.133.124.164/32 -j ACCEPT Squire Support iptables -A INPUT -p tcp i eth0 --dport 22 An example showing how to -s 192.168.0.0/24 -j ACCEPT allow IP subnets instead of individual IP addresses. Having added ssh connectivity you can proceed to add any other service in the same way (for e.g. if you need ftp access to the SVI or telnet access to the SVI). STEP 3 Add your DNS server Command Description iptables -A INPUT p udp -s <DNS server Allow all UDP packets from the IP>/32 -j ACCEPT given IP address.
STEP 4 Add your DHCP Server (If you use DHCP) Command Description iptables -A INPUT i eth1 -p tcp --sport Allow all TCP packets with 68 --dport 67 -j ACCEPT source port 68 and destination port 67. If you use other ports for DHCP requests then please change the source and destinations port in the command to the left (sport and dport) iptables -A INPUT i eth1 -p udp --sport Allow all UDP packets with 68 --dport 67 -j ACCEPT source port 68 and destination port 67. If you use other ports for DHCP requests then please change the source and destinations port in the command to the left (sport and dport)
STEP 5 Add your media Gateway IP Address

SVI User Guide

Command
iptables -A INPUT -s <Media Gateway IP Address>/32 -j ACCEPT
Description Allow all traffic from this IP address to pass through.
The table below shows how to configure the firewall to allow VoIP traffic STEP 6 Allowing VoIP Traffic Command Description iptables -A INPUT -p udp -i eth0 --dport 5060 This will allow SIP traffic (UDP -s 192.168.0.2/32 -j ACCEPT port 5060) from IP 192.168.0.2 to pass through the firewall iptables -A INPUT -p tcp -i eth0 --dport 1720 This will allow H323 traffic -s 192.168.0.2/32 -j ACCEPT (TCP port 1720) from IP 192.168.0.2 to pass through the firewall. STEP 7 Blocking all Other Traffic Command Description DROP Drops all incoming traffic not explicitly allowed.
iptables -P INPUT
iptables-save >
STEP 8 Save current rules Command Description /etc/sysconfig/iptables Saves the current rules as default which will be loaded next time your computer restarts.
9.2.2 REMOVING IPTABLES If you are having difficulty getting your traffic through because of IPtables or you have another firewall that you need you can turn off all the rules by using these commands below. Make sure you enter these commands exactly in the order they appear or you will lose remote connectivity to the box: Command Description iptables P INPUT ACCEPT Change the default Input policy to accept all packets iptables F This will flush out all the existing rules iptables-save > /etc/sysconfig/iptables Saves the current rules as default which will be loaded next time your computer restarts. 9.3 EXAMPLE CONFIGURATION
This section contains an example configuration for setting up the firewall with the following parameters:
SVI User Guide

SVI IP address DNS Server IP address Media Gateway IP address H323 End Point IP address SIP End Point IP address Remote access IP address
83.12.12.100 81.20.20.1 83.12.12.200 192.2.2.1 192.2.2.3 192.168.1.10
The config for the above setup can be found here:

#Flush all current rules iptables F #Allow all packets from local loopback - This is essentioal for SVI's internal communication iptables -A INPUT -i lo -p all -j ACCEPT iptables -A OUTPUT -o lo -p all j ACCEPT #Allow all currently established connections iptables -A INPUT -i eth0 -m state -state ESTABLISHED,RELATED -j ACCEPT
#Allow (udp) traffic from DNS Server iptables -A INPUT p udp -s 81.20.20.1/32 -j ACCEPT #Allow (all) traffic from Media Gateway iptables -A INPUT -s 83.12.12.200/32 -j ACCEPT #Allow (tcp port 1720) traffic from H323 Endpoint iptables -A INPUT -p tcp -i eth0 --dport 1720 -s 192.2.2.1/32 -j ACCEPT #Allow (udp port 5060) traffic from SIP Endpoint
SVI User Guide

iptables -A INPUT -p udp -i eth0 --dport 5060 -s 192.2.2.3/32 -j ACCEPT #Allow (tcp port 22) traffic from remote client iptables -A INPUT -p tcp -i eth0 --dport 22 -s 192.168.1.10/32 -j ACCEPT #Drop all other Incoming packets iptables -P INPUT DROP #Save current config so that it loads when the OS is restarted iptables-save > /etc/sysconfig/iptables
A default configuration file which you can edit can be found here:
#Flush all current rules iptables F #Allow all packets from local loopback - This is essential for SVI's internal communication iptables -A INPUT -i lo -p all -j ACCEPT # Allow all packets from local loopback - This is essential for SVI's internal communication iptables -A OUTPUT -o lo -p all j ACCEPT #Allow all currently established connections iptables -A INPUT -i eth0 -m state -state ESTABLISHED,RELATED -j ACCEPT
#Allow (udp) traffic from DNS Server iptables -A INPUT p udp -s <DNS IP address>/32 -j ACCEPT #Allow (all) traffic from Media Gateway iptables -A INPUT -s <MediaGateway IP address>/32 -j ACCEPT #Allow (tcp port 1720) traffic from H323 Endpoint iptables -A INPUT -p tcp -i eth0 --dport 1720 -s <H323 Endpoint>/32 -j ACCEPT #Allow (udp port 5060) traffic from SIP Endpoint iptables -A INPUT -p udp -i eth0 --dport 5060 -s <SIP Endpoint>/32 -j ACCEPT #Allow (tcp port 22) traffic from remote client iptables -A INPUT -p tcp i eth0 --dport 22 -s <remote SVI access IP address>/32 -j ACCEPT #Drop all other Incoming packets iptables -P INPUT DROP #Save current config so that it loads when the OS is restarted iptables-save > /etc/sysconfig/iptables
SVI User Guide

10 SYSTEM MONITORING USING SNMP

The SVI supports the SNMP Get message allowing for the interrogation of all attributes on the SVI. When used with an SNMP management tool this allows for monitoring and graphing of the SVIs performance. The most commonly monitored information is the call statistic information which can be provided on routing criteria and hunt group resources. This includes: Current call statistics Total call statistics Total calls over 24 hour period ASR, PDD, ACD, minutes
10.1 SETTING UP SNMP MONITORING The system will be delivered with the snmp.cfg/snmp.xml configuration/wizard file. To ensure that SNMP is running on the SVI, make sure that the snmp.cfg is included in Dbase.cfg. The snmp.cfg file should be checked to ensure that the IP resource instance is unique across the system. 10.2 SETTING UP THE ATTRIBUTE OID. The OID is a unique identifier used by SNMP to identify the resource item of a system that the SNMP protocol is uniquely interested in. Each instance of a resources attribute is given a unique OID at start-up. These OIDs will not change for a particular attribute for a given release version of the SVI. Where possible, all future releases will maintain the OID but in some situations the OID may change so always check the OIDs are correct for your installation when updating to a new release of the SVI. The format of the OID is <system oid.resource number.attribute number.instance> The system OID is configurable against the System resources OID attribute which is generally defined in snmp.cfg. 10.3 INSPECTING OID VALUES To inspect the OID value of a give resources attribute, the show SNMP OAM command is used. >show snmp <resource>
SVI User Guide

Showing the OID values of a resource
The OID displayed shows the complete OID for a given resource attribute. In the screen shoot above the system OID is 1.3.6.1.2.1.2.2 the resource is 18, the attribute 0-53 and the instance (0-1000).
SVI User Guide

10.4 SNMP TRAPS The SVI can generate an SNMP TRAP if any resource changes Status. The Debug resource sets the Trap Address and Port; Debug 0 SNMP Trap Address 192.168.2.14 Debug 0 SNMP Trap Port 162 Traps are only sent on resources which have been configured to do so. Every rsource has an Options attribute. Use this to set the SNMP-Trap option for resources you wish to trap Status changes on. 10.5 USING PAESSLER PRTG SNMP TOOL Squire recommends using the PRTG SNMP monitoring tool from Paessler to monitor the SVI. http://www.paessler.com/prtg Paessler provide a demo license d
irect from their website for a trail or licenses can be purchased directly from Paessler or through Squires. 10.5.1 SETTING UP A MONITOR From the main PRTG Traffic Grapher window; go to Edit->Add Sensor.
SVI User Guide

Select Next, then SNMP (Simple Network Management Protocol).
Choose Custom SNMP Sensor
SVI User Guide

Select an Alias and IP for the SVI. SNMP Version should be V1, port=161 and Community String=public.
SVI User Guide

Input the OID of the Resource/Attribute/Instance you wish to monitor from the show snmp <resource> described in Section 11.3. For stats such as ASR and Active calls type should be Gauge, for stats such as Setup/Ringing/Answer you can choose Delta for a changes per minute display rather than the absolute value. For stats returning time set the scale to divide 60 so as to get minutes rather than seconds. Indicator and Unit can remain empty. For stats returning time set the scale to divide 60 so as to get minutes rather than seconds. Indicator and Unit can remain empty. You must Test the OID and get back a valid response before clicking Next.
SVI User Guide

If a group already exists for the SVI Insert into it, otherwise create a new group. Recommended scanning interval is 10 seconds, this can be increased to save bandwidth if you wish. Finish.
This is an example of Setup/Ringing/Answer Delta values displayed in PRTG
SVI User Guide

10.5.2 SETTING UP ALARMS PRTG can raise alarms via email if a sensor reaches a specified threshold. To add an email notification, follow these steps:
From the main PRTG window select Extras->Options
Select Mail Server and input the details of the account you want notifications to be send from and click OK.
SVI User Guide

Right Click the sensor you wish to add the notification to and select Edit
Select Notifications & Limits
SVI User Guide

Click Add Threshold Notification and give the Notification a name. Then set the threshold at which PRTG should send an email. In the example below if the ASR reaches less than 60% for 10 minutes it will send the alert.
Now select the email tab check the Send Mail box as well as setting the email address PRTG should send alerts to.
SVI User Guide

Select the Template you wish to use. The Notification template is recommended as it contains the most information, including the current sensor value.
SVI User Guide


Svi User Guide

Încărcat de

Informații document

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Svi User Guide

Încărcat de

Drepturi de autor:

Formate disponibile

SVI Product Series SVI User Guide (2.

SVI User Guide

Squire Technologies Confidential

SVI User Guide

SYSTEM OVERVIEW .............................................................................. 10

SVI User Guide

SVI DATABASE ....................................................................................... 26

SVI User Guide

OAM INTERFACE ................................................................................... 34

SVI User Guide

LOG FILES .............................................................................................. 61

PROTOCOL MONITORING AND TRACE CAPTURE............................. 68

SVI User Guide

Filtering On Protocol ................................................................................................ 69 Filtering on IP Address ............................................................................................. 69

BACKING UP THE SVI ............................................................................ 70

PROTECTING AND FIREWALLING THE SVI ........................................ 71

SYSTEM MONITORING USING SNMP ................................................. 78

Squire Technologies Confidential

SVI User Guide

Squire Technologies Confidential

SVI User Guide

Squire Technologies Confidential

SVI User Guide

Squire Technologies Confidential

SVI User Guide

Squire Technologies Confidential

SVI User Guide

SVI User Guide

Squire Technologies Confidential

SVI User Guide

Displaying IP Address Information

To find the Default Gateway Address use the >route n

Displaying Default Gateway

Squire Technologies Confidential

SVI User Guide

EDITING FILES WITH THE LINUX EDITOR

Squire Technologies Confidential

SVI User Guide

USING GREP COMMAND TO SEARCH THROUGH FILES

Squire Technologies Confidential

SVI User Guide

Squire Technologies Confidential

SVI User Guide

Squire Technologies Confidential

SVI User Guide

Squire Technologies Confidential

SVI User Guide

2.8.2 GW SERVICE SCRIPT

Name sswitch Symbolic Link Yes

Squire Technologies Confidential

SVI User Guide

Squire Technologies Confidential

SVI User Guide

START OAM SESSION HELPER SCRIPT

Name oam Symbolic Link

2.8.7 START SINGLE OAM SESSION HELPER SCRIPT

2.8.8 TAIL A LOG FILE IN REAL TIME

Squire Technologies Confidential

SVI User Guide

2.8.9 OPEN CURRENT LOGFILE

SVI User Guide

SVI User Guide

Squire Technologies Confidential

SVI User Guide