TB Wiki - User contributions [en]

Toolpack prerequisite CentOS4 2-3

2009-05-27T18:16:16Z

10.0.0.157: /* Toolpack Basic packages */ correct typo zlib-devel instead of zlib-devel2

This page shows the Toolpack 2-3 prerequisites for CentOS 4.

== Toolpack Prerequisite ==

=== Toolpack Basic packages ===

The software listed below is required by the host machines.

yum install gcc
yum install zlib-devel

=== Toolpack System Database ===

The Toolpack system database is used by the main host and requires mySQL database server. The
system database packages are as follows:

yum install mysql-server
yum install mysql-devel
yum install openssl

Depending on the CentOS installation, the command paths for the database (i.e. mysql_install_db, mysqladmin, mysql) and system tools (chkconfig, service, etc) may not be included in the active PATH environment variable. MySql is usually installed in /usr/bin and system tools in sbin.

1. start and enable mysql

chkconfig mysqld on
service mysqld start

2. Install the database.

mysql_install_db

3. Log onto mysql, create a tbdb user. The ''[DatabaseUsername]'' and ''[DatabasePassword]'' will need to be supplied to the toolpack installer.

mysql -u root -p
CREATE USER '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL PRIVILEGES ON *.* TO '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
exit

ex.

mysql -u root -p
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL PRIVILEGES ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
exit

To verify if the user is created:

mysql -u root -p
SELECT * FROM mysql.user;
exit

4. Retrieve the socket path (this command will give the path to the socket file).

mysql_config --socket

5. Create a symbolic link to the path retrieve using the last command.

ln -s <PATH TAKEN FROM THE LAST CMD> /tmp/mysql.sock

For example:

ln -s /var/lib/mysql/mysql.sock /tmp/mysql.sock

6. Set the permission. Select option 7 (Create full privileges) for all database (*) on all hosts (%) for
the user ''[DatabaseUsername]'' (i.e. tbdb).

mysql_setpermission

7.Install odbc driver and driver manager

yum install mysql-connector-odbc

7a. For 32 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-32bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

7b. For 64 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-64bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

8. Manually configure the odbc manager. Make sure mysql driver is enable(removing the comments for the mysql driver). Set the Driver as the previous command answer.

vim /etc/odbcinst.ini

Here is an example:

# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

9. Configure mysql to support database replication (Will not interfere if your system do not use it).

vim /etc/my.cnf

Add 2 new variable in the mysql config file

Add log-bin and server-id. The value of server-id needs to be unique on each host( do not use 0 ).

Make sure it is in the [mysqld] section

log-bin
server-id=''[UniqueId]''

Example:

[root@TL-CENTOS64-02 tblab]# cat /etc/my.cnf
[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
user=mysql
log-bin
server-id=1
# Default to using old password format for compatibility with mysql 3.x
# clients (those using the mysqlclient10 compatibility package).
old_passwords=1

[mysqld_safe]
log-error=/var/log/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid
[root@TL-CENTOS64-02 tblab]#

Reboot the mysql service

service mysqld restart

=== Toolpack System Web Portal ===

The Toolpack System Web Portal is required in order to host the Toolpack Web Portal. It requires the execution of all following commands:

1. Manually install fcgi:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/src/centos/fcgi-2.4.0.tar.gz
tar -xzf fcgi-2.4.0.tar.gz
cd fcgi-2.4.0
./configure
make
make install
cd ../

2. Install pcre:

yum install pcre

3. Install lighttpd:

3a. For 32 bits sytem:

wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-1.4.20-6.el4.i386.rpm
wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/spawn-fcgi-1.4.20-6.el4.i386.rpm
wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-fastcgi-1.4.20-6.el4.i386.rpm
rpm -ivh lighttpd-1.4.20-6.el4.i386.rpm lighttpd-fastcgi-1.4.20-6.el4.i386.rpm spawn-fcgi-1.4.20-6.el4.i386.rpm

3b. For 64 bits sytem:

wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-1.4.20-6.el4.x86_64.rpm
wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/spawn-fcgi-1.4.20-6.el4.x86_64.rpm
wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-fastcgi-1.4.20-6.el4.x86_64.rpm
rpm -ivh lighttpd-1.4.20-6.el4.x86_64.rpm lighttpd-fastcgi-1.4.20-6.el4.x86_64.rpm spawn-fcgi-1.4.20-6.el4.x86_64.rpm

4. Install Ruby:

yum install ruby
yum install ruby-devel

6. Manually install rubygems:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/src/centos/rubygems-0.9.0.tgz
tar -xzf rubygems-0.9.0.tgz
cd rubygems-0.9.0
ruby setup.rb
cd ../

7. Install gem fcgi:

gem install fcgi

In case the gem file is corrupted (or the site is unavailable), follow the following guidelines to compile the gem directly:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/src/centos/ruby-fcgi-0.8.7.tar.gz
tar -xzvf ruby-fcgi-0.8.7.tar.gz
cd ruby-fcgi-0.8.7
ruby install.rb config
ruby install.rb setup
ruby install.rb install
cd ../

8. Install libxml:

yum install libxml2

Make sure that the firewall enables these following services and ports. Failure to open those ports will render socket communication between the distributed software elements unavailable.
Service: http (12358/tcp)
Port: All ports (tcp/udp) enabled for local networks

=== Toolpack Development Prerequisite ===
The Toolpack System Development prerequisite section is only required for customers that will develop their own application using the Toolpack API:

yum install gcc-c++
yum install libxml2-devel
yum install unixODBC-devel
yum install zlib-devel

== Validation Guide (Optional) ==
If you would like to verify your installation go to the [[Toolpack_Installation:Validate_Toolpack_Installation|Toolpack Validation Guide]]

== Toolpack System installation ==

Now that the prerequisite are installed, now it is time to install the [[toolpack_installer_2-3|Toolpack system]]

Toolpack prerequisite CentOS5 2-3

2009-05-27T18:15:46Z

10.0.0.157: /* Toolpack Basic packages */ correct typo zlib-devel instead of zlib-devel2

This page shows the Toolpack 2-3 prerequisites for CentOS 5.

== Toolpack Prerequisite ==

=== Toolpack Basic packages ===

The software listed below is required by the host machines.

yum install gcc
yum install zlib-devel

=== Toolpack System Database ===

The Toolpack system database is used by the main host and requires mySQL database server. The
system database packages are as follows:

yum install mysql-server
yum install mysql-devel

Depending on the CentOS installation, the command paths for the database (i.e. mysql_install_db, mysqladmin, mysql) and system tools (chkconfig, service, etc) may not be included in the active PATH environment variable. MySql is usually installed in /usr/bin and system tools in sbin.

1. start and enable mysql

chkconfig mysqld on
service mysqld start

2. Install the database.

mysql_install_db

3. Log onto mysql, create a tbdb user. The ''[DatabaseUsername]'' and ''[DatabasePassword]'' will need to be supplied to the toolpack installer.

mysql -u root -p
CREATE USER '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL PRIVILEGES ON *.* TO '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
exit

ex.

mysql -u root -p
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL PRIVILEGES ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
exit

To verify if the user is created:

mysql -u root -p
SELECT * FROM mysql.user;
exit

4. Retrieve the socket path (this command will give the path to the socket file).

mysql_config --socket

5. Create a symbolic link to the path retrieve using the last command.

ln -s <PATH TAKEN FROM THE LAST CMD> /tmp/mysql.sock

For example:

ln -s /var/lib/mysql/mysql.sock /tmp/mysql.sock

6. Set the permission. Select option 7 (Create full privileges) for all database (*) on all hosts (%) for
the user ''[DatabaseUsername]'' (i.e. tbdb).

mysql_setpermission

7.Install odbc driver and driver manager

yum install mysql-connector-odbc

7a. For 32 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-32bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

7b. For 64 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-64bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

8. Manually configure the odbc manager. Make sure mysql driver is enable(removing the comments for the mysql driver). Set the Driver as the previous command answer.

vim /etc/odbcinst.ini

Here is an example:

# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

9. Configure mysql to support database replication (Will not interfere if your system do not use it).

vim /etc/my.cnf

Add 2 new variable in the mysql config file

Add log-bin and server-id. The value of server-id needs to be unique on each host( do not use 0 ).

Make sure it is in the [mysqld] section

log-bin
server-id=''[UniqueId]''

Example:

[root@TL-CENTOS64-02 tblab]# cat /etc/my.cnf
[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
user=mysql
log-bin
server-id=1
# Default to using old password format for compatibility with mysql 3.x
# clients (those using the mysqlclient10 compatibility package).
old_passwords=1

[mysqld_safe]
log-error=/var/log/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid
[root@TL-CENTOS64-02 tblab]#

Reboot the mysql service

service mysqld restart

=== Toolpack System Web Portal ===

The Toolpack System Web Portal is required in order to host the Toolpack Web Portal. It requires the execution of all following commands:

1. Manually install fcgi:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/src/centos/fcgi-2.4.0.tar.gz
tar -xzf fcgi-2.4.0.tar.gz
cd fcgi-2.4.0
./configure
make
make install
cd ../

2. Install pcre:

yum install pcre

3. Install lighttpd:

3a. For 32 bits sytem:

wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-1.4.18-1.el5.rf.i386.rpm
wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-fastcgi-1.4.18-1.el5.rf.i386.rpm
rpm -ivh lighttpd-1.4.18-1.el5.rf.i386.rpm lighttpd-fastcgi-1.4.18-1.el5.rf.i386.rpm

3b. For 64 bits sytem:

wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-1.4.18-1.el5.rf.x86_64.rpm
wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-fastcgi-1.4.18-1.el5.rf.x86_64.rpm
rpm -ivh lighttpd-1.4.18-1.el5.rf.x86_64.rpm lighttpd-fastcgi-1.4.18-1.el5.rf.x86_64.rpm

4. Install Ruby:

yum install ruby
yum install ruby-devel

6. Manually install rubygems:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/src/centos/rubygems-0.9.0.tgz
tar -xzf rubygems-0.9.0.tgz
cd rubygems-0.9.0
ruby setup.rb
cd ../

7. Install gem fcgi:

gem install fcgi

8. Install libxml:

yum install libxml2

Make sure that the firewall enables these following services and ports. Failure to open those ports will render socket communication between the distributed software elements unavailable.
Service: http (12358/tcp)
Port: All ports (tcp/udp) enabled for local networks

=== Toolpack Stream Server ===

The Tmedia Toolpack Stream Server requires the execution of the following commands:

yum install libpcap

=== Toolpack Development Prerequisite ===
The Toolpack System Development prerequisite section is only required for customers that will develop their own application using the Toolpack API:

yum install gcc-c++
yum install libxml2-devel
yum install libpcap-devel
yum install unixODBC-devel
yum install zlib-devel

== Validation Guide (Optional) ==
If you would like to verify your installation go to the [[Toolpack_Installation:Validate_Toolpack_Installation|Toolpack Validation Guide]]

== Toolpack System installation ==

Now that the prerequisite are installed, now it is time to install the [[toolpack_installer_2-3|Toolpack system]]

Toolpack Troubleshooting:Web Portal

2009-05-27T15:26:45Z

10.0.0.157: creation

Cannot access the web portal

== Failed to connect ==
Verify that the firewall(host and possibly network) enable http/https.
:Modify the firewall rules to accept incoming http and https request.

== Verify lighttpd instance ==
For Unix host, verify that there is not 2 lighttpd instance using the same configuration file.
:If they do, you should close or kill one.

Toolpack prerequisite Debian4 2-3

2009-05-25T14:31:51Z

10.0.0.157: /* Toolpack Prerequisite */

This page shows the Toolpack 2-3 prerequisites for Debian 4.

== Toolpack Prerequisite ==

WARNING: This prerequisite was not validate yet

=== Toolpack Basic packages ===

apt-get install sysvconfig
apt-get install zlib1g-dev

=== Toolpack System Database ===

1. Install mysql.

apt-get install mysql-server
apt-get install libmysqlclient15-dev

2. Configure mysql

mysql_install_db
service mysql start
/usr/bin/mysqladmin -u root password 'mysql'
mysql -u root -p

exit

3. Log onto mysql, create a tbdb user. The ''[DatabaseUsername]'' and ''[DatabasePassword]'' will need to be supplied to the toolpack installer.

mysql -u root -p
CREATE USER '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL PRIVILEGES ON *.* TO '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
exit

ex.

mysql -u root -p
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL PRIVILEGES ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
exit

To verify if the user is created:

mysql -u root -p
SELECT * FROM mysql.user;
exit

4. Retrieve the socket path (this command will give the path to the socket file).

mysql_config --socket

5. Create a symbolic link to the path retrieve using the last command.

ln -s <PATH TAKEN FROM THE LAST CMD> /tmp/mysql.sock

For example:
ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock

Set the permission. Select option 7 (Create full privileges) for all database (*) on all hosts (%) for the targeted user.

mysql_setpermission

Install ODBC

apt-get install unixodbc
apt-get install libmyodbc

Configure ODBC to use the MySQL connector

sudo odbcinst -i -f /usr/share/libmyodbc/odbcinst.ini -d

Configure mysql to support database replication (Will not interfere if your system do not use it).
vi /etc/mysql/my.cnf

Add 2 new variable in the mysql config file

Add log-bin and server-id. The value of server-id needs to be unique on each host( do not use 0 ).

Make sure it is in the [mysqld] section

log-bin
server-id=''[UniqueId]''

Example:
# The following can be used as easy to replay backup logs or for replication.
server-id = 1
log_bin = /var/log/mysql/mysql-bin.log

Restart MySQL service
service mysqld restart

=== Toolpack System Web Portal ===

Install web server packages

apt-get install libfcgi
apt-get install libfcgi-dev
apt-get install lighttpd
apt-get install ruby irb ri rdoc build-essential
apt-get install rubygems
apt-get install ruby1.8-dev
apt-get install libopenssl-ruby1.8

Install fcgi gem

gem install fcgi

Install libxml2 ( was already installed )

apt-get install libxml2

Use the UI to prevent lighttpd to start at boot time. ( Remove the '*' besides the lighttpd service )

sysvconfig

Stop the lighttpd service

service lighttpd stop

Firewall seems to be disable by default. But if there is one, it needs to allow:

Service: http (12358/tcp)

Port: All ports (tcp/udp) enabled for local networks

=== Toolpack Stream Server ===

Install pcap0.8 for the stream server

apt-get install libpcap0.8

=== Toolpack Development Prerequisite ===

Available soon

== Toolpack System installation ==

Now that the prerequisite are installed, now it is time to install the [[toolpack_installer_2-3|Toolpack system]]

Toolpack prerequisite Debian4 2-3

2009-05-25T14:30:53Z

10.0.0.157: add database replication

This page shows the Toolpack 2-3 prerequisites for Debian 4.

== Toolpack Prerequisite ==

WARNING: This prerequisite was not validate yet

=== Toolpack Basic packages ===

apt-get install sysvconfig
apt-get install zlib1g-dev

=== Toolpack System Database ===

1. Install mysql.

apt-get install mysql-server
apt-get install libmysqlclient15-dev

2. Configure mysql

mysql_install_db
service mysql start
/usr/bin/mysqladmin -u root password 'mysql'
mysql -u root -p

exit

3. Log onto mysql, create a tbdb user. The ''[DatabaseUsername]'' and ''[DatabasePassword]'' will need to be supplied to the toolpack installer.

mysql -u root -p
CREATE USER '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL PRIVILEGES ON *.* TO '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
exit

ex.

mysql -u root -p
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL PRIVILEGES ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
exit

To verify if the user is created:

mysql -u root -p
SELECT * FROM mysql.user;
exit

4. Retrieve the socket path (this command will give the path to the socket file).

mysql_config --socket

5. Create a symbolic link to the path retrieve using the last command.

ln -s <PATH TAKEN FROM THE LAST CMD> /tmp/mysql.sock

For example:
ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock

Set the permission. Select option 7 (Create full privileges) for all database (*) on all hosts (%) for the targeted user.

mysql_setpermission

Install ODBC

apt-get install unixodbc
apt-get install libmyodbc

Configure ODBC to use the MySQL connector

sudo odbcinst -i -f /usr/share/libmyodbc/odbcinst.ini -d

Configure mysql to support database replication (Will not interfere if your system do not use it).
vi /etc/mysql/my.cnf

Add 2 new variable in the mysql config file

Add log-bin and server-id. The value of server-id needs to be unique on each host( do not use 0 ).

Make sure it is in the [mysqld] section

log-bin
server-id=''[UniqueId]''

Example:
# The following can be used as easy to replay backup logs or for replication.
server-id = 1
log_bin = /var/log/mysql/mysql-bin.log

=== Toolpack System Web Portal ===

Install web server packages

apt-get install libfcgi
apt-get install libfcgi-dev
apt-get install lighttpd
apt-get install ruby irb ri rdoc build-essential
apt-get install rubygems
apt-get install ruby1.8-dev
apt-get install libopenssl-ruby1.8

Install fcgi gem

gem install fcgi

Install libxml2 ( was already installed )

apt-get install libxml2

Use the UI to prevent lighttpd to start at boot time. ( Remove the '*' besides the lighttpd service )

sysvconfig

Stop the lighttpd service

service lighttpd stop

Firewall seems to be disable by default. But if there is one, it needs to allow:

Service: http (12358/tcp)

Port: All ports (tcp/udp) enabled for local networks

=== Toolpack Stream Server ===

Install pcap0.8 for the stream server

apt-get install libpcap0.8

=== Toolpack Development Prerequisite ===

Available soon

== Toolpack System installation ==

Now that the prerequisite are installed, now it is time to install the [[toolpack_installer_2-3|Toolpack system]]

Toolpack Installation:toolpack validate Debian4 2-3

2009-05-25T14:24:48Z

10.0.0.157: correction for debian

If any of those steps fails, refer to the [[Toolpack_prerequisite_Debian4_2-3|Debian 4 installation guide]]

== apt-get Packages ==

*Validation of the following package on the system using yum:
dpkg -l sysvconfig
dpkg -l zlib1g-dev
dpkg -l mysql-server
dpkg -l libmysqlclient15-dev
dpkg -l unixodbc
dpkg -l libmyodbc
dpkg -l libfcgi
dpkg -l libfcgi-dev
dpkg -l lighttpd
dpkg -l ruby irb ri rdoc build-essential
dpkg -l rubygems
dpkg -l ruby1.8-dev
dpkg -l libopenssl-ruby1.8
dpkg -l libxml2
dpkg -l libpcap0.8

Example:
tl-debian64-01:/home/tblab# dpkg -l sysvconfig
Desired=Unknown/Install/Remove/Purge/Hold
| Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-installed
|/ Err?=(none)/Hold/Reinst-required/X=both-problems (Status,Err: uppercase=bad)
||/ Name Version Description
+++-=============================-=============================-==========================================================================
ii sysvconfig 0.70 A text menu based utility for configuring init script links
tl-debian64-01:/home/tblab#

== Other Packages Installed ==
=== gem Installation ===
*execute the following command:
gem list --local
: Result should contain:
*** LOCAL GEMS ***

fcgi (0.8.7)
FastCGI library for Ruby.

sources (0.0.1)
This package provides download sources for remote gem installation

== ODBC Configuration ==

*Verify odbc config file:
cat /etc/odbcinst.ini
: Result should contain:
[MySQL]
Description = MySQL driver
Driver = /usr/lib/odbc/libmyodbc.so
Setup = /usr/lib/odbc/libodbcmyS.so
CPTimeout =
CPReuse =
UsageCount = 2

== MySQL Configuration ==
*Verify MySQL config file:
cat /etc/mysql/my.cnf
: Result should contain under [mysqld]:
# The following can be used as easy to replay backup logs or for replication.
server-id = 1
log_bin = /var/log/mysql/mysql-bin.log

'''Note''': server-id value may vary, but server-id needs to be a non-zero value and unique when using more than one host.

*Verify if the server is running
service mysqld status
: Result, should be something like this:
/usr/bin/mysqladmin Ver 8.41 Distrib 5.0.32, for pc-linux-gnu on x86_64
Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
This software comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to modify and redistribute it under the GPL license

Server version 5.0.32-Debian_7etch8-log
Protocol version 10
Connection Localhost via UNIX socket
UNIX socket /var/run/mysqld/mysqld.sock
Uptime: 30 min 49 sec

Threads: 1 Questions: 449 Slow queries: 0 Opens: 753 Flush tables: 1 Open tables: 64 Queries per second avg: 0.243.

Toolpack Installation:toolpack validate CentOS5 2-3

2009-05-25T14:17:09Z

10.0.0.157:

Toolpack Installation:toolpack validate Debian4 2-3

2009-05-22T21:03:32Z

10.0.0.157: New page: If any of those steps fails, refer to the Debian 4 installation guide == apt-get Packages == *Validation of the following package on the system usin...

If any of those steps fails, refer to the [[Toolpack_prerequisite_Debian4_2-3|Debian 4 installation guide]]

== apt-get Packages ==

*Validation of the following package on the system using yum:
yum list installed gcc
yum list installed zlib-devel2
yum list installed mysql-server
yum list installed mysql-devel
yum list installed mysql-connector-odbc
yum list installed pcre
yum list installed ruby
yum list installed ruby-devel
yum list installed libxml2
yum list installed libpcap

Example:
[root@TL-CENTOS64-02 log]# yum list installed gcc
Installed Packages
gcc.x86_64 4.1.2-42.el5 installed

== Other Packages Installed ==
=== gem Installation ===
*execute the following command:
gem list --local
: Result should contain:
*** LOCAL GEMS ***

fcgi (0.8.7)
FastCGI library for Ruby.

sources (0.0.1)
This package provides download sources for remote gem installation

=== lighttpd Installation ===
*execute the following command:
rpm -qa | grep lighttpd
: Result should contain:
lighttpd-1.4.18-1.el5.rf
lighttpd-fastcgi-1.4.18-1.el5.rf

=== fcgi Installation ===
*execute the following command:
find /usr/local/lib -name \*fcgi\*
: Result should contain:
/usr/local/lib/libfcgi.so.0.0.0
/usr/local/lib/libfcgi.so.0
/usr/local/lib/libfcgi.so
/usr/local/lib/libfcgi.a
/usr/local/lib/libfcgi.la

== ODBC Configuration ==
*Verify that the following file exists:
ls -al /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so

*Verify odbc config file:
cat /etc/odbcinst.ini
: Result should contain:
# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

== MySQL Configuration ==
*Verify MySQL config file:
cat /etc/my.cnf
: Result should contain:
log-bin
server-id=1
'''Note''': server-id value may vary, but server-id needs to be a non-zero value and unique when using more than one host.

*Verify if the server is running
service mysqld status
: Result:
mysqld (pid 5101) is running...

Toolpack Installation:toolpack validate common 2-3

2009-05-22T20:56:48Z

10.0.0.157: /* Database HA user only */

== MySQL Configuration ==
*Connect to mysql using tbdb:
mysql -u tbdb -p

*Verify the user list
mysql> select * from mysql.user;
+----------------+------+------------------+-------------+-------------+
| Host | User | Password | Select_priv | Insert_priv |
+----------------+------+------------------+-------------+-------------+
| localhost | root | 68d4f47c49a579c9 | Y | Y |
| tl-sol10i32-01 | root | | Y | Y |
| 127.0.0.1 | root | | Y | Y |
| localhost | | | N | N |
| tl-sol10i32-01 | | | N | N |
| % | tbdb | 68d4f47c49a579c9 | Y | Y |
+----------------+------+------------------+-------------+-------------+
6 rows in set (0.00 sec)

: Remove the 'empty' users, in the previous example the 4th and 5th user should be remove.
mysql> DELETE FROM mysql.user where user=<nowiki>''</nowiki>;

== Database HA user only ==
*Connect to the mysql on secondary host, from the primary host.
mysql -u tbdb -p -h [SecondaryHostNameOrIp]
: Example:
mysql -u tbdb -p -h tl-centos64-03

*Verify the slave state of the mysql server
show slave status \G
: Result:
If toolpack was never started, it should be empty.
Otherwise should include:

Master_Host: 10.2.0.69 <--- Primary host database server: Can be hostname or ip address.
Master_User: tbdb <--- Primary host MySQL username: Should be tbdb.
Master_Port: 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer
Connect_Retry: 60
Master_Log_File: mysqld-bin.000001 <--- Should be the same value as the master status, see below.

*Connect to the mysql on primary host
mysql -u tbdb -p

*Verify the master state of the mysql server
show master status \G
: Result:
If toolpack was never started, it should be empty.
Otherwise should include:
File: mysqld-bin.000001 <--- Should be the same value as the slave status, see above.
Position: 84685442
Binlog_Do_DB:

== Verify toolpack.ini ==
*Open the toolpack.ini file
cat /lib/tb/toolpack/setup/[TbxGwPort]/[MajorVersion]/toolpack.ini
notepad C:\TelcoBridges\toolpack\setup\[TbxGwPort]\[MajorVersion]\toolpack.ini
: Example:
cat /lib/tb/toolpack/setup/12358/2.3/toolpack.ini
notepad C:\TelcoBridges\toolpack\setup\12401\2.3\toolpack.ini

*Validate the parameters:
# Variables related to networking
TBX_GW_PORT = 12358 <--- Should be the same as the TbxGwPort
TBX_GW_ADDRESS_0 = 10.2.0.69 <--- Needs to be set if there is more than 1 network interface.
TBX_GW_ADDRESS_1 = 10.2.1.69 <--- Needs to be set if there is more than 1 network interface.
TBX_PRIMARY_HOST = 1 <--- Primary host needs to be set to TRUE or 1, secondary host needs to be set to FALSE or 0.

# Variables related to database access driver
TBDB_DRIVER = OTLODBC <--- Needs to be set to OTLODBC.
TBDB_DB_NAME = toolpack_0 <--- Can be a different value, but typically toolpack_0.
TBDB_ODBC_DRIVER = MySQL <--- Needs to be set to MySQL.

# Variables related to database server configuration
TBDB_SERVER_PRI = 10.2.0.69 <--- Primary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_PRI = tbdb <--- Primary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_PRI = tbdbpw <--- Primary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_PRI = 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

TBDB_SERVER_SEC = <--- Secondary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_SEC = <--- Secondary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_SEC = <--- Secondary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_SEC = <--- Secondary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

== Firewall ==
*Shutdown the firewall, for testing only.
service iptables stop

Toolpack Installation:toolpack validate CentOS5 2-3

2009-05-22T20:54:29Z

10.0.0.157:

Toolpack Installation:toolpack validate common 2-3

2009-05-22T20:54:26Z

10.0.0.157:

== MySQL Configuration ==
*Connect to mysql using tbdb:
mysql -u tbdb -p

*Verify the user list
mysql> select * from mysql.user;
+----------------+------+------------------+-------------+-------------+
| Host | User | Password | Select_priv | Insert_priv |
+----------------+------+------------------+-------------+-------------+
| localhost | root | 68d4f47c49a579c9 | Y | Y |
| tl-sol10i32-01 | root | | Y | Y |
| 127.0.0.1 | root | | Y | Y |
| localhost | | | N | N |
| tl-sol10i32-01 | | | N | N |
| % | tbdb | 68d4f47c49a579c9 | Y | Y |
+----------------+------+------------------+-------------+-------------+
6 rows in set (0.00 sec)

: Remove the 'empty' users, in the previous example the 4th and 5th user should be remove.
mysql> DELETE FROM mysql.user where user=<nowiki>''</nowiki>;

== Database HA user only ==
*Connect to the mysql on secondary host, from the primary host.
mysql -u tbdb -p -h [SecondaryHostNameOrIp]
Example:
mysql -u tbdb -p -h tl-centos64-03

*Verify the slave state of the mysql server
show slave status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:

Master_Host: 10.2.0.69 <--- Primary host database server: Can be hostname or ip address.
Master_User: tbdb <--- Primary host MySQL username: Should be tbdb.
Master_Port: 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer
Connect_Retry: 60
Master_Log_File: mysqld-bin.000001 <--- Should be the same value as the master status, see below.

*Connect to the mysql on primary host
mysql -u tbdb -p

*Verify the master state of the mysql server
show master status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:
File: mysqld-bin.000001 <--- Should be the same value as the slave status, see above.
Position: 84685442
Binlog_Do_DB:

== Verify toolpack.ini ==
*Open the toolpack.ini file
cat /lib/tb/toolpack/setup/[TbxGwPort]/[MajorVersion]/toolpack.ini
notepad C:\TelcoBridges\toolpack\setup\[TbxGwPort]\[MajorVersion]\toolpack.ini
: Example:
cat /lib/tb/toolpack/setup/12358/2.3/toolpack.ini
notepad C:\TelcoBridges\toolpack\setup\12401\2.3\toolpack.ini

*Validate the parameters:
# Variables related to networking
TBX_GW_PORT = 12358 <--- Should be the same as the TbxGwPort
TBX_GW_ADDRESS_0 = 10.2.0.69 <--- Needs to be set if there is more than 1 network interface.
TBX_GW_ADDRESS_1 = 10.2.1.69 <--- Needs to be set if there is more than 1 network interface.
TBX_PRIMARY_HOST = 1 <--- Primary host needs to be set to TRUE or 1, secondary host needs to be set to FALSE or 0.

# Variables related to database access driver
TBDB_DRIVER = OTLODBC <--- Needs to be set to OTLODBC.
TBDB_DB_NAME = toolpack_0 <--- Can be a different value, but typically toolpack_0.
TBDB_ODBC_DRIVER = MySQL <--- Needs to be set to MySQL.

# Variables related to database server configuration
TBDB_SERVER_PRI = 10.2.0.69 <--- Primary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_PRI = tbdb <--- Primary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_PRI = tbdbpw <--- Primary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_PRI = 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

TBDB_SERVER_SEC = <--- Secondary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_SEC = <--- Secondary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_SEC = <--- Secondary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_SEC = <--- Secondary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

== Firewall ==
*Shutdown the firewall, for testing only.
service iptables stop

Toolpack Installation:Validate Toolpack Installation

2009-05-22T20:51:33Z

10.0.0.157:

This page shows how to validate your Toolpack installation.

== Prerequisites ==

=== Release 2-3 ===

==== OS Specific ====
: [[Toolpack_Installation:toolpack_validate_CentOS4_2-3|CentOS 4 Prerequisites Validate Guide]]
: [[Toolpack_Installation:toolpack_validate_CentOS5_2-3|CentOS 5 Prerequisites Validate Guide]]
: [[Toolpack_Installation:toolpack_validate_Debian4_2-3|Debian 4 Prerequisites Validate Guide]]
: [[Toolpack_Installation:toolpack_validate_Solaris10_Intel_2-3|Solaris 10 Intel Prerequisites Validate Guide]]
: [[Toolpack_Installation:toolpack_validate_Windows_XP_2-3|Windows XP Prerequisites Validate Guide]]

==== Common to all OS ====
: [[Toolpack_Installation:toolpack_validate_common_2-3|Common Prerequisites Validate Guide]]

Toolpack Installation:toolpack validate CentOS5 2-3

2009-05-22T20:50:52Z

10.0.0.157:

Toolpack Installation:toolpack validate common 2-3

2009-05-22T20:50:37Z

10.0.0.157: New page: == MySQL Configuration == *Verify MySQL config file: cat /etc/my.cnf : Result should contain: log-bin server-id=1 '''Note''': server-id value may vary, but server-id needs to be a no...

== MySQL Configuration ==
*Verify MySQL config file:
cat /etc/my.cnf
: Result should contain:
log-bin
server-id=1
'''Note''': server-id value may vary, but server-id needs to be a non-zero value and unique when using more than one host.

*Verify if the server is running
service mysqld status
: Result:
mysqld (pid 5101) is running...

*Connect to mysql using tbdb:
mysql -u tbdb -p

*Verify the user list
mysql> select * from mysql.user;
+----------------+------+------------------+-------------+-------------+
| Host | User | Password | Select_priv | Insert_priv |
+----------------+------+------------------+-------------+-------------+
| localhost | root | 68d4f47c49a579c9 | Y | Y |
| tl-sol10i32-01 | root | | Y | Y |
| 127.0.0.1 | root | | Y | Y |
| localhost | | | N | N |
| tl-sol10i32-01 | | | N | N |
| % | tbdb | 68d4f47c49a579c9 | Y | Y |
+----------------+------+------------------+-------------+-------------+
6 rows in set (0.00 sec)

: Remove the 'empty' users, in the previous example the 4th and 5th user should be remove.
mysql> DELETE FROM mysql.user where user=<nowiki>''</nowiki>;

== Database HA user only ==
*Connect to the mysql on secondary host, from the primary host.
mysql -u tbdb -p -h [SecondaryHostNameOrIp]
Example:
mysql -u tbdb -p -h tl-centos64-03

*Verify the slave state of the mysql server
show slave status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:

Master_Host: 10.2.0.69 <--- Primary host database server: Can be hostname or ip address.
Master_User: tbdb <--- Primary host MySQL username: Should be tbdb.
Master_Port: 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer
Connect_Retry: 60
Master_Log_File: mysqld-bin.000001 <--- Should be the same value as the master status, see below.

*Connect to the mysql on primary host
mysql -u tbdb -p

*Verify the master state of the mysql server
show master status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:
File: mysqld-bin.000001 <--- Should be the same value as the slave status, see above.
Position: 84685442
Binlog_Do_DB:

== Verify toolpack.ini ==
*Open the toolpack.ini file
cat /lib/tb/toolpack/setup/[TbxGwPort]/[MajorVersion]/toolpack.ini
: Example:
cat /lib/tb/toolpack/setup/12358/2.3/toolpack.ini

*Validate the parameters:
# Variables related to networking
TBX_GW_PORT = 12358 <--- Should be the same as the TbxGwPort
TBX_GW_ADDRESS_0 = 10.2.0.69 <--- Needs to be set if there is more than 1 network interface.
TBX_GW_ADDRESS_1 = 10.2.1.69 <--- Needs to be set if there is more than 1 network interface.
TBX_PRIMARY_HOST = 1 <--- Primary host needs to be set to TRUE or 1, secondary host needs to be set to FALSE or 0.

# Variables related to database access driver
TBDB_DRIVER = OTLODBC <--- Needs to be set to OTLODBC.
TBDB_DB_NAME = toolpack_0 <--- Can be a different value, but typically toolpack_0.
TBDB_ODBC_DRIVER = MySQL <--- Needs to be set to MySQL.

# Variables related to database server configuration
TBDB_SERVER_PRI = 10.2.0.69 <--- Primary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_PRI = tbdb <--- Primary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_PRI = tbdbpw <--- Primary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_PRI = 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

TBDB_SERVER_SEC = <--- Secondary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_SEC = <--- Secondary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_SEC = <--- Secondary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_SEC = <--- Secondary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

== Firewall ==
*Shutdown the firewall, for testing only.
service iptables stop

Toolpack Installation:toolpack validate CentOS5 2-3

2009-05-22T20:36:52Z

10.0.0.157: /* MySQL Configuration */

If any of those steps fails, refer to the [[Toolpack_prerequisite_CentOS5_2-3|CentOS5 installation guide]]

== Yum Packages ==

*Validation of the following package on the system using yum:
yum list installed gcc
yum list installed zlib-devel2
yum list installed mysql-server
yum list installed mysql-devel
yum list installed mysql-connector-odbc
yum list installed pcre
yum list installed ruby
yum list installed ruby-devel
yum list installed libxml2
yum list installed libpcap

Example:
[root@TL-CENTOS64-02 log]# yum list installed gcc
Installed Packages
gcc.x86_64 4.1.2-42.el5 installed

== Other Packages Installed ==
=== gem Installation ===
*execute the following command:
gem list --local
: Result should contain:
*** LOCAL GEMS ***

fcgi (0.8.7)
FastCGI library for Ruby.

sources (0.0.1)
This package provides download sources for remote gem installation

=== lighttpd Installation ===
*execute the following command:
rpm -qa | grep lighttpd
: Result should contain:
lighttpd-1.4.18-1.el5.rf
lighttpd-fastcgi-1.4.18-1.el5.rf

=== fcgi Installation ===
*execute the following command:
find /usr/local/lib -name \*fcgi\*
: Result should contain:
/usr/local/lib/libfcgi.so.0.0.0
/usr/local/lib/libfcgi.so.0
/usr/local/lib/libfcgi.so
/usr/local/lib/libfcgi.a
/usr/local/lib/libfcgi.la

== ODBC Configuration ==
*Verify that the following file exists:
ls -al /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so

*Verify odbc config file:
cat /etc/odbcinst.ini
: Result should contain:
# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

== MySQL Configuration ==
*Verify MySQL config file:
cat /etc/my.cnf
: Result should contain:
log-bin
server-id=1
'''Note''': server-id value may vary, but server-id needs to be a non-zero value and unique when using more than one host.

*Verify if the server is running
service mysqld status
: Result:
mysqld (pid 5101) is running...

*Connect to mysql using tbdb:
mysql -u tbdb -p

*Verify the user list
mysql> select * from mysql.user;
+----------------+------+------------------+-------------+-------------+
| Host | User | Password | Select_priv | Insert_priv |
+----------------+------+------------------+-------------+-------------+
| localhost | root | 68d4f47c49a579c9 | Y | Y |
| tl-sol10i32-01 | root | | Y | Y |
| 127.0.0.1 | root | | Y | Y |
| localhost | | | N | N |
| tl-sol10i32-01 | | | N | N |
| % | tbdb | 68d4f47c49a579c9 | Y | Y |
+----------------+------+------------------+-------------+-------------+
6 rows in set (0.00 sec)

: Remove the 'empty' users, in the previous example the 4th and 5th user should be remove.
mysql> DELETE FROM mysql.user where user=<nowiki>''</nowiki>;

== Database HA user only ==
*Connect to the mysql on secondary host, from the primary host.
mysql -u tbdb -p -h [SecondaryHostNameOrIp]
Example:
mysql -u tbdb -p -h tl-centos64-03

*Verify the slave state of the mysql server
show slave status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:

Master_Host: 10.2.0.69 <--- Primary host database server: Can be hostname or ip address.
Master_User: tbdb <--- Primary host MySQL username: Should be tbdb.
Master_Port: 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer
Connect_Retry: 60
Master_Log_File: mysqld-bin.000001 <--- Should be the same value as the master status, see below.

*Connect to the mysql on primary host
mysql -u tbdb -p

*Verify the master state of the mysql server
show master status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:
File: mysqld-bin.000001 <--- Should be the same value as the slave status, see above.
Position: 84685442
Binlog_Do_DB:

== Verify toolpack.ini ==
*Open the toolpack.ini file
cat /lib/tb/toolpack/setup/[TbxGwPort]/[MajorVersion]/toolpack.ini
: Example:
cat /lib/tb/toolpack/setup/12358/2.3/toolpack.ini

*Validate the parameters:
# Variables related to networking
TBX_GW_PORT = 12358 <--- Should be the same as the TbxGwPort
TBX_GW_ADDRESS_0 = 10.2.0.69 <--- Needs to be set if there is more than 1 network interface.
TBX_GW_ADDRESS_1 = 10.2.1.69 <--- Needs to be set if there is more than 1 network interface.
TBX_PRIMARY_HOST = 1 <--- Primary host needs to be set to TRUE or 1, secondary host needs to be set to FALSE or 0.

# Variables related to database access driver
TBDB_DRIVER = OTLODBC <--- Needs to be set to OTLODBC.
TBDB_DB_NAME = toolpack_0 <--- Can be a different value, but typically toolpack_0.
TBDB_ODBC_DRIVER = MySQL <--- Needs to be set to MySQL.

# Variables related to database server configuration
TBDB_SERVER_PRI = 10.2.0.69 <--- Primary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_PRI = tbdb <--- Primary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_PRI = tbdbpw <--- Primary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_PRI = 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

TBDB_SERVER_SEC = <--- Secondary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_SEC = <--- Secondary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_SEC = <--- Secondary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_SEC = <--- Secondary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

== Firewall ==
*Shutdown the firewall, for testing only.
service iptables stop

Toolpack Installation:toolpack validate CentOS5 2-3

2009-05-22T20:19:42Z

10.0.0.157: add firewall

If any of those steps fails, refer to the [[Toolpack_prerequisite_CentOS5_2-3|CentOS5 installation guide]]

== Yum Packages ==

*Validation of the following package on the system using yum:
yum list installed gcc
yum list installed zlib-devel2
yum list installed mysql-server
yum list installed mysql-devel
yum list installed mysql-connector-odbc
yum list installed pcre
yum list installed ruby
yum list installed ruby-devel
yum list installed libxml2
yum list installed libpcap

Example:
[root@TL-CENTOS64-02 log]# yum list installed gcc
Installed Packages
gcc.x86_64 4.1.2-42.el5 installed

== Other Packages Installed ==
=== gem Installation ===
*execute the following command:
gem list --local
: Result should contain:
*** LOCAL GEMS ***

fcgi (0.8.7)
FastCGI library for Ruby.

sources (0.0.1)
This package provides download sources for remote gem installation

=== lighttpd Installation ===
*execute the following command:
rpm -qa | grep lighttpd
: Result should contain:
lighttpd-1.4.18-1.el5.rf
lighttpd-fastcgi-1.4.18-1.el5.rf

=== fcgi Installation ===
*execute the following command:
find /usr/local/lib -name \*fcgi\*
: Result should contain:
/usr/local/lib/libfcgi.so.0.0.0
/usr/local/lib/libfcgi.so.0
/usr/local/lib/libfcgi.so
/usr/local/lib/libfcgi.a
/usr/local/lib/libfcgi.la

== ODBC Configuration ==
*Verify that the following file exists:
ls -al /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so

*Verify odbc config file:
cat /etc/odbcinst.ini
: Result should contain:
# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

== MySQL Configuration ==
*Verify MySQL config file:
cat /etc/my.cnf
: Result should contain:
log-bin
server-id=1
'''Note''': server-id value may vary, but server-id needs to be a non-zero value and unique when using more than one host.

*Verify if the server is running
service mysqld status
: Result:
mysqld (pid 5101) is running...

*Connect to mysql using tbdb:
mysql -u tbdb -p

*Verify the user list
mysql> select * from mysql.user;
+----------------+------+------------------+-------------+-------------+
| Host | User | Password | Select_priv | Insert_priv |
+----------------+------+------------------+-------------+-------------+
| localhost | root | 68d4f47c49a579c9 | Y | Y |
| tl-sol10i32-01 | root | | Y | Y |
| 127.0.0.1 | root | | Y | Y |
| localhost | | | N | N |
| tl-sol10i32-01 | | | N | N |
| % | tbdb | 68d4f47c49a579c9 | Y | Y |
+----------------+------+------------------+-------------+-------------+
6 rows in set (0.00 sec)
Remove the 'empty' users, in the previous example the 4th and 5th user should be remove.
DELETE FROM mysql.user where user=<nowiki>''</nowiki>;

== Database HA user only ==
*Connect to the mysql on secondary host, from the primary host.
mysql -u tbdb -p -h [SecondaryHostNameOrIp]
Example:
mysql -u tbdb -p -h tl-centos64-03

*Verify the slave state of the mysql server
show slave status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:

Master_Host: 10.2.0.69 <--- Primary host database server: Can be hostname or ip address.
Master_User: tbdb <--- Primary host MySQL username: Should be tbdb.
Master_Port: 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer
Connect_Retry: 60
Master_Log_File: mysqld-bin.000001 <--- Should be the same value as the master status, see below.

*Connect to the mysql on primary host
mysql -u tbdb -p

*Verify the master state of the mysql server
show master status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:
File: mysqld-bin.000001 <--- Should be the same value as the slave status, see above.
Position: 84685442
Binlog_Do_DB:

== Verify toolpack.ini ==
*Open the toolpack.ini file
cat /lib/tb/toolpack/setup/[TbxGwPort]/[MajorVersion]/toolpack.ini
: Example:
cat /lib/tb/toolpack/setup/12358/2.3/toolpack.ini

*Validate the parameters:
# Variables related to networking
TBX_GW_PORT = 12358 <--- Should be the same as the TbxGwPort
TBX_GW_ADDRESS_0 = 10.2.0.69 <--- Needs to be set if there is more than 1 network interface.
TBX_GW_ADDRESS_1 = 10.2.1.69 <--- Needs to be set if there is more than 1 network interface.
TBX_PRIMARY_HOST = 1 <--- Primary host needs to be set to TRUE or 1, secondary host needs to be set to FALSE or 0.

# Variables related to database access driver
TBDB_DRIVER = OTLODBC <--- Needs to be set to OTLODBC.
TBDB_DB_NAME = toolpack_0 <--- Can be a different value, but typically toolpack_0.
TBDB_ODBC_DRIVER = MySQL <--- Needs to be set to MySQL.

# Variables related to database server configuration
TBDB_SERVER_PRI = 10.2.0.69 <--- Primary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_PRI = tbdb <--- Primary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_PRI = tbdbpw <--- Primary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_PRI = 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

TBDB_SERVER_SEC = <--- Secondary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_SEC = <--- Secondary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_SEC = <--- Secondary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_SEC = <--- Secondary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

== Firewall ==
*Shutdown the firewall, for testing only.
service iptables stop

Toolpack Installation:toolpack validate CentOS5 2-3

2009-05-22T20:16:18Z

10.0.0.157:

If any of those steps fails, refer to the [[Toolpack_prerequisite_CentOS5_2-3|CentOS5 installation guide]]

== Yum Packages ==

*Validation of the following package on the system using yum:
yum list installed gcc
yum list installed zlib-devel2
yum list installed mysql-server
yum list installed mysql-devel
yum list installed mysql-connector-odbc
yum list installed pcre
yum list installed ruby
yum list installed ruby-devel
yum list installed libxml2
yum list installed libpcap

Example:
[root@TL-CENTOS64-02 log]# yum list installed gcc
Installed Packages
gcc.x86_64 4.1.2-42.el5 installed

== Other Packages Installed ==
=== gem Installation ===
*execute the following command:
gem list --local
: Result should contain:
*** LOCAL GEMS ***

fcgi (0.8.7)
FastCGI library for Ruby.

sources (0.0.1)
This package provides download sources for remote gem installation

=== lighttpd Installation ===
*execute the following command:
rpm -qa | grep lighttpd
: Result should contain:
lighttpd-1.4.18-1.el5.rf
lighttpd-fastcgi-1.4.18-1.el5.rf

=== fcgi Installation ===
*execute the following command:
find /usr/local/lib -name \*fcgi\*
: Result should contain:
/usr/local/lib/libfcgi.so.0.0.0
/usr/local/lib/libfcgi.so.0
/usr/local/lib/libfcgi.so
/usr/local/lib/libfcgi.a
/usr/local/lib/libfcgi.la

== ODBC Configuration ==
*Verify that the following file exists:
ls -al /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so

*Verify odbc config file:
cat /etc/odbcinst.ini
: Result should contain:
# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

== MySQL Configuration ==
*Verify MySQL config file:
cat /etc/my.cnf
: Result should contain:
log-bin
server-id=1
'''Note''': server-id value may vary, but server-id needs to be a non-zero value and unique when using more than one host.

*Verify if the server is running
service mysqld status
: Result:
mysqld (pid 5101) is running...

*Connect to mysql using tbdb:
mysql -u tbdb -p

*Verify the user list
mysql> select * from mysql.user;
+----------------+------+------------------+-------------+-------------+
| Host | User | Password | Select_priv | Insert_priv |
+----------------+------+------------------+-------------+-------------+
| localhost | root | 68d4f47c49a579c9 | Y | Y |
| tl-sol10i32-01 | root | | Y | Y |
| 127.0.0.1 | root | | Y | Y |
| localhost | | | N | N |
| tl-sol10i32-01 | | | N | N |
| % | tbdb | 68d4f47c49a579c9 | Y | Y |
+----------------+------+------------------+-------------+-------------+
6 rows in set (0.00 sec)
Remove the 'empty' users, in the previous example the 4th and 5th user should be remove.
DELETE FROM mysql.user where user=<nowiki>''</nowiki>;

== Database HA user only ==
*Connect to the mysql on secondary host, from the primary host.
mysql -u tbdb -p -h [SecondaryHostNameOrIp]
Example:
mysql -u tbdb -p -h tl-centos64-03

*Verify the slave state of the mysql server
show slave status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:

Master_Host: 10.2.0.69 <--- Primary host database server: Can be hostname or ip address.
Master_User: tbdb <--- Primary host MySQL username: Should be tbdb.
Master_Port: 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer
Connect_Retry: 60
Master_Log_File: mysqld-bin.000001 <--- Should be the same value as the master status, see below.

*Connect to the mysql on primary host
mysql -u tbdb -p

*Verify the master state of the mysql server
show master status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:
File: mysqld-bin.000001 <--- Should be the same value as the slave status, see above.
Position: 84685442
Binlog_Do_DB:

== Verify toolpack.ini ==
*Open the toolpack.ini file
cat /lib/tb/toolpack/setup/[TbxGwPort]/[MajorVersion]/toolpack.ini
: Example:
cat /lib/tb/toolpack/setup/12358/2.3/toolpack.ini

*Validate the parameters:
# Variables related to networking
TBX_GW_PORT = 12358 <--- Should be the same as the TbxGwPort
TBX_GW_ADDRESS_0 = 10.2.0.69 <--- Needs to be set if there is more than 1 network interface.
TBX_GW_ADDRESS_1 = 10.2.1.69 <--- Needs to be set if there is more than 1 network interface.
TBX_PRIMARY_HOST = 1 <--- Primary host needs to be set to TRUE or 1, secondary host needs to be set to FALSE or 0.

# Variables related to database access driver
TBDB_DRIVER = OTLODBC <--- Needs to be set to OTLODBC.
TBDB_DB_NAME = toolpack_0 <--- Can be a different value, but typically toolpack_0.
TBDB_ODBC_DRIVER = MySQL <--- Needs to be set to MySQL.

# Variables related to database server configuration
TBDB_SERVER_PRI = 10.2.0.69 <--- Primary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_PRI = tbdb <--- Primary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_PRI = tbdbpw <--- Primary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_PRI = 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

TBDB_SERVER_SEC = <--- Secondary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_SEC = <--- Secondary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_SEC = <--- Secondary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_SEC = <--- Secondary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

Toolpack Installation:toolpack validate CentOS5 2-3

2009-05-22T20:15:27Z

10.0.0.157: add toolpack.ini and ha validation

If any of those steps fails, refer to the [[Toolpack_prerequisite_CentOS5_2-3|CentOS5 installation guide]]

== Yum Packages ==

*Validation of the following package on the system using yum:
yum list installed gcc
yum list installed zlib-devel2
yum list installed mysql-server
yum list installed mysql-devel
yum list installed mysql-connector-odbc
yum list installed pcre
yum list installed ruby
yum list installed ruby-devel
yum list installed libxml2
yum list installed libpcap

Example:
[root@TL-CENTOS64-02 log]# yum list installed gcc
Installed Packages
gcc.x86_64 4.1.2-42.el5 installed

== Other Packages Installed ==
=== gem Installation ===
*execute the following command:
gem list --local
: Result should contain:
*** LOCAL GEMS ***

fcgi (0.8.7)
FastCGI library for Ruby.

sources (0.0.1)
This package provides download sources for remote gem installation

=== lighttpd Installation ===
*execute the following command:
rpm -qa | grep lighttpd
: Result should contain:
lighttpd-1.4.18-1.el5.rf
lighttpd-fastcgi-1.4.18-1.el5.rf

=== fcgi Installation ===
*execute the following command:
find /usr/local/lib -name \*fcgi\*
: Result should contain:
/usr/local/lib/libfcgi.so.0.0.0
/usr/local/lib/libfcgi.so.0
/usr/local/lib/libfcgi.so
/usr/local/lib/libfcgi.a
/usr/local/lib/libfcgi.la

== ODBC Configuration ==
*Verify that the following file exists:
ls -al /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so

*Verify odbc config file:
cat /etc/odbcinst.ini
: Result should contain:
# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

== MySQL Configuration ==
*Verify MySQL config file:
cat /etc/my.cnf
: Result should contain:
log-bin
server-id=1
'''Note''': server-id value may vary, but server-id needs to be a non-zero value and unique when using more than one host.

*Verify if the server is running
service mysqld status
: Result:
mysqld (pid 5101) is running...

*Connect to mysql using tbdb:
mysql -u tbdb -p

*Verify the user list
mysql> select * from mysql.user;
+----------------+------+------------------+-------------+-------------+
| Host | User | Password | Select_priv | Insert_priv |
+----------------+------+------------------+-------------+-------------+
| localhost | root | 68d4f47c49a579c9 | Y | Y |
| tl-sol10i32-01 | root | | Y | Y |
| 127.0.0.1 | root | | Y | Y |
| localhost | | | N | N |
| tl-sol10i32-01 | | | N | N |
| % | tbdb | 68d4f47c49a579c9 | Y | Y |
+----------------+------+------------------+-------------+-------------+
6 rows in set (0.00 sec)
Remove the 'empty' users, in the previous example the 4th and 5th user should be remove.
DELETE FROM mysql.user where user=<nowiki>''</nowiki>;

== Database HA user only ==
*Connect to the mysql on secondary host, from the primary host.
mysql -u tbdb -p -h [SecondaryHostNameOrIp]
Example:
mysql -u tbdb -p -h tl-centos64-03

*Verify the slave state of the mysql server
show slave status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:

Master_Host: 10.2.0.69 <--- Primary host database server: Can be hostname or ip address.
Master_User: tbdb <--- Primary host MySQL username: Should be tbdb.
Master_Port: 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer
Connect_Retry: 60
Master_Log_File: mysqld-bin.000001 <--- Should be the same value as the master status, see below.

*Connect to the mysql on primary host
mysql -u tbdb -p
Example:
mysql -u tbdb -p
*Verify the master state of the mysql server
show master status \G
Result:
If toolpack was never started, it should be empty.
Otherwise should include:
File: mysqld-bin.000001 <--- Should be the same value as the slave status, see above.
Position: 84685442
Binlog_Do_DB:

== Verify toolpack.ini ==
*Open the toolpack.ini file
cat /lib/tb/toolpack/setup/[TbxGwPort]/[MajorVersion]/toolpack.ini
: Example:
cat /lib/tb/toolpack/setup/12358/2.3/toolpack.ini

*Validate the parameters:
# Variables related to networking
TBX_GW_PORT = 12358 <--- Should be the same as the TbxGwPort
TBX_GW_ADDRESS_0 = 10.2.0.69 <--- Needs to be set if there is more than 1 network interface.
TBX_GW_ADDRESS_1 = 10.2.1.69 <--- Needs to be set if there is more than 1 network interface.
TBX_PRIMARY_HOST = 1 <--- Primary host needs to be set to TRUE or 1, secondary host needs to be set to FALSE or 0.

# Variables related to database access driver
TBDB_DRIVER = OTLODBC <--- Needs to be set to OTLODBC.
TBDB_DB_NAME = toolpack_0 <--- Can be a different value, but typically toolpack_0.
TBDB_ODBC_DRIVER = MySQL <--- Needs to be set to MySQL.

# Variables related to database server configuration
TBDB_SERVER_PRI = 10.2.0.69 <--- Primary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_PRI = tbdb <--- Primary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_PRI = tbdbpw <--- Primary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_PRI = 3306 <--- Primary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

TBDB_SERVER_SEC = <--- Secondary host database server: Can be hostname or ip address (localhost, 127.0.0.1 not accepted), Ignore on the secondary host.
TBDB_UID_SEC = <--- Secondary host MySQL username: Should be tbdb, Ignore on the secondary host.
TBDB_PWD_SEC = <--- Secondary host MySQL password: Needs to be the right password (default: tbdbpw), Ignore on the secondary host.
TBDB_PORT_SEC = <--- Secondary host MySQL port: Should be 3306 unless specified otherwise in the installer, Ignore on the secondary host.

Main Page

2009-05-21T12:55:11Z

10.0.0.157: add troubleshooting section

'''Welcome to Telcowiki, the TelcoBridges wiki.'''

This site serves as the primary reference for the TelcoBridges family of products, including Tmedia, Tdev, and Tmonitor, and the software provided with them. It is currently a work in progress and navigation and nomenclature are likely to change continuously as we grow it. Authorized users (including TelcoBridges employees, partners and customers) are invited to [[Editing TelcoWiki|contribute]] and improve the content here.

{| class="wikitable" border="1" cellpadding="3"

!width="225" style="background:#efefef;" |SOFTWARE
!width="225" style="background:#efefef;" |HARDWARE
!width="225" style="background:#efefef;" |USE CASES
|-
| valign="top" | '''Toolpack'''

*[[Toolpack|About Toolpack]]
*[[Supported_os_toolpack|Toolpack Supported OS]]
*[[Installing_Toolpack|Installing Toolpack]]
*[[Upgrading_Toolpack|Upgrading Toolpack]]
*[[Using_toolpack|Using Toolpack]]
*[[Troubleshooting_toolpack|Troubleshooting Toolpack]]
*User Guide

'''Version history'''
*[[version 2.3]]

'''Specific features'''
*[[H.248]]
*[[HA Manager]]
*[[RADIUS]]
*[[Scriptable Routing Engine]]
*[[SIP]]
*[[TB StreamServer]]
*[[Voice codecs]]

| valign="top" | '''Tmedia'''
*[[TMG3200]]
*[[TMG800]]

'''Tdev'''
*[[TMP6400]]
*[[TMP800]]
*[[TMS1600]]

'''Tmonitor'''
*[[TM1000]]
**[[Isolation patch panel]]
**[[Monitoring patch panel]]

'''Other'''
*TB640

| valign="top" | '''Tmedia and Tdev'''
*Conferencing
*Fax over IP
*Ringback tones
*SIP trunking
*Unified Communications
*Voicemail

'''Tmonitor'''
*Lawful intercept
*Location-based services (LBS)
*Network Monitoring

|}

== Disclaimer ==
The information on this web site is subject to change without notice. No part of this web site may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of TelcoBridges. TelcoBridges may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. The furnishing of access to this web site does not give you license to these patents, trademarks, copyrights, or other intellectual property except as expressly provided in any written license agreement from TelcoBridges.

The information provided in this web site is intended as a guide only. For the latest detailed engineering specifications, please contact your TelcoBridges Application Engineer. TelcoBridges is committed to continually improving product designs, as a result, product specifications may be subject to change without notification.

== Copyright ==

This web site is ©2003-2009 TelcoBridges Inc. All rights reserved.

Toolpack installation 2-3

2009-05-20T20:53:45Z

10.0.0.157: /* Toolpack installation */

This section contains the steps required to install the Toolpack system from new host. You will be required to install the prerequisite before installing Toolpack itself.

If you want to migrate a Toolpack 2-2 system, please follow this [[Toolpack_major_upgrades_2-3|Major Upgrade Procedure]]

=== Prerequisites ===
The prerequisite will be different according to your operating system. The prerequisite guide needs to be executed once per system. If your OS is not included in the list below, please contact TelcoBridges support.

: [[toolpack_prerequisite_CentOS5_2-3|CentOS 5 prerequisite guide]]
: [[toolpack_prerequisite_Debian4_2-3|Debian 4 prerequisite guide]]
: [[toolpack_prerequisite_Solaris10_Intel_2-3|Solaris 10 Intel prerequisite guide]]
: [[toolpack_prerequisite_Windows_XP_2-3|Windows XP prerequisite guide]]

=== Toolpack installation ===

: [[toolpack_installer_2-3|Toolpack Installer]]

----
Back to main [[Installing_Toolpack|Toolpack installation]] page

Toolpack prerequisite CentOS5 2-3

2009-05-20T20:11:07Z

10.0.0.157: /* Toolpack System Database */

This page shows the Toolpack 2-3 prerequisites for CentOS 5.

== Toolpack Prerequisite ==

=== Toolpack Basic packages ===

The software listed below is required by the host machines.

yum install gcc
yum install zlib-devel2

=== Toolpack System Database ===

The Toolpack system database is used by the main host and requires mySQL database server. The
system database packages are as follows:

yum install mysql-server
yum install mysql-devel

Depending on the CentOS installation, the command paths for the database (i.e. mysql_install_db, mysqladmin, mysql) and system tools (chkconfig, service, etc) may not be included in the active PATH environment variable. MySql is usually installed in /usr/bin and system tools in sbin.

1. start and enable mysql

chkconfig mysqld on
service mysqld start

2. Install the database.

mysql_install_db

3. Log onto mysql, create a tbdb user. The ''[DatabaseUsername]'' and ''[DatabasePassword]'' will need to be supplied to the toolpack installer.

mysql -u root -p
CREATE USER '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL PRIVILEGES ON *.* TO '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
exit

ex.

mysql -u root -p
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL PRIVILEGES ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
exit

To verify if the user is created:

mysql -u root -p
SELECT * FROM mysql.user;
exit

4. Retrieve the socket path (this command will give the path to the socket file).

mysql_config --socket

5. Create a symbolic link to the path retrieve using the last command.

ln -s <PATH TAKEN FROM THE LAST CMD> /tmp/mysql.sock

For example:

ln -s /var/lib/mysql/mysql.sock /tmp/mysql.sock

6. Set the permission. Select option 7 (Create full privileges) for all database (*) on all hosts (%) for
the user ''[DatabaseUsername]'' (i.e. tbdb).

mysql_setpermission

7.Install odbc driver and driver manager

yum install mysql-connector-odbc

7a. For 32 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-32bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

7b. For 64 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-64bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

8. Manually configure the odbc manager. Make sure mysql driver is enable(removing the comments for the mysql driver). Set the Driver as the previous command answer.

vim /etc/odbcinst.ini

Here is an example:

# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

9. Configure mysql to support database replication (Will not interfere if your system do not use it).

vim /etc/my.cnf

Add 2 new variable in the mysql config file

Add log-bin and server-id. The value of server-id needs to be unique on each host( do not use 0 ).

Make sure it is in the [mysqld] section

log-bin
server-id=''[UniqueId]''

Example:

[root@TL-CENTOS64-02 tblab]# cat /etc/my.cnf
[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
user=mysql
log-bin
server-id=1
# Default to using old password format for compatibility with mysql 3.x
# clients (those using the mysqlclient10 compatibility package).
old_passwords=1

[mysqld_safe]
log-error=/var/log/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid
[root@TL-CENTOS64-02 tblab]#

Reboot the mysql service

service mysqld restart

=== Toolpack System Web Portal ===

The Toolpack System Web Portal is required in order to host the Toolpack Web Portal. It requires the execution of all following commands:

1. Manually install fcgi:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/src/centos/fcgi-2.4.0.tar.gz
tar -xzf fcgi-2.4.0.tar.gz
cd fcgi-2.4.0
./configure
make
make install
cd ../

2. Install pcre:

yum install pcre

3. Install lighttpd:

3a. For 32 bits sytem:

wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-1.4.18-1.el5.rf.i386.rpm
wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-fastcgi-1.4.18-1.el5.rf.i386.rpm
rpm -ivh lighttpd-1.4.18-1.el5.rf.i386.rpm lighttpd-fastcgi-1.4.18-1.el5.rf.i386.rpm

3b. For 64 bits sytem:

wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-1.4.18-1.el5.rf.x86_64.rpm
wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-fastcgi-1.4.18-1.el5.rf.x86_64.rpm
rpm -ivh lighttpd-1.4.18-1.el5.rf.x86_64.rpm lighttpd-fastcgi-1.4.18-1.el5.rf.x86_64.rpm

4. Install Ruby:

yum install ruby
yum install ruby-devel

6. Manually install rubygems:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/src/centos/rubygems-0.9.0.tgz
tar -xzf rubygems-0.9.0.tgz
cd rubygems-0.9.0
ruby setup.rb
cd ../

7. Install gem fcgi:

gem install fcgi

8. Install libxml:

yum install libxml2

Make sure that the firewall enables these following services and ports. Failure to open those ports will render socket communication between the distributed software elements unavailable.
Service: http (12358/tcp)
Port: All ports (tcp/udp) enabled for local networks

=== Toolpack Stream Server ===

The Tmedia Toolpack Stream Server requires the execution of the following commands:

yum install libpcap

=== Toolpack Development Prerequisite ===
The Toolpack System Development prerequisite section is only required for customers that will develop their own application using the Toolpack API:

yum install gcc-c++
yum install libxml2-devel
yum install libpcap-devel
yum install unixODBC-devel
yum install zlib-devel

== Toolpack System installation ==

Now that the prerequisite are installed, now it is time to install the [[toolpack_installer_2-3|Toolpack system]]

Scriptable Routing Engine

2009-05-20T15:45:58Z

10.0.0.157:

Toolpack v2.3 introduces a scriptable routing engine that complements the existing approach to building call [[routes]]. This new approach is based on the [http://www.ruby-lang.org/en/ Ruby] programming language, which offers a high-level, natural language-like approach to programming known as [[scripting]]. With Ruby, no code compilation is required to use routing [[scripts]]; in fact, you write scripts within your web browser. A high-level overview of how to write scripts is available upon request by contacting the TelcoBridges [mailto:support@telcobridges.com support team].

As part of the initial release, TelcoBridges is providing a number of ready-to-use scripts such as [[percentage routing]], [[round-robin routing]], [[least-cost routing]], [[SIP trunking]], PRI reselling with over-subscription, etc., with additional scripts to be made available as we go forward. This new approach is meant to supplement the current approach to building routes. It should also make it possible for your service provider customers, once properly trained by you, to modify routing tables on their own.

== Prerequisites ==
There is no additional software required to use the scriptable routing engine. All necessary software is installed by the [[Toolpack]] installer application. While the Ruby language is natural language-like and easily approachable, some understanding of programming or Ruby is required in order to modify existing scripts. The Ruby scripts provided with Toolpack essentially consist of a series of mini scripts or sub-scripts (akin to classes in C++); therefore creating a script from scratch does require more experience. Please see the [http://www.ruby-lang.org/ Ruby site] for additional information on Ruby. That site features a helpful tutorial called “Ruby in 20 minutes”. There is also a section called “Ruby from Other Languages” which will help you understand Ruby if your frame of reference is C++, Java, or a scripting language such as Perl, PHP, or Python.

The Toolpack scriptable routing engine is based on the 1.8.x branch of Ruby.

== Steps ==
You access the Scriptable Routing Engine via the Toolpack [[web portal]]. After logging into the Toolpack web portal with your web browser, do the following steps to either modify or create a script and to then activate it.

*To modify a bundled script or to create a script from scratch, go to '''Gateway > Routing Scripts''' in the navigation menu on the left hand side of the web page.
**Select '''Create New Script''' to generate a default script. Here you will name your script. There is a checkbox called ‘Create default script files’ that is checked by default. If left checked, it will add the default scripts elements to your script.
**In the '''Editing NAPS''' section, you are initially presented with a list of NAPS configured on the system. Via the '''Create New NAP Column''' item, you have the ability to add custom fields for the purposes of adding weights or other variables that your scripts should take into account.
***The list of available [[NAP|NAPs]] is accessed via '''Global > NAPS'''.
**In addition to authoring scripts in the web browser, Ruby scripts can be authored in any application that offers text editing functionality. Importing a Ruby script into Toolpack is as simple as copying it from the source application document and paste it in to the editing window of the web browser.
*To assign and activate a script, go to '''Gateway > Configurations''' at the bottom of the navigation menu on the left hand side of the web page. If you are already satisfied with your gateway configuration, then click on '''Edit Configuration''' to edit your existing gateway configuration. If you want to create a new gateway configuration, click on '''Create New Configuration'''. A new window will open. Locate the '''Use Script''' sub-menu underneath the '''Use script''' section. ('''''See Figure 1'''''). You then click on the pop-up menu and choose the script you want.
**The list of available scripts is determined via the Routing Scripts menu item we saw in the previous bullet.

'''Figure 1: Use Script sub-menu'''

[[Image:script-sub-menu.jpg]]

*Once you have selected a script, you need to create routes and network access points (NAPs).
**The '''Editing Routes''' section is where you create new routes. In addition to the standard route parameters, you can add new custom parameters as well. These parameters and their values can be accessed in the scripts.
**The '''Editing Naps''' section is where you manage NAPs. In addition to the standard NAP parameters, you can add new custom parameters as well. These parameters and their values can be accessed in the scripts.
***This is used to add NAP-specific parameters to the routing scripts.
***The list of NAPs is always populated with the NAPs of your current configurations.
*In order to activate a new script or a modified script, you must force a reload of the gateway’s configuration.
**If you have created a new gateway configuration, you need to change the current configuration of the gateway instance. This can be done by accessing the Instance menu, editing the gateway instance and changing its configuration to your new one. If you have modified an existing gateway configuration, you do need to change anything. In both cases however, you need to activate the configuration in '''Global > Systems'''. There you select the system to which you want to apply the configuration, clicking '''Edit''' besides its name. In the new page that opens, click '''Activate''' in the '''Active Configuration''' section.

== Tutorial guide ==
To learn how to use the Scriptable Routing Engine, click the following link to go to the [[routing_script_tutorial|Script Routing Tutorial]].

== Mini development guide ==
To learn about the parameters available in for each object go read the [[Routing_script_tutorial:Mini_Development_Guide|Script Routing Mini Development Guide]].

== Testing this feature ==
To test this feature, you will want to modify some of the provided scripts by changing variables such as route costing or NAP targets.

== Known issues ==
The following are known issues with the Scriptable Routing Engine:
*Scripts (including script sub-components provided by TelcoBridges) are not updated when Toolpack is upgraded to new version (for example, to the release version of v2.3.0, v2.3.1, etc.). This means that if there is an update (bug fix) of the basic script, you will need to manually update any existing scripts.

*If you are using dynamic fields (using the '''Creating New Route Column '''or the '''Create New Nap Column''' option) with routing scripts and you plan to use NAP names, those NAP names need to be '''''all capital''''' letters (i.e.: not just the first letter needs to be capitalized.)

----

Return to [[Version_2.3|Toolpack v2.3 Release Notes]]

Routing script tutorial:route match Tutorial

2009-05-20T15:45:13Z

10.0.0.157:

== route_match tutorial ==

'route_match' is a method implemented in the base_routing and is use to match a route to a call through parameters and/or status. This tutorial will explain how to use the parameter for the 'route_match' method.

=== route_match examples ===
----
Things to know about these examples:
* A new field called 'priority' needs to be add to the routes.
* A new field called 'asr_threshold' needs to be add to the routes.
* A new field called 'usage_threshold' needs to be add to the routes.

==== route_match setup ====
Time to take a look how to match route to a call. List of routes use for the example:
Calling Called NAP Remapped NAP Priority
5550000 1110000 isdn sip 4
5550000 2220000 sip isdn 3
5550000 3330000 sip_p2 isdn_1 2

List of naps:
Name Asr threshold Usage threshold
isdn 40 90
sip 52 92

Input used in the test script window:
@call_params = {:calling => '5550000', :called => '5550002', :nap => 'isdn'}
@nap_list = [
{:name => 'sip', },
{:name => 'isdn' },
{:name => 'sip_p3' }
]

=== :call_field_name and :route_field_name parameter ===
----

==== :call_field_name and :route_field_name script example ====

Let's start with the :call_field_name and :route_field_name combo. The first example shows how to use the :call_field_name to match the calling number of the incoming call with the calling number of the route.

It will also try to find a route which has the same remapped nap parameter as the nap parameter of the incoming call, therefore ignoring the nap parameter of the route.
require 'base_routing'

class MatchTutorial < BaseRouting
route_match :call_field_name => :calling
route_match :call_field_name => :calling, :route_field_name => :calling
route_match :call_field_name => :nap, :route_field_name => :remapped_nap

end

@@routing = MatchTutorial.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

==== :call_field_name and :route_field_name script output ====

If you look at the first 2 lines of the MatchTutorial class definition:
route_match :call_field_name => :calling
route_match :call_field_name => :calling, :route_field_name => :calling

Both lines do the exact same thing. The both try to match the calling number of the incoming call with the calling number of the routing call.

By default the if the :route_field_name is not explicitly declared, route_match will try to match the parameter from the :call_field_name to the same parameter in the route (in this case :calling). It is also important to notice that the :route_field_name parameter cannot be use without a :call_field_name parameter first.

It is also important to notice that the called number, the nap and the priority in the routes were ignored by our match rules.

The script will find a match. Here is the output:
Call Params:
Reason: ok
Called: 5550002
Calling: 5550000
Nap: isdn
Matched route:
Remapped calling:
Called: 2220000
Calling: 5550000
Remapped called:
Priority: 3
Remapped nap: isdn
Nap: sip
Output: OUT: Nap attribute must be remapped
OUT:

=== :method and :proc parameter ===
----
Let's try the :method and :proc. The next example is a isdn-sip gateway.

It uses the one of the method contain in base_routing (:match_nap_availability), it will compare the :asr_statistics_struct_last_24h_asr_percent nap status with the :asr_threshold in the naps, and will also compare the :usage_percent nap status with the :usage_threshold.

The threshold and the status in this example were set so that a sip to isdn call will be dropped, but a isdn to sip call will be accepted.

==== :method and :proc input ====
It is possible to set the nap status values in the test windows. Here is the input in the test window:
@call_params = {:calling => '5550000', :called => '5550002', :nap => 'isdn'}
@nap_list = [
{:name => 'sip', :availability_percent => '100', :asr_statistics_struct_last_24h_asr_percent => '60', :usage_percent => '85' },
{:name => 'isdn', :availability_percent => '100', :asr_statistics_struct_last_24h_asr_percent => '40', :usage_percent => '100' },
{:name => 'sip_p3', :availability_percent => '0', :asr_statistics_struct_last_24h_asr_percent => '10', :usage_percent => '90' }
]

==== :method and :proc script example ====
require 'base_routing'

#
# This class requires that your add columns in the nap called asr_threshold and usage_threshold
#
class MatchProcMethodTutorial < BaseRouting
route_match :call_field_name => :nap
route_match :method => :match_nap_availability
route_match :method => :match_nap_available_call
route_match :proc => Proc.new { |route, call, nap_list|
result = true
#get the outgoing nap
nap=nap_list[route[:remapped_nap].intern]
puts "usage remapped nap #{nap[:name]}"
if nap.nil?
puts "Cannot found route with outgoing nap '#{route[:remapped_nap]}'"
result = false
end

#get the last 24hrs asr
asr_24hrs_status = nap[:asr_statistics_struct_last_24h_asr_percent].to_i
asr_24hrs_threshold = nap[:asr_threshold].to_i
puts "asr status #{asr_24hrs_status}, treshold#{asr_24hrs_threshold}"
if asr_24hrs_status < asr_24hrs_threshold
puts "Insufficient ASR in the last 24hrs for nap '#{route[:remapped_nap]}'"
result = false
end

result
}

def match_nap_available_call(route, call, nap_list)
#get the outgoing nap
nap=nap_list[route[:remapped_nap].intern]
puts "usage remapped nap #{nap[:name]}"
if nap.nil?
puts "Cannot found route with outgoing nap '#{route[:remapped_nap]}'"
return false
end

# verify how many calls are available in the nap
nap_usage_status = nap[:usage_percent].to_i
nap_usage_threshold = nap[:usage_threshold].to_i
puts "usage status #{nap_usage_status}, treshold#{nap_usage_threshold}"
if nap_usage_status > nap_usage_threshold
puts "Nap usage of '#{route[:remapped_nap]}' is higher then threshold '#{nap_usage_status}' "
return false
end

true

end

end

@@routing = MatchProcMethodTutorial.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

==== :method and :proc output ====
The gateway application queries every second the status and keep it available for routing script (due to the synchronous nature of the status query, it is preferable to have another thread polling the status than querying the status for each call).

The script uses 2 status available (:asr_statistics_struct_last_24h_asr_percent and :asr_threshold in the naps) in the naps, for a complete list of the status available go [[Routing_script_tutorial:Mini_Development_Guide#Nap status|here]] in the NAP_STATS_FIELDS define.

If you check the NAP_STATS_FIELDS define, you will see that :asr_statistics_struct_last_24h_asr_percent is the combination of 2 field names asr_statistics_struct and last_24h_asr_percent.

You might have noticed that the block in the proc function did not use the return keyword, it is a rule from ruby where you cannot use the return keyword in a block.

Here is the output:
Call Params:
Reason: ok
Called: 5550002
Calling: 5550000
Nap: isdn
Matched route:
Remapped calling:
Called: 1110000
Calling: 5550000
Remapped called:
Priority: 4
Remapped nap: sip
Nap: isdn

Output: OUT: usage remapped nap sip
OUT:
OUT: usage status 85, treshold92
OUT:
OUT: usage remapped nap sip
OUT:
OUT: asr status 60, treshold52
OUT:
OUT: Nap attribute must be remapped
OUT:

----
Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Routing script tutorial:Mini Development Guide

2009-05-20T15:43:48Z

10.0.0.157: /* Nap statuses */

== Call parameters ==

=== Accept ===
The following call parameters are available in the call object:
* calling
* calling_noa
* calling_npi
* called
* called_noa
* called_npi
* nap

They can all be remapped if they are given to the accept method of the call object.

=== Refuse ===
The following call parameters may be set in the refuse method of the call object:
* reason
Currently the only supported value is "no_route".

== Route parameters ==
All route may have these parameters:
* calling
* called
* nap
* remapped_calling
* remapped_called
* remapped_nap
* remapped_profile

Additionnaly it is possible to add dynamic route attributes in the web portal. These can be referenced by their name.

== Nap status ==
All the status fields of the NAPs are provided for use by the routing scripts. See the nap status provider for more details on which fields are available in the CEngineStatTransNap.hpp file.

'''Notice:''' These values may change between major release.
#define NAP_STATS_FIELDS \
/* Field, szName, szDescription, szOptions */ \
( SIGNALING_TYPE, "signaling_type", "Signaling type.", "" ) \
( INCOMING_CALL_CNT, "inst_incoming_call_cnt", "Instantaneous Count of incoming calls.", "" ) \
( OUTGOING_CALL_CNT, "inst_outgoing_call_cnt", "Instantaneous Count of outgoing calls.", "" ) \
( AVAILABLE_CNT, "available_cnt", "Number of available circuits or channels.", "" ) \
( UNAVAILABLE_CNT, "unavailable_cnt", "Number of unavailable circuits or channels.", "" ) \
( AVAILABILITY_PCT, "availability_percent", "Percentage of available circuits or channels.", "" ) \
( USAGE_PCT, "usage_percent", "Percentage of used circuits or channels.", "" ) \
( TOTAL_INCOMING_CALL_CNT, "total_incoming_call_cnt", "Total Count of incoming calls.", "" ) \
( ASR_STRUCT, "asr_statistics_struct", "Detailed Answer-Seizure Rate Statistics.", "" ) \
( GLOBAL_ASR_PCT, "global_asr_percent", "Global calculated ASR percentage.", "" ) \
( TOTAL_OUTGOING_CALL_CNT, "total_outgoing_call_cnt", "Total Count of outgoing calls.", "" ) \
( LAST_24H_ASR_PCT, "last_24h_asr_percent", "Last 24 hours calculated ASR percentage.", "" ) \
( LAST_24H_OUTGOING_CALL_CNT, "last_24h_outgoing_call_cnt", "Last 24 hours outgoing calls.", "" ) \
( HOUR_ASR_PCT, "current_hour_asr_percent", "Current hour calculated ASR percentage.", "" ) \
( HOUR_OUTGOING_CALL_CNT, "current_hour_outgoing_call_cnt", "Current hour outgoing calls.", "" ) \
( LAST_HOUR_ASR_PCT, "last_hour_asr_percent", "Last hour calculated ASR percentage.", "" ) \
( LAST_HOUR_OUTGOING_CALL_CNT, "last_hour_outgoing_call_cnt", "Last hour outgoing calls.", "" ) \
( AVAILABILITY_DETECTION_STRUCT, "availability_detection_struct", "Detailed availibility detection Statistics", "" ) \
( POLL_REMOTE_PROXY, "poll_remote_proxy", "Remote proxy polling enabled", "" ) \
( TIME_SINCE_POLLING, "time_since_polling", "Time since the last availibility polling", "" ) \
( TIME_AVAILABLE, "time_available", "Formated Time since the NAP is available", "" ) \
( TIME_AVAILABLE_SECONDS, "time_available_seconds", "Number of seconds since the NAP is available", "x" ) \
( TIME_UNAVAILABLE, "time_unavailable", "Time since the NAP is unavailable", "" ) \
( TIME_UNAVAILABLE_SECONDS, "time_unavailable_seconds", "Number of seconds since the NAP is unavailable", "x" ) \
( REGISTRATION_STRUCT, "registration_struct", "Detailed registration Statistics", "" ) \
( REGISTER_TO_PROXY, "register_to_proxy", "Register to proxy enabled", "" ) \
( IS_REGISTERED, "registered", "Is registered", "" ) \
( TIME_SINCE_REFRESH, "time_since_refresh", "Time since the last refresh", "" ) \
( TIME_REGISTERED, "time_registered", "Formated Time since the NAP is registered", "" ) \
( TIME_REGISTERED_SECONDS, "time_registered_seconds", "Number of seconds since the NAP is registered", "x" ) \
( TIME_NOT_REGISTERED, "time_not_registered", "Formated Time since the NAP is not registered", "" ) \
( TIME_NOT_REGISTERED_SECONDS, "time_not_registered_seconds", "Number of seconds since the NAP is not registered", "x" ) \
/*!< Nap Status Fields */

If the nap status is part of a substructure, it's name in the routing scripts must be composed of the structure name appended by an underscore and the field name.

For example the name to use for the global ASR percentage is:

asr_statistics_struct_global_asr_percent

It is also possible to add dynamic nap attributes in the web portal. These can be referenced by their name.

== Test parameters ==

=== @call_params ===
That variable should contain a hash of call parameters that will passed to the routing script. This is equivalent to the incoming call parameters.

=== @nap_list ===
A list of hash containing the nap statuses. This is equivalent to the nap statuses at the time the call is to be routed.

'''The nap list is hashed by the nap names in UPPERCASE.''' It is important to consider this when creating new dynamic route or nap attributes that may nap names that will be used to fetch a status.

----
Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Routing script tutorial

2009-05-20T15:42:13Z

10.0.0.157:

== Introduction ==
The scripts requires you to define a class that will help you select one of your previously created routes.
There are 3 mandatory things to define for your script to work:

# Define your new script routing class, which can contain one or many of these methods (route_order,route_match,route_remap)
# The 'init_routes' method
# The 'route' method

For more information about the parameters that can be use within a method, go see the [[Routing_script_tutorial:Mini_Development_Guide|mini development guide]]

== Script routing class ==

The scripting class is use to define on which call/nap parameters the call need to match the route or to remap the call parameter.
You also need to define all new methods required by your script routing class.
It is highly recommended to derive your new class for the 'base_routing' class, because it give your a lot of functionality.

== What I need to define a script routing class ==
There are 3 methods that can be use
# route_order
# route_match
# route_remap
'route_order' will be called before the 'route_match' which will all be called before the 'route_remap'.

=== 'route_order' method ===

'route_order' allows to order routes using one of 3 possible arguments. It is only possible to call 'route_order' once.
# :route_field_name - The field name of the **route** to order with. The value of the route field should be an **integer** so that it can be compared.
# :proc - A user supplied **proc** to call instead of trying to order internally. It should accept two argument: route list, nap list and return the sorted route list.
# :method - A user supplied **method** to call instead of trying to order internally. It should accept two argument: route list, nap list and return the sorted route list.

base_routing pre-implemented ordering method:
* 'order_by_asr', this method will order the routes according to the asr(average success rate). This method requires to add a custom **nap** parameter called ':asr_type', its value can be: global, last_24h, current_hour, last_hour. It can be use in your custom class like this:

route_order :method => :order_by_asr

=== 'route_match' method ===

'route_match' allows to match a call to one route using one of 4 possible arguments. It is possible to call 'route_match' multiple times to reduce the number of matching routes. Since 'route_match' will return the first matching route it find, there is a possibility that there is more than one route match, therefore it is important to order the routes or prioritize them using 'route_order'.

# :call_field_name - The field name of the call to try to match
# :route_field_name - The field name of the route to try to match with. The default is to use the call field name. If the value of the field is empty, the match is considered positive. The value of the route field can be a regular expression. e.g. /555000./
# :proc - A user supplied proc to call instead of trying to do the match internally. It should accept three argument: route, call, nap list and return a boolean to indicate the match.
# :method - A user supplied method to call instead of trying to do the match internally. It should accept three argument: route, call, nap list and return a boolean to indicate the match.

base_routing pre-implemented matching method:
* 'match_nap_availability', this method will verify the availability through the nap status.
route_match :method => :match_nap_availability
* 'match_asr_threshhold', this method will verify will match any route who's destination nap has a higher asr than the treshold stored for that nap. This method requires to add 2 custom **nap** parameters called. First is 'asr_threshhold_type', its values can be : global, last_24h, current_hour, last_hour. The second is 'asr_threshhold', its value needs to be an **integer** between 0 and 100.
route_match :method => :match_asr_threshhold

=== 'route_remap' method ===

'route_remap' allows to remap the parameter of the route or the call using one of the 4 possible arguments. There are actually 3 type of remapping that can be done. using the :call_field_name/:route_field_name arguments, the :proc argument and/or the :method argument.

# :call_field_name - The field name of the call to remap
# :route_field_name - The field name of the route to remap with. The default is to use the call field name. If the value of the field is empty, the incoming call's attribute is used. The value of the route field can be a regular expression remap. e.g. /(555000.)/001\1/
# :proc - A user supplied proc to call instead of trying to do the remap internally. It should accept four argument: route, call, nap list, remapped fields and return a hash of remapped fields.
# :method - A user supplied method to call instead of trying to do the match internally. It should accept four argument: route, call, nap list, remapped fields and return a hash of remapped fields.

=== 'init_routes' method ===

The 'init_routes' is a mandatory method that is call every time the script is loaded ( think loading the configuration ).
This can be use at your advantage to do some pre-processing like ordering your routes, that way the routes will not be re-ordered at every call that comes in.

=== 'route' method ===

The 'route' is a mandatory method that is call at every call that comes in. This is where you can do the dynamic routing part.

== What else? ==

There are numerous possibilities:
* Add new methods for route selection.
* Add new columns in the nap or route.
* Create scripts that includes other scripts to help make the routing more modular.

=== Examples and tutorials ===

* [[Routing_script_tutorial:Routing_Class_Tutorial|script routing class tutorial]]
* [[Routing_script_tutorial:route_order_Tutorial|'route_order' tutorial]].
* [[Routing_script_tutorial:route_match_Tutorial|'route_match' tutorial]].
* [[Routing_script_tutorial:route_remap_Tutorial|'route_remap' tutorial]].
* pre-made routing script are also available through the web portal in the script routing menu.

----
Back to the [[Scriptable_Routing_Engine|Scriptable Routing Engine]] page.

Routing script tutorial:Mini Development Guide

2009-05-20T15:41:34Z

10.0.0.157: New page: == Call parameters == === Accept === The following call parameters are available in the call object: * calling * calling_noa * calling_npi * called * called_noa * called_npi * nap They c...

== Call parameters ==

=== Accept ===
The following call parameters are available in the call object:
* calling
* calling_noa
* calling_npi
* called
* called_noa
* called_npi
* nap

They can all be remapped if they are given to the accept method of the call object.

=== Refuse ===
The following call parameters may be set in the refuse method of the call object:
* reason
Currently the only supported value is "no_route".

== Route parameters ==
All route may have these parameters:
* calling
* called
* nap
* remapped_calling
* remapped_called
* remapped_nap
* remapped_profile

Additionnaly it is possible to add dynamic route attributes in the web portal. These can be referenced by their name.

== Nap statuses ==
All the status fields of the NAPs are provided for use by the routing scripts. See the nap status provider for more details on which fields are available in the CEngineStatTransNap.hpp file.

'''Notice:''' These values may change between major release.
#define NAP_STATS_FIELDS \
/* Field, szName, szDescription, szOptions */ \
( SIGNALING_TYPE, "signaling_type", "Signaling type.", "" ) \
( INCOMING_CALL_CNT, "inst_incoming_call_cnt", "Instantaneous Count of incoming calls.", "" ) \
( OUTGOING_CALL_CNT, "inst_outgoing_call_cnt", "Instantaneous Count of outgoing calls.", "" ) \
( AVAILABLE_CNT, "available_cnt", "Number of available circuits or channels.", "" ) \
( UNAVAILABLE_CNT, "unavailable_cnt", "Number of unavailable circuits or channels.", "" ) \
( AVAILABILITY_PCT, "availability_percent", "Percentage of available circuits or channels.", "" ) \
( USAGE_PCT, "usage_percent", "Percentage of used circuits or channels.", "" ) \
( TOTAL_INCOMING_CALL_CNT, "total_incoming_call_cnt", "Total Count of incoming calls.", "" ) \
( ASR_STRUCT, "asr_statistics_struct", "Detailed Answer-Seizure Rate Statistics.", "" ) \
( GLOBAL_ASR_PCT, "global_asr_percent", "Global calculated ASR percentage.", "" ) \
( TOTAL_OUTGOING_CALL_CNT, "total_outgoing_call_cnt", "Total Count of outgoing calls.", "" ) \
( LAST_24H_ASR_PCT, "last_24h_asr_percent", "Last 24 hours calculated ASR percentage.", "" ) \
( LAST_24H_OUTGOING_CALL_CNT, "last_24h_outgoing_call_cnt", "Last 24 hours outgoing calls.", "" ) \
( HOUR_ASR_PCT, "current_hour_asr_percent", "Current hour calculated ASR percentage.", "" ) \
( HOUR_OUTGOING_CALL_CNT, "current_hour_outgoing_call_cnt", "Current hour outgoing calls.", "" ) \
( LAST_HOUR_ASR_PCT, "last_hour_asr_percent", "Last hour calculated ASR percentage.", "" ) \
( LAST_HOUR_OUTGOING_CALL_CNT, "last_hour_outgoing_call_cnt", "Last hour outgoing calls.", "" ) \
( AVAILABILITY_DETECTION_STRUCT, "availability_detection_struct", "Detailed availibility detection Statistics", "" ) \
( POLL_REMOTE_PROXY, "poll_remote_proxy", "Remote proxy polling enabled", "" ) \
( TIME_SINCE_POLLING, "time_since_polling", "Time since the last availibility polling", "" ) \
( TIME_AVAILABLE, "time_available", "Formated Time since the NAP is available", "" ) \
( TIME_AVAILABLE_SECONDS, "time_available_seconds", "Number of seconds since the NAP is available", "x" ) \
( TIME_UNAVAILABLE, "time_unavailable", "Time since the NAP is unavailable", "" ) \
( TIME_UNAVAILABLE_SECONDS, "time_unavailable_seconds", "Number of seconds since the NAP is unavailable", "x" ) \
( REGISTRATION_STRUCT, "registration_struct", "Detailed registration Statistics", "" ) \
( REGISTER_TO_PROXY, "register_to_proxy", "Register to proxy enabled", "" ) \
( IS_REGISTERED, "registered", "Is registered", "" ) \
( TIME_SINCE_REFRESH, "time_since_refresh", "Time since the last refresh", "" ) \
( TIME_REGISTERED, "time_registered", "Formated Time since the NAP is registered", "" ) \
( TIME_REGISTERED_SECONDS, "time_registered_seconds", "Number of seconds since the NAP is registered", "x" ) \
( TIME_NOT_REGISTERED, "time_not_registered", "Formated Time since the NAP is not registered", "" ) \
( TIME_NOT_REGISTERED_SECONDS, "time_not_registered_seconds", "Number of seconds since the NAP is not registered", "x" ) \
/*!< Nap Status Fields */

If the nap status is part of a substructure, it's name in the routing scripts must be composed of the structure name appended by an underscore and the field name.

For example the name to use for the global ASR percentage is:

asr_statistics_struct_global_asr_percent

It is also possible to add dynamic nap attributes in the web portal. These can be referenced by their name.

== Test parameters ==

=== @call_params ===
That variable should contain a hash of call parameters that will passed to the routing script. This is equivalent to the incoming call parameters.

=== @nap_list ===
A list of hash containing the nap statuses. This is equivalent to the nap statuses at the time the call is to be routed.

'''The nap list is hashed by the nap names in UPPERCASE.''' It is important to consider this when creating new dynamic route or nap attributes that may nap names that will be used to fetch a status.

----
Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Routing script tutorial:route remap Tutorial

2009-05-20T15:21:05Z

10.0.0.157:

== route_remap tutorial ==

'route_remap' is a method implemented in the base_routing and is use to modify call parameters. This tutorial will explain how to use the parameter for the 'route_remap' method.

=== route_remap examples ===
----
Things to know about these examples:
* A new field called 'priority' needs to be add to the routes.
* A new field called 'asr_threshold' needs to be add to the routes.
* A new field called 'usage_threshold' needs to be add to the routes.

==== route_remap setup ====

Time to take a look how to match route to a call. List of routes use for the example:
Calling Called NAP Remapped NAP Priority
5550000 1110000 isdn sip 4
5550000 2220000 sip isdn 3
5550000 3330000 sip_p2 isdn_1 2

List of naps:
Name Asr threshold Usage threshold
isdn 40 90
sip 52 92

Input used in the test script window:
@call_params = {:calling => '5550000', :called => '5550002', :nap => 'isdn'}
@nap_list = [
{:name => 'sip', },
{:name => 'isdn' },
{:name => 'sip_p3' }
]

=== route_remap parameter ===
----

The following example is a isdn to sip gateway. This time we will remap the called and the calling number.
require 'base_routing'

class RemapTutorial < BaseRouting
route_match :call_field_name => :nap
route_remap :call_field_name => :called, :route_field_name => :called
route_remap :method => :remapped_tutorial
route_remap :proc => Proc.new { |route, call, nap_list, remapped_fields|

puts "Proc is called"
#remapping calling
if remapped_fields[:calling].nil?
remap_calling = call.get(:calling)
puts "call : #{remap_calling}"
else
remap_calling = remapped_fields[:calling]
puts "remapped : #{remap_calling}"
end

if( remap_calling == "5550000" )
remap_calling = "9871111"
elsif ( remap_calling == "7772222")
remap_calling = "6541111"
end

puts "remap_calling : #{remap_calling}"
remapped_fields[:calling] = remap_calling

remapped_fields
}

def remapped_tutorial(route, call, nap_list, remapped_fields)

puts "Method is called"
if remapped_fields[:calling].nil?
remap_calling = call.get(:calling)
puts "call : #{remap_calling}"
else
remap_calling = remapped_fields[:calling]
puts "remapped : #{remap_calling}"
end

if( remap_calling == "5550000" )
remap_calling = "7772222"
elsif( remap_calling == "9871111" )
remap_calling = "9992222"
end

puts "remap_calling : #{remap_calling}"
remapped_fields[:calling] = remap_calling

remapped_fields

end

end

@@routing = RemapTutorial.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

==== route_remap script output ====

The called number is remapped by the the :call_field_name / :route_field_name. Like 'route_match', if :call_field_name is used alone the parameter (in this case :called), will be remapped by the same parameter of :route_field_name. The following 2 lines will have the exact same behavior (they both remapped the called number of the call with the called number of the route):
route_remap :call_field_name => :called
route_remap :call_field_name => :called, :route_field_name => :called

As for the :method and :proc parameters, they both remap the calling number but to different values.

It is important when remapping to always verify the remapped_fields parameter. If some parameters were remapped previously, the changes will be supply in the remapped_fields (4th parameter of your method or proc). The remapping result needs to put in that hash and return in your method or proc. It is possible though that you may want to overwrite the change done previously, in that case use directly the call parameter but of course you will need to order your 'route_remap' accordingly. They are executed in the order they are declared.

The actual changes on the call will only be "merged" after all the remapping are done.

Here is the output of the example:
Call Params:
Reason: ok
Called: 2220000
Calling: 6541111
Nap: sip
Matched route:
Remapped calling:
Called: 2220000
Calling: 5550000
Remapped called:
Priority: 3
Remapped nap: isdn
Nap: sip
Output: OUT: Method is called
OUT:
OUT: call : 5550000
OUT:
OUT: remap_calling : 7772222
OUT:
OUT: Proc is called
OUT:
OUT: remapped : 7772222
OUT:
OUT: remap_calling : 6541111
OUT:
OUT: Nap attribute must be remapped
OUT:

----
Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Routing script tutorial:route remap Tutorial

2009-05-20T15:20:47Z

10.0.0.157: New page: == route_remap tutorial == 'route_remap' is a method implemented in the base_routing and is use to modify call parameters. This tutorial will explain how to use the parameter for the 'rou...

== route_remap tutorial ==

'route_remap' is a method implemented in the base_routing and is use to modify call parameters. This tutorial will explain how to use the parameter for the 'route_remap' method.

=== route_remap examples ===
Things to know about these examples:
* A new field called 'priority' needs to be add to the routes.
* A new field called 'asr_threshold' needs to be add to the routes.
* A new field called 'usage_threshold' needs to be add to the routes.

==== route_remap setup ====

Time to take a look how to match route to a call. List of routes use for the example:
Calling Called NAP Remapped NAP Priority
5550000 1110000 isdn sip 4
5550000 2220000 sip isdn 3
5550000 3330000 sip_p2 isdn_1 2

List of naps:
Name Asr threshold Usage threshold
isdn 40 90
sip 52 92

Input used in the test script window:
@call_params = {:calling => '5550000', :called => '5550002', :nap => 'isdn'}
@nap_list = [
{:name => 'sip', },
{:name => 'isdn' },
{:name => 'sip_p3' }
]

=== route_remap parameter ===

The following example is a isdn to sip gateway. This time we will remap the called and the calling number.
require 'base_routing'

class RemapTutorial < BaseRouting
route_match :call_field_name => :nap
route_remap :call_field_name => :called, :route_field_name => :called
route_remap :method => :remapped_tutorial
route_remap :proc => Proc.new { |route, call, nap_list, remapped_fields|

puts "Proc is called"
#remapping calling
if remapped_fields[:calling].nil?
remap_calling = call.get(:calling)
puts "call : #{remap_calling}"
else
remap_calling = remapped_fields[:calling]
puts "remapped : #{remap_calling}"
end

if( remap_calling == "5550000" )
remap_calling = "9871111"
elsif ( remap_calling == "7772222")
remap_calling = "6541111"
end

puts "remap_calling : #{remap_calling}"
remapped_fields[:calling] = remap_calling

remapped_fields
}

def remapped_tutorial(route, call, nap_list, remapped_fields)

puts "Method is called"
if remapped_fields[:calling].nil?
remap_calling = call.get(:calling)
puts "call : #{remap_calling}"
else
remap_calling = remapped_fields[:calling]
puts "remapped : #{remap_calling}"
end

if( remap_calling == "5550000" )
remap_calling = "7772222"
elsif( remap_calling == "9871111" )
remap_calling = "9992222"
end

puts "remap_calling : #{remap_calling}"
remapped_fields[:calling] = remap_calling

remapped_fields

end

end

@@routing = RemapTutorial.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

==== route_remap script output ====

The called number is remapped by the the :call_field_name / :route_field_name. Like 'route_match', if :call_field_name is used alone the parameter (in this case :called), will be remapped by the same parameter of :route_field_name. The following 2 lines will have the exact same behavior (they both remapped the called number of the call with the called number of the route):
route_remap :call_field_name => :called
route_remap :call_field_name => :called, :route_field_name => :called

As for the :method and :proc parameters, they both remap the calling number but to different values.

It is important when remapping to always verify the remapped_fields parameter. If some parameters were remapped previously, the changes will be supply in the remapped_fields (4th parameter of your method or proc). The remapping result needs to put in that hash and return in your method or proc. It is possible though that you may want to overwrite the change done previously, in that case use directly the call parameter but of course you will need to order your 'route_remap' accordingly. They are executed in the order they are declared.

The actual changes on the call will only be "merged" after all the remapping are done.

Here is the output of the example:
Call Params:
Reason: ok
Called: 2220000
Calling: 6541111
Nap: sip
Matched route:
Remapped calling:
Called: 2220000
Calling: 5550000
Remapped called:
Priority: 3
Remapped nap: isdn
Nap: sip
Output: OUT: Method is called
OUT:
OUT: call : 5550000
OUT:
OUT: remap_calling : 7772222
OUT:
OUT: Proc is called
OUT:
OUT: remapped : 7772222
OUT:
OUT: remap_calling : 6541111
OUT:
OUT: Nap attribute must be remapped
OUT:

----
Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Routing script tutorial

2009-05-20T15:13:12Z

10.0.0.157:

== Introduction ==
The scripts requires you to define a class that will help you select one of your previously created routes.
There are 3 mandatory things to define for your script to work:

# Define your new script routing class, which can contain one or many of these methods (route_order,route_match,route_remap)
# The 'init_routes' method
# The 'route' method

For more information about the parameters that can be use within a method, go see the [[mini development guide]]

== Script routing class ==

The scripting class is use to define on which call/nap parameters the call need to match the route or to remap the call parameter.
You also need to define all new methods required by your script routing class.
It is highly recommended to derive your new class for the 'base_routing' class, because it give your a lot of functionality.

== What I need to define a script routing class ==
There are 3 methods that can be use
# route_order
# route_match
# route_remap
'route_order' will be called before the 'route_match' which will all be called before the 'route_remap'.

=== 'route_order' method ===

'route_order' allows to order routes using one of 3 possible arguments. It is only possible to call 'route_order' once.
# :route_field_name - The field name of the **route** to order with. The value of the route field should be an **integer** so that it can be compared.
# :proc - A user supplied **proc** to call instead of trying to order internally. It should accept two argument: route list, nap list and return the sorted route list.
# :method - A user supplied **method** to call instead of trying to order internally. It should accept two argument: route list, nap list and return the sorted route list.

base_routing pre-implemented ordering method:
* 'order_by_asr', this method will order the routes according to the asr(average success rate). This method requires to add a custom **nap** parameter called ':asr_type', its value can be: global, last_24h, current_hour, last_hour. It can be use in your custom class like this:

route_order :method => :order_by_asr

=== 'route_match' method ===

'route_match' allows to match a call to one route using one of 4 possible arguments. It is possible to call 'route_match' multiple times to reduce the number of matching routes. Since 'route_match' will return the first matching route it find, there is a possibility that there is more than one route match, therefore it is important to order the routes or prioritize them using 'route_order'.

# :call_field_name - The field name of the call to try to match
# :route_field_name - The field name of the route to try to match with. The default is to use the call field name. If the value of the field is empty, the match is considered positive. The value of the route field can be a regular expression. e.g. /555000./
# :proc - A user supplied proc to call instead of trying to do the match internally. It should accept three argument: route, call, nap list and return a boolean to indicate the match.
# :method - A user supplied method to call instead of trying to do the match internally. It should accept three argument: route, call, nap list and return a boolean to indicate the match.

base_routing pre-implemented matching method:
* 'match_nap_availability', this method will verify the availability through the nap status.
route_match :method => :match_nap_availability
* 'match_asr_threshhold', this method will verify will match any route who's destination nap has a higher asr than the treshold stored for that nap. This method requires to add 2 custom **nap** parameters called. First is 'asr_threshhold_type', its values can be : global, last_24h, current_hour, last_hour. The second is 'asr_threshhold', its value needs to be an **integer** between 0 and 100.
route_match :method => :match_asr_threshhold

=== 'route_remap' method ===

'route_remap' allows to remap the parameter of the route or the call using one of the 4 possible arguments. There are actually 3 type of remapping that can be done. using the :call_field_name/:route_field_name arguments, the :proc argument and/or the :method argument.

# :call_field_name - The field name of the call to remap
# :route_field_name - The field name of the route to remap with. The default is to use the call field name. If the value of the field is empty, the incoming call's attribute is used. The value of the route field can be a regular expression remap. e.g. /(555000.)/001\1/
# :proc - A user supplied proc to call instead of trying to do the remap internally. It should accept four argument: route, call, nap list, remapped fields and return a hash of remapped fields.
# :method - A user supplied method to call instead of trying to do the match internally. It should accept four argument: route, call, nap list, remapped fields and return a hash of remapped fields.

=== 'init_routes' method ===

The 'init_routes' is a mandatory method that is call every time the script is loaded ( think loading the configuration ).
This can be use at your advantage to do some pre-processing like ordering your routes, that way the routes will not be re-ordered at every call that comes in.

=== 'route' method ===

The 'route' is a mandatory method that is call at every call that comes in. This is where you can do the dynamic routing part.

== What else? ==

There are numerous possibilities:
* Add new methods for route selection.
* Add new columns in the nap or route.
* Create scripts that includes other scripts to help make the routing more modular.

=== Examples and tutorials ===

* [[Routing_script_tutorial:Routing_Class_Tutorial|script routing class tutorial]]
* [[Routing_script_tutorial:route_order_Tutorial|'route_order' tutorial]].
* [[Routing_script_tutorial:route_match_Tutorial|'route_match' tutorial]].
* [[Routing_script_tutorial:route_remap_Tutorial|'route_remap' tutorial]].
* pre-made routing script are also available through the web portal in the script routing menu.

----
Back to the [[Scriptable_Routing_Engine|Scriptable Routing Engine]] page.

Routing script tutorial:route match Tutorial

2009-05-20T15:11:21Z

10.0.0.157: /* route_match examples */

== route_match tutorial ==

'route_match' is a method implemented in the base_routing and is use to match a route to a call through parameters and/or status. This tutorial will explain how to use the parameter for the 'route_match' method.

=== route_match examples ===
----
Things to know about these examples:
* A new field called 'priority' needs to be add to the routes.
* A new field called 'asr_threshold' needs to be add to the routes.
* A new field called 'usage_threshold' needs to be add to the routes.

==== route_match setup ====
Time to take a look how to match route to a call. List of routes use for the example:
Calling Called NAP Remapped NAP Priority
5550000 1110000 isdn sip 4
5550000 2220000 sip isdn 3
5550000 3330000 sip_p2 isdn_1 2

List of naps:
Name Asr threshold Usage threshold
isdn 40 90
sip 52 92

Input used in the test script window:
@call_params = {:calling => '5550000', :called => '5550002', :nap => 'isdn'}
@nap_list = [
{:name => 'sip', },
{:name => 'isdn' },
{:name => 'sip_p3' }
]

=== :call_field_name and :route_field_name parameter ===
----

==== :call_field_name and :route_field_name script example ====

Let's start with the :call_field_name and :route_field_name combo. The first example shows how to use the :call_field_name to match the calling number of the incoming call with the calling number of the route.

It will also try to find a route which has the same remapped nap parameter as the nap parameter of the incoming call, therefore ignoring the nap parameter of the route.
require 'base_routing'

class MatchTutorial < BaseRouting
route_match :call_field_name => :calling
route_match :call_field_name => :calling, :route_field_name => :calling
route_match :call_field_name => :nap, :route_field_name => :remapped_nap

end

@@routing = MatchTutorial.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

==== :call_field_name and :route_field_name script output ====

If you look at the first 2 lines of the MatchTutorial class definition:
route_match :call_field_name => :calling
route_match :call_field_name => :calling, :route_field_name => :calling

Both lines do the exact same thing. The both try to match the calling number of the incoming call with the calling number of the routing call.

By default the if the :route_field_name is not explicitly declared, route_match will try to match the parameter from the :call_field_name to the same parameter in the route (in this case :calling). It is also important to notice that the :route_field_name parameter cannot be use without a :call_field_name parameter first.

It is also important to notice that the called number, the nap and the priority in the routes were ignored by our match rules.

The script will find a match. Here is the output:
Call Params:
Reason: ok
Called: 5550002
Calling: 5550000
Nap: isdn
Matched route:
Remapped calling:
Called: 2220000
Calling: 5550000
Remapped called:
Priority: 3
Remapped nap: isdn
Nap: sip
Output: OUT: Nap attribute must be remapped
OUT:

=== :method and :proc parameter ===
----
Let's try the :method and :proc. The next example is a isdn-sip gateway.

It uses the one of the method contain in base_routing (:match_nap_availability), it will compare the :asr_statistics_struct_last_24h_asr_percent nap status with the :asr_threshold in the naps, and will also compare the :usage_percent nap status with the :usage_threshold.

The threshold and the status in this example were set so that a sip to isdn call will be dropped, but a isdn to sip call will be accepted.

==== :method and :proc input ====
It is possible to set the nap status values in the test windows. Here is the input in the test window:
@call_params = {:calling => '5550000', :called => '5550002', :nap => 'isdn'}
@nap_list = [
{:name => 'sip', :availability_percent => '100', :asr_statistics_struct_last_24h_asr_percent => '60', :usage_percent => '85' },
{:name => 'isdn', :availability_percent => '100', :asr_statistics_struct_last_24h_asr_percent => '40', :usage_percent => '100' },
{:name => 'sip_p3', :availability_percent => '0', :asr_statistics_struct_last_24h_asr_percent => '10', :usage_percent => '90' }
]

==== :method and :proc script example ====
require 'base_routing'

#
# This class requires that your add columns in the nap called asr_threshold and usage_threshold
#
class MatchProcMethodTutorial < BaseRouting
route_match :call_field_name => :nap
route_match :method => :match_nap_availability
route_match :method => :match_nap_available_call
route_match :proc => Proc.new { |route, call, nap_list|
result = true
#get the outgoing nap
nap=nap_list[route[:remapped_nap].intern]
puts "usage remapped nap #{nap[:name]}"
if nap.nil?
puts "Cannot found route with outgoing nap '#{route[:remapped_nap]}'"
result = false
end

#get the last 24hrs asr
asr_24hrs_status = nap[:asr_statistics_struct_last_24h_asr_percent].to_i
asr_24hrs_threshold = nap[:asr_threshold].to_i
puts "asr status #{asr_24hrs_status}, treshold#{asr_24hrs_threshold}"
if asr_24hrs_status < asr_24hrs_threshold
puts "Insufficient ASR in the last 24hrs for nap '#{route[:remapped_nap]}'"
result = false
end

result
}

def match_nap_available_call(route, call, nap_list)
#get the outgoing nap
nap=nap_list[route[:remapped_nap].intern]
puts "usage remapped nap #{nap[:name]}"
if nap.nil?
puts "Cannot found route with outgoing nap '#{route[:remapped_nap]}'"
return false
end

# verify how many calls are available in the nap
nap_usage_status = nap[:usage_percent].to_i
nap_usage_threshold = nap[:usage_threshold].to_i
puts "usage status #{nap_usage_status}, treshold#{nap_usage_threshold}"
if nap_usage_status > nap_usage_threshold
puts "Nap usage of '#{route[:remapped_nap]}' is higher then threshold '#{nap_usage_status}' "
return false
end

true

end

end

@@routing = MatchProcMethodTutorial.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

==== :method and :proc output ====
The gateway application queries every second the status and keep it available for routing script (due to the synchronous nature of the status query, it is preferable to have another thread polling the status than querying the status for each call).

The script uses 2 status available (:asr_statistics_struct_last_24h_asr_percent and :asr_threshold in the naps) in the naps, for a complete list of the status available go [[knowledgebase:toolpack:script_routing#nap_statuses|here]] in the NAP_STATS_FIELDS define.

If you check the NAP_STATS_FIELDS define, you will see that :asr_statistics_struct_last_24h_asr_percent is the combination of 2 field names asr_statistics_struct and last_24h_asr_percent.

You might have noticed that the block in the proc function did not use the return keyword, it is a rule from ruby where you cannot use the return keyword in a block.

Here is the output:
Call Params:
Reason: ok
Called: 5550002
Calling: 5550000
Nap: isdn
Matched route:
Remapped calling:
Called: 1110000
Calling: 5550000
Remapped called:
Priority: 4
Remapped nap: sip
Nap: isdn

Output: OUT: usage remapped nap sip
OUT:
OUT: usage status 85, treshold92
OUT:
OUT: usage remapped nap sip
OUT:
OUT: asr status 60, treshold52
OUT:
OUT: Nap attribute must be remapped
OUT:

----
Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Routing script tutorial:route match Tutorial

2009-05-20T15:08:26Z

10.0.0.157: New page: == route_match tutorial == 'route_match' is a method implemented in the base_routing and is use to match a route to a call through parameters and/or status. This tutorial will explain how...

== route_match tutorial ==

'route_match' is a method implemented in the base_routing and is use to match a route to a call through parameters and/or status. This tutorial will explain how to use the parameter for the 'route_match' method.

=== route_match examples ===
----
Things to know about these examples:
# A new field called 'priority' needs to be add to the routes.
# A new field called 'asr_threshold' needs to be add to the routes.
# A new field called 'usage_threshold' needs to be add to the routes.

==== route_match setup ====
Time to take a look how to match route to a call. List of routes use for the example:
Calling Called NAP Remapped NAP Priority
5550000 1110000 isdn sip 4
5550000 2220000 sip isdn 3
5550000 3330000 sip_p2 isdn_1 2

List of naps:
Name Asr threshold Usage threshold
isdn 40 90
sip 52 92

Input used in the test script window:
@call_params = {:calling => '5550000', :called => '5550002', :nap => 'isdn'}
@nap_list = [
{:name => 'sip', },
{:name => 'isdn' },
{:name => 'sip_p3' }
]

=== :call_field_name and :route_field_name parameter ===
----

==== :call_field_name and :route_field_name script example ====

Let's start with the :call_field_name and :route_field_name combo. The first example shows how to use the :call_field_name to match the calling number of the incoming call with the calling number of the route.

It will also try to find a route which has the same remapped nap parameter as the nap parameter of the incoming call, therefore ignoring the nap parameter of the route.
require 'base_routing'

class MatchTutorial < BaseRouting
route_match :call_field_name => :calling
route_match :call_field_name => :calling, :route_field_name => :calling
route_match :call_field_name => :nap, :route_field_name => :remapped_nap

end

@@routing = MatchTutorial.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

==== :call_field_name and :route_field_name script output ====

If you look at the first 2 lines of the MatchTutorial class definition:
route_match :call_field_name => :calling
route_match :call_field_name => :calling, :route_field_name => :calling

Both lines do the exact same thing. The both try to match the calling number of the incoming call with the calling number of the routing call.

By default the if the :route_field_name is not explicitly declared, route_match will try to match the parameter from the :call_field_name to the same parameter in the route (in this case :calling). It is also important to notice that the :route_field_name parameter cannot be use without a :call_field_name parameter first.

It is also important to notice that the called number, the nap and the priority in the routes were ignored by our match rules.

The script will find a match. Here is the output:
Call Params:
Reason: ok
Called: 5550002
Calling: 5550000
Nap: isdn
Matched route:
Remapped calling:
Called: 2220000
Calling: 5550000
Remapped called:
Priority: 3
Remapped nap: isdn
Nap: sip
Output: OUT: Nap attribute must be remapped
OUT:

=== :method and :proc parameter ===
----
Let's try the :method and :proc. The next example is a isdn-sip gateway.

It uses the one of the method contain in base_routing (:match_nap_availability), it will compare the :asr_statistics_struct_last_24h_asr_percent nap status with the :asr_threshold in the naps, and will also compare the :usage_percent nap status with the :usage_threshold.

The threshold and the status in this example were set so that a sip to isdn call will be dropped, but a isdn to sip call will be accepted.

==== :method and :proc input ====
It is possible to set the nap status values in the test windows. Here is the input in the test window:
@call_params = {:calling => '5550000', :called => '5550002', :nap => 'isdn'}
@nap_list = [
{:name => 'sip', :availability_percent => '100', :asr_statistics_struct_last_24h_asr_percent => '60', :usage_percent => '85' },
{:name => 'isdn', :availability_percent => '100', :asr_statistics_struct_last_24h_asr_percent => '40', :usage_percent => '100' },
{:name => 'sip_p3', :availability_percent => '0', :asr_statistics_struct_last_24h_asr_percent => '10', :usage_percent => '90' }
]

==== :method and :proc script example ====
require 'base_routing'

#
# This class requires that your add columns in the nap called asr_threshold and usage_threshold
#
class MatchProcMethodTutorial < BaseRouting
route_match :call_field_name => :nap
route_match :method => :match_nap_availability
route_match :method => :match_nap_available_call
route_match :proc => Proc.new { |route, call, nap_list|
result = true
#get the outgoing nap
nap=nap_list[route[:remapped_nap].intern]
puts "usage remapped nap #{nap[:name]}"
if nap.nil?
puts "Cannot found route with outgoing nap '#{route[:remapped_nap]}'"
result = false
end

#get the last 24hrs asr
asr_24hrs_status = nap[:asr_statistics_struct_last_24h_asr_percent].to_i
asr_24hrs_threshold = nap[:asr_threshold].to_i
puts "asr status #{asr_24hrs_status}, treshold#{asr_24hrs_threshold}"
if asr_24hrs_status < asr_24hrs_threshold
puts "Insufficient ASR in the last 24hrs for nap '#{route[:remapped_nap]}'"
result = false
end

result
}

def match_nap_available_call(route, call, nap_list)
#get the outgoing nap
nap=nap_list[route[:remapped_nap].intern]
puts "usage remapped nap #{nap[:name]}"
if nap.nil?
puts "Cannot found route with outgoing nap '#{route[:remapped_nap]}'"
return false
end

# verify how many calls are available in the nap
nap_usage_status = nap[:usage_percent].to_i
nap_usage_threshold = nap[:usage_threshold].to_i
puts "usage status #{nap_usage_status}, treshold#{nap_usage_threshold}"
if nap_usage_status > nap_usage_threshold
puts "Nap usage of '#{route[:remapped_nap]}' is higher then threshold '#{nap_usage_status}' "
return false
end

true

end

end

@@routing = MatchProcMethodTutorial.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

==== :method and :proc output ====
The gateway application queries every second the status and keep it available for routing script (due to the synchronous nature of the status query, it is preferable to have another thread polling the status than querying the status for each call).

The script uses 2 status available (:asr_statistics_struct_last_24h_asr_percent and :asr_threshold in the naps) in the naps, for a complete list of the status available go [[knowledgebase:toolpack:script_routing#nap_statuses|here]] in the NAP_STATS_FIELDS define.

If you check the NAP_STATS_FIELDS define, you will see that :asr_statistics_struct_last_24h_asr_percent is the combination of 2 field names asr_statistics_struct and last_24h_asr_percent.

You might have noticed that the block in the proc function did not use the return keyword, it is a rule from ruby where you cannot use the return keyword in a block.

Here is the output:
Call Params:
Reason: ok
Called: 5550002
Calling: 5550000
Nap: isdn
Matched route:
Remapped calling:
Called: 1110000
Calling: 5550000
Remapped called:
Priority: 4
Remapped nap: sip
Nap: isdn

Output: OUT: usage remapped nap sip
OUT:
OUT: usage status 85, treshold92
OUT:
OUT: usage remapped nap sip
OUT:
OUT: asr status 60, treshold52
OUT:
OUT: Nap attribute must be remapped
OUT:

----
Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Routing script tutorial:route order Tutorial

2009-05-20T14:54:52Z

10.0.0.157:

== route_order tutorial ==
'route_order' is a method implemented in the base_routing and is use to order routes. This tutorial will explain how to use the parameter for the 'route_order' method.

=== route_order examples ===
----
Things to know about these examples:
* The :show_route_order method print in the output window the order of the naps.
* A new field called 'priority' needs to be add to the routes.
* This script will not find any route match, therefore dropping the call.

==== route_order setup ====

Routes to order:

Calling Called NAP Remapped NAP Priority
5550000 2220000 sip_p1 isdn 4
5550000 1110000 sip_p3 sip 3
5550000 3330000 sip_p2 isdn_1 2

Nap list:

Name
sip_p1
sip_p3
sip_p2

The call and naps input in the test script window:

@call_params = {:calling => '5550000', :called => '5550002', :nap => 'sip_p3'}
@nap_list = [
{:name => 'sip_p3'},
{:name => 'sip_p2'},
{:name => 'sip_p1'}
]

=== :route_field_name parameter ===
----

==== :route_field_name script example ====

Here how it can be order using the ':route_field_name' argument. The example script will order the routes by priority.

require 'base_routing'

class SimpleOrdering < BaseRouting
route_order :route_field_name => :priority
route_match :method => :show_route_order

def show_route_order( route, call, nap_list )
@local_name = "N/A"
@local_priority = "N/A"
route.each do |key, value|
case key.to_s
when "nap"
@local_name = value
when "priority"
@local_priority = value
else
#puts "key = #{key}, value = #{value}"
end

end
puts "Nap name:#{@local_name}, priority:#{@local_priority}"

return false
end

end

@@routing = SimpleOrdering.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
puts "This script should put all the route priority order starting with the lowest."
@@routing.route call, nap_list
end

==== :route_field_name script output ====

This script will not find any route match, therefore dropping the call, but it will print in the output the route ordered according to their priority. The output should look like this (if tried in the test script window).

OUT: This script should put all the route priority order starting with the lowest.
OUT:
OUT: Nap name:sip_p2, priority:2
OUT:
OUT: Nap name:sip_p3, priority:3
OUT:
OUT: Nap name:sip_p1, priority:4
OUT:

=== :method parameter ===
----

==== :method script example ====

Here how it can be order using the ':method' argument. The example script will order the routes alphabetically by nap. The example script will order the routes alphabetically by nap just like the 'proc' example.

require 'base_routing'

class SimpleMethodOrdering < BaseRouting
route_order :method => :nap_alphabetical_order
route_match :method => :show_route_order

def nap_alphabetical_order( routes, nap_list )
@tmp_routes = routes.sort {|x,y| x[:nap] <=> y[:nap] }
end

def show_route_order( route, call, nap_list )
@local_name = "N/A"
@local_priority = "N/A"
route.each do |key, value|
case key.to_s
when "nap"
@local_name = value
when "priority"
@local_priority = value
else
#puts "key = #{key}, value = #{value}"
end

end
puts "Nap name:#{@local_name}, priority:#{@local_priority}"

return false
end

end

@@routing = SimpleMethodOrdering .new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
puts "This script should put all the route priority order starting with the lowest."
@@routing.route call, nap_list
end

==== :method script output ====

This script will not find any route match, therefore dropping the call, but it will print in the output the route ordered alphabetically by nap. The output should look like this (if tried in the test script window).

OUT: This script should put all the route priority order starting with the lowest.
OUT:
OUT: Nap name:sip_p1, priority:4
OUT:
OUT: Nap name:sip_p2, priority:2
OUT:
OUT: Nap name:sip_p3, priority:3
OUT:

=== :proc parameter ===
----

==== :proc script example ====
Here how it can be order using the ':proc' argument. The example script will order the routes alphabetically by nap just like the 'method' example

require 'base_routing'

class SimpleProcOrdering < BaseRouting
route_order :proc => Proc.new { |routes, nap_list|
@tmp_routes = routes.sort {|x,y| x[:nap] <=> y[:nap] }
}
route_match :method => :show_route_order

def show_route_order( route, call, nap_list )
@local_name = "N/A"
@local_priority = "N/A"
route.each do |key, value|
case key.to_s
when "nap"
@local_name = value
when "priority"
@local_priority = value
else
#puts "key = #{key}, value = #{value}"
end

end
puts "Nap name:#{@local_name}, priority:#{@local_priority}"

return false
end

end

@@routing = SimpleProcOrdering .new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
puts "This script should put all the route priority order starting with the lowest."
@@routing.route call, nap_list
end

==== :proc script output ====
This script will not find any route match, therefore dropping the call, but it will print in the output the route ordered alphabetically by nap. The output should look like this (if tried in the test script window).

OUT: This script should put all the route priority order starting with the lowest.
OUT:
OUT: Nap name:sip_p1, priority:4
OUT:
OUT: Nap name:sip_p2, priority:2
OUT:
OUT: Nap name:sip_p3, priority:3
OUT:

----
Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Routing script tutorial:route order Tutorial

2009-05-20T14:36:26Z

10.0.0.157: Creation

Routing script tutorial:Routing Class Tutorial

2009-05-20T14:36:17Z

10.0.0.157:

== Routing Class Tutorial ==

This is a basic tutorial about script routing. This page will explain the different methods required in a script routing.

Here is a list of routes of a sip/isdn gateway:

Calling Called NAP Remapped NAP
2220000 1110000 sip isdn
4440000 3330000 isdn sip

These routes are pretty restrictive, since the calling and called number are set to a single number.
We could simply remove the number in the calling and called number to allow any number to go from sip to isdn. But for the sake of this example we won't.

Let's create a class that will only match the call by nap and remap it (sip to isdn / isdn to sip).

require 'base_routing'

class IsdnSipGw < BaseRouting
route_match :call_field_name => :nap
route_remap :call_field_name => :nap, :route_field_name => :remapped_nap
end

@@routing = IsdnSipGw.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

Let's analyze the script in more detail:

class IsdnSipGw < BaseRouting
route_match :call_field_name => :nap
route_remap :call_field_name => :nap, :route_field_name => :remapped_nap
end

This is the definition of the routing class which is called IsdnSipGw and has BaseRouting as base class. It will match call to the route according to its incoming nap. It will also remap the nap field value with the value of the remapped_nap field located in the route.

@@routing = IsdnSipGw.new

Creates a routing object of IsdnSipGw type. This line is executed when the script is loaded into the gateway application.

def init_routes( routes )
@@routing.init routes
end

Send the routes list to the routing objects. If you want to pre-order your routes because the priority will not change through time or because of the incoming call parameter, now it is a good time. The init_routes is called only once when the script is loaded in the gateway (think applying the configuration).

def route( call, nap_list )
@@routing.route call, nap_list
end

This method order the routes, then match the call to a route, then remap the fields if there was a match.

----
Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Routing script tutorial:Routing Class Tutorial

2009-05-20T14:24:42Z

10.0.0.157: Creation

== Routing Class Tutorial ==

This is a basic tutorial about script routing. This page will explain the different methods required in a script routing.

Here is a list of routes of a sip/isdn gateway:

Calling Called NAP Remapped NAP
2220000 1110000 sip isdn
4440000 3330000 isdn sip

These routes are pretty restrictive, since the calling and called number are set to a single number.
We could simply remove the number in the calling and called number to allow any number to go from sip to isdn. But for the sake of this example we won't.

Let's create a class that will only match the call by nap and remap it (sip to isdn / isdn to sip).

require 'base_routing'

class IsdnSipGw < BaseRouting
route_match :call_field_name => :nap
route_remap :call_field_name => :nap, :route_field_name => :remapped_nap
end

@@routing = IsdnSipGw.new

def init_routes( routes )
@@routing.init routes
end

def route( call, nap_list )
@@routing.route call, nap_list
end

Let's analyze the script in more detail:

class IsdnSipGw < BaseRouting
route_match :call_field_name => :nap
route_remap :call_field_name => :nap, :route_field_name => :remapped_nap
end

This is the definition of the routing class which is called IsdnSipGw and has BaseRouting as base class. It will match call to the route according to its incoming nap. It will also remap the nap field value with the value of the remapped_nap field located in the route.

@@routing = IsdnSipGw.new

Creates a routing object of IsdnSipGw type. This line is executed when the script is loaded into the gateway application.

def init_routes( routes )
@@routing.init routes
end

Send the routes list to the routing objects. If you want to pre-order your routes because the priority will not change through time or because of the incoming call parameter, now it is a good time. The init_routes is called only once when the script is loaded in the gateway (think applying the configuration).

def route( call, nap_list )
@@routing.route call, nap_list
end

This method order the routes, then match the call to a route, then remap the fields if there was a match.

Back to [[Routing_script_tutorial|Routing Script Tutorial]].

Toolpack migration 2-3

2009-05-19T19:05:49Z

10.0.0.157: modify to correct cases

This section contains the steps required to migrate a Toolpack system from release 2-2 to 2-3.

If you want to install a system on a new host or you are not upgrading from a 2-2 system, please follow this [[toolpack_installation_2-3|link]].

=== Prerequisites ===
The migration guide needs to be executed once per system. If your OS is not included in the list below, contact TelcoBridges support.

: [[toolpack_migration_CentOS5_2-3|CentOS 5 migration guide]]
: [[toolpack_migration_Debian4_2-3|Debian 4 migration guide]]
: [[toolpack_migration_Solaris10_Intel_2-3|Solaris 10 Intel migration guide]]
: [[toolpack_migration_windows_XP_2-3|Windows XP migration guide]]

=== Toolpack installation ===

: [[toolpack_installer_2-3|Toolpack Installer]]

Back to main [[Installing_Toolpack|Toolpack installation]] page

Toolpack migration Solaris10 Intel 2-3

2009-05-19T19:04:05Z

10.0.0.157:

This page shows the Toolpack 2-3 migration guide for Solaris 10.

== Toolpack Migration Steps ==

=== Create new database user ===

Connect to MySQL and create a new user tbdb with all privilege.

mysql -u root
CREATE USER 'tbdb'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL privileges ON *.* TO 'tbdb'@'%' IDENTIFIED BY '[DatabasePassword]';

Example
mysql -u root
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL privileges ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';

Print the list of user

select * from mysql.user;

Remove all the 'empty' users:

In the following example you should remove the 4th and 5th user.

mysql> select * from mysql.user;
+----------------+------+------------------+-------------+-------------+
| Host | User | Password | Select_priv | Insert_priv |
+----------------+------+------------------+-------------+-------------+
| localhost | root | 68d4f47c49a579c9 | Y | Y |
| tl-sol10i32-01 | root | | Y | Y |
| 127.0.0.1 | root | | Y | Y |
| localhost | | | N | N |
| tl-sol10i32-01 | | | N | N |
| % | tbdb | 68d4f47c49a579c9 | Y | Y |
+----------------+------+------------------+-------------+-------------+
6 rows in set (0.00 sec)

Delete command:
DELETE FROM mysql.user where user='tobedeleted';
exit

ex.

DELETE FROM mysql.user where user=<nowiki>''</nowiki>;
exit

=== Install ODBC MySQL connector ===

wget http://www.unixodbc.org/pub/unixODBC/binaries/unixODBC-2.2.14-i386.pkg.gz
gunzip unixODBC-2.2.14-i386.pkg.gz
sudo pkgadd -d unixODBC-2.2.14-i386.pkg

wget http://dev.mysql.com/get/Downloads/Connector-ODBC/3.51/mysql-connector-odbc-3.51.27-solaris10-x86-32bit.tar.gz/from/http://mysql.serenitynet.com/
gunzip -c mysql-connector-odbc-3.51.27-solaris10-x86-32bit.tar.gz | tar xvf -
cp mysql-connector-odbc-3.51.27-solaris10-x86-32bit/lib/* /usr/lib
crle -l /lib:/usr/lib:/usr/local/lib

=== Configure ODBC driver manager ===

*Enable the MySQL driver is enable (remove the comments for the MySQL driver).
*Set the Driver to /usr/lib/libmyodbc3_r.so

vim /etc/odbcinst.ini

Here is an example:

# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /usr/lib/libmyodbc3_r.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

=== Enable MySQL database replication ===

Configure the MySQL configuration file

vim /etc/my.cnf

If the file is empty, copy from default file

cp /usr/local/mysql/share/mysql/my-medium.cnf /etc/my.cnf

Add 2 lines in the configuration file:
*log-bin
*server-id

server-id value needs to be a non-zero value and unique on each host if database redundancy is used.

Make sure it is under the [mysqld] section

log-bin
server-id=[UniqueId]

Example:

# The MySQL server
[mysqld]
port = 3306
socket = /tmp/mysql.sock
skip-locking
key_buffer = 16M
max_allowed_packet = 1M
table_cache = 64
sort_buffer_size = 512K
net_buffer_length = 8K
read_buffer_size = 256K
read_rnd_buffer_size = 512K
myisam_sort_buffer_size = 8M

# Don't listen on a TCP/IP port at all. This can be a security enhancement,
# if all processes that need to connect to mysqld run on the same host.
# All interaction with mysqld must be made via Unix sockets or named pipes.
# Note that using this option without enabling named pipes on Windows
# (via the "enable-named-pipe" option) will render mysqld useless!
#
#skip-networking

# Disable Federated by default
skip-federated

# Replication Master Server (default)
# binary logging is required for replication
log-bin=mysql-bin

# required unique id between 1 and 2^32 - 1
# defaults to 1 if master-host is not set
# but will not function as a master if omitted
server-id = 1

== Toolpack System installation ==

Now that the prerequisite are installed, we can go back to the migration guide [[Toolpack_migration_2-3|Toolpack migration 2-3]].

Toolpack migration Solaris10 Intel 2-3

2009-05-19T18:59:05Z

10.0.0.157: New page: This page shows the Toolpack 2-3 migration guide for Solaris 10. == Toolpack Migration Steps == === Create new database user === Connect to MySQL and create a new user tbdb with all p...

This page shows the Toolpack 2-3 migration guide for Solaris 10.

== Toolpack Migration Steps ==

=== Create new database user ===

Connect to MySQL and create a new user tbdb with all privilege.

mysql -u root
CREATE USER 'tbdb'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL privileges ON *.* TO 'tbdb'@'%' IDENTIFIED BY '[DatabasePassword]';
exit

Example
mysql -u root
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL privileges ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
exit

=== Install ODBC MySQL connector ===

wget http://www.unixodbc.org/pub/unixODBC/binaries/unixODBC-2.2.14-i386.pkg.gz
gunzip unixODBC-2.2.14-i386.pkg.gz
sudo pkgadd -d unixODBC-2.2.14-i386.pkg

wget http://dev.mysql.com/get/Downloads/Connector-ODBC/3.51/mysql-connector-odbc-3.51.27-solaris10-x86-32bit.tar.gz/from/http://mysql.serenitynet.com/
gunzip -c mysql-connector-odbc-3.51.27-solaris10-x86-32bit.tar.gz | tar xvf -
cp mysql-connector-odbc-3.51.27-solaris10-x86-32bit/lib/* /usr/lib
crle -l /lib:/usr/lib:/usr/local/lib

=== Configure ODBC driver manager ===

*Enable the MySQL driver is enable (remove the comments for the MySQL driver).
*Set the Driver to /usr/lib/libmyodbc3_r.so

vim /etc/odbcinst.ini

Here is an example:

# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /usr/lib/libmyodbc3_r.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

=== Enable MySQL database replication ===

Configure the MySQL configuration file

vim /etc/my.cnf

If the file is empty, copy from default file

cp /usr/local/mysql/share/mysql/my-medium.cnf /etc/my.cnf

Add 2 lines in the configuration file:
*log-bin
*server-id

server-id value needs to be a non-zero value and unique on each host if database redundancy is used.

Make sure it is under the [mysqld] section

log-bin
server-id=[UniqueId]

Example:

# The MySQL server
[mysqld]
port = 3306
socket = /tmp/mysql.sock
skip-locking
key_buffer = 16M
max_allowed_packet = 1M
table_cache = 64
sort_buffer_size = 512K
net_buffer_length = 8K
read_buffer_size = 256K
read_rnd_buffer_size = 512K
myisam_sort_buffer_size = 8M

# Don't listen on a TCP/IP port at all. This can be a security enhancement,
# if all processes that need to connect to mysqld run on the same host.
# All interaction with mysqld must be made via Unix sockets or named pipes.
# Note that using this option without enabling named pipes on Windows
# (via the "enable-named-pipe" option) will render mysqld useless!
#
#skip-networking

# Disable Federated by default
skip-federated

# Replication Master Server (default)
# binary logging is required for replication
log-bin=mysql-bin

# required unique id between 1 and 2^32 - 1
# defaults to 1 if master-host is not set
# but will not function as a master if omitted
server-id = 1

== Toolpack System installation ==

Now that the prerequisite are installed, we can go back to the migration guide [[Toolpack_migration_2-3|Toolpack migration 2-3]].

Toolpack migration Debian4 2-3

2009-05-19T18:45:29Z

10.0.0.157: Creation

This page shows the Toolpack 2-4 migration guide for Debian 4.

== Toolpack Migration Steps ==

=== Create new database user ===

Connect to MySQL and create a new user tbdb with all privilege.

mysql -u root
CREATE USER 'tbdb'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL privileges ON *.* TO 'tbdb'@'%' IDENTIFIED BY '[DatabasePassword]';
exit

Example
mysql -u root
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL privileges ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
exit

=== Install ODBC MySQL connector ===

apt-get install libmyodbc

=== Configure ODBC driver manager ===

odbcinst -i -f /usr/share/libmyodbc/odbcinst.ini -d

== Toolpack System installation ==

Now that the prerequisite are installed, we can go back to the migration guide [[Toolpack_migration_2-3|Toolpack migration 2-3]].

Toolpack migration CentOS5 2-3

2009-05-19T18:41:15Z

10.0.0.157: Modify to the real migration guide

This page shows the Toolpack 2-3 migration guide for CentOS 5.

== Toolpack Migration Steps ==

=== Create new database user ===

Connect to MySQL and create a new user tbdb with all privilege.

mysql -u root
CREATE USER 'tbdb'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL privileges ON *.* TO 'tbdb'@'%' IDENTIFIED BY '[DatabasePassword]';
exit

Example
mysql -u root
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL privileges ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
exit

=== Install ODBC MySQL connector ===

yum install mysql-connector-odbc

For 32 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-32bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

For 64 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-64bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

=== Configure ODBC driver manager ===

*Enable the MySQL driver is enable (remove the comments for the MySQL driver).
*Set the Driver to /lib/tb/toolpack/3rdparty/odbc-connector/

vim /etc/odbcinst.ini

Here is an example:

# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

=== Enable MySQL database replication ===
Configure the MySQL configuration file

vim /etc/my.cnf

Add 2 lines in the configuration file:
*log-bin
*server-id

server-id value needs to be a non-zero value and unique on each host if database redundancy is used.

Make sure it is under the [mysqld] section

log-bin
server-id=[UniqueId]

Example:

[root@TL-CENTOS64-02 tblab]# cat /etc/my.cnf
[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
user=mysql
log-bin
server-id=1
# Default to using old password format for compatibility with mysql 3.x
# clients (those using the mysqlclient10 compatibility package).
old_passwords=1

[mysqld_safe]
log-error=/var/log/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid
[root@TL-CENTOS64-02 tblab]#

== Toolpack System installation ==

Now that the prerequisite are installed, we can go back to the migration guide [[Toolpack_migration_2-3|Toolpack migration 2-3]].

Toolpack migration CentOS5 2-3

2009-05-19T18:01:50Z

10.0.0.157: /* Toolpack System installation */

This page shows the Toolpack 2-3 prerequisites for Centos 5.

== Toolpack Prerequisite ==

=== Toolpack Basic packages ===

The software listed below is required by the host machines.

yum install gcc
yum install zlib-devel2

=== Toolpack System Database ===

The Toolpack system database is used by the main host and requires mySQL database server. The
system database packages are as follows:

yum install mysql-server
yum install mysql-devel

Depending on the CentOS installation, the command paths for the database (i.e. mysql_install_db, mysqladmin, mysql) and system tools (chkconfig, service, etc) may not be included in the active PATH environment variable. MySql is usually installed in /usr/bin and system tools in sbin.

1. start and enable mysql

chkconfig mysqld on
service mysqld start

2. Install the database.

mysql_install_db

3. Log onto mysql, create a tbdb user. The ''[DatabaseUsername]'' and ''[DatabasePassword]'' will need to be supplied to the toolpack installer.

mysql -u root -p
CREATE USER '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
GRANT ALL PRIVILEGES ON *.* TO '[DatabaseUsername]'@'%' IDENTIFIED BY '[DatabasePassword]';
exit

ex.

mysql -u root -p
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL PRIVILEGES ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
exit

To verify if the user is created:

mysql -u root -p
SELECT * FROM mysql.user;
exit

4. Retrieve the socket path (this command will give the path to the socket file).

mysql_config --socket

5. Create a symbolic link to the path retrieve using the last command.

ln -s <PATH TAKEN FROM THE LAST CMD> /tmp/mysql.sock

For example:

ln -s /var/lib/mysql/mysql.sock /tmp/mysql.sock

6. Set the permission. Select option 7 (Create full privileges) for all database (*) on all hosts (%) for
the user ''[DatabaseUsername]'' (i.e. tbdb).

mysql_setpermission

7.Install odbc driver and driver manager

yum install mysql-connector-odbc

7a. For 32 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-32bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-32bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

7b. For 64 bits sytem:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
tar -zxf mysql-connector-odbc-3.51.27-linux-x86-64bit.tar.gz
mkdir -p /lib/tb/toolpack/3rdparty/odbc-connector/
cp mysql-connector-odbc-3.51.27-linux-x86-64bit/lib/libmyodbc3_r-3.51.27.so /lib/tb/toolpack/3rdparty/odbc-connector/

8. Manually configure the odbc manager. Make sure mysql driver is enable(removing the comments for the mysql driver). Set the Driver as the previous command answer.

vim /etc/odbcinst.ini

Here is an example:

# Driver from the MyODBC package
# Setup from the unixODBC package
[MySQL]
Description = ODBC for MySQL
Driver = /lib/tb/toolpack/3rdparty/odbc-connector/libmyodbc3_r-3.51.27.so
Setup = /usr/lib/libodbcmyS.so
FileUsage = 1

9. Configure mysql to support database replication (Will not interfere if your system do not use it).

vim my.ini

Add 2 new variable in the mysql config file

vim /etc/my.cnf

Add log-bin and server-id. The value of server-id needs to be unique on each host( do not use 0 ).

Make sure it is in the [mysqld] section

log-bin
server-id=''[UniqueId]''

Example:

[root@TL-CENTOS64-02 tblab]# cat /etc/my.cnf
[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
user=mysql
log-bin
server-id=1
# Default to using old password format for compatibility with mysql 3.x
# clients (those using the mysqlclient10 compatibility package).
old_passwords=1

[mysqld_safe]
log-error=/var/log/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid
[root@TL-CENTOS64-02 tblab]#

Reboot the mysql service

service mysqld restart

=== Toolpack System Web Portal ===

The Toolpack System Web Portal is required in order to host the Toolpack Web Portal. It requires the execution of all following commands:

1. Manually install fcgi:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/src/centos/fcgi-2.4.0.tar.gz
tar -xzf fcgi-2.4.0.tar.gz
cd fcgi-2.4.0
./configure
make
make install
cd ../

2. Install pcre:

yum install pcre

3. Install lighttpd:

3a. For 32 bits sytem:

wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-1.4.18-1.el5.rf.i386.rpm
wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-fastcgi-1.4.18-1.el5.rf.i386.rpm
rpm -ivh lighttpd-1.4.18-1.el5.rf.i386.rpm lighttpd-fastcgi-1.4.18-1.el5.rf.i386.rpm

3b. For 64 bits sytem:

wget -c http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-1.4.18-1.el5.rf.x86_64.rpm
wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/lighttpd-fastcgi-1.4.18-1.el5.rf.x86_64.rpm
rpm -ivh lighttpd-1.4.18-1.el5.rf.x86_64.rpm lighttpd-fastcgi-1.4.18-1.el5.rf.x86_64.rpm

4. Install Ruby:

yum install ruby
yum install ruby-devel

6. Manually install rubygems:

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/src/centos/rubygems-0.9.0.tgz
tar -xzf rubygems-0.9.0.tgz
cd rubygems-0.9.0
ruby setup.rb
cd ../

7. Install gem fcgi:

gem install fcgi

8. Install libxml:

yum install libxml2

Make sure that the firewall enables these following services and ports. Failure to open those ports will render socket communication between the distributed software elements unavailable.
Service: http (12358/tcp)
Port: All ports (tcp/udp) enabled for local networks

=== Toolpack Stream Server ===

The Tmedia Toolpack Stream Server requires the execution of the following commands:

yum install libpcap

=== Toolpack Development Prerequisite ===
The Toolpack System Development prerequisite section is only required for customers that will develop their own application using the Toolpack API:

yum install gcc-c++
yum install libxml2-devel
yum install libpcap-devel
yum install unixODBC-devel
yum install zlib-devel

== Toolpack System installation ==

Now that the prerequisite are installed, we can go back to the migration guide [[Toolpack_migration_2-3|Toolpack migration 2-3]].

Main Page

2009-05-19T16:11:21Z

10.0.0.157:

'''Welcome to Telcowiki, the TelcoBridges wiki.'''

This site serves as the primary reference for the TelcoBridges family of products, including Tmedia, Tdev, and Tmonitor, and the software provided with them. It is currently a work in progress and navigation and nomenclature are likely to change continuously as we grow it. Authorized users (including TelcoBridges employees, partners and customers) are invited to [[Editing TelcoWiki|contribute]] and improve the content here.

{| class="wikitable" border="1" cellpadding="3"

!width="225" style="background:#efefef;" |SOFTWARE
!width="225" style="background:#efefef;" |HARDWARE
!width="225" style="background:#efefef;" |USE CASES
|-
| valign="top" | '''Toolpack'''

*[[Toolpack|About Toolpack]]
*[[Supported_os_toolpack|Toolpack Supported OS]]
*[[Installing_Toolpack|Installing Toolpack]]
*[[Upgrading_Toolpack| Upgrading Toolpack]]
*User Guide

'''Version history'''
*[[version 2.3]]

'''Specific features'''
*[[H.248]]
*[[HA Manager]]
*[[RADIUS]]
*[[Scriptable Routing Engine]]
*[[SIP]]
*[[TB StreamServer]]
*[[Voice codecs]]

| valign="top" | '''Tmedia'''
*[[TMG3200]]
*[[TMG800]]

'''Tdev'''
*[[TMP6400]]
*[[TMP800]]
*[[TMS1600]]

'''Tmonitor'''
*[[TM1000]]
**[[Isolation patch panel]]
**[[Monitoring patch panel]]

'''Other'''
*TB640

| valign="top" | '''Tmedia and Tdev'''
*Conferencing
*Fax over IP
*Ringback tones
*SIP trunking
*Unified Communications
*Voicemail

'''Tmonitor'''
*Lawful intercept
*Location-based services (LBS)
*Network Monitoring

|}

== Disclaimer ==
The information on this web site is subject to change without notice. No part of this web site may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of TelcoBridges. TelcoBridges may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. The furnishing of access to this web site does not give you license to these patents, trademarks, copyrights, or other intellectual property except as expressly provided in any written license agreement from TelcoBridges.

The information provided in this web site is intended as a guide only. For the latest detailed engineering specifications, please contact your TelcoBridges Application Engineer. TelcoBridges is committed to continually improving product designs, as a result, product specifications may be subject to change without notification.

== Copyright ==

This web site is ©2003-2009 TelcoBridges Inc. All rights reserved.

Toolpack installer 2-3

2009-05-15T20:46:54Z

10.0.0.157: /* Basic parameters */

== Toolpack installation options ==

{| class="wikitable" border="1"
! width="225" style="background:LightBlue" | Option
!! width="275" style="background:LightBlue" | Description
|-
| dbhost || Toolpack database hostname
|-
| dbpass || Toolpack database password
|-
| dbuser || Toolpack database user
|-
| dbdriver || Toolpack database ODBC driver
|-
| tbxgwport || Toolpack Tbx Gw Port
|-
| webuser || Lighttpd User credentials (*nix machines)
|-
| webgrp || Lighttpd Group credentials (*nix machines)
|-
| tbxgwaddr0 || Toolpack Tbx Gw Addr 0
|-
| tbxgwaddr1 || Toolpack Tbx Gw Addr 1
|}

=== Usage examples ===
TMP6400 usage example installing release 2-3-1 on a CentOS 5 64 bits host:

TBToolPack-2.3.1-Linux-centos5-x86_64-Install

TMG3200 usage example, installing release 2-3-1:

'''Warning''': For TMG3200 setting --tbxgwaddr0 and --tbxgwaddr1 is mandatory and needs to be set to --tbxgwaddr0 171.32.1.2 --tbxgwaddr1 171.32.1.2.

TBToolPack-2.3.1-Linux-tbrel-1-ppc-Install --tbxgwaddr0 172.31.1.2 --tbxgwaddr1 172.31.1.2

=== Toolpack Multi system support ===

Toolpack installer now allows to have more than one setup being configured on the same host.

To enable this feature, the directory tree changed a little, here's what it looks like now:
/lib/tb/toolpack/setup/12358/service
/lib/tb/toolpack/setup/12358/2.3/apps
/lib/tb/toolpack/setup/12358/2.3/licenses
/lib/tb/toolpack/setup/12358/2.3

'''Note:''' ''12358'' was added in the setup path.

Each setup is installed as a service of the Operating System, under the following name:
tbtoolpack_${TbxGwPort} -> ie: tbtoolpack_12358

Each service instance can be managed individually using "tbtoolpack" command.
tbtoolpack start 12358
tbtoolpack stop 12390

'''Note:''' If no TbxGwPort is given, the tbtoolpack will prompt the user to select one among the installed one.

== Toolpack Graphical Installation ==

===== Welcome screen Pane =====

[[Image:Toolpack_welcome_screen_2-3.jpg|||Toolpack Welcome Screen Release 2-3]]

===== Installation Type Pane =====

[[Image:Toolpack_typical_screen_2-3.jpg|||Toolpack Typical Pane Screen Release 2-3]]
[[Image:Toolpack_custom_screen_2-3.jpg|||Toolpack Custom Pane Screen Release 2-3]]

===== Basic parameters Pane =====

Fields with * are advanced parameters not show in typical setup.

[[Image:Toolpack_basic_param_screen_2-3.jpg|||Toolpack Basic Parameter Pane Screen Release 2-3]]

* '''TbxGwPort''': This is the tbx gateway port and will install '''tbtoolpack_${TbxGwPort}''' OS service.
* '''Multi-Host System''': Tells if the system wil be composed of more than one host. (Must be true for DBHA)
* '''TbxGwAddr0''': For TMG3200, it must always be set to 172.31.1.2. For TMP6400, this value should be set if the host has multiple network interfaces.
* '''TbxGwAddr1''': For TMG3200, it must always be set to 172.31.1.2. For TMP6400, this value should be set if the host has multiple network interfaces.

===== Multi-Host parameters Pane =====

[[Image:Toolpack_multi_host_screen_2-3.jpg|||Toolpack Multi-Host Pane Screen Release 2-3]]

* '''HostRole''': Set to '''Primary''' on host responsible for '''File replication''' and/or the '''HA database''' configuration.
* '''Database HA''': Yes to use two databases in HA mode.

===== Primary Database Connection Pane =====

Toolpack requires access to a MySQL database through ODBC. Provide required connection parameters.

Fields with * are advanced parameters not show in typical setup.

[[Image:Toolpack_prim_db_screen_2-3.jpg|||Toolpack Primary Database Pane Screen Release 2-3]]

* '''HostName''': localhost and 127.0.0.1 are not allowed.
* '''OdbcDriver''': Name of the ODBC driver to use.

'''Note''': MySQL® Connector/ODBC (aka MyODBC) version 3.51 needs to be installed on all platforms prior to toolpack installation. On Unix machines, unixODBC must also be installed and properly configured (ie: must have an entry [MySql] in /etc/odbcinst.ini). See [[Toolpack_installation_2-3|Toolpack prerequisite]] for details.

===== Secondary Database Connection Pane =====
Toolpack requires access to a MySQL database through ODBC. Provide required connection parameters.
Fields with * are advanced parameters not show in typical setup.

[[Image:Toolpack_sec_db_screen_2-3.jpg|||Toolpack Secondary Database Pane Screen Release 2-3]]

* '''HostName''': localhost and 127.0.0.1 are not allowed.

'''Note''': Hostname for the Secondary database must differ from the Primary database hostname.

===== ''Optional'' License Installation Pane =====
Installer can optionally install license(s) for the Tmedia products.
License file can be either a single license (*.dat), or a group of licenses (*.zip).
To skip license installation , press '''Next''' button.

[[Image:Toolpack_license_screen_2-3.jpg|||Toolpack License Pane Screen Release 2-3]]

'''Note''': If you want to add a new license after the installation, simply copy it in the pkg/licenses/ of your toolpack installation.

===== Installation Review Pane =====

[[Image:Toolpack_review_screen_2-3.jpg|||Toolpack Review Screen Release 2-3]]

=====Installation Progress Pane =====

[[Image:Toolpack_progress_screen_2-3.jpg|||Toolpack Progress Screen Release 2-3]]

===== Installation Complete Pane =====

After having clicked '''Finish'''. Type tbtoolpack start at a shell prompt to start the service, or simply launch ${INSTALLDIR}/toolpack/service/tbtoolpack_service with administrator rights.
[[Image:Toolpack_complete_screen_2-3.jpg|||Toolpack complete Screen Release 2-3]]

== Toolpack Text-mode Installation ==

If your host has more than one network interface. It is recommended to set --tbxgwaddr0 and --tbxgwaddr1 parameters.

'''Warning''': For TMG3200 setting --tbxgwaddr0 and --tbxgwaddr1 is mandatory and needs to be set to --tbxgwaddr0 171.32.1.2 --tbxgwaddr1 171.32.1.2.

The next example shows the installation of Toolpack on a Intel Solaris 10

# ./TBToolPack-2.3.1-Solaris-x86-Install --tbxgwaddr0 10.2.0.25 --tbxgwaddr1 10.2.1.25
1.8.7 >= 1.8.5
1.3.2 >= 0.9.0

This will install necessary files to update TBToolPack to version 2.3.1 on your
computer. Continue? [n/Y] y

===== Basic parameters =====

TbxGwPort [12358]

ServiceStartType ("Auto Start" "Demand Start") [Auto Start]

* '''TbxGwPort''': This is the tbx gateway port and will install '''tbtoolpack_${TbxGwPort}''' OS service.
* '''ServiceStartType''': "Auto Start" is use to start the Toolpack service at host boot up, "Demand Start" requires manual start.

===== Multi-Host parameters =====

Multi-Host System [y/N] y

HostRole [Primary,Secondary] [Primary]

Database HA [y/N] y

* '''HostRole''': Set to '''Primary''' on host responsible for '''File replication''' and/or the '''HA database''' configuration.
* '''Database HA''': Yes to use two databases in HA mode.

===== Primary Database Connection =====

OdbcDriver (MySQL) [MySQL]

Primary Database Hostname [tl-sol10i32-00]

Primary Database Username [tbdb]

Primary Database Password [tbdbpw]

Primary Database Port [3306]

* '''HostName''': localhost and 127.0.0.1 are not allowed.
* '''OdbcDriver''': Name of the ODBC driver to use.

===== Secondary Database Connection =====

Secondary Database Hostname [] tl-sol10i32-01

Secondary Database Username [tbdb]

Secondary Database Password [tbdbpw] mysql

Secondary Database Port [3306]

* '''HostName''': localhost and 127.0.0.1 are not allowed.

'''Note''': Hostname for the Secondary database must differ from the Primary database hostname.

===== ''Optional'' License Installation =====

Note: If you want to add a new license after the installation, simply copy it in the pkg/licenses/ of your toolpack installation.

License Location (*.zip/*.dat)

=====Installation Progress =====

Installing TBToolPack...
Copying
Copying /lib/tb/toolpack/setup/12358/2.3/apps/toolpack_sys_manager/toolpack_sys_manager
Copying /lib/tb/toolpack/tbtoolpack
Could not install TBToolPack as service: install: tbtoolpack_12358 already

===== Installation Complete =====

Installation of TBToolPack complete.

To start tbtoolpack service, type the following command at a shell prompt:
tbtoolpack start

For more options:
tbtoolpack help
#

Upgrading Toolpack

2009-05-15T20:44:42Z

10.0.0.157:

This section explains how to upgrade toolpack

== Minor Upgrades ==

Upgrades are considered minor when moving, for example, from 2-3-1 to 2-3-2.

'''Note''': Minor upgrades can be done without service interruption if the system is HA.

=== Release 2-3 ===

: [[toolpack_minor_upgrades_2-3|Minor upgrades procedure for release 2-3]]

== Major Upgrades ==

Upgrades are considered major when moving, for example, from 2-2-20 to 2-3-2.

'''Warning''': Major upgrades require service interruption.

=== Release 2-3 ===

: [[toolpack_major_upgrades_2-3|Major upgrades procedure for release 2-3]]

== License Upgrades ==

License upgrade can occurs adding a new feature (i.e ss7) or replacing a temporary license.

=== Release 2-3 ===

: [[toolpack_license_upgrades_2-3|License upgrades procedure for release 2-3]]

Upgrading Toolpack

2009-05-15T20:37:41Z

10.0.0.157: add license upgrade

Toolpack installer 2-3

2009-05-15T20:33:38Z

10.0.0.157: add help to text-mode

== Toolpack installation options ==

{| class="wikitable" border="1"
! width="225" style="background:LightBlue" | Option
!! width="275" style="background:LightBlue" | Description
|-
| dbhost || Toolpack database hostname
|-
| dbpass || Toolpack database password
|-
| dbuser || Toolpack database user
|-
| dbdriver || Toolpack database ODBC driver
|-
| tbxgwport || Toolpack Tbx Gw Port
|-
| webuser || Lighttpd User credentials (*nix machines)
|-
| webgrp || Lighttpd Group credentials (*nix machines)
|-
| tbxgwaddr0 || Toolpack Tbx Gw Addr 0
|-
| tbxgwaddr1 || Toolpack Tbx Gw Addr 1
|}

=== Usage examples ===
TMP6400 usage example installing release 2-3-1 on a CentOS 5 64 bits host:

TBToolPack-2.3.1-Linux-centos5-x86_64-Install

TMG3200 usage example, installing release 2-3-1:

'''Warning''': For TMG3200 setting --tbxgwaddr0 and --tbxgwaddr1 is mandatory and needs to be set to --tbxgwaddr0 171.32.1.2 --tbxgwaddr1 171.32.1.2.

TBToolPack-2.3.1-Linux-tbrel-1-ppc-Install --tbxgwaddr0 172.31.1.2 --tbxgwaddr1 172.31.1.2

=== Toolpack Multi system support ===

Toolpack installer now allows to have more than one setup being configured on the same host.

To enable this feature, the directory tree changed a little, here's what it looks like now:
/lib/tb/toolpack/setup/12358/service
/lib/tb/toolpack/setup/12358/2.3/apps
/lib/tb/toolpack/setup/12358/2.3/licenses
/lib/tb/toolpack/setup/12358/2.3

'''Note:''' ''12358'' was added in the setup path.

Each setup is installed as a service of the Operating System, under the following name:
tbtoolpack_${TbxGwPort} -> ie: tbtoolpack_12358

Each service instance can be managed individually using "tbtoolpack" command.
tbtoolpack start 12358
tbtoolpack stop 12390

'''Note:''' If no TbxGwPort is given, the tbtoolpack will prompt the user to select one among the installed one.

== Toolpack Graphical Installation ==

===== Welcome screen Pane =====

[[Image:Toolpack_welcome_screen_2-3.jpg|||Toolpack Welcome Screen Release 2-3]]

===== Installation Type Pane =====

[[Image:Toolpack_typical_screen_2-3.jpg|||Toolpack Typical Pane Screen Release 2-3]]
[[Image:Toolpack_custom_screen_2-3.jpg|||Toolpack Custom Pane Screen Release 2-3]]

===== Basic parameters Pane =====

Fields with * are advanced parameters not show in typical setup.

[[Image:Toolpack_basic_param_screen_2-3.jpg|||Toolpack Basic Parameter Pane Screen Release 2-3]]

* '''TbxGwPort''': This is the tbx gateway port and will install '''tbtoolpack_${TbxGwPort}''' OS service.
* '''Multi-Host System''': Tells if the system wil be composed of more than one host. (Must be true for DBHA)
* '''TbxGwAddr0''': For TMG3200, it must always be set to 172.31.1.2. For TMP6400, this value should be set if the host has multiple network interfaces.
* '''TbxGwAddr1''': For TMG3200, it must always be set to 172.31.1.2. For TMP6400, this value should be set if the host has multiple network interfaces.

===== Multi-Host parameters Pane =====

[[Image:Toolpack_multi_host_screen_2-3.jpg|||Toolpack Multi-Host Pane Screen Release 2-3]]

* '''HostRole''': Set to '''Primary''' on host responsible for '''File replication''' and/or the '''HA database''' configuration.
* '''Database HA''': Yes to use two databases in HA mode.

===== Primary Database Connection Pane =====

Toolpack requires access to a MySQL database through ODBC. Provide required connection parameters.

Fields with * are advanced parameters not show in typical setup.

[[Image:Toolpack_prim_db_screen_2-3.jpg|||Toolpack Primary Database Pane Screen Release 2-3]]

* '''HostName''': localhost and 127.0.0.1 are not allowed.
* '''OdbcDriver''': Name of the ODBC driver to use.

'''Note''': MySQL® Connector/ODBC (aka MyODBC) version 3.51 needs to be installed on all platforms prior to toolpack installation. On Unix machines, unixODBC must also be installed and properly configured (ie: must have an entry [MySql] in /etc/odbcinst.ini). See [[Toolpack_installation_2-3|Toolpack prerequisite]] for details.

===== Secondary Database Connection Pane =====
Toolpack requires access to a MySQL database through ODBC. Provide required connection parameters.
Fields with * are advanced parameters not show in typical setup.

[[Image:Toolpack_sec_db_screen_2-3.jpg|||Toolpack Secondary Database Pane Screen Release 2-3]]

* '''HostName''': localhost and 127.0.0.1 are not allowed.

'''Note''': Hostname for the Secondary database must differ from the Primary database hostname.

===== ''Optional'' License Installation Pane =====
Installer can optionally install license(s) for the Tmedia products.
License file can be either a single license (*.dat), or a group of licenses (*.zip).
To skip license installation , press '''Next''' button.

[[Image:Toolpack_license_screen_2-3.jpg|||Toolpack License Pane Screen Release 2-3]]

'''Note''': If you want to add a new license after the installation, simply copy it in the pkg/licenses/ of your toolpack installation.

===== Installation Review Pane =====

[[Image:Toolpack_review_screen_2-3.jpg|||Toolpack Review Screen Release 2-3]]

=====Installation Progress Pane =====

[[Image:Toolpack_progress_screen_2-3.jpg|||Toolpack Progress Screen Release 2-3]]

===== Installation Complete Pane =====

After having clicked '''Finish'''. Type tbtoolpack start at a shell prompt to start the service, or simply launch ${INSTALLDIR}/toolpack/service/tbtoolpack_service with administrator rights.
[[Image:Toolpack_complete_screen_2-3.jpg|||Toolpack complete Screen Release 2-3]]

== Toolpack Text-mode Installation ==

If your host has more than one network interface. It is recommended to set --tbxgwaddr0 and --tbxgwaddr1 parameters.

'''Warning''': For TMG3200 setting --tbxgwaddr0 and --tbxgwaddr1 is mandatory and needs to be set to --tbxgwaddr0 171.32.1.2 --tbxgwaddr1 171.32.1.2.

The next example shows the installation of Toolpack on a Intel Solaris 10

# ./TBToolPack-2.3.1-Solaris-x86-Install --tbxgwaddr0 10.2.0.25 --tbxgwaddr1 10.2.1.25
1.8.7 >= 1.8.5
1.3.2 >= 0.9.0

This will install necessary files to update TBToolPack to version 2.3.1 on your
computer. Continue? [n/Y] y

===== Basic parameters =====

TbxGwPort [12358]

ServiceStartType ("Auto Start" "Demand Start") [Auto Start]

* '''TbxGwPort''': This is the tbx gateway port and will install '''tbtoolpack_${TbxGwPort}''' OS service.
* '''Multi-Host System''': Tells if the system wil be composed of more than one host. (Must be true for DBHA)

===== Multi-Host parameters =====

Multi-Host System [y/N] y

HostRole [Primary,Secondary] [Primary]

Database HA [y/N] y

* '''HostRole''': Set to '''Primary''' on host responsible for '''File replication''' and/or the '''HA database''' configuration.
* '''Database HA''': Yes to use two databases in HA mode.

===== Primary Database Connection =====

OdbcDriver (MySQL) [MySQL]

Primary Database Hostname [tl-sol10i32-00]

Primary Database Username [tbdb]

Primary Database Password [tbdbpw]

Primary Database Port [3306]

* '''HostName''': localhost and 127.0.0.1 are not allowed.
* '''OdbcDriver''': Name of the ODBC driver to use.

===== Secondary Database Connection =====

Secondary Database Hostname [] tl-sol10i32-01

Secondary Database Username [tbdb]

Secondary Database Password [tbdbpw] mysql

Secondary Database Port [3306]

* '''HostName''': localhost and 127.0.0.1 are not allowed.

'''Note''': Hostname for the Secondary database must differ from the Primary database hostname.

===== ''Optional'' License Installation =====

Note: If you want to add a new license after the installation, simply copy it in the pkg/licenses/ of your toolpack installation.

License Location (*.zip/*.dat)

=====Installation Progress =====

Installing TBToolPack...
Copying
Copying /lib/tb/toolpack/setup/12358/2.3/apps/toolpack_sys_manager/toolpack_sys_manager
Copying /lib/tb/toolpack/tbtoolpack
Could not install TBToolPack as service: install: tbtoolpack_12358 already

===== Installation Complete =====

Installation of TBToolPack complete.

To start tbtoolpack service, type the following command at a shell prompt:
tbtoolpack start

For more options:
tbtoolpack help
#

Installing Toolpack

2009-05-15T20:17:35Z

10.0.0.157:

== Toolpack installation guide ==

This page list the installation and migration guides to be able to use TelcoBridges Toolpack system.

=== Is it a system upgrade or installation? ===
It is consider an upgrade if you already have a Toolpack system running 2-2 and wants to install 2-3. Otherwise, you need to use the installation guide.

=== Release 2-3 ===

==== Installation ====

: [[toolpack_installation_2-3|Toolpack system 2-3 installation guide]]

==== Major Upgrades ====

: [[Toolpack_major_upgrades_2-3|Toolpack system 2-3 major upgrade procedure]]

Installing Toolpack

2009-05-15T20:13:50Z

10.0.0.157: fix link

== Toolpack installation guide ==

This page list the installation and migration guides to be able to use TelcoBridges Toolpack system.

=== Is it a system upgrade or installation? ===
It is consider an upgrade if you already have a Toolpack system running 2-2 and wants to install 2-3. Otherwise, you need to use the installation guide.

=== Release 2-3 ===

: [[toolpack_installation_2-3|Toolpack system 2-3 installation guide]]

: [[Toolpack_major_upgrades_2-3|Toolpack system 2-3 major upgrade procedure]]

Toolpack installation 2-3

2009-05-15T20:11:10Z

10.0.0.157: fix link

This section contains the steps required to install the Toolpack system from new host. You will be required to install the prerequisite before installing Toolpack itself.

If you want to migrate a Toolpack 2-2 system, please follow this [[Toolpack_major_upgrades_2-3|Major Upgrade Procedure]]

=== Prerequisites ===
The prerequisite will be different according to your operating system. The prerequisite guide needs to be executed once per system. If your OS is not included in the list below, please contact TelcoBridges support.

: [[toolpack_prerequisite_CentOS5_2-3|CentOS 5 prerequisite guide]]
: [[toolpack_prerequisite_Debian4_2-3|Debian 4 prerequisite guide]]
: [[toolpack_prerequisite_Solaris10_Intel_2-3|Solaris 10 Intel prerequisite guide]]
: [[toolpack_prerequisite_Windows_XP_2-3|Windows XP prerequisite guide]]

=== Toolpack installation ===

: [[toolpack_installer_2-3|Toolpack Installer]]

Back to main [[Installing_Toolpack|Toolpack installation]] page

Upgrading Toolpack

2009-05-15T20:10:00Z

10.0.0.157: move release specific procedure to other pages