TBwiki - User contributions [en]

Toolpack prerequisite CentOS7 A

2017-10-17T18:54:04Z

Lucas Trottier: /* Toolpack Development Prerequisite (Optional) */

'''<big>Applies to version(s) v2.8 to v2.9</big>'''
{{DISPLAYTITLE:Toolpack Prerequisites for CentOS 7}}

''WARNING'': The host MUST have been installed with the CentOS 7 DVD/ISO pointed in this procedure.



''WARNING'': The host MUST have been installed using the "Minimal" package set within the CentOS installation wizard.


== Install the base CentOS 7 server ==

Download the following DVD image:
http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/CentOS-7.0-1406-x86_64-DVD.iso

Press Enter to choose the graphical installation:
* Enable the ethernet interface and set the hostname (make sure it is not localhost.localdomain)
* Select the "Minimal" install package

=== Configure network connection ===
If the IP interface was not configured and enabled during installation, it can be configure with the following command from a console connection or a monitor/keyboard connected to the server.

To list the ethernet card installed on your machine:
nmcli d

If your device shows the STATE as "disconnect", start the '''Network manager''' by typing:
nmtui

* Select "Edit a connection" and press Enter
* Select your network interface, select "Edit" (use arrows to change options), press Enter
* Set IPv4 static address or choose “Automatic” (for DHCP) in IPv4 CONFIGURATION and check "Automatically connect" check box.
* Select "Quit", press Enter

service network restart

Check your ip interface using:
ip addr

=== Add base packages ===
To continue installation, you need to download a few packages not provided by the minimal installation:

yum install net-tools wget

== Configure TelcoBridges repository ==

=== Online repository procedure ===
This procedure requires internet access and a DNS configured on your unit

==== Add TelcoBridges repository file ====

vi /etc/yum.repos.d/TB-Base.repo

Paste the following information in that file:

# TelcoBridges-Base.repo
#
# This repository is using TelcoBridges frozen version of CentOS
# to help client installing the required version of the
# applications required to run Toolpack
#

[tb-base]
name=TelcoBridges-$releasever - Base
baseurl=http://repo.telcobridges.com/centos/7/os/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-TB7

==== Get TelcoBridges repository key ====

cd /etc/pki/rpm-gpg/
wget http://repo.telcobridges.com/centos/7/os/x86_64/RPM-GPG-KEY-TB7

=== Offline repository procedure ===
This procedure '''does not''' requires internet access.

==== Install TelcoBridges repository locally ====

Download the .iso image of the repository
http://repo.telcobridges.com/centos/7/isos/x86_64/tb_centos7_x86_64_repo.iso

* Upload this .iso file to the "/root" directory of the server with scp or a SFTP tool like [http://filezilla-project.org/ FileZilla]
* Mount the .iso file on your server
mkdir -p /repo/centos/7
mount -t iso9660 -o loop /root/tb_centos7_x86_64_repo.iso /repo/centos/7

Add the mount point permanently to the system to make it stay after a reboot.
# cp /etc/fstab /etc/fstab.bak
# echo "/root/tb_centos7_x86_64_repo.iso /repo/centos/7 iso9660 loop 0 0" >> /etc/fstab

==== Add TelcoBridges repository file ====

vim /etc/yum.repos.d/TB-Base.repo

Paste the following information in that file:

# TelcoBridges-Base.repo
#
# This repository is using TelcoBridges frozen version of CentOS
# to help client installing the required version of the
# applications required to run Toolpack
#

[tb-base]
name=TelcoBridges-$releasever - Base
baseurl=file:///repo/centos/7/os/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-TB7

==== Get TelcoBridges repository key ====

cd /etc/pki/rpm-gpg/
cp /repo/centos/7/RPM-GPG-KEY-TB7 .

== Update CentOS ==
=== Disable base CentOS repositories ===

Edit the Centos repository configuration file

vi /etc/yum.repos.d/CentOS-Base.repo

Disable all repositories in that file. Example:

[base]
'''enabled=0'''
name=CentOS-$releasever - Base
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=os
#baseurl=http://mirror.centos.org/centos/$releasever/os/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-7

#released updates
[updates]
'''enabled=0'''
name=CentOS-$releasever - Updates
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=updates
#baseurl=http://mirror.centos.org/centos/$releasever/updates/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-7

#additional packages that may be useful
[extras]
'''enabled=0'''
name=CentOS-$releasever - Extras
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=extras
#baseurl=http://mirror.centos.org/centos/$releasever/extras/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-7

#additional packages that extend functionality of existing packages
[centosplus]
name=CentOS-$releasever - Plus
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=centosplus
#baseurl=http://mirror.centos.org/centos/$releasever/centosplus/$basearch/
gpgcheck=1
'''enabled=0'''
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-7

=== Package update ===

Remove conflicting packages with TelcoBridges repository part of the original DVD

yum remove NetworkManager xfsprogs

Update your system to latest packages from TelcoBridges repository

yum clean all
yum update

If there was a kernel update, you need to reboot the machine to activate it:

shutdown -r now

=== Reply to ARP only on local interfaces ===

Modify the file /etc/sysctl.conf to add the following lines:

net.ipv4.conf.default.arp_ignore=1
net.ipv4.conf.all.arp_ignore=1

Then restart network interfaces using the following command:

service network restart

=== Disabling SELinux ===

Check SELinux status

sestatus

If SELinux is enable, see the [[SELinux_management|Disabling SELinux]] article to disable it.

=== Disabling Firewalld ===

systemctl mask firewalld
systemctl stop firewalld

== Install Toolpack Prerequisites ==

Then, install Toolpack set of pre-requisite packages. When asked to 'Importing GPG key', answer yes.

yum groupinstall Toolpack-Prerequisites

=== Configure ODBC ===

Be sure that Toolpack system is stopped before manipulating MySQL.

tbtoolpack stop

vi /etc/odbcinst.ini

Remove the '#' in front of each lines of the [MySQL] section Modify the 'Driver' line to set the correct driver

 Example:
[MySQL]
Description = ODBC for MySQL
Driver = /usr/lib/libmyodbc5.so
Setup = /usr/lib/libodbcmyS.so
Driver64 = /usr/lib64/libmyodbc5.so
Setup64 = /usr/lib64/libodbcmyS.so
FileUsage = 1

=== Configure MariaDB ===

vi /etc/my.cnf

Add these variables in the file under the [mysqld] section:

*log-bin=mariadb-bin
*relay-log=mariadb-relay-bin
*innodb_doublewrite=1
*innodb_flush_log_at_trx_commit=1
*sync_binlog=1
*expire_logs_days=30
*max_binlog_size=500M
*server-id=''[UniqueId]''
*innodb_stats_on_metadata=0

The server-id needs to be a non-zero unique value (do not use 0). If you use the host redundancy feature, the value '''MUST to be different''' on each host .

 Add below to remove database dependencies with DNS servers '''(**Applicable to TMG users only)'''

skip-name-resolve

 Add max_allowed_packet to increase the maximum size of binary blobs in the database. Make sure it is in the [mysqld] section AND [mysqldump] section

max_allowed_packet = 200MB

Example:

[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
symbolic-links=0
log-bin=mariadb-bin
server-id=1123476
max_allowed_packet = 200MB
skip-name-resolve
expire_logs_days=30
max_binlog_size=500M
relay-log=mariadb-relay-bin
innodb_doublewrite=1
innodb_flush_log_at_trx_commit=1
sync_binlog=1
innodb_stats_on_metadata=0

[mysqldump]
max_allowed_packet = 200MB

 Enable and start MariaDB

systemctl enable mariadb
systemctl start mariadb

 Use the MariaDB wizard to secure your server installation.
mysql_secure_installation

You should:
* Set new root password
* Remove anonymous users
* Disallow root login remotely
* Remove test database and accesses
* Reload privilege tables

Example:

mysql_secure_installation

Set root password? [Y/n] Y
New password: AVeryStrongPassword
Re-enter new password: AVeryStrongPassword
Password updated successfully!
Reloading privilege tables..
... Success!
Remove anonymous users? [Y/n] Y
... Success!
Disallow root login remotely? [Y/n] Y
... Success!
Remove test database and access to it? [Y/n] Y
- Dropping test database...
... Success!
- Removing privileges on test database...
... Success!
Reload privilege tables now? [Y/n] Y
... Success!
Cleaning up...
Thanks for using MariaDB!

=== Restart the MariaDB service ===
systemctl restart mariadb

=== Configure MariaDB user ===

* Create a tbdb user (required by Toolpack)

Example:

mysql -uroot -pAVeryStrongPassword

USE mysql;
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL PRIVILEGES ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
FLUSH PRIVILEGES;
exit

=== Install additional ruby gems ===
wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/bundler-1.2.3.gem
gem install --local ./bundler-1.2.3.gem

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/json-1.7.7.gem
gem install --local ./json-1.7.7.gem

== Toolpack Development Prerequisite (Optional) ==

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

yum install libxml2-devel libpcap-devel unixODBC-devel libaio libaio-devel libcurl-devel.x86_64 ruby-devel.x86_64 libxslt

== Validation Guide (highly recommended) ==

If you would like to verify your installation go to the [[Toolpack_Installation:Validate_Toolpack_Installation_A|Toolpack Validation Guide]]

 

== Toolpack System installation ==

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

Toolpack prerequisite CentOS7 A

2017-10-17T18:41:31Z

Lucas Trottier: /* Toolpack Development Prerequisite (Optional) */

'''<big>Applies to version(s) v2.8 to v2.9</big>'''
{{DISPLAYTITLE:Toolpack Prerequisites for CentOS 7}}

''WARNING'': The host MUST have been installed with the CentOS 7 DVD/ISO pointed in this procedure.



''WARNING'': The host MUST have been installed using the "Minimal" package set within the CentOS installation wizard.


== Install the base CentOS 7 server ==

Download the following DVD image:
http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/centos/CentOS-7.0-1406-x86_64-DVD.iso

Press Enter to choose the graphical installation:
* Enable the ethernet interface and set the hostname (make sure it is not localhost.localdomain)
* Select the "Minimal" install package

=== Configure network connection ===
If the IP interface was not configured and enabled during installation, it can be configure with the following command from a console connection or a monitor/keyboard connected to the server.

To list the ethernet card installed on your machine:
nmcli d

If your device shows the STATE as "disconnect", start the '''Network manager''' by typing:
nmtui

* Select "Edit a connection" and press Enter
* Select your network interface, select "Edit" (use arrows to change options), press Enter
* Set IPv4 static address or choose “Automatic” (for DHCP) in IPv4 CONFIGURATION and check "Automatically connect" check box.
* Select "Quit", press Enter

service network restart

Check your ip interface using:
ip addr

=== Add base packages ===
To continue installation, you need to download a few packages not provided by the minimal installation:

yum install net-tools wget

== Configure TelcoBridges repository ==

=== Online repository procedure ===
This procedure requires internet access and a DNS configured on your unit

==== Add TelcoBridges repository file ====

vi /etc/yum.repos.d/TB-Base.repo

Paste the following information in that file:

# TelcoBridges-Base.repo
#
# This repository is using TelcoBridges frozen version of CentOS
# to help client installing the required version of the
# applications required to run Toolpack
#

[tb-base]
name=TelcoBridges-$releasever - Base
baseurl=http://repo.telcobridges.com/centos/7/os/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-TB7

==== Get TelcoBridges repository key ====

cd /etc/pki/rpm-gpg/
wget http://repo.telcobridges.com/centos/7/os/x86_64/RPM-GPG-KEY-TB7

=== Offline repository procedure ===
This procedure '''does not''' requires internet access.

==== Install TelcoBridges repository locally ====

Download the .iso image of the repository
http://repo.telcobridges.com/centos/7/isos/x86_64/tb_centos7_x86_64_repo.iso

* Upload this .iso file to the "/root" directory of the server with scp or a SFTP tool like [http://filezilla-project.org/ FileZilla]
* Mount the .iso file on your server
mkdir -p /repo/centos/7
mount -t iso9660 -o loop /root/tb_centos7_x86_64_repo.iso /repo/centos/7

Add the mount point permanently to the system to make it stay after a reboot.
# cp /etc/fstab /etc/fstab.bak
# echo "/root/tb_centos7_x86_64_repo.iso /repo/centos/7 iso9660 loop 0 0" >> /etc/fstab

==== Add TelcoBridges repository file ====

vim /etc/yum.repos.d/TB-Base.repo

Paste the following information in that file:

# TelcoBridges-Base.repo
#
# This repository is using TelcoBridges frozen version of CentOS
# to help client installing the required version of the
# applications required to run Toolpack
#

[tb-base]
name=TelcoBridges-$releasever - Base
baseurl=file:///repo/centos/7/os/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-TB7

==== Get TelcoBridges repository key ====

cd /etc/pki/rpm-gpg/
cp /repo/centos/7/RPM-GPG-KEY-TB7 .

== Update CentOS ==
=== Disable base CentOS repositories ===

Edit the Centos repository configuration file

vi /etc/yum.repos.d/CentOS-Base.repo

Disable all repositories in that file. Example:

[base]
'''enabled=0'''
name=CentOS-$releasever - Base
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=os
#baseurl=http://mirror.centos.org/centos/$releasever/os/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-7

#released updates
[updates]
'''enabled=0'''
name=CentOS-$releasever - Updates
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=updates
#baseurl=http://mirror.centos.org/centos/$releasever/updates/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-7

#additional packages that may be useful
[extras]
'''enabled=0'''
name=CentOS-$releasever - Extras
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=extras
#baseurl=http://mirror.centos.org/centos/$releasever/extras/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-7

#additional packages that extend functionality of existing packages
[centosplus]
name=CentOS-$releasever - Plus
mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=centosplus
#baseurl=http://mirror.centos.org/centos/$releasever/centosplus/$basearch/
gpgcheck=1
'''enabled=0'''
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-7

=== Package update ===

Remove conflicting packages with TelcoBridges repository part of the original DVD

yum remove NetworkManager xfsprogs

Update your system to latest packages from TelcoBridges repository

yum clean all
yum update

If there was a kernel update, you need to reboot the machine to activate it:

shutdown -r now

=== Reply to ARP only on local interfaces ===

Modify the file /etc/sysctl.conf to add the following lines:

net.ipv4.conf.default.arp_ignore=1
net.ipv4.conf.all.arp_ignore=1

Then restart network interfaces using the following command:

service network restart

=== Disabling SELinux ===

Check SELinux status

sestatus

If SELinux is enable, see the [[SELinux_management|Disabling SELinux]] article to disable it.

=== Disabling Firewalld ===

systemctl mask firewalld
systemctl stop firewalld

== Install Toolpack Prerequisites ==

Then, install Toolpack set of pre-requisite packages. When asked to 'Importing GPG key', answer yes.

yum groupinstall Toolpack-Prerequisites

=== Configure ODBC ===

Be sure that Toolpack system is stopped before manipulating MySQL.

tbtoolpack stop

vi /etc/odbcinst.ini

Remove the '#' in front of each lines of the [MySQL] section Modify the 'Driver' line to set the correct driver

 Example:
[MySQL]
Description = ODBC for MySQL
Driver = /usr/lib/libmyodbc5.so
Setup = /usr/lib/libodbcmyS.so
Driver64 = /usr/lib64/libmyodbc5.so
Setup64 = /usr/lib64/libodbcmyS.so
FileUsage = 1

=== Configure MariaDB ===

vi /etc/my.cnf

Add these variables in the file under the [mysqld] section:

*log-bin=mariadb-bin
*relay-log=mariadb-relay-bin
*innodb_doublewrite=1
*innodb_flush_log_at_trx_commit=1
*sync_binlog=1
*expire_logs_days=30
*max_binlog_size=500M
*server-id=''[UniqueId]''
*innodb_stats_on_metadata=0

The server-id needs to be a non-zero unique value (do not use 0). If you use the host redundancy feature, the value '''MUST to be different''' on each host .

 Add below to remove database dependencies with DNS servers '''(**Applicable to TMG users only)'''

skip-name-resolve

 Add max_allowed_packet to increase the maximum size of binary blobs in the database. Make sure it is in the [mysqld] section AND [mysqldump] section

max_allowed_packet = 200MB

Example:

[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
symbolic-links=0
log-bin=mariadb-bin
server-id=1123476
max_allowed_packet = 200MB
skip-name-resolve
expire_logs_days=30
max_binlog_size=500M
relay-log=mariadb-relay-bin
innodb_doublewrite=1
innodb_flush_log_at_trx_commit=1
sync_binlog=1
innodb_stats_on_metadata=0

[mysqldump]
max_allowed_packet = 200MB

 Enable and start MariaDB

systemctl enable mariadb
systemctl start mariadb

 Use the MariaDB wizard to secure your server installation.
mysql_secure_installation

You should:
* Set new root password
* Remove anonymous users
* Disallow root login remotely
* Remove test database and accesses
* Reload privilege tables

Example:

mysql_secure_installation

Set root password? [Y/n] Y
New password: AVeryStrongPassword
Re-enter new password: AVeryStrongPassword
Password updated successfully!
Reloading privilege tables..
... Success!
Remove anonymous users? [Y/n] Y
... Success!
Disallow root login remotely? [Y/n] Y
... Success!
Remove test database and access to it? [Y/n] Y
- Dropping test database...
... Success!
- Removing privileges on test database...
... Success!
Reload privilege tables now? [Y/n] Y
... Success!
Cleaning up...
Thanks for using MariaDB!

=== Restart the MariaDB service ===
systemctl restart mariadb

=== Configure MariaDB user ===

* Create a tbdb user (required by Toolpack)

Example:

mysql -uroot -pAVeryStrongPassword

USE mysql;
CREATE USER 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
GRANT ALL PRIVILEGES ON *.* TO 'tbdb'@'%' IDENTIFIED BY 'tbdbpw';
FLUSH PRIVILEGES;
exit

=== Install additional ruby gems ===
wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/bundler-1.2.3.gem
gem install --local ./bundler-1.2.3.gem

wget http://download.distribution.telcobridges.com/3rdparty/prerequisite/bin/linux/json-1.7.7.gem
gem install --local ./json-1.7.7.gem

== Toolpack Development Prerequisite (Optional) ==

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

yum install libxml2-devel libpcap-devel unixODBC-devel libaio libaio-devel libcurl-devel.x86_64 libxslt

== Validation Guide (highly recommended) ==

If you would like to verify your installation go to the [[Toolpack_Installation:Validate_Toolpack_Installation_A|Toolpack Validation Guide]]

 

== Toolpack System installation ==

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

Tbstatus monitoring

2017-09-25T15:16:10Z

Lucas Trottier: /* Download the script archive */

Tbstatus monitoring is a ruby script which makes use of the [[Status_API|tbstatus API]] to gather statistics on a system. It periodically collects statistics according to a configuration file (tbstatus.yml). Results are presented in .csv files per selected module. This includes any statistics that tbstatus API can gather. E.g. trunks, signaling links status, ISUP interface status, NAPs status, calls status, etc.

'''Note:''' tbstatus.rb ruby script is different from the [[Status_API#Viewing_status_tree_using_the_command-line_tool|tbstatus command-line tool]].

== Download the script archive ==
Download the script here: [[media:tbstatus_monitor.zip]].

This archive contain the gzip tar archive named ''tbstatus_monitor.tgz'':
* tbstatus.rb : Status script.
* tbstatus.yml : Configuration file
* Instructions.txt : Quick instruction

== Copy the script archive to TMG ==
* Transfer the .tgz file containing the script tbstatus.rb, and the configuration file tbstatus.yml to the host of TMG800, TMG3200 or TMG7800-CTRL using sFTP (Filezilla or Winscp)

* Uncompress the file
tar xzf tbstatus_monitor.tgz
cd tbstatus_monitor

== Script Usage ==
<nowiki>
[Tbstatus_monitor]# ./tbstatus.rb
Usage: tbstatus.rb [path]
path: '/*', /nap or any other supported path

Usage: tbstatus.rb [GROUP]
GROUP: any defined GROUP in yml config file in CAPITAL letters
(:all to print them all)

Usage: tbstatus.rb [command]
command: :all to print statistics for all defined GROUPS
:dump to print all statistics for all supported paths

Usage: tbstatus.rb -d
Goes into deamon mode, and start logging system statistics
according to YML config file

CFG: -f can be used as first argument to specify YML cfg file</nowiki>

== Adjust configuration file ==
Change the configuration file to select the required monitoring modules. This can be done by editing the tbstatus.yml file, you will see the below lines within.
 
* To specify the output .csv file name
<pre>slog_file: DATABASE.csv</pre>

* Or, output in a SQLite database file
<pre>slog_file: DATABASE.sqlite</pre>

* To specify the file rotation period
<pre>slog_rotation_period: daily</pre>

* To specify the statistics gathering interval
<pre>slog_update_interval: 15m</pre>

* Configure the required module statistics
Comment out the lines (statistics) which are not required with a "#" sign. This reduces the number of files and the columns within files generated.
 
Below example gathers the ISUP interface cic group statistics and put the result in ISUP_INTERFACE_CIC_GROUPS.csv files:
<pre>
- ISUP_INTERFACE_CIC_GROUPS:
slog_file: ISUP_INTERFACE_CIC_GROUPS.csv
slog_rotation_period: daily
slog_update_interval: 15m
paths:
- /isup/interface/cic_group:
# - desired_group_state
# - start_continuity_check
# - interface_down
- idle_cnt
- incoming_cnt
- outgoing_cnt
- locally_blocked_cnt
- remotely_blocked_cnt
- locally_remotely_blocked_cnt
- reset_cnt
- suspended_cnt
</pre>

To get the list of available path or a short description of each available statistics fields:
* [[Status_API#Viewing_status_tree_using_the_command-line_tool|View status statistic paths]]
* [[Status_API#Viewing_statistics_field_description_with_the_command-line_tool|View statistics field description]]

Instead of .csv files, statistics can be saved in a SQLite database file. Below example gathers the NAPs statistics:
<pre>
- NAPS:
slog_file: NAPS.sqlite
slog_rotation_period: daily
slog_update_interval: 10s
paths:
- /nap:
- available_cnt
- unavailable_cnt
- availability_percent
</pre>

== Execute the script in deamon mode ==
* Change the script file permission
chmod +x tbstatus.rb

* Execute tbstatus script in daemon mode
nohup ./tbstatus.rb -d &

* To stop it, kill the process
[root@TB007036 ~]# ps -ef | grep tbstatus
root 20800 15165 0 04:17 pts/0 00:00:01 /usr/bin/ruby ./tbstatus.rb -d
root 23191 15165 0 04:46 pts/0 00:00:00 grep tbstatus
[root@TB007036 ~]# kill -9 20800

== Execute the script on the Web Portal ==
Alternatively, you can start the tbstatus monitor tool in with Toolpack. Therefore, the script will start and stop automatically at the same time as Toolpack service:
 
*On the Web Portal, Go to Host -> Applications -> Create New Application
Name: tbstatus_monitor
Application Type: user-specific
bin path: /root/tbstatus_monitor/tbstatus.rb
working path: /root/tbstatus_monitor
Command line arguments: -f tbstatus.yml -d

== Collect the data in .csv files ==
* Multiple .csv files will be created in the same directory. They will be rotated and zipped according to the yml configuration. These files can be extracted from the unit with sFTP, or SSH scp commands to be analyzed by an external system.
Example files:
ADAPTER_IP_INTERFACES.csv
ADAPTER_LINE_INTERFACE_LINE_SERVICES.csv
ADAPTER_LINE_INTERFACES.csv
ADAPTER_SENSORS.csv
ADAPTER_USAGE.csv
DATABASE.csv
ISUP_INTERFACE_CIC_GROUPS.csv
ISUP_INTERFACES.csv
MTP2_LINKS.csv
MTP3_LINKS.csv
MTP3_LINKSETS.csv
MTP3_ROUTES.csv
NAPS_24hour_data.csv
NAPS.csv

The result of ISUP_INTERFACE_CIC_GROUPS.csv with the above configuration would be:
date,time,path,item_name,idle_cnt,incoming_cnt,outgoing_cnt,locally_blocked_cnt,remotely_blocked_cnt,locally_remotely_blocked_cnt,reset_cnt,suspended_cnt
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_00,30,0,0,0,0,0,0,0
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_02,31,0,0,0,0,0,0,0
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_04,31,0,0,0,0,0,0,0
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_05,31,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_00,30,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_02,31,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_04,31,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_05,31,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_00,30,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_02,31,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_04,31,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_05,31,0,0,0,0,0,0,0

'''Columns:''' date, time, path and item_name are always there. All other columns depends on the selected fields in the configuration file.

'''Lines:''' one per paths/item per update interval; in that example, there is 4 CIC groups. Note that the first entries are written at 22:24 because the script was started at that time.

== Access data in the SQLite database ==
* Check for the database file which matches the configuration in tbstatus.yml. Following the example above, it is:
NAPS.sqlite

* Check for the database table name
[root@165 tbstatus_monitor]# sqlite3 NAPS.sqlite '.tables';
/nap

* Access the statistics in the database file
[root@165 tbstatus_monitor]# sqlite3 NAPS.sqlite 'SELECT * FROM "/nap" ORDER BY oid DESC LIMIT 10';
2014-05-26 15:44:51|TBSERVER|1500|0|100
2014-05-26 15:44:51|SS7_NAP|30|0|100
2014-05-26 15:44:50|SIP_NAP_1PLUS1|1500|0|100
2014-05-26 15:44:50|ISDN_1_1|30|0|100
2014-05-26 15:44:50|CANDY|0|1500|0
2014-05-26 15:44:40|TBSERVER|1500|0|100
2014-05-26 15:44:40|SS7_NAP|30|0|100
2014-05-26 15:44:40|SIP_NAP_1PLUS1|1500|0|100
2014-05-26 15:44:40|ISDN_1_1|30|0|1

Tbstatus monitoring

2017-09-25T15:15:09Z

Lucas Trottier: /* Download the script archive */

Tbstatus monitoring is a ruby script which makes use of the [[Status_API|tbstatus API]] to gather statistics on a system. It periodically collects statistics according to a configuration file (tbstatus.yml). Results are presented in .csv files per selected module. This includes any statistics that tbstatus API can gather. E.g. trunks, signaling links status, ISUP interface status, NAPs status, calls status, etc.

'''Note:''' tbstatus.rb ruby script is different from the [[Status_API#Viewing_status_tree_using_the_command-line_tool|tbstatus command-line tool]].

== Download the script archive ==
Download the script here: [[file:tbstatus_monitor.zip]].

This archive contain the gzip tar archive named ''tbstatus_monitor.tgz'':
* tbstatus.rb : Status script.
* tbstatus.yml : Configuration file
* Instructions.txt : Quick instruction

== Copy the script archive to TMG ==
* Transfer the .tgz file containing the script tbstatus.rb, and the configuration file tbstatus.yml to the host of TMG800, TMG3200 or TMG7800-CTRL using sFTP (Filezilla or Winscp)

* Uncompress the file
tar xzf tbstatus_monitor.tgz
cd tbstatus_monitor

== Script Usage ==
<nowiki>
[Tbstatus_monitor]# ./tbstatus.rb
Usage: tbstatus.rb [path]
path: '/*', /nap or any other supported path

Usage: tbstatus.rb [GROUP]
GROUP: any defined GROUP in yml config file in CAPITAL letters
(:all to print them all)

Usage: tbstatus.rb [command]
command: :all to print statistics for all defined GROUPS
:dump to print all statistics for all supported paths

Usage: tbstatus.rb -d
Goes into deamon mode, and start logging system statistics
according to YML config file

CFG: -f can be used as first argument to specify YML cfg file</nowiki>

== Adjust configuration file ==
Change the configuration file to select the required monitoring modules. This can be done by editing the tbstatus.yml file, you will see the below lines within.
 
* To specify the output .csv file name
<pre>slog_file: DATABASE.csv</pre>

* Or, output in a SQLite database file
<pre>slog_file: DATABASE.sqlite</pre>

* To specify the file rotation period
<pre>slog_rotation_period: daily</pre>

* To specify the statistics gathering interval
<pre>slog_update_interval: 15m</pre>

* Configure the required module statistics
Comment out the lines (statistics) which are not required with a "#" sign. This reduces the number of files and the columns within files generated.
 
Below example gathers the ISUP interface cic group statistics and put the result in ISUP_INTERFACE_CIC_GROUPS.csv files:
<pre>
- ISUP_INTERFACE_CIC_GROUPS:
slog_file: ISUP_INTERFACE_CIC_GROUPS.csv
slog_rotation_period: daily
slog_update_interval: 15m
paths:
- /isup/interface/cic_group:
# - desired_group_state
# - start_continuity_check
# - interface_down
- idle_cnt
- incoming_cnt
- outgoing_cnt
- locally_blocked_cnt
- remotely_blocked_cnt
- locally_remotely_blocked_cnt
- reset_cnt
- suspended_cnt
</pre>

To get the list of available path or a short description of each available statistics fields:
* [[Status_API#Viewing_status_tree_using_the_command-line_tool|View status statistic paths]]
* [[Status_API#Viewing_statistics_field_description_with_the_command-line_tool|View statistics field description]]

Instead of .csv files, statistics can be saved in a SQLite database file. Below example gathers the NAPs statistics:
<pre>
- NAPS:
slog_file: NAPS.sqlite
slog_rotation_period: daily
slog_update_interval: 10s
paths:
- /nap:
- available_cnt
- unavailable_cnt
- availability_percent
</pre>

== Execute the script in deamon mode ==
* Change the script file permission
chmod +x tbstatus.rb

* Execute tbstatus script in daemon mode
nohup ./tbstatus.rb -d &

* To stop it, kill the process
[root@TB007036 ~]# ps -ef | grep tbstatus
root 20800 15165 0 04:17 pts/0 00:00:01 /usr/bin/ruby ./tbstatus.rb -d
root 23191 15165 0 04:46 pts/0 00:00:00 grep tbstatus
[root@TB007036 ~]# kill -9 20800

== Execute the script on the Web Portal ==
Alternatively, you can start the tbstatus monitor tool in with Toolpack. Therefore, the script will start and stop automatically at the same time as Toolpack service:
 
*On the Web Portal, Go to Host -> Applications -> Create New Application
Name: tbstatus_monitor
Application Type: user-specific
bin path: /root/tbstatus_monitor/tbstatus.rb
working path: /root/tbstatus_monitor
Command line arguments: -f tbstatus.yml -d

== Collect the data in .csv files ==
* Multiple .csv files will be created in the same directory. They will be rotated and zipped according to the yml configuration. These files can be extracted from the unit with sFTP, or SSH scp commands to be analyzed by an external system.
Example files:
ADAPTER_IP_INTERFACES.csv
ADAPTER_LINE_INTERFACE_LINE_SERVICES.csv
ADAPTER_LINE_INTERFACES.csv
ADAPTER_SENSORS.csv
ADAPTER_USAGE.csv
DATABASE.csv
ISUP_INTERFACE_CIC_GROUPS.csv
ISUP_INTERFACES.csv
MTP2_LINKS.csv
MTP3_LINKS.csv
MTP3_LINKSETS.csv
MTP3_ROUTES.csv
NAPS_24hour_data.csv
NAPS.csv

The result of ISUP_INTERFACE_CIC_GROUPS.csv with the above configuration would be:
date,time,path,item_name,idle_cnt,incoming_cnt,outgoing_cnt,locally_blocked_cnt,remotely_blocked_cnt,locally_remotely_blocked_cnt,reset_cnt,suspended_cnt
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_00,30,0,0,0,0,0,0,0
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_02,31,0,0,0,0,0,0,0
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_04,31,0,0,0,0,0,0,0
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_05,31,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_00,30,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_02,31,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_04,31,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_05,31,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_00,30,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_02,31,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_04,31,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_05,31,0,0,0,0,0,0,0

'''Columns:''' date, time, path and item_name are always there. All other columns depends on the selected fields in the configuration file.

'''Lines:''' one per paths/item per update interval; in that example, there is 4 CIC groups. Note that the first entries are written at 22:24 because the script was started at that time.

== Access data in the SQLite database ==
* Check for the database file which matches the configuration in tbstatus.yml. Following the example above, it is:
NAPS.sqlite

* Check for the database table name
[root@165 tbstatus_monitor]# sqlite3 NAPS.sqlite '.tables';
/nap

* Access the statistics in the database file
[root@165 tbstatus_monitor]# sqlite3 NAPS.sqlite 'SELECT * FROM "/nap" ORDER BY oid DESC LIMIT 10';
2014-05-26 15:44:51|TBSERVER|1500|0|100
2014-05-26 15:44:51|SS7_NAP|30|0|100
2014-05-26 15:44:50|SIP_NAP_1PLUS1|1500|0|100
2014-05-26 15:44:50|ISDN_1_1|30|0|100
2014-05-26 15:44:50|CANDY|0|1500|0
2014-05-26 15:44:40|TBSERVER|1500|0|100
2014-05-26 15:44:40|SS7_NAP|30|0|100
2014-05-26 15:44:40|SIP_NAP_1PLUS1|1500|0|100
2014-05-26 15:44:40|ISDN_1_1|30|0|1

File:Tbstatus monitor.zip

2017-09-25T15:13:28Z

Lucas Trottier: uploaded a new version of "File:Tbstatus monitor.zip": Version 1.8

Tbstatus Monitoring Script

Tbstatus monitoring

2017-09-25T15:01:02Z

Lucas Trottier:

Tbstatus monitoring is a ruby script which makes use of the [[Status_API|tbstatus API]] to gather statistics on a system. It periodically collects statistics according to a configuration file (tbstatus.yml). Results are presented in .csv files per selected module. This includes any statistics that tbstatus API can gather. E.g. trunks, signaling links status, ISUP interface status, NAPs status, calls status, etc.

'''Note:''' tbstatus.rb ruby script is different from the [[Status_API#Viewing_status_tree_using_the_command-line_tool|tbstatus command-line tool]].

== Download the script archive ==
Download the script here: [[file:tbstatus_monitor.tgz]].

The archive contain the following files:
* tbstatus.rb : Status script.
* tbstatus.yml : Configuration file
* Instructions.txt : Quick instruction

== Copy the script archive to TMG ==
* Transfer the .tgz file containing the script tbstatus.rb, and the configuration file tbstatus.yml to the host of TMG800, TMG3200 or TMG7800-CTRL using sFTP (Filezilla or Winscp)

* Uncompress the file
tar xzf tbstatus_monitor.tgz
cd tbstatus_monitor

== Script Usage ==
<nowiki>
[Tbstatus_monitor]# ./tbstatus.rb
Usage: tbstatus.rb [path]
path: '/*', /nap or any other supported path

Usage: tbstatus.rb [GROUP]
GROUP: any defined GROUP in yml config file in CAPITAL letters
(:all to print them all)

Usage: tbstatus.rb [command]
command: :all to print statistics for all defined GROUPS
:dump to print all statistics for all supported paths

Usage: tbstatus.rb -d
Goes into deamon mode, and start logging system statistics
according to YML config file

CFG: -f can be used as first argument to specify YML cfg file</nowiki>

== Adjust configuration file ==
Change the configuration file to select the required monitoring modules. This can be done by editing the tbstatus.yml file, you will see the below lines within.
 
* To specify the output .csv file name
<pre>slog_file: DATABASE.csv</pre>

* Or, output in a SQLite database file
<pre>slog_file: DATABASE.sqlite</pre>

* To specify the file rotation period
<pre>slog_rotation_period: daily</pre>

* To specify the statistics gathering interval
<pre>slog_update_interval: 15m</pre>

* Configure the required module statistics
Comment out the lines (statistics) which are not required with a "#" sign. This reduces the number of files and the columns within files generated.
 
Below example gathers the ISUP interface cic group statistics and put the result in ISUP_INTERFACE_CIC_GROUPS.csv files:
<pre>
- ISUP_INTERFACE_CIC_GROUPS:
slog_file: ISUP_INTERFACE_CIC_GROUPS.csv
slog_rotation_period: daily
slog_update_interval: 15m
paths:
- /isup/interface/cic_group:
# - desired_group_state
# - start_continuity_check
# - interface_down
- idle_cnt
- incoming_cnt
- outgoing_cnt
- locally_blocked_cnt
- remotely_blocked_cnt
- locally_remotely_blocked_cnt
- reset_cnt
- suspended_cnt
</pre>

To get the list of available path or a short description of each available statistics fields:
* [[Status_API#Viewing_status_tree_using_the_command-line_tool|View status statistic paths]]
* [[Status_API#Viewing_statistics_field_description_with_the_command-line_tool|View statistics field description]]

Instead of .csv files, statistics can be saved in a SQLite database file. Below example gathers the NAPs statistics:
<pre>
- NAPS:
slog_file: NAPS.sqlite
slog_rotation_period: daily
slog_update_interval: 10s
paths:
- /nap:
- available_cnt
- unavailable_cnt
- availability_percent
</pre>

== Execute the script in deamon mode ==
* Change the script file permission
chmod +x tbstatus.rb

* Execute tbstatus script in daemon mode
nohup ./tbstatus.rb -d &

* To stop it, kill the process
[root@TB007036 ~]# ps -ef | grep tbstatus
root 20800 15165 0 04:17 pts/0 00:00:01 /usr/bin/ruby ./tbstatus.rb -d
root 23191 15165 0 04:46 pts/0 00:00:00 grep tbstatus
[root@TB007036 ~]# kill -9 20800

== Execute the script on the Web Portal ==
Alternatively, you can start the tbstatus monitor tool in with Toolpack. Therefore, the script will start and stop automatically at the same time as Toolpack service:
 
*On the Web Portal, Go to Host -> Applications -> Create New Application
Name: tbstatus_monitor
Application Type: user-specific
bin path: /root/tbstatus_monitor/tbstatus.rb
working path: /root/tbstatus_monitor
Command line arguments: -f tbstatus.yml -d

== Collect the data in .csv files ==
* Multiple .csv files will be created in the same directory. They will be rotated and zipped according to the yml configuration. These files can be extracted from the unit with sFTP, or SSH scp commands to be analyzed by an external system.
Example files:
ADAPTER_IP_INTERFACES.csv
ADAPTER_LINE_INTERFACE_LINE_SERVICES.csv
ADAPTER_LINE_INTERFACES.csv
ADAPTER_SENSORS.csv
ADAPTER_USAGE.csv
DATABASE.csv
ISUP_INTERFACE_CIC_GROUPS.csv
ISUP_INTERFACES.csv
MTP2_LINKS.csv
MTP3_LINKS.csv
MTP3_LINKSETS.csv
MTP3_ROUTES.csv
NAPS_24hour_data.csv
NAPS.csv

The result of ISUP_INTERFACE_CIC_GROUPS.csv with the above configuration would be:
date,time,path,item_name,idle_cnt,incoming_cnt,outgoing_cnt,locally_blocked_cnt,remotely_blocked_cnt,locally_remotely_blocked_cnt,reset_cnt,suspended_cnt
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_00,30,0,0,0,0,0,0,0
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_02,31,0,0,0,0,0,0,0
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_04,31,0,0,0,0,0,0,0
"09/17/2014","22:24:22",/isup/interface/cic_group,C011107_05,31,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_00,30,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_02,31,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_04,31,0,0,0,0,0,0,0
"09/17/2014","22:30:00",/isup/interface/cic_group,C011107_05,31,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_00,30,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_02,31,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_04,31,0,0,0,0,0,0,0
"09/17/2014","22:45:00",/isup/interface/cic_group,C011107_05,31,0,0,0,0,0,0,0

'''Columns:''' date, time, path and item_name are always there. All other columns depends on the selected fields in the configuration file.

'''Lines:''' one per paths/item per update interval; in that example, there is 4 CIC groups. Note that the first entries are written at 22:24 because the script was started at that time.

== Access data in the SQLite database ==
* Check for the database file which matches the configuration in tbstatus.yml. Following the example above, it is:
NAPS.sqlite

* Check for the database table name
[root@165 tbstatus_monitor]# sqlite3 NAPS.sqlite '.tables';
/nap

* Access the statistics in the database file
[root@165 tbstatus_monitor]# sqlite3 NAPS.sqlite 'SELECT * FROM "/nap" ORDER BY oid DESC LIMIT 10';
2014-05-26 15:44:51|TBSERVER|1500|0|100
2014-05-26 15:44:51|SS7_NAP|30|0|100
2014-05-26 15:44:50|SIP_NAP_1PLUS1|1500|0|100
2014-05-26 15:44:50|ISDN_1_1|30|0|100
2014-05-26 15:44:50|CANDY|0|1500|0
2014-05-26 15:44:40|TBSERVER|1500|0|100
2014-05-26 15:44:40|SS7_NAP|30|0|100
2014-05-26 15:44:40|SIP_NAP_1PLUS1|1500|0|100
2014-05-26 15:44:40|ISDN_1_1|30|0|1

Security policy

2017-09-15T15:08:35Z

Lucas Trottier:

{{DISPLAYTITLE:Security Policy}}

TelcoBridges Tctrl Operating Software is running over a variant of CentOS 5 or 7 that is managed by TelcoBridges. The resulting operating system is a selected set of binary packages (RPM) meticulously chosen from RedHat/CentOS official packages. Some software packages version have been frozen on earlier release to insure a full compatibility and quality of TelcoBridges software. As an example, the Ruby version package that TelcoBridges is using (1.8.7) is following CentOS 6 repository, since CentOS 7 integrates version 2.x. TelcoBridges follows RedHat/CentOS and vendors security announcement by subscribing to their mailing list.

=== Security Update Procedure ===
When a new security update (RHSA) is released from RedHat or from the vendors of one of the software component not following the official CentOS package, TelcoBridges follows a rigorous security update procedure:
# first check if the affected packages are in one of our repositories.
# insert affected package in TelcoBridges '''DEV''' repository
# after 1 to 1.5 week of development testing, insert the package in the '''QA''' repository for regression testing
# once tested, migrate the packages from the QA repository to the '''OFFICIAL''' repository

=== TelcoBridges CentOS 5 and 7 Repositories ===
http://repo.telcobridges.com

{| class="wikitable"
|-
! Version !! DEV !! QA !! OFFICIAL
|-
| CentOS 5 || [http://repo.telcobridges.com/centos/5_dev/ link here] || [http://repo.telcobridges.com/centos/5_qa/ link here]|| [http://repo.telcobridges.com/centos/5/ link here]
|-
| CentOS 7 || [http://repo.telcobridges.com/centos/7_dev/ link here] || [http://repo.telcobridges.com/centos/7_qa/ link here] || [http://repo.telcobridges.com/centos/7/ link here]
|}

=== TelcoBridges product upgrade procedure ===
To upgrade the CentOS packages on one of TelcoBridges products, please follow this [[Upgrade_CentOS|link]].

Main Page

2017-09-15T15:03:42Z

Lucas Trottier:

[[Image:tsbc_banner.png|center|600px|link=https://sbc.telcobridges.com/|Subscription-based Virtual TSBC Eliminates CAPEX]]

'''Welcome to the TBwiki! [http://www.telcobridges.com TelcoBridges] has developed this wiki to help you with your product and service questions.'''

{|
|STYLE="vertical-align: top"|
{| cellpadding="5" border="1" class="wikitable"
! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" colspan="2" |

Products

! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

OAM&P

! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

Features

! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

Solutions

! width="225" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

TBSupport

|-

| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 121px" |
[[Tsbc|''T''sbc]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TSBC-SW]]
*[[TSBC5000]]

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[Datasheet|Datasheet]]
*[[Product_Installation|Installing]]
*[[Gateway_Upgrade|Upgrading]]
*[[Web Portal]]

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[TSBC_Carrier_Interconnection_Solution|Carrier Interconnection]]
*[[TSBC_NGN_Interconnection_Solution|NGN Interconnection]]
*[[TSBC_Operator_Interconnection_Solution|Operator Interconnection]]
*[[TSBC_Transcoding_Solution|Transcoding]]

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Support:Contacting TelcoBridges technical support|Contacting TB Support]]
*[[Support:License_server|License Server]]
|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 121px" |
[[Tmedia|''T''media]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TMG800]]
*[[TMG3200]]
*[[TMG7800]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" rowspan="3"|

*[[Datasheet|Datasheet]]
*[[Product_Installation|Installing]]
*[[Gateway_Upgrade|Upgrading]]
*[[Web Portal]]
*[[TMG-CONTROL_Version_History|Version History]]
*[[Troubleshooting]]
[[:Category:Gateway_OAM&P|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[Signaling_protocols|Signaling Protocols]]
*[[Redundancy_&_High_Availability|Redundancy & High Availability]]
*[[Tmedia_Routing|Routing]]
*[[Network_monitoring|Network Monitoring]]
[[:Category:Tmedia_Features|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[Carrier_Solutions|Carriers]]
*[[Operator_Solutions|Operators]]
*[[MVNO_&_MVNE_Solutions|MVNO & MVNE]]
*[[Call_Center_Solutions| Call Centers]]

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" rowspan="6"|
*[[Media:TB_Support_Services_2017_v2.pdf‎|TB Support Services (.pdf)]]
*[[Media:TB_Support.pdf|TB Support (.pdf)]]
*[[Media:TB_Support_Full_length.pdf|TB Support Details]]
*[[Support:Contacting TelcoBridges technical support|Contacting TB Support]]
*[[Support:License_server|License Server]]
*[[Support:Time_tracking_tool|Time Tracking Tool]]
*[[:Category:FAQ|Frequently Asked Questions]]
*[[Support:Forums|Support Forums]]
*[[Support:How To Submit A Problem|Submitting an Issue]]

'''Important Notices'''
*[[Field_notices|Field Notices]]
*[[Security_advisories |Security Advisories]]

'''Legal'''

*[[Media:Product Warranty.pdf|Product Warranty]]
*[[Media:Terms & Conditions.pdf|Standard Terms & Conditions]]

'''Interoperability'''

*[[Interoperability:Vendors|Vendors]]
*[[Interoperability:Certifications|Certifications]]

'''Policies'''

*[[End-of-Life (EOL) policy|End-of-Life (EOL)]]
*[[Security policy|Security Updates Policy]]

'''Other'''
*[[Regulatory compliance|Regulatory Compliance]]

|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 80px" |
[[Ttrans|''T''trans]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TMGIP800]]
*[[TMGIP3200]]
*[[TMGIP7800]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Voice_codecs|Voice Codecs]]
*[[Network_monitoring|Network Monitoring]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Transcoding_Gateway_Solutions|Transcoding]]
|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 80px" |
[[Tsig|''T''sig]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TSG800]]
*[[TSG3200]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Signaling_protocols|Signaling Protocols]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Signaling_Gateway_Solutions|Signaling]]
|-

| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 105px" |
[[Tdev|''T''dev]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TMP800]]
*[[TMP6400]]
*[[TMP6400-CTRL]]
*[[TMP6400-TMS]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Installing Toolpack|Installing]]
*[[Upgrading Toolpack|Upgrading]]
*[[Toolpack_Web_Portal|Provisioning]]
[[:Category:Tdev_OAM%26P|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[High_Availability_Overview|Redundancy & High Availability]]
*[[Tdev_Signaling_Protocols|Signaling Protocols]]
*[[Voice_codecs|Voice Codecs]]
[[:Category:Tdev_Features|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Prepaid & postpaid calling|Prepaid & Postpaid Calling]]
*[[Ringback tones|Ringback Tones]]
*[[Unified communications|Unified Communications]]
[[:Category:Tdev_Solutions|...more]]
|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 80px" |
[[Tmonitor|''T''monitor]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TM1000]]
*[[TM3000]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Installing Toolpack|Installing]]
*[[Upgrading Toolpack|Upgrading]]
*[[Toolpack_Web_Portal|Provisioning]]
[[:Category:Tmonitor_OAM%26P|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Tmonitor_Lawful_Intercept|Lawful Intercept]]
*[[Network_monitoring|Network Monitoring]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Location-based services|Location-Based Services (LBS)]]
*[[Network monitoring|Network Monitoring]]
|}
|}

== Using TBwiki ==

Please note that the TBWiki is a living document, in which navigation choices and the naming of content evolves over time.

There are various ways to search for information in the TBWiki. You can choose to search in the table above, use the glossary in the navigation bar, or use the search box on the left-hand side of each page.

== Disclaimer ==

The information on the TBwiki 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 Inc. TelcoBridges may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this web site or associated documents. 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 agreement from TelcoBridges.

The information provided in this web site is intended as a guide. No responsibility is implied and the terms of your agreement with TelcoBridges will continue to claim precedence. For the latest detailed engineering specifications, please contact TelcoBridges. TelcoBridges is committed to continually improving product designs, as a result, product specifications may be subject to change without notification.

== Copyright ==

*This web site and its content, as well as any external links to content on TelcoBridges servers, is ©2002-2017 TelcoBridges Inc. All rights reserved.

Security policy

2017-09-15T14:47:08Z

Lucas Trottier:

Security policy

2017-09-15T14:46:53Z

Lucas Trottier: Created page with "{{DISPLAYTITLE:Security Prolicy}} TelcoBridges Tctrl Operating Software is running over a variant of CentOS 5 or 7 that is managed by TelcoBridges. The resulting operating sy..."

{{DISPLAYTITLE:Security Prolicy}}

TelcoBridges Tctrl Operating Software is running over a variant of CentOS 5 or 7 that is managed by TelcoBridges. The resulting operating system is a selected set of binary packages (RPM) meticulously chosen from RedHat/CentOS official packages. Some software packages version have been frozen on earlier release to insure a full compatibility and quality of TelcoBridges software. As an example, the Ruby version package that TelcoBridges is using (1.8.7) is following CentOS 6 repository, since CentOS 7 integrates version 2.x. TelcoBridges follows RedHat/CentOS and vendors security announcement by subscribing to their mailing list.

=== Security Update Procedure ===
When a new security update (RHSA) is released from RedHat or from the vendors of one of the software component not following the official CentOS package, TelcoBridges follows a rigorous security update procedure:
# first check if the affected packages are in one of our repositories.
# insert affected package in TelcoBridges '''DEV''' repository
# after 1 to 1.5 week of development testing, insert the package in the '''QA''' repository for regression testing
# once tested, migrate the packages from the QA repository to the '''OFFICIAL''' repository

=== TelcoBridges CentOS 5 and 7 Repositories ===
http://repo.telcobridges.com

{| class="wikitable"
|-
! Version !! DEV !! QA !! OFFICIAL
|-
| CentOS 5 || [http://repo.telcobridges.com/centos/5_dev/ link here] || [http://repo.telcobridges.com/centos/5_qa/ link here]|| [http://repo.telcobridges.com/centos/5/ link here]
|-
| CentOS 7 || [http://repo.telcobridges.com/centos/7_dev/ link here] || [http://repo.telcobridges.com/centos/7_qa/ link here] || [http://repo.telcobridges.com/centos/7/ link here]
|}

FreeSBC:Download

2017-06-26T18:10:37Z

Lucas Trottier:

=== Bare metal image download ===
* https://licenses.telcobridges.com/download/tsbc_sw?name=BareMetal

=== OpenStack image download ===
* https://licenses.telcobridges.com/download/tsbc_sw?name=OpenStack

=== KVM image download ===
* https://licenses.telcobridges.com/download/tsbc_sw?name=KVM

Parameter: SIP: Use isup-oli format

2017-06-22T21:05:09Z

Lucas Trottier:

In some TDM networks, the [[Routing_script_tutorial:Mini_Development_Guide#Script_parameters_protocol_mapping|Originating Line Information (OLI)]] parameter defined in ANSI ISUP and 5ESS ISDN is used to carry information related to the calling party and the class of service for a call. Legacy multifrequency (MF) signalling networks carry this information in the ANI II Digits.

By default, the OLI is carried on SIP using the "oli" URI parameter:

From:“Jonh Doe”<sip:+15553335511@sip.domain.net;oli=00>;tag=797D3031343235320021656B

With the option '''Use isup-oli format''', the "isup-oli" URI parameter is used instead of "oli" URI parameter:
From:“Jonh Doe”<sip:+15553335511@sip.domain.net;isup-oli=00>;tag=797D3031343235320021656B

* When inter-working the OLI parameter from ISDN/ISUP to SIP, the OLI parameter is added to the From Header in the SIP INVITE message. If the NAP Advanced Parameters [[Parameter:_Privacy_Type|Privacy Type]] is set, the OLI parameter is added to the ''Remote-Party-Id'' and/or or ''P-Asserted-Identity''.
* When inter-working the OLI parameter from the SIP to ISDN/ISUP, the From SIP Header OLI parameter is added to the SETUP/IAM message on the TDM leg.

[[Category:Parameters]]

Parameter: ISUP Protocol Variant

2017-06-20T21:52:17Z

Lucas Trottier:

* ANSI88: Used for ANSI88 specification
* ANSI92: Used for ANSI92 specification
* ANSI95: Used for ANSI95 specification
* TELCORDIA: Used for BELLCORE specification
* ITU: Used for ITU, ITU88 and ITU92 specification
* ITU97: Used for ITU97 specification
* SINGAPORE: Used for SINGAPORE specification
* Q767: Used for Q767 specification
* NTT: Used for NTT specification
* CHINA: Used for CHINA specification
* ETSI: Used for ETSI specification
* ETSIV3: Used for ETSI V3 specification
* UK: Used for UK specification
* SPIROU: Used for Spirou specification
* RUSSIA: Used for Russia specification

The SIP header Content-type base value:
Content-Type:application/ISUP;base=itu-t92+;version=itu-t
is set according to the following table:
{| class="wikitable"
|-
! ISUP Protocol Variant !! Content-Type base value
|-
| ANSI88, ANSI92, ANSI95 || ansi00
|-
| TELECORDIA || gr317
|-
| ETSI || etsi121
|-
| ETSIV3 || etsi356
|-
| ITU, ITU97, SINGAPORE, Q767, NTT, CHINA, UK, SPIROU, RUSSIA || itu-t92+
|}

[[Category:Parameters]]

Parameter: ISUP Protocol Variant

2017-06-20T21:51:56Z

Lucas Trottier:

* ANSI88: Used for ANSI88 specification
* ANSI92: Used for ANSI92 specification
* ANSI95: Used for ANSI95 specification
* TELCORDIA: Used for BELLCORE specification
* ITU: Used for ITU, ITU88 and ITU92 specification
* ITU97: Used for ITU97 specification
* SINGAPORE: Used for SINGAPORE specification
* Q767: Used for Q767 specification
* NTT: Used for NTT specification
* CHINA: Used for CHINA specification
* ETSI: Used for ETSI specification
* ETSIV3: Used for ETSI V3 specification
* UK: Used for UK specification
* SPIROU: Used for Spirou specification
* RUSSIA: Used for Russia specification

The SIP header Content-type base value:
Content-Type:application/ISUP;base=itu-t92+;version=itu-t
is set according to the following table:
{| class="wikitable"
|-
! ISUP Protocol Variant !! Content-Type base value
|-
| ANSI88, ANSI92, ANSI95 || ansi00
|-
| TELECORDIA || gr317
|-
| ETSI || etsi121
|-
| ETSIV3 || etsi356
|-
| ETSI || etsi121
|-
| ITU, ITU97, SINGAPORE, Q767, NTT, CHINA, UK, SPIROU, RUSSIA || itu-t92+
|}

[[Category:Parameters]]

Parameter: Content-Type

2017-06-20T21:42:03Z

Lucas Trottier:

SIP header Content-type version value (typically itu-t, ansi or itu-t92+)

Content-Type:application/ISUP;base=itu-t92+;version=itu-t

[[Category:Parameters]]

Parameter: Content-Type

2017-06-20T21:41:45Z

Lucas Trottier:

SIP header Content-type version value (typically itu-t, ansi or itu-t92+)

Content-Type:application/ISUP;base=itu-t92+;version=itu-t92+

[[Category:Parameters]]

Parameter: ISUP Protocol Variant

2017-06-20T21:34:18Z

Lucas Trottier:

Parameter: Protocol Type

2017-06-20T21:32:40Z

Lucas Trottier:

The Protocol Type/Variant parameter is used to identify the SS7 protocol variant that will be used with a particular object. The appropriate protocol variant depends on the user's geographical location. Values are chosen from a drop-down list. The Protocol Type parameter can take on the following values, '''depending on the object being configured''':

* ITU
* ITU88
* ITU92
* ITU97
* TELCORDIA
* ANSI88
* ANSI92
* ANSI95
* SINGAPORE
* Q767
* TTC (*)
* NTT
* CHINA
* ETSI
* ETSIV3
* UK
* SPIROU
* RUSSIA

(*) Available only through the TB640 native API as those are not currently supported by layers above (MTP3, M3UA, etc) in the complete Toolpack framework.

== SCCP Global Title Protocol Variant ==
* ITU
* ANSI
* CHINA

== SCCP Route Protocol Variant ==

{| class="wikitable" border="1"
! width="150" style="background:#efefef;" |Route Protocol Variant
! width="350" style="background:#efefef;" |Description
|-
| ANSI 88|| Used for ANSI88
|-
| ANSI 92|| Used for ANSI92
|-
| ANSI 96|| Used for ANSI96
|-
| TELCORDIA|| Used for TELCORDIA
|-
| ITU 88|| Used for ITU88
|-
| ITU 92|| Used for ITU92
|-
| ITU 96|| Used for ITU96
|-
| GSM 0806|| On GSM route, [[SCCP:UDTS]] is not sent. Valid in both ITU and ANSI networks
|}

[[Category:Parameters]]

Toolpack:Configuring Virtual Port C

2017-05-30T18:25:40Z

Lucas Trottier: /* To configure a virtual port */

=== '''''Applies to version(s): v2.10''''' ===
{{DISPLAYTITLE:Configuring a Virtual Port}}

One or more virtual ports can be created to manage IP traffic.

 

== To configure a virtual port ==

1. Select '''IP Interfaces''' from the navigation panel

[[Image:Create Voip Interface_0.png]] 

2. Click the '''Virtual Ports''' tab.
*Click '''Create New Virtual Port'''

[[Image:VirtualPort_0.png]] 

3. Configure the virtual port.

*Enter a name for the virtual port
*Select the hardware device to which the virtual port is assinged
*Enter a VLAN ID
*Click '''Create'''

[[Image:VirtuaPort_1a.png]] 

4. From the Available ports window, select a physical port to which the virtual port is assigned. Note that this window is scrollable.

[[Image:VirtuaPort_2a.png]] 

The selected port is displayed in the current physical ports window.

[[Image:VirtualPort_3a.png]]

<div class="mw-collapsible mw-collapsed" data-collapsetext="Northbound Interface" data-expandtext="Northbound Interface" style="width: 400px;">

'''Path'''
<pre>
/configurations/@[configuration_name]/hardware_units/@[hardware_name]/virtual_ports/@[port_name]
</pre>

'''Parameters (text)'''
<pre>
/configurations/@[configuration_name]/hardware_units/@[hardware_name]/virtual_ports/@[port_name]
ethernet_ports = [ "@[port_name]" ]
name = "@[port_name]"
untagged = true
vid = 0
</pre>

'''Parameters (json)'''
<pre>
{
"ethernet_ports" : [
"@[port_name]"
],
"name" : "@[port_name]",
"untagged" : true,
"vid" : 0
}
</pre>
</div>

==List of Parameters==

* [[Parameter: Name|Name]]
* [[Parameter: Unit to create for|Unit to create for]]
* [[Parameter: Untagged|Untagged]]
* [[Parameter: VlAN ID|VLAN ID]]
* [[Parameter: Used by SBC|Used by SBC]]

Toolpack:Configuring Virtual Port B

2017-05-30T18:25:17Z

Lucas Trottier: /* To configure a virtual port */

=== '''''Applies to version(s): v2.9.''''' ===
{{DISPLAYTITLE:Configuring a Virtual Port}}

One or more virtual ports can be created to manage IP traffic.

 

== To configure a virtual port ==

1. Select '''IP Interfaces''' from the navigation panel

[[Image:Create Voip Interface_0.png]] 

2. Click the '''Virtual Ports''' tab.
*Click '''Create New Virtual Port'''

[[Image:VirtualPort_0.png]] 

3. Configure the virtual port.

*Enter a name for the virtual port
*Select the hardware device to which the virtual port is assinged
*Enter a VLAN ID
*Click '''Create'''

[[Image:VirtuaPort_1.png]] 

4. From the Available ports window, select a physical port to which the virtual port is assigned. Note that this window is scrollable.

[[Image:VirtuaPort_2.png]] 

The selected port is displayed in the current physical ports window.

[[Image:VirtualPort_3.png]]

<div class="mw-collapsible mw-collapsed" data-collapsetext="Northbound Interface" data-expandtext="Northbound Interface" style="width: 400px;">

'''Path'''
<pre>
/configurations/@[configuration_name]/hardware_units/@[hardware_name]/virtual_ports/@[port_name]
</pre>

'''Parameters (text)'''
<pre>
/configurations/@[configuration_name]/hardware_units/@[hardware_name]/virtual_ports/@[port_name]
ethernet_ports = [ "@[port_name]" ]
name = "@[port_name]"
untagged = true
vid = 0
</pre>

'''Parameters (json)'''
<pre>
{
"ethernet_ports" : [
"@[port_name]"
],
"name" : "@[port_name]",
"untagged" : true,
"vid" : 0
}
</pre>
</div>

==List of Parameters==

* [[Parameter: Name|Name]]
* [[Parameter: Unit to create for|Unit to create for]]
* [[Parameter: Untagged|Untagged]]
* [[Parameter: VlAN ID|VLAN ID]]

Toolpack:Configuring Virtual Port A

2017-05-30T18:20:35Z

Lucas Trottier: /* To configure a virtual port */

=== '''''Applies to version(s): v2.8.''''' ===
{{DISPLAYTITLE:Configuring a Virtual Port}}

One or more virtual ports can be created to manage IP traffic.

 

== To configure a virtual port ==

1. Select '''IP Interfaces''' from the navigation panel:

[[Image:Create Voip Interface_0.png]] 

2. Click '''Create New Virtual Port''':

[[Image:VirtuaPort_0.png]] 

3. Configure the virtual port:

*Enter a name for the virtual port
*Select the hardware device to which the virtual port is assinged
*Enter a VLAN ID
*Click '''Create'''

[[Image:VirtuaPort_1.png]] 

4. From the ''Available'' ports window, select a physical port to which the virtual port is assigned. Note that this window is scrollable.

[[Image:VirtuaPort_2.png]] 

The selected port is displayed in the ''current'' physical ports window.

[[Image:VirtualPort_3.png]]

==List of Parameters==

* [[Parameter: Name|Name]]
* [[Parameter: Unit to create for|Unit to create for]]
* [[Parameter: Untagged|Untagged]]
* [[Parameter: VlAN ID|VLAN ID]]

Routing script tutorial:Mini Development Guide

2017-05-30T16:06:18Z

Lucas Trottier: /* sip uri parameters */

== Call object ==

=== Get ===

This function is used to get the call parameters. The possible parameters are described in the section "Call parameters"

called_number = caf_call.get :called

=== List_params ===

This function is used to retrieve the list of supported call parameters. For example to extract all the possible call params from the the call object and put it in hash.

caf_call.list_params.each {|param| call[param] = caf_call.get param }

=== Accept ===

This function is used to accept a call. It actually creates one outgoing route that gateway application will use to bridge the incoming call leg. If more than one outgoing route is "accepted", gateway will try them one by one in the same order they were accepted. If an outgoing call leg fails (according to 'route retry' parameters), the next route in line will be used.

This method takes 2 arguments, the call parameters (hash) and the route parameters (hash). Note that calling this method does NOT stop the flow of the script.

Apply route remapping rules

caf_call.accept out_call, route

=== Refuse ===

This function is used to set the reason code for the incoming call leg refusal. However, this function does NOT stop the flow of the script.

caf_call.refuse :reason => :temporary_failure

To immediately refuse the incoming call leg and stop processing the script, the script must raise an exception. Exiting the script by raising the exception overwrites any reason cause previously stored using refuse().

raise RoutingException, :no_route

The supported refusal cause values for both refuse() and raise() are described in the section "[[Routing_script_tutorial:Mini_Development_Guide#Reason_values|Reason values]]".

=== Script parameters protocol mapping ===

The following call parameters are available in the call object. For example

called_number = call[:called]

{| cellspacing="1" cellpadding="1" border="1" style="width: 921px; height: 805px;"
|-
! scope="col" | '''Script parameter name'''
! scope="col" | '''ISDN '''
! scope="col" | '''R2 CAS''' 
! scope="col" | '''SS7 '''
! scope="col" | '''SIP '''
! scope="col" | '''Comment '''
! scope="col" | '''Toolpack version '''
|-
| leg_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Leg ID 
| 
|-
| session_id 
| N/A 
| N/A 
| N/A 
| N/A 
| Session ID 
| 
|-
| calling 
| Q931: 'Calling party number' IE - Number digits 
| ANI (Group B) 
| Q763: 'Calling party number' IE - address signals (*) 
| SIP:From - user-info 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead. 
| 
|-
| calling_noa 
| Q931: 'Calling party number' IE - Type of number 
| N/A 
| Q763: 'Calling party number' IE - nature of address indicator (*) 
| N/A 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead 
| 
|-
| calling_npi 
| Q931: 'Calling party number' IE - Numbering plan identification 
| N/A 
| Q763: 'Calling party number' IE - numbering plan indicator (*) 
| N/A 
| * In ANSI SS7 LNP networks, the IE 'generic address parameter' is used (when present) instead 
| 
|-
| calling_display 
| Q931: 'Display' IE - Display information 
Q931: 'Facility CNAM' IE when presentation is allowed for DMS/NI2 variants 
| N/A 
| Q763
ITU97: 'Display information' IE - display information
ANSI95: 'Generic name' IE - display information
| SIP:From - display-name 
| 
| 
|-
| calling_display_type 
| Q931: 'Display' IE - Display information (present and/or first byte) 
| N/A 
| Q763: 'Display information' IE - present or not 
| N/A 
| 
| 
|-
| calling_presentation 
| Q931: 'Calling party number' IE - Presentation indicator 
| N/A 
| Q763: 'Calling party number' IE - address presentation restricted indicator 
|
SIP:From - display-name (displays 'anonymous' or not)

SIP:Remote-party-id - privacy 

| 
| 
|-
| calling_screening 
| Q931: 'Calling party number' IE - Screening indicator 
| N/A 
| Q763: 'Calling party number' IE - screening 
| SIP:Remote-party-id - screen 
| 
| 
|-
| calling_category 
| N/A 
| Call party category (Group A) 
| Q763: 'Calling party's category' IE - calling party's category 
|
SIP:From - cpc

SIP:P-asserted-identity - cpc 

| 
| 
|-
| calling_subscriber
(Generic Number / NDS) 
| Q931: 2nd 'Calling party number' IE - Number digits 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - Number digits 
|
SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| Requires option 'support 2 calling number IE' in the profile. This variable has priority over 'private_address' in the outgoing direction. 
| 
|-
| calling_subscriber_noa 
| Q931: 2nd 'Calling party number' IE - Type of number 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - nature of address indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| calling_subscriber_npi 
| Q931: 2nd 'Calling party number' IE - Numbering plan identification 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - numbering plan indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
 
| 
|-
| calling_subscriber_presentation 
| Q931: 2nd 'Calling party number' IE - Presentation indicator 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - presentation restricted indicator 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| calling_subscriber_screening 
| Q931: 2nd 'Calling party number' IE - Screening indicator 
| N/A 
| Q763: Generic number IE with type 'additional calling party number' - screening 
| SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 
| 
| 
|-
| private_display 
| Q931: 'Facility CNAM' IE when presentation is restricted for DMS/NI2 variants 
| N/A 
| N/A 
|
SIP:P-asserted-identity - display-name 

SIP:Remote-party-id - display-name 

| 
| 
|-
| private_display_type 
| N/A 
| N/A 
| N/A 
| N/A 
| Indicate presence or not of the private calling information 
| 
|-
| private_address 
| N/A 
| N/A 
| N/A 
|
SIP:P-asserted-identity - userinfo

SIP:Remote-party-id - user-info 

| 
| 
|-
| called 
| Q931: 'Called party number' IE - Number digits 
| DNIS (Group A) 
| Q763: 'Called party number' IE - address signals 
| SIP:To - user-info and host 
| 
| 
|-
| called_noa 
| Q931: 'Called party number' IE - Type of number 
| N/A 
| Q763: 'Called party number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| called_npi 
| Q931: 'Called party number' IE - Numbering plan identification 
| N/A 
| Q763: 'Called party number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| charge_number 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - address signals 
| N/A 
| 
| 
|-
| charge_number_noa 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| charge_number_npi 
| N/A 
| N/A 
| ANSI: 'Charge number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| redirecting_number_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default redirecting number and original called number forwarding behavior from incoming to outgoing leg 
| 
|-
| redirecting_number 
| Q931: 'Redirecting number' 1st IE - Number digits 
| N/A 
| Q763: 'Redirecting number' IE - address signals 
| SIP:Diversion (2nd header) - display-name 
| 
| 
|-
| redirecting_number_noa 
| Q931: 'Redirecting number' 1st IE - Type of number 
| N/A 
| Q763: 'Redirecting number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| redirecting_number_npi 
| Q931: 'Redirecting number' 1st IE - Numbering plan identification 
| N/A 
| Q763: 'Redirecting number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| redirecting_number_presentation 
| Q931: 'Redirecting number' 1st IE - Presentation indicator 
| N/A 
| Q763: 'Redirecting number' IE - address presentation restricted indicator 
| SIP:Diversion (2nd header) - diversion-privacy 
| 
| 
|-
| redirecting_number_indicator 
| N/A 
| N/A 
| Q763: 'Redirection information' IE - redirecting indicator 
| N/A 
| 
| 
|-
| redirecting_number_reason 
| Q931: 'Redirecting number' 1st IE - Reason for redirection 
| N/A 
| Q763: 'Redirection information' IE - redirecting reason 
| SIP:Diversion (2nd header) - diversion-reason 
| 
| 
|-
| redirecting_number_counter 
| N/A 
| N/A 
| Q763: 'Redirection information' IE - redirection counter 
| SIP:Diversion (2nd header) - diversion-counter 
| 
| 
|-
| original_called_number
(OCN) 
| Q931: 'Redirecting number' 2nd IE - Number digits 
| N/A 
| Q763: 'Redirection number' IE - address signals 
| SIP:Diversion  (1st header) - display-name 
| 
| 
|-
| original_called_number_noa 
| Q931: 'Redirecting number' 2nd IE - Type of number 
| N/A 
| Q763: 'Redirection number' IE - nature of address indicator 
| N/A 
| 
| 
|-
| original_called_number_npi 
| Q931: 'Redirecting number' 2nd IE - Numbering plan identification 
| N/A 
| Q763: 'Redirection number' IE - numbering plan indicator 
| N/A 
| 
| 
|-
| original_called_number_presentation 
| Q931: 'Redirecting number' 2nd IE - Presentation indicator 
| N/A 
| Q763: 'Redirection number' IE - address presentation restricted indicator 
| SIP:Diversion (1st header) - diversion-privacy 
| 
| 
|-
| original_called_number_reason 
| Q931: 'Redirecting number' 2nd IE - Reason for redirection 
| N/A 
| Q763: 'Redirection information' IE - original redirection reason 
| SIP:Diversion (1st header) - diversion-reason 
| 
| 
|-
| original_called_number_counter 
| N/A 
| N/A 
| N/A 
| SIP:Diversion (1st header) - diversion-counter 
| 
| 
|-
| ported_number 
| N/A 
| N/A 
| Q763: 'Called party number' IE - address signals 
| SIP:RequestURI - rn 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| ported_number_noa 
| N/A 
| N/A 
| Q763: 'Called party number' IE - nature of address indicator 
| N/A 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| ported_number_npi 
| N/A 
| N/A 
| Q763: 'Called party number' IE - numbering plan indicator 
| N/A 
| Only valid if SIP/SS7 supports LNP 
| 
|-
| oli
(Originating line information) 
| 5ESS Codeset 6 OLI - Value 
| N/A 
| ANSI: 'Originating line information' IE - OLI 
|
SIP:From - oli

SIP:P-asserted-identity - oli 

| 
| 
|-
| request_uri 
| N/A 
| N/A 
| N/A 
| Complete Request URI string 
| 
| 
|-
| request_uri_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default URI forwarding behavior from incoming to outgoing leg 
| 
|-
| sip_header 
| N/A 
| N/A 
| N/A 
| Any header 
| Requires option 'Forward custom headers' in Profiles->SIP 
| 2.7.63 
|-
| nap
(Network Access Point) 
| N/A 
| N/A 
| N/A 
| N/A 
| Incoming leg NAP name (read-only) 
| 
|-
| type_of_network_identification 
| Q931: 'Transit network selection' IE - Type of network identification 
| N/A 
| Q763: 'Transit network selection' IE - Type of network identification 
| N/A 
| 
| 2.7 
|-
| network_identification 
| Q931: 'Transit network selection' IE - Network identification 
| N/A 
| Q763: 'Transit network selection' IE - Network identification 
| SIP: Request-Line - cic 
| 
| 2.7 
|-
| network_identification_plan 
| Q931: 'Transit network selection' IE - Network identification plan 
| N/A 
| Q763: 'Transit network selection' IE - Network identification plan 
| N/A 
| 
| 2.7 
|-
| location_number_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Overwrite default location number forwarding behavior from incoming to outgoing leg 
| 2.7 
|-
| location_number 
| N/A 
| N/A 
| Q763: 'Location number' IE - address signals 
| N/A 
| 
| 2.7 
|-
| location_number_noa 
| N/A 
| N/A 
| Q763: 'Location number' IE - nature of address indicator 
| N/A 
| 
| 2.7 
|-
| location_number_npi 
| N/A 
| N/A 
| Q763: 'Location number' IE - numbering plan indicator 
| N/A 
| 
| 2.7 
|-
| location_number_presentation 
| N/A 
| N/A 
| Q763: 'Location number' IE - presentation restricted indicator 
| N/A 
| 
| 2.7 
|-
| location_number_screening 
| N/A 
| N/A 
| Q763: 'Location number' IE - screening 
| N/A 
| 
| 2.7 
|-
| mlpp_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| A script needs to set this to true if it wants to overwrite MLPP information in the outgoing leg. Otherwise, profile relay 'outgoing mode' applies automatically. 
| 2.7 
|-
| mlpp_look_for_busy 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - look ahead for busy 
| N/A 
| 
| 2.7 
|-
| mlpp_precedence_level 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - precedence level 
| SIP:Resource-Priority - q735 
| 
| 2.7 
|-
| mlpp_network_identity 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - network identity 
| N/A 
| 
| 2.7 
|-
| mlpp_service_domain 
| N/A 
| N/A 
| Q763: 'MLPP precedence' IE - MLPP service domain 
| N/A 
| 
| 2.7 
|-
| called_isub 
| Q931: 'Called party subaddress' IE - subaddress information 
| N/A 
| Q763: 'Access transport' IE 
| SIP:To - isub parameter 
| 
| 2.7 
|-
| called_isub_type 
| Q931: 'Called party subaddress' IE - type of subaddress 
| N/A 
| Q763: 'Access transport' IE 
| SIP:To - isub-encoding parameter 
| 
| 2.7 
|-
| calling_isub 
| Q931: 'Calling party subaddress' IE - subaddress information 
| N/A 
| Q763: 'Access transport' IE 
| SIP:From - isub 
| 
| 2.7 
|-
| calling_isub_type 
| Q931: 'Callinf party subaddress' IE - type of subaddress 
| N/A 
| Q763: 'Access transport' IE 
| SIP:From - isub-encoding 
| 
| 2.7 
|-
| ss7_fci_default 
| N/A 
| N/A 
| Default forward call indicator (FCI) value. 
| N/A 
| Toolpack will overwrite FCI bits A, D, F, I and M with appropriate values according to call conditions 
| 2.7 
|-
| ss7_fci_force_mask 
| N/A 
| N/A 
| Mask to select bits from ss7_fci_default that must be forced. 
| N/A 
| Bits from ss7_fci_default which corresponding bit in ss7_fci_force_mask is set will be forced, and no more controlled by Toolpack 
| 2.7 
|-
| ss7_bci_default 
| N/A 
| N/A 
| Default backward call indicator (BCI) value. 
| N/A 
| Toolpack will overwrite BCI bits AB, I, K, M and N with appropriate values according to call conditions 
| 2.7 
|-
| ss7_bci_force_mask 
| N/A 
| N/A 
| Mask to select bits from ss7_bci_default that must be forced. 
| N/A 
| Bits from ss7_bci_default which corresponding bit in ss7_bci_force_mask is set will be forced, and no more controlled by Toolpack 
| 2.7 
|-
| tdm_ls_name
(Line Service or T1/E1 trunk) 
| Incoming leg line service name 
| Incoming leg line service name 
| Incoming leg line service name 
| N/A 
| (read-only) 
| 2.7 
|-
| tdm_timeslot_nb 
| Incoming leg timeslot number 
| Incoming leg timeslot number 
| Incoming leg timeslot number 
| N/A 
| (read-only) 
| 2.7 
|-
| rtp_local_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg local SDP IP address 
| (read-only) 
| 2.7 
|-
| rtp_local_port 
| N/A 
| N/A 
| N/A 
| Incoming leg local SDP IP port 
| (read-only) 
| 2.7 
|-
| rtp_remote_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SDP IP address 
| (read-only) 
| 2.7 
|-
| rtp_remote_port 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SDP IP port 
| (read-only) 
| 2.7 
|-
| ss7_cot_enabled 
| N/A 
| N/A 
| Requests SS7 in-call continuity test for this outgoing SS7 call 
| N/A 
| Toolpack will request continuity test on the timeslot before making the outgoing call. If COT fails, the call will be dropped (then another route may be attempted) 
| 2.8 
|-
| reverse_charging_indication 
| Incoming leg Reverse charging indication IE present 
| N/A 
| N/A 
| N/A 
| If set in routing script, will add Reverse charging indication IE in outgoing leg (also use reverse_charging_indication_forward_enabled) 
| 2.8.12 
|-
| reverse_charging_indication_forward_enabled 
| N/A 
| N/A 
| N/A 
| N/A 
| Enable forwarding of reverse charging indication from incoming to outgoing leg 
| 2.8.12 
|-
| sip_local_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg local SIP IP address 
| (read-only) 
| 2.8.13 
|-
| sip_local_port 
| N/A 
| N/A 
| N/A 
| Incoming leg local SIP UDP port 
| (read-only) 
| 2.8.13 
|-
| sip_remote_addr 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SIP IP address 
| (read-only) 
| 2.8.13 
|-
| sip_remote_port 
| N/A 
| N/A 
| N/A 
| Incoming leg remote SIP UDP port 
| (read-only) 
| 2.8.13 
|}

 

=== Noa values ===

*<tt>unknown_number (0x2)</tt>
*<tt>international_number (0x4)</tt>
*<tt>national_number (0x3)</tt>
*<tt>subscriber_number (0x1)</tt>
*<tt>network_specific (0x5)</tt>
*<tt>network_routing_national_format (0x7)</tt>
*<tt>network_routing_international_format (0x8)</tt>
*<tt>abbreviated_number (0x6)</tt>
*<tt>subscriber_number_operator_requested (0x71)</tt>
*<tt>national_number_operator_requested (0x72)</tt>
*<tt>international_number_operator_requested (0x73)</tt>
*<tt>no_number_present_operator_requested (0x74)</tt>
*<tt>no_number_present_cut_through_call_to_carrier (0x75)</tt>
*<tt>test_line_test_code (0x77)</tt>
*<tt>non_unique_subscriber_number (0x71)</tt>
*<tt>non_unique_national_number (0x73)</tt>
*<tt>non_unique_international_number (0x74)</tt>
*<tt>call_950_numbe (0x76)</tt>
*<tt>special_number (0x73)</tt>
*<tt>national_number_with_transit_network_selection (0x74)</tt>
*<tt>international_number_with_transit_network_selection (0x75)</tt>

Those values will be remapped to the protocol specific NOA value. To provide protocol specific value:

*<tt>call_params[:called_noa] = 0x70</tt>

or

*<tt>call_params[:called_noa] = 112</tt>

=== Npi values ===

*<tt>unknown_number</tt>
*<tt>isdn</tt>
*<tt>telephony</tt>
*<tt>private</tt>
*<tt>data</tt>
*<tt>telex</tt>
*<tt>national</tt>

=== Calling Display Type values ===

*<tt>unspecified</tt> => Type is unspecified.
*<tt>calling_party_name</tt> => Type is 0xB1.

Those values will be remapped to the protocol specific Display Information Type value. To provide protocol specific value:

*<tt>call_params[:calling_display_type] = 0xB1</tt>

or

*<tt>call_params[:calling_display_type] = 177</tt>

=== Calling Display value ===

*<tt>call_params[:calling_display] = "Roger Fluffy"</tt>

=== Presentation values for Calling number, Calling Subscriber (Generic Number), Redirecting Number, Original Called Number (OCN) and Location Number ===

*<tt>unspecified</tt>
*<tt>not_available (0x2)</tt>
*<tt>allowed (0x0)</tt>
*<tt>restricted (0x1)</tt>
*<tt>addr_restricted</tt>
*<tt>name_restricted</tt>

=== Calling Party Category ===
values for calling_category
*<tt>unspecified</tt> <tt>(0xa)</tt>
*<tt>unknown</tt> <tt>(0x0)</tt>
*<tt>operator_french</tt> <tt>(0x1)</tt>
*<tt>operator_english</tt> <tt>(0x2)</tt>
*<tt>operator_german</tt> <tt>(0x3)</tt>
*<tt>operator_russian</tt> <tt>(0x4)</tt>
*<tt>operator_spanish</tt> <tt>(0x5)</tt>
*<tt>subscriber</tt> <tt>(0xa)</tt>
*<tt>subscriber_with_priority</tt> <tt>(0xb)</tt>
*<tt>data</tt> <tt>(0xc)</tt>
*<tt>test</tt> <tt>(0xd)</tt>
*<tt>payphone</tt> <tt>(0xf)</tt>

=== Screening values for Calling number, Calling Subscriber (Generic Number), and Location Number ===

*<tt>unspecified</tt>
*<tt>no (0x0)</tt>
*<tt>pass (0x1)</tt>
*<tt>fail (0x2)</tt>
*<tt>network_provided (0x3)</tt>

=== Redirecting indicator values ===

SS7:

*<tt>no_redirection</tt>
*<tt>call_rerouted</tt>
*<tt>call_rerouted_all_restricted</tt>
*<tt>call_diverted</tt>
*<tt>call_diverted_all_restricted</tt>
*<tt>call_rerouted_restricted</tt>
*<tt>call_diverted_restricted</tt>
*<tt>spare</tt>

=== Redirecting number, Original Called Number and Diversion Reason ===

ISDN:

*<tt>unknown</tt>
*<tt>busy</tt>
*<tt>no_reply</tt>
*<tt>deflection</tt>
*<tt>dte_out_of_order</tt>
*<tt>forwarding_by_called_dte</tt>
*<tt>unconditional</tt>

SS7:

*<tt>unknown</tt>
*<tt>busy (SIP: user-busy)</tt>
*<tt>no_reply (SIP: no-answer)</tt>
*<tt>unconditional</tt>
*<tt>deflection</tt>
*<tt>deflection_immediate</tt>
*<tt>mobile_not_reachable</tt>

=== OLI (originating line information) values ===

The OLI parameter is a string that represents an integer value from 0 to 255.

=== Information Transfer Capability values ===

information_transfer_capability:

*<tt>digital</tt>
*<tt>restricted_digital</tt>
*<tt>digital_with_tones</tt>
*<tt>speech</tt>
*<tt>3_1_khz_audio</tt>
*<tt>video</tt>

=== redirecting_number_forward_enabled values ===

Controls forwarding or discarding of redirecting number (SIP: diversion header) to outgoing call leg.

Values for this parameter are "0", "1", "false" or "true.
*0/false: Redirecting number (and original called number) is not forwarded to outgoing call leg
*1/true: Redirecting number (and original called number) is forwarded to outgoing call leg

The value for this parameter at input of routing script depends on the "Forward redirecting number" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.

Note: To "insert" a new redirecting number value on the outgoing leg, redirecting_number_forward_enabled must also be set to true.

=== request_uri ===

Enables access to the Request-Line URI. 

For example, if the Request-Line is:
<pre>Request-Line: INVITE sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0</pre>
Then the retrieved request_uri will be "sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0". 

In the routing scripts, to retrieve only the called number, this script can be used: 
<pre> if call_params[:request_uri] && call_params[:request_uri] =~ /sip:(.*)@.*/
call_params[:called] = $1
end
</pre>
=== request_uri_forward_enabled values ===

Controls forwarding or discarding of request uri to outgoing call leg.The request uri is the information in the "Request-Line:" of the SIP INVITE message. 

Values for this parameter are "0", "1", "false" or "true. 

* 0/false: Request uri is not forwarded to outgoing call leg 

* 1/true: Request uri is forwarded to outgoing call leg 

The value for this parameter at input of routing script is always false. 

=== sip_header values ===
Contains custom sip headers from the inbound call leg. Any custom sip header can be added to an outgoing call leg: 

'''Note:'''

The SIP header is in hash format for a releases older than rel2.7.161.

It has been changed to string format because using a hash does not allow having multiple times the same header for certain releases of rel2.8 and rel2.9

Beginning from rel2.10.21, both hash and string format are supported to construct the outgoing SIP header. However only string format is used for the incoming SIP header.

'''hash format:'''
<pre>call[ :sip_header ] = {"P-my-custom-header"=>"value1", "P-my-custom-header2"=>"value2", "P-my-custom-header3"=>"value3"}</pre>

'''string format:'''
<pre>call[ :sip_header ] = "P-my-custom-header:value1 \nP-my-custom-header2:value2 \nP-my-custom-header3:value3"

</pre>

* PCAP sample: [[File:TB_Custom_SIP_Headers.pcap]]

List of sip headers that will not appear in call[:sip_header] since they are already processed by the SIP stack:
<pre>
Accept Error-Info Remote-Party-ID
Accept-Contact Event Replaces
Accept-Encoding Expires Reply-To
Accept-Language From Request-Disposition
Alert-Info In-Reply-To Subject
Allow Max-Forwards Subscription-State
Allow-Events MIME-version Supported
Also Min-Expires Timestamp
Anonymity Min-SE To
Authorization Organization Unsupported
Authentication-Info Path User-Agent
Call-ID Priority Via
Call-Info Privacy Warning
Contact Proxy-Authenticate WWW-Authenticate
Content-Disposition Proxy-Authorization Require
Content-Encoding Proxy-Require Response-Key
Content-Language P-Media-Authorization Retry-After
Content-Length P-Preferred-Identity RPID-Privacy
Content-Type P-Asserted-Identity Route
CSeq RAck RSeq
RAck Reason Security-Client
Reason Record-Route Security-Server
Date Refer-To Security-Verify
Diversion Referred-By Server
Encryption Reject-Contact Service-Route
Session-Expires
</pre>

=== sip uri parameters ===
Access to parameters of several SIP headers (To, From, P-Asserted-Identity, Remote-Party-ID, Contact).

<pre>
call[ :calling_parameters ]
call[ :called_parameters ]
call[ :private_address_parameters ] (for P-Asserted-Identity or Remote-Party-ID)
call[ :contact_parameters ]
</pre>

These parameters (if present) contains a hash with 3 keys: user_param, uri_param and header_param.
If a param has already a specific field (oli, isub, cpc, transport), it won't be present in the new generic structure.

By default, the parameters are not forwarded in a SIP to SIP call flow. The parameters '''will be forwarded''' only if:
* accessed (read) from either the inbound or outbound call parameters
* written in either the inbound or outbound call parameters

Using this code in routing script:
<pre>
puts "calling_param = #{ call[ :calling_parameters].inspect}"
</pre>

Example, From header format and what you will see in call[ :calling_parameters]:
<pre>
From:"test"<sip:4440000;user_param1=1;user_param2@10.3.10.217;uri_param3=3>;header_param4=4;tag=6F97303034343030002A2484
calling_param = {"user_param"=>"user_param1=1;user_param2", "uri_param"=>"uri_param3=3", "header_param"=>"header_param4=4"}
</pre>

'''Note''' that printing the inbound or outbound call parameters is considered as a "read" action and would result in forwarding the parameter on the outbound leg.

<pre>
From:"test"<sip:4440000@10.3.10.217;user=phone>;tag=6F97303034343030002A2484
calling_param = {"uri_param"=>"user=phone"}
</pre>

Example to insert outgoing parameters and overwrite received values.
<pre>
call [:calling_parameters] = {"user_param"=>"user_param7=7;user_param8", "uri_param"=>"uri_param9=9", "header_param"=>"header_paramA=A"}
</pre>

Example to add user=phone and keep all other uri parameters.
<pre>
if call [:calling_parameters]
if call [:calling_parameters]["uri_param"]
call[:calling_parameters]["uri_param"] << ";user=phone"
else
call [:calling_parameters]["uri_param"] = "user=phone"
end
else
call [:calling_parameters] = {"uri_param"=>"user=phone"}
end
</pre>

=== MLPP Precedence values ===

mlpp_look_for_busy:

*<tt>allowed</tt>
*<tt>path_reserved</tt>
*<tt>not_allowed</tt>

mlpp_precedence_level:

*<tt>flash_override</tt>
*<tt>flash</tt>
*<tt>immediate</tt>
*<tt>priority</tt>
*<tt>routine</tt>

mlpp_network_identity:

3 digits value from 0 to 999

mlpp_service_domain:

24 bits value from 0 to 16777215

=== ISUB subaddress information values ===

called_isub_type:
calling_isub_type:

*<tt>nsap</tt>
*<tt>nsap_ia5</tt>
*<tt>nsap_bcd</tt>
*<tt>user</tt>

called_isub:
calling_isub:

Digits for the subaddress information.

=== Network Identification Plan ===

network_identification_plan:

*<tt>Unknown</tt> (value 0)
*<tt>cic</tt> (3 digits carrier identification code plus circuit code, value 1, SS7 or ISDN)
*<tt>user</tt> (User, value 2, ISDN only)
*<tt>cic4</tt> (4 digits carrier identification code plus circuit code, value 2, SS7 only)
*<tt>dnic</tt> (public Data Network ID, value 3, SS7 only)
*<tt>mnic</tt> (public land mobile network, value 6, SS7 only)

== Route parameters ==

All route may have these parameters:

*calling
*called
*nap
*remapped_calling
*remapped_called
*remapped_nap
*remapped_destination_leg_profile (called remapped_profile prior to Toolpack 2.9)
*remapped_source_leg_profile (called remapped_incoming_profile prior to Toolpack 2.9)

Example:

route[:remapped_nap]

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

== Playing prompts announcements or tones ==

New feature in release 2.6, all bridges may have these parameters. These can be used to play IVR prompts (audio files) in different states of the call flow.

*'''announcement_tone''' (played before outgoing call is routed)
*'''ring_tone''' (played after when waiting for outgoing call to answer)
*'''busy_tone''' (played if outgoing call failed)
*'''disconnect_tone''' (played after the call has reached it's maximum duration)

The following sections show how to access those different parameters from '''inside''' a filter. The 'params' hash is the sole argument passed to a filter function and contains call, nap, route and bridge parameters. This hash is created by the base_routing.rb scripts to regroup all relevant information just before calling the filter functions.

=== Tone string format ===

All tone strings (:announcement_tone, :busy_tone, :ring_tone, :disconnect_tone) inside bridge parameters are using this format.
<pre>"file1.wav:repeat:start_off:end_off,file2.wav:repeat:start_off:end_off,file3.wav:repeat:start_off:end_off"
</pre>
Optional parameters:
* repeat: number of times to play the file (0 and 1 have the same result)
* start_off: Start offset in milliseconds
* end_off: End offset in milliseconds

Http and other path formats are described here: [[Customer_application_framework:play_audio_files#Play_path_format|Path format]]

==== Example 1 ====
The following example will play file1.wav once, and then play file2.wav in loop:
"file1.wav,file2.wav:-1"

==== Example 2 ====
The following example will play file1.wav from start offset of 1 second to end offset of 3 seconds, then twice file2.wav from second 5 to second 10.
"file1.wav:0:1000:3000,file2.wav:2:5000:10000"

==== Example 3 ====
The following example will play file1.wav once, ending at offset of 30 seconds.
"file1.wav:0:0:30000"

=== announcement_tone ===

params[:bridge][:announcement_tone] = "announcement.wav"

Audio file played on the incoming call before any outgoing call is placed. The outgoing call occurs when the file finished playing.

==== announcement_tone options ====
===== announcement_tone_answer =====
params[:bridge][:announcement_tone_answer] = "yes"

Forces an answer of the call before playing the announcement. Default if argument not provided is "no", in which case call is only alerted with in-band media.

===== announcement_code_detect =====
This option allows to enable tone detection during the announcement play.

Collected digits can be inserted into the CDR logs (radius attribute "Telcob-CollectedDigits", or text CDR variable @{CollectedDigits}).

Collected digits can also be sent back to routing script, which is called again with the same call attributes, except that the called number is replaced by the collected digits.

Code detect has multiple options, as shown in the following code:
code_detect = {
:type => :DTMF, # :DTMF or :MFR1 tone detection.
# Default is MFR1.
:prefix => "", # Prefix (digits) that is removed from collected digits.
# Default is empty.
:suffix => "", # Suffix (digits) that is removed from collected digits
# and causes routing script to be immediately called.
# Default is empty.
:suffix_removal => false, # Controls the removal of the suffix from the collected digit string that's reported to routing script.
# Default is false
:timeout => 0, # Inter-digit timeout (ms) after which collected digits are passed to the routing script.
# Use 0 for "no timeout".
# Default is 1000ms
:barge_in_interruption => true, # When enabled, playing announcement is stopped as soon as first digit is collected.
# Default is true.
:proceed_on_play_done => false, # When true: Outgoing call is made after announcement finishes playing.
# Routing script is not called again.
# When false: Outgoing call is never made.
# Digits are collected until timeout or suffix match,
# then routing script is called again.
# Default is false.
:cas_on_hook => false, # Specific for CAS-R1 calls. Makes CAS bits switch to "on-hook" when announcement finished playing
# (but the call is not "terminated" from Toolpack point of view)
# Default is false.
:cas_on_hook_delay => 0, # Duration of cas bits "on-hook" state.
# Only effective if cas_on_hook is set to true.
# Value of 0 stands for "infinite delay".
# Default is 0.
:repeat_delay => 0, # Delay between repetition of the announcement. The announcement will repeat
# itself every "repeat_delay" until a code is detected (suffix match or timetout).
# Value of 0 stands for "infinite delay" (no repeating).
# Default is 0.
}
'''Example 1''': Collect DTMF digits, and call routing script again with collected digits upon timeout or suffix match.
code_detect = { :type => :DTMF, :suffix => "#", :timeout => 5000 }
params[:bridge][:announcement_code_detect] = code_detect

'''Example 2''': Collect digits during the announcement (for CDR logs), then proceed (make outgoing call) after announcement finishes playing
code_detect = { :type => :DTMF, :timeout => 0, :barge_in_interruption => false, :proceed_on_play_done => true }
params[:bridge][:announcement_code_detect] = code_detect

==== Controlling what happens after announcement ====
The routing script can control what happens with the call after the announcement finishes playing:
* An outgoing call is made
* Incoming call is hung-up
* Do nothing (wait for the incoming call to hang-up)
===== An outgoing call is made =====
This happens when the script has returned matching routes (and did not raise RoutingException)

===== Incoming call is hung-up =====
This happens when the script returns no routes (in which case base_routing will raises RoutingException with cause :no_route).

It also happens when the script explicitly raises RoutingException.

The incoming call will be terminated with the specified cause.
For example
raise RoutingException, :temporary_failure
(See "Reason values" section in this page for list of available causes)

===== Do nothing (wait for the incoming call to hang-up) =====
If a filter raises RoutingException with code :ok, then the incoming call will not be terminated at the end of the announcement play.
Announcement digit collection will remain active if appropriate.
For example:
raise RoutingException, :ok

=== ring_tone ===
params[:bridge][:ring_tone] = "ringing.wav"

Audio file played on the incoming call while waiting for the outgoing call to be answered.

Ring tone playback can also be configured in the Web Portal, from the incoming call's profile (under "Tones and Call Progress Options").

Routing script has precedence over profile (a routing script that fills params[:bridge][:ring_tone] will override the profile's ring tone behavior).

==== ring_tone options ====
===== ring_tone_state =====
params[:bridge][:ring_tone_state] = :alerted

Call state from which ring tone is being played. Available values are:
* '''immediately''': Ring tone starts playing immediately on the incoming leg
* '''accepted''': Ring tone starts playing as soon as outgoing call is accepted
* '''callprogress''': Ring tone starts playing as soon as "call progress" is received on the outgoing call
* '''alerted''' (default): Ring tone starts playing only once outgoing call is alerted (but won't play if alert indicates early media from outgoing call)

This option also apply when params[:bridge][:ring_tone] is not used, because it also apply to ring tone playback configured in the Web Portal, from the incoming call's profile.

=== busy_tone ===
Toolpack 2.8 and above:
params[:bridge][:busy_tone] = "no_route.wav"

Note: Obsolete name (toolpack 2.7.153 and earlier, but still supported in recent releases):
params[:bridge][:call_progress_tone] = "no_route.wav"

Audio file played on the incoming call when outgoing call fails (never answered).

Note that announcement_tone, if used, is played before the outgoing call attempt is made, and thus before the busy_tone.

Busy tone playback can also be configured in the Web Portal, from the incoming call's profile (under "Tones and Call Progress Options").

Routing script has precedence over profile (a routing script that fills params[:bridge][:busy_tone] will override the profile's busy tone behavior).

Special value '''"none"''' can be used by routing script to force playing nothing (as empty string would default to profile's behavior)

==== busy_tone options ====
===== busy_tone_answer =====
params[:bridge][:busy_tone_answer] = "yes"

Forces an answer of the call before playing the busy tone. Default if argument not provided is "no", in which case call is only alerted with in-band media.

=== disconnect_tone ===
params[:bridge][:disconnect_tone] = "max_duration.wav"

Audio file played on the incoming call when call duration (:max_call_duration) is reached. Then the leg will be terminated with specified reason (:call_duration_reason).

==== disconnect_tone options ====
===== max_call_duration =====
params[:bridge][:max_call_duration] = "60000"

Maximum call duration in millisecond. This timer is started when entering answer state.

===== call_duration_reason =====
params[:bridge][:call_duration_reason] = :resource_unavailable

Drop both legs with this reason when call duration (:max_call_duration) is reached.

=== Managing audio prompts through Web Portal ===
Audio prompts can be uploaded or deleted from the TMedia unit through the Web Portal:
[[Toolpack:Configuring_Audio_Prompts_A|Managing audio prompts]]

Prompts management must be done using the Web Portal of the primary server (in systems with redundant TMedia units or redundant host servers).
The file will automatically get replicated to the secondary server.

=== Managing audio prompts manually ===
Any file on the TMedia host file system can be played. This means it's possible to manage prompts through ssh/scp.

==== The default (replicated) prompts folder ====
By default, when playing a prompt, Toolpack will look in the default prompts folder:
/lib/tb/toolpack/pkg/prompts
The root of this "prompts" directory is automatically replicated to secondary unit of redundant setups (1+1, N+1, redundant hosts). Sub-folders won't be replicated.

Any prompt play request without explicit file path will map to this folder. For example:
params[:bridge][:busy_tone] = "no_route.wav"
This will correspond to file /lib/tb/toolpack/pkg/prompts/no_route.wav

==== Relative file paths ====
Any file path that begins with "file://" is considered relative to the tbstreamserver application's working directory:
/lib/tb/toolpack/setup/12358/2.8/apps/tbstreamserver/
(Where "2.8" may be replaced by the current major version of your system)

For example:
params[:bridge][:busy_tone] = "file://my_folder/no_route.wav"
This will correspond to file /lib/tb/toolpack/setup/12358/2.8/apps/tbstreamserver/my_folder/no_route.wav

==== Absolute file paths ====
Absolute paths can also be provided.
For example:
params[:bridge][:busy_tone] = "file:///root/my_folder/no_route.wav"
This will correspond to file /root/my_folder/no_route.wav

== Recording call legs ==
Introduced in release 2.6.44, it's now possible to use routing scripts to ask for recording incoming and/or outgoing call legs.

See example filter script "call_recording" (created by default in Web Portal routing scripts starting with 2.6.44) for an example.

=== Recording the incoming call leg ===
To record the incoming call leg, the routing script (in a "after filter" for example) has to set the following parameter:

bridge[ :record_incoming ] = ""

=== Recording the outgoing call leg ===
To record the outgoing call leg, the routing script (in a "after filter" for example) has to set the following parameter, per route (the decision to record or not, or the file name to record to, can be set per matching route):

# Need to clone the routes in order to have the right to modify them
routes = clone_routes params[:routes]
routes.each do |route|
route[ :record_outgoing ] = ""
end
# Store modified routes back to the parameters for this outgoing call
params[:routes] = routes

=== Record the outgoing call leg within incoming leg's recorded file (mixing) ===
[...]
route[ :record_outgoing ] = "@{MixWithIncoming}"
[...]

=== Choosing file path to record to ===
The value assigned to ":record_incoming" or ":record_outgoing" is the path to record the file to.

The paths can be absolute, or relative. When relative, they are relative to the "tbstreamserver" application working directory, for example:
/lib/tb/toolpack/setup/12358/2.7/apps/tbstreamserver/

* Empty file name will default to a name that contains various information about the call:
** ''LinkId'': Id common between all legs of this call bridge
** ''LegId'': Unique Id for this leg
** ''Nap'': Current NAP name this call leg is from
** ''Direction'': "IN" or "OUT" (depends if call leg is incoming or outgoing leg)
** ''Calling'': The calling number of this call leg
** ''Called'': The called number of this call leg
** ''Protocol'': The signaling protocol of this call leg (SS7, ISDN, CAS, SIP)
** ''Media info'': Codec + IP/Port for SIP calls, Trunk/Timeslot for TDM calls
* To record outgoing call leg in the same audio file as incoming call leg (mixing), use the following:
** @{MixWithIncoming}: Record outgoing legs in same file as incoming legs
* Variables can be used to insert in the recording path information that's not already available from routing scripts:
** @{CURRENT_PKG}: Version of current package
*** Example: 2.6.45
** @{DATE format}: Prints the date, where 'format' is expressed as described for the 'strftime' function
*** Example: @{DATE %Y-%m-%d} => 2013-01-28
** @{DefaultName}: Replaced by the default file name for recording, which contains:
*** LinkId: Id common between all legs of this call bridge
*** LegId: Unique Id for this leg
*** Nap: Current NAP name this call leg is from
*** Direction: "IN" or "OUT" (depends if call leg is incoming or outgoing leg)
*** Calling: Calling number
*** Called: Called number
*** Protocol: Protocol type of this call (SS7, ISDN, CASR2, SIP)
*** Media info: Codec + IP/Port for SIP calls, Trunk/Timeslot for TDM calls
*** Example: "73EBA698-F3D67B4B-NAP_SS7-IN-5550000-5550001-SS7-TRUNK_BELL_11-24.wav"
*** Example: "73EBA698-73EBA698-NAP_SIP-OUT-5550000-5550001-SIP-G723-10.3.10.101-1050.wav"
** @{DefaultPath}: Default recording folder and file name: "@{RECORD_PATH}/@{DATE %Y-%m-%d}/@{DefaultName}"
*** Example: "/lib/tb/toolpack/setup/12358/recorded_calls/73EBA698-F3D67B4B-NAP_SS7-IN-5550000-5550001-SS7-TRUNK_BELL_11-24.wav"
*** Example: "/lib/tb/toolpack/setup/12358/recorded_calls/73EBA698-73EBA698-NAP_SIP-OUT-5550000-5550001-SIP-G723-10.3.10.101-1050.wav"
** @{Direction}: Direction of current leg (IN our OUT)
*** Example: IN
** @{LegId}: Current LegId (Unique Id for this leg)
*** Example: F3D67B4B
** @{LinkId}: Current LinkId (Id common between all legs of this call bridge)
*** Example: 73EBA698
** @{PKG_HOME}: Path where packages are stored.
*** Note: It's not recomended to use that path on redundant systems, package file replication may cause confusion in recorded files.
*** Example: /lib/tb/toolpack/pkg
** @{PROMPT_PATH}: Default path where audio prompts are stored
*** Note: It's not recomended to use that path on redundant systems, package file replication may cause confusion in recorded files.
*** Example: /lib/tb/toolpack/pkg/prompts
** @{Protocol}: Protocol of current leg
*** Example: SS7
** @{RECORD_PATH}: Default recording folder: "@{TB_SETUP_HOME}/recorded_calls/"
** @{TBX_GW_PORT}: Current "System Id" (also called "Gateway Port")
*** Example: 12358
** And all variables listed here: [[Customer_application_framework:play_audio_files#Helpful_variables_to_build_play_or_record_file_paths|Building play or record file path]]

== Controlling UUI (user-to-user information) relay ==
UUI (user-to-user information) can be present in different messages received by either call leg during a call. For example, information can be carried during the initial invite, other information can be carried when the call is alerted, answered, or terminated.

Routing scripts can control if the UUI received from one leg through the call will be forwarded or not to the other call leg:
*uui_forward_enabled

Routing scripts can also read and modify the UUI received with the incoming call leg, before it gets forwarded upon creation of the outgoing call leg:
*uui

=== UUI (user-to-user indication) values ===

Byte array represented as ruby String. Use ''bridge=params[:bridge]'', then ''bridge[:uui]'' to access the data.

To access the bytes in Ruby, use ruby String operator []. For example: bridge[:uui][0] will return the binary value of the first UUI byte.

Function each_byte can also be useful to iterate through all bytes of the UUI.

=== uui_forward_enabled values ===

Controls forwarding or discarding of UUI to outgoing call leg.

Values for this parameter are "0", "1", "false" or "true.
* 0/false: UUI is not forwarded between call legs
* 1/true: UUI is forwarded between call legs

The value for this parameter at input of routing script depends on the "Forward UUI" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.

== Authorization ==
Starting with release 2.7, it is possible to issue RADIUS authorization requests from routing scripts. To do so, the params[:authorization] object must be filled with the required RADIUS attributes and [[#Refuse|an exception must be raised]] with reason :authorization_required.

When the authorization is completed, the routing script is called again with the result. The params[:authorization] object will be filled with the RADIUS attributes from the response. The params[:authorization][:result] field will also contain a string indicating the result of the authorization:

* ''accept'': The authorization was successful.
* ''reject'': The authorization was refused.
* ''challenge'': The authorization was challenged.
* ''timeout'': The authorization was not answered.

== Call diversion options ==
It's possible to control the call flow when a call diversion information is received in the alerting state.

Two fields are available: bridge[ :diversion ] and bridge[ :diversion_reason ]

The internal release cause TOOLPACK_DIVERT_NOT_ALLOWED is used by gateway application to terminate both legs.

bridge[ :diversion ] = :allowed
The alert message will not be analyzed and the call will be progressed. Default behavior.
bridge[ :diversion ] = :not_allowed
If the alert message indicates that the call is diverted, the call will be released no matter the In-band information to allow
early media.
bridge[ :diversion ] = :not_allowed_w_early_media
The call will be released If the alert message indicates that the call is diverted with in-band information to allow early media.
bridge[ :diversion_reason ] = "*"
If the diversion is not allowed, the gateway will drop the call for any redirecting reason.
bridge[ :diversion_reason ] = "0,1,2"
or
bridge[ :diversion_reason ] = "unknown,busy,no_reply"
If the diversion is not allowed, the redirecting reason will be analyzed and the call will only be dropped for the configured cases.

See section [[Routing_script_tutorial:Mini_Development_Guide#Redirecting_number,_Original_Called_Number_and_Diversion_Reason|Redirecting number reason values]].

== Call transfer requests ==
Toolpack allows to relay [[Call transfer]] requests from one leg to the other, or to process them locally (making another outgoing call to replace the call that requested the call transfer).

If the chosen [[Call transfer]] mode is to process requests locally, upon reception of a call transfer request (SIP REFER or ISDN Facility), routing script will be called once again, to select the routes for the new outgoing call (call transfer target).

=== How to route call transfer request ===
Routing of a call transfer request is done exactly like routing of a normal incoming call.
The routing script generally does not need any modification to support that.

In some cases, the routing script may want to use information related to the transfer request to perform routing, or to insert information in the outgoing call leg.
Additional information is provided to the routing script, allowing routing decisions using information from the call transfer request (SIP REFER or ISDN Facility).
See below...

=== params[ :call ] content during transfer request ===
When processing a call transfer request, the params[ :call ] hash contains the information from the inbound call (same as was passed to the routing script upon arrival of the inbound call)
call = params[ :call ] -> Information from original inbound call, with exception of call[ :called ]

One exception (convenient because it allows a unmodified routing script to process call transfer request the same way as any other routing request):
call[ :called ] -> Replaced by the called number from the call transfer request (also called "redirection number")
Complementary information:
call[ :original_called_number ] -> Contains the called number that was initially received from the incoming call, prior to call transfer request
call[ :redirecting_number ] -> Number of the call from which the call transfer request was received (generally equals to original_called_number)

These fields will also be included in the outgoing call made after routing:
* original called number and redirecting number are existing fields on SS7 and ISDN calls
* SIP "diversion" header is used for SIP calls

=== params[ :transfer ] content ===
(this if valid only for release 2.7.102 and above) 
When processing a call transfer request, information from the call transfer request message (SIP REFER, ISDN Facility) is provided in params[ :transfer ]:
transfer = params[ :transfer ]
The following field is always present:
transfer[ :original_nap ] -> Contains the NAP of the first call from which a call transfer request was received
transfer[ :redirecting_nap ] -> Contains the NAP of the call from which the current call transfer request was received
(same as :original_nap for the first call transfer, different for subsequent transfers)
Examples of other fields that may be present, when appropriate:
transfer[ :uui ] -> The UUI (user-to-user information) found in the call transfer request
transfer[ :sip_header ] -> Contains custom SIP headers from the call transfer request
transfer[ :request_uri ] -> Contains the SIP Request URI

These field are 'read-only'. They won't be included in the outgoing call, as they represent the content of the call transfer request, not the outgoing call to make.

To insert/modify attributes of the outgoing call, the parameters from params[ :call ] must be edited instead.

== Redirection ==
In release 2.8 and above, redirection contacts are obtained from the routing engine in the following format:

contacts = params[ :contacts ]
contacts = {
:index=>"3",
:list=>[
{:called_number=>"6660", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"",
:raw_data=>"", :expiration=>"3600"},
{:called_number=>"6661", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6661@192.168.215.127",
:raw_data=>"<sip:6661@192.168.215.127>", :expiration=>"3600"}
{:called_number=>"6662", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6662@192.168.215.128",
:raw_data=>"<sip:6662@192.168.215.128>", :expiration=>"3600"},
{:called_number=>"6663", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6663@192.168.215.129",
:raw_data=>"<sip:6663@192.168.215.129>", :expiration=>"3600"},
{:called_number=>"6664", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6664@192.168.215.150",
:raw_data=>"<sip:6664@192.168.215.150>", :expiration=>"3600"}
],
:source_indexes=>"nil,0,0,0,2"
}

* <code>params[:contacts][:list]</code> contains the contact log. Each contact within the list has the following fields:
** <code>:called_number</code> - the called number
** <code>:is_number_ported</code> - if the called number has been ported (for SIP: if the npdi parameter is present)
** <code>:ported_number</code> - the called number that was ported (for SIP: the rn parameter value, if available)
** <code>:sip_uri</code> - the SIP URI of the contact, without the contact-params section (without the expires and q contact parameters)
** <code>:raw_data</code> - the raw data representing the contact in the signaling protocol. For SIP, this is the full SIP URI (including the expires and q contact parameters).
** <code>:priority</code> - the priority of the contact [0-1000]
** <code>:expiration</code> - the expiration time in seconds of the contact
* <code>params[:contacts][:index]</code> contains the index of the contact that is currently being routed.
* <code>params[:contacts][:source_indexes]</code> contains a comma-separated list of indexes from <code>params[:contacts][:list]</code>. Each index represents the contact from which the contact in the list was obtained from.

To get more information, see:
*[[Routing_script_tutorial:SIP_Redirection_Contacts|SIP Redirection Contacts Parameters in a Call Flow]]

== Terminating calls ==
In release 2.8, it is now possible to terminate a call through the routing scripts. The [[#Reason values|reason code]] must be specified in <code>params[:bridge][:reason]</code>. The <code>:terminate</code> hash must be created and copied into <code>params</code>:
terminate = {}
params[:terminate] = terminate
The following fields can then be set in <code>:terminate</code>:
* <code>:sip_header</code>
* <code>:contacts</code> # list of contacts as described in the [[#Redirection|redirection]] section
* <code>:isup_raw</code>
* <code>:isup_raw_variant</code>
* <code>:redirecting_number</code>
* <code>:redirecting_number_noa</code>
* <code>:redirecting_number_npi</code>
* <code>:redirecting_number_presentation</code>
* <code>:redirecting_number_reason</code>
* <code>:redirecting_number_counter</code>
* <code>:redirecting_number_indicator</code>
* <code>:original_called_number</code>
* <code>:original_called_number_noa</code>
* <code>:original_called_number_npi</code>
* <code>:original_called_number_presentation</code>
* <code>:original_called_number_reason</code>
* <code>:original_called_number_counter</code>

== Reason values ==

Check here for Termination Reason Cause codes: 

[[Termination_cause_codes|Termination Reason Cause codes]]
 

Example to refuse an incoming call leg.
raise RoutingException, :no_route

Reason cause strings available inside routing scripts:

List of Q.850 reason causes:
:unallocated_number
:no_route_to_network
:no_route_to_destination
:send_special_tone
:misdialled_trunk_prefix
:channel_unacceptable
:call_awarded_in_established_channel
:preemption
:reattempt
:qor_ported_number
:normal_call_clearing
:user_busy
:no_user_responding
:no_answer_from_user
:subscriber_absent
:call_rejected
:number_changed
:redirection
:exchange_routing_error
:non_selected_user_clearing
:destination_out_of_order
:address_incomplete
:facility_rejected
:response_to_status_enquiry
:normal_unspecified
:no_circuit_available
:network_out_of_order
:frame_mode_out_of_service
:frame_mode_connection_operational
:temporary_failure
:switching_equipment_congestion
:access_information_discarded
:requested_circuit_not_available
:precedence_call_blocked
:resource_unavailable
:quality_of_service_not_available
:requested_facility_not_subscribed
:outgoing_calls_barred
:outgoing_calls_barred_within_cug
:incoming_calls_barred
:incoming_calls_barred_within_cug
:bearer_cap_not_authorized
:bearer_cap_not_available
:inconsistency_access_info
:service_not_available
:bearer_cap_not_implemented
:channel_type_not_implemented
:requested_facility_not_implemented
:only_restricted_digital_info
:service_not_implemented
:invalid_call_reference
:channel_does_not_exist
:call_identity_does_not_exist
:call_identity_in_use
:no_call_suspended
:call_has_been_cleared
:user_not_member_of_cug
:incompatible_destination
:non_existant_cug
:invalid_transit_network
:invalid_message_unspecified
:mandatory_ie_missing
:message_type_non_existent
:message_not_compatible_with_call_state
:ie_non_existent
:invalid_ie_content
:msg_not_compatible_with_call_state
:recovery_on_timer_expiry
:parameter_non_existent_passed_on
:message_with_non_recognized_parameters_discarded
:protocol_error
:interworking_unspecified

List of toolpack reason causes:

:toolpack_normal or :normal
:toolpack_resource_error or :resource_error
:toolpack_timeout or :timeout
:toolpack_no_route or :no_route
:toolpack_call_collision or :call_collision
:toolpack_sync_drop or :sync_drop
:toolpack_signaling_error or :signaling_error
:toolpack_locally_rejected or :locally_rejected
:toolpack_interface_not_available or :interface_not_available
:toolpack_reset_in_progress or :reset_in_progress
:toolpack_adapter_reject or :adapter_reject
:toolpack_missing_or_invalid_ie or :missing_or_invalid_ie
:toolpack_incoming_only or :incoming_only
:toolpack_system_configuration_changed or :system_configuration_changed
:toolpack_resource_no_more_available or :resource_no_more_available
:toolpack_incompatible_media or :incompatible_media
:toolpack_resource_allocation_failed or :resource_allocation_failed
:toolpack_data_path_not_available or :data_path_not_available
:toolpack_local_congestion or :local_congestion
:toolpack_authorization_required or :authorization_required
:toolpack_call_divert_is_not_allowed or :call_divert_is_not_allowed

List of SIP reason causes: 
Reason causes starting with a digit must use the following syntax (can't use : as prefix).

'300_multiple_choices'
'301_moved_permanently'
'302_moved_temporarily'
'305_use_proxy'
'380_alternative_service'
'400_bad_request'
'401_unauthorized'
'402_payment_required'
'403_forbidden'
'404_not_found'
'405_method_not_allowed'
'406_not_acceptable'
'407_proxy_authentication_required'
'408_request_timeout'
'409_conflict'
'410_gone'
'413_request_entity_too_large'
'414_request_URI_too_long'
'415_unsupported_media'
'416_unsupported_URI_scheme'
'420_bad_extension'
'421_extension_required'
'422_session_timer_too_small'
'423_interval_too_brief'
'429_referrer_identity_error'
'480_temporary_unavailable'
'481_call_or_transaction_does_not_exist'
'482_loop_detected'
'483_too_many_hops'
'484_address_incomplete'
'485_ambiguous'
'486_busy_here'
'487_request_terminated'
'488_not_acceptable_here'
'489_bad_event'
'491_retry_after'
'500_server_internal_error'
'501_not_implemented'
'502_bad_gateway'
'503_service_unavailable'
'504_server_timeout'
'505_version_unsupported'
'513_message_too_large'
'600_busy_everywhere'
'603_decline'
'604_not_exist_anywhere'
'606_not_acceptable'

== 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.

Routing script call attribute name Description
--------------------------------------------------------------------------------------------
"signaling_type" Signaling type (SS7, ISDN, CASR2, SIP)
"inst_incoming_call_cnt" Instantaneous Count of incoming calls.
"inst_outgoing_call_cnt" Instantaneous Count of outgoing calls.
"available_cnt" Number of available circuits or channels.
"unavailable_cnt" Number of unavailable circuits or channels.
"availability_percent" Percentage of available circuits or channels.
"usage_percent" Percentage of used circuits or channels.
"unused_shared_percent" Percentage of used circuits or channels of this NAP available to make new calls with (taking into account shared with other NAPs)
"total_incoming_call_cnt" Total Count of incoming calls.
"asr_statistics_struct" Detailed Answer-Seizure Rate Statistics.
"global_asr_percent" Global calculated ASR percentage.
"total_outgoing_call_cnt" Total Count of outgoing calls.
"last_24h_asr_percent" Last 24 hours calculated ASR percentage.
"last_24h_outgoing_call_cnt" Last 24 hours outgoing calls.
"current_hour_asr_percent" Current hour calculated ASR percentage.
"current_hour_outgoing_call_cnt" Current hour outgoing calls.
"last_hour_asr_percent" Last hour calculated ASR percentage.
"last_hour_outgoing_call_cnt" Last hour outgoing calls.
"availability_detection_struct" Detailed availibility detection Statistics
"poll_remote_proxy" Remote proxy polling enabled
"is_available" Remote proxy actually available or not
"time_since_polling" Time since the last availibility polling
"time_available_seconds" Number of seconds since the NAP is available
"time_unavailable_seconds" Number of seconds since the NAP is unavailable
"registration_struct" Detailed registration Statistics
"register_to_proxy" Register to proxy enabled
"registered" Actually registered or not
"time_since_refresh" Time since the last refresh
"time_registered_seconds" Number of seconds since the NAP is registered
"time_not_registered_seconds" Number of seconds since the NAP is not registered

 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.

== Telephony Services ==
In release 2.10 and the above, telephony services (CNAM Request) can be manage from the routing engine in the following format:

params[:telephony_services].each do |service| -> Array of telephony services
service[:name] -> Customer telephony service name
service[:type] -> For now only "CNAM Request"
service[:enabled] -> Indicate if the service is enabled (true) or not (false)
(Only the telephony service define in the profile associated to the NAP is enabled)
(The others telephony services define in others profiles are disabled)
(If we are in the case where we return in the routing script with a response, it is important to set :enabled to false in order to avoid repeating the same query)
serviceParams = service[:params]
serviceParams[:return_to_script] -> Indicates to Gateway if we must return to the routing script after receiving the CNAM response
(It is important to set back to false this field to avoid an infinite loop)
serviceQuery = service[:query]
serviceQuery[:phone] -> 10 digits of calling number from the incoming call to send to the CNAM server
serviceQuery[:timeout] -> Timeout in millisecond to wait a CNAM response from CNAM server
(Default value from profile configuration)
serviceResponse = service[:response]
serviceResponse[:success] -> Indicates if we received a good CNAM response from the CNAM Server (Only present if :return_to_script is set to true)
serviceResponse[:caller_name] -> The caller name received in the CNAM response from the CNAM Server (Only present if :return_to_script is set to true)

== Routing Script Tests ==
The Web portal features a tool for Testing Scripts. The user must enter parameters to simulate the incoming call and after pressing the Test button, will output selected routes and numbers. You do not need to activate the new routes, or the new scripts to use this test tool: It can be used to test the routing scripts and routing table before activating it.
This is available in the Routing Scripts section of the Web portal.

=== 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.

 

==== @params ====

A hash of hashes containing parameters. This hash contains bridge parameters and other kind of parameter groups may be added in the future.

@params = {
:bridge => {:announcement_tone, "announcement.wav"},
:contacts => {
:index=>"1",
:list=>[
{:called_number=>"6660", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"",
:raw_data=>"", :expiration=>"3600"},
{:called_number=>"6661", :priority=>"1000", :is_number_ported=>"0", :sip_uri=>"sip:6661@192.168.215.127",
:raw_data=>"<sip:6661@192.168.215.127>", :expiration=>"3600"}
],
:source_indexes=>"nil,0"
}
}

 

----

 Back to [[Routing script tutorial|Routing Script Tutorial]].

[[category:Needs revising]]

Troubleshooting Toolpack

2017-04-06T11:20:12Z

Lucas Trottier: /* System configuration backup */

This page contains pointers to help troubleshoot [[Toolpack]]-based systems.

 

== Web portal ==

Problem: '''The web portal does not start or is not accessible.'''
*See '[[Toolpack Troubleshooting:Web Portal|How to troubleshoot the web portal]]'
 
Problem: '''I cannot perform addition or modification of configuration in the web portal. '''
Usually this occurs in a new Toolpack Platform, for example, when new Toolpack software has been just installed on a host or a new TMG3200 is started up.
*See '[[Toolpack Troubleshooting:Cannot Add or Edit Configuration|How to edit the active configuration]]'
 

Problem: '''The system does not work properly with a copied configuration.'''
*See [[Web Portal:Configuration Copy|How to copy a configuration]]
 

Problem: '''There are no web browser on the linux host server'''
ssh tunnel can be use to re-direct the connection on a remote host port to a local port:
*See [[How to setup ssh tunnel with PuTTY]]
 

== System configuration backup ==

Problem: '''How do I make sure I keep my system configuration?''' 

All the configuration are stored in a MySQL database. To perform a backup, refer to the following links:
*[[Toolpack:Database_Backup_C|Backup procedure for v2.8 or 2.9]]
*[[Toolpack:Database_Backup_B|Backup procedure for v2.7]]
*[[Toolpack:Database_Backup_A|Backup procedure for v2.5 or v2.6]] 
For releases before 2.4 or older or if you do not have access to the web portal, see [[Manual Database Backup]]. 
 
For scheduled backups, see [[Scheduled Database Backup]]

 

== Calls ==
Problem: '''The Tmedia device does not accept or generate calls'''
*See here: [[How to troubleshoot call routing|How to troubleshoot call routing]]
 

== Fax Calls ==
Problem: '''Fax call is not working'''
*Please follow the instructions here: [[How to troubleshoot Fax Calls|How to troubleshoot Fax Calls]]
 

== SS7 CIC group is locally blocked ==
Problem: '''A SS7 Circuit Identification Code is blocked.''' 
*You can control this: See [[SS7 Circuit group control]]
 

== Network Interfaces ==
Problem: '''E1 trunks are not up''' 
*See '[[How to Debug Trunk Interfaces|How to debug trunk interfaces]]' 
 

Problem: '''Cannot ping VoIP interface''' 
The IP address of the VoIP port is configured and you cannot ping it. 
*See '[[How to debug VoIP|How to debug a VoIP interface]]' 
 

== How to gather all logs ==
Problem: '''Which application logs should I gather?'''
*See '[[TBReport|How to gather all logs with TBReport]]' (Version 2.9 and up)
 

== Access to unit ==
Problem: '''I lost access to the unit. How to recover the IP address of the unit?'''
*Please follow the procedure in the installation guide: '[[Product_Installation|Installation Guides]]'
 

Problem: '''I lost the SSH password'''
*It is possible to reset the SSH password. Please contact support@telcobridges.com to get the procedure.
 

Problem: '''I want to do a factory reset'''
*Normally a Factory Reset is not required. System can be re-configured to original settings in a few steps. Please contact support@telcobridges.com to get the procedure.
*Factory reset is available on recent versions of the TelcoBridges units. The procedure is described here: '[[Factory_Reset|Factory Reset]]'.
 

== Installation (for developers) ==
Problem: '''Toolpack fails during installation'''
*See '[[Toolpack Installation:Toolpack installer troubleshooting|Toolpack installer troubleshooting]]'
 

Problem: '''Can't download a new software package ''' 
*You see this error while trying to download a software package with wget: 
Resolving download.telcobridges.com... failed: Temporary failure in name resolution.
wget: unable to resolve host address `download.telcobridges.com
*See "nameserver" in  [[TMG:Change_Management_IP_Address|Configure Management IP address]]
 

Problem: '''The Toolpack system does not start'''
*See '[[Toolpack Installation:Validate Toolpack Installation|How to validate the Toolpack installation]]'
 

Problem: '''I want to change the hostname of the server running Toolpack'''
*See '[[Toolpack Installation:Change hostname|How to change the host name]]'
 

== How to submit a problem ==
Problem: '''I don't know what else to do'''
*Help our support team help you by giving as much information as possible; see '[[Support:How To Submit A Problem|How To Submit A Problem]]'

[[Category:Tdev_OAM&P|Troubleshoot]]

Main Page

2017-04-03T14:34:22Z

Lucas Trottier:

'''Welcome to the TBwiki! [http://www.telcobridges.com TelcoBridges] has developed this wiki to help you with your product and service questions.'''

{|
|STYLE="vertical-align: top"|
{| cellpadding="5" border="1" class="wikitable"
! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" colspan="2" |

Products

! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

OAM&P

! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

Features

! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

Solutions

|-

| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 121px" |
[[Tsbc|''T''sbc]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TSBC5000]]

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[Datasheet|Datasheet]]
*[[Product_Installation|Installing]]
*[[Gateway_Upgrade|Upgrading]]
*[[Web Portal]]

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[TSBC_Carrier_Interconnection_Solution|Carrier Interconnection]]
*[[TSBC_NGN_Interconnection_Solution|NGN Interconnection]]
*[[TSBC_Operator_Interconnection_Solution|Operator Interconnection]]
*[[TSBC_Transcoding_Solution|Transcoding]]

|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 121px" |
[[Tmedia|''T''media]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TMG800]]
*[[TMG3200]]
*[[TMG7800]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" rowspan="3"|

*[[Datasheet|Datasheet]]
*[[Product_Installation|Installing]]
*[[Gateway_Upgrade|Upgrading]]
*[[Web Portal]]
*[[TMG-CONTROL_Version_History|Version History]]
*[[Troubleshooting]]
[[:Category:Gateway_OAM&P|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[Signaling_protocols|Signaling Protocols]]
*[[Redundancy_&_High_Availability|Redundancy & High Availability]]
*[[Tmedia_Routing|Routing]]
*[[Network_monitoring|Network Monitoring]]
[[:Category:Tmedia_Features|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[Carrier_Solutions|Carriers]]
*[[Operator_Solutions|Operators]]
*[[MVNO_&_MVNE_Solutions|MVNO & MVNE]]
*[[Call_Center_Solutions| Call Centers]]
|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 80px" |
[[Ttrans|''T''trans]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TMGIP800]]
*[[TMGIP3200]]
*[[TMGIP7800]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Voice_codecs|Voice Codecs]]
*[[Network_monitoring|Network Monitoring]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Transcoding_Gateway_Solutions|Transcoding]]
|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 80px" |
[[Tsig|''T''sig]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TSG800]]
*[[TSG3200]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Signaling_protocols|Signaling Protocols]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Signaling_Gateway_Solutions|Signaling]]
|-

| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 105px" |
[[Tdev|''T''dev]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TMP800]]
*[[TMP6400]]
*[[TMP6400-CTRL]]
*[[TMP6400-TMS]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Installing Toolpack|Installing]]
*[[Upgrading Toolpack|Upgrading]]
*[[Toolpack_Web_Portal|Provisioning]]
[[:Category:Tdev_OAM%26P|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[High_Availability_Overview|Redundancy & High Availability]]
*[[Tdev_Signaling_Protocols|Signaling Protocols]]
*[[Voice_codecs|Voice Codecs]]
[[:Category:Tdev_Features|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Prepaid & postpaid calling|Prepaid & Postpaid Calling]]
*[[Ringback tones|Ringback Tones]]
*[[Unified communications|Unified Communications]]
[[:Category:Tdev_Solutions|...more]]
|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 80px" |
[[Tmonitor|''T''monitor]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TM1000]]
*[[TM3000]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Installing Toolpack|Installing]]
*[[Upgrading Toolpack|Upgrading]]
*[[Toolpack_Web_Portal|Provisioning]]
[[:Category:Tmonitor_OAM%26P|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Tmonitor_Lawful_Intercept|Lawful Intercept]]
*[[Network_monitoring|Network Monitoring]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Location-based services|Location-Based Services (LBS)]]
*[[Network monitoring|Network Monitoring]]
|}
|STYLE="vertical-align: top"|
{| cellpadding="5" border="1" class="wikitable"
! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

Support

|-
| valign="top" style="background: none repeat scroll 0% 0% rgb(255, 255, 255); height: 466px" |
'''[[TB Support]]'''
*[[Media:TB_Support.pdf|TB Support (.pdf)]]
*[[Media:TB_Support_Full_length.pdf|TB Support Details]]
*[[Support:Contacting TelcoBridges technical support|Contacting TB Support]]
*[[Support:License_server|License Server]]
*[[Support:Time_tracking_tool|Time Tracking Tool]]
*[[:Category:FAQ|Frequently Asked Questions]]
*[[Support:Forums|Support Forums]]
*[[Support:How To Submit A Problem|Submitting an Issue]]

'''Important Notices'''
*[[Field_notices|Field Notices]]
*[[Security_advisories |Security Advisories]]

'''Legal'''

*[[Media:Product Warranty.pdf|Product Warranty]]
*[[Media:Terms & Conditions.pdf|Standard Terms & Conditions]]

'''Interoperability'''

*[[Interoperability:Vendors|Vendors]]
*[[Interoperability:Certifications|Certifications]]

'''Policies'''

*[[End-of-Life (EOL) policy|End-of-Life (EOL)]]

'''Other'''
*[[Regulatory compliance|Regulatory Compliance]]

|}
|}

== Using TBwiki ==

Please note that the TBWiki is a living document, in which navigation choices and the naming of content evolves over time.

There are various ways to search for information in the TBWiki. You can choose to search in the table above, use the glossary in the navigation bar, or use the search box on the left-hand side of each page.

== Disclaimer ==

The information on the TBwiki 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 Inc. TelcoBridges may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this web site or associated documents. 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 agreement from TelcoBridges.

The information provided in this web site is intended as a guide. No responsibility is implied and the terms of your agreement with TelcoBridges will continue to claim precedence. For the latest detailed engineering specifications, please contact TelcoBridges. TelcoBridges is committed to continually improving product designs, as a result, product specifications may be subject to change without notification.

== Copyright ==

*This web site and its content, as well as any external links to content on TelcoBridges servers, is ©2002-2015 TelcoBridges Inc. All rights reserved.

Main Page

2017-04-03T14:33:25Z

Lucas Trottier:

'''Welcome to the TBwiki! [http://www.telcobridges.com TelcoBridges] has developed this wiki to help you with your product and service questions.'''

{|
|STYLE="vertical-align: top"|
{| cellpadding="5" border="1" class="wikitable"
! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" colspan="2" |

Products

! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

OAM&P

! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

Features

! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

Solutions

|-

| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 121px" |
[[Tsbc|''T''sbc]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TSBC5000]]

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[Datasheet|Datasheet]]
*[[Product_Installation|Installing]]
*[[Gateway_Upgrade|Upgrading]]
*[[Web Portal]]

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[TSBC_Carrier_Interconnection_Solution|Carrier Interconnection]]
*[[TSBC_NGN_Interconnection_Solution|NGN Interconnection]]
*[[TSBC_Operator_Interconnection_Solution|Operator Interconnection]]
*[[TSBC_Transcoding_Solution|Transcoding]]

|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 121px" |
[[Tmedia|''T''media]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TMG800]]
*[[TMG3200]]
*[[TMG7800]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" rowspan="3"|

*[[Datasheet|Datasheet]]
*[[Product_Installation|Installing]]
*[[Gateway_Upgrade|Upgrading]]
*[[Web Portal]]
*[[TMG-CONTROL_Version_History|Version History]]
*[[Troubleshooting]]
[[:Category:Gateway_OAM&P|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[Signaling_protocols|Signaling Protocols]]
*[[Redundancy_&_High_Availability|Redundancy & High Availability]]
*[[Tmedia_Routing|Routing]]
*[[Network_monitoring|Network Monitoring]]
[[:Category:Tmedia_Features|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |

*[[Carrier_Solutions|Carriers]]
*[[Operator_Solutions|Operators]]
*[[MVNO_&_MVNE_Solutions|MVNO & MVNE]]
*[[Call_Center_Solutions| Call Centers]]
|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 80px" |
[[Ttrans|''T''trans]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TMGIP800]]
*[[TMGIP3200]]
*[[TMGIP7800]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Voice_codecs|Voice Codecs]]
*[[Network_monitoring|Network Monitoring]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Transcoding_Gateway_Solutions|Transcoding]]
|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 80px" |
[[Tsig|''T''sig]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TSG800]]
*[[TSG3200]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Signaling_protocols|Signaling Protocols]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Signaling_Gateway_Solutions|Signaling]]
|-

| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 105px" |
[[Tdev|''T''dev]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TMP800]]
*[[TMP6400]]
*[[TMP6400-CTRL]]
*[[TMP6400-TMS]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Installing Toolpack|Installing]]
*[[Upgrading Toolpack|Upgrading]]
*[[Toolpack_Web_Portal|Provisioning]]
[[:Category:Tdev_OAM%26P|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[High_Availability_Overview|Redundancy & High Availability]]
*[[Tdev_Signaling_Protocols|Signaling Protocols]]
*[[Voice_codecs|Voice Codecs]]
[[:Category:Tdev_Features|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Prepaid & postpaid calling|Prepaid & Postpaid Calling]]
*[[Ringback tones|Ringback Tones]]
*[[Unified communications|Unified Communications]]
[[:Category:Tdev_Solutions|...more]]
|-
| width="80" style="background: none repeat scroll 0% 0% rgb(0, 83, 139); height: 80px" |
[[Tmonitor|''T''monitor]]

| width="130" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[TM1000]]
*[[TM3000]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Installing Toolpack|Installing]]
*[[Upgrading Toolpack|Upgrading]]
*[[Toolpack_Web_Portal|Provisioning]]
[[:Category:Tmonitor_OAM%26P|...more]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Tmonitor_Lawful_Intercept|Lawful Intercept]]
*[[Network_monitoring|Network Monitoring]]
| style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" |
*[[Location-based services|Location-Based Services (LBS)]]
*[[Network monitoring|Network Monitoring]]
|}
|STYLE="vertical-align: top"|
{| cellpadding="5" border="1" class="wikitable"
! width="210" style="background: none repeat scroll 0% 0% rgb(0, 83, 139);" |

Support

|-
| valign="top" style="background: none repeat scroll 0% 0% rgb(255, 255, 255); height: 466px" |
'''[[TB Support]]'''
*[[Media:TB_Support.pdf|TB Support (.pdf)]]
*[[Media:TB_Support_Full_length.pdf|TB Support Details]]
*[[Support:Contacting TelcoBridges technical support|Contacting TB Support]]
*[[Support:License_server|License Server]]
*[[Support:Time_tracking_tool|Time Tracking Tool]]
*[[:Category:FAQ|Frequently Asked Questions]]
*[[https://docs.telcobridges.com/tbwiki/Support:Forums]]
*[[Support:How To Submit A Problem|Submitting an Issue]]

'''Important Notices'''
*[[Field_notices|Field Notices]]
*[[Security_advisories |Security Advisories]]

'''Legal'''

*[[Media:Product Warranty.pdf|Product Warranty]]
*[[Media:Terms & Conditions.pdf|Standard Terms & Conditions]]

'''Interoperability'''

*[[Interoperability:Vendors|Vendors]]
*[[Interoperability:Certifications|Certifications]]

'''Policies'''

*[[End-of-Life (EOL) policy|End-of-Life (EOL)]]

'''Other'''
*[[Regulatory compliance|Regulatory Compliance]]

|}
|}

== Using TBwiki ==

Please note that the TBWiki is a living document, in which navigation choices and the naming of content evolves over time.

There are various ways to search for information in the TBWiki. You can choose to search in the table above, use the glossary in the navigation bar, or use the search box on the left-hand side of each page.

== Disclaimer ==

The information on the TBwiki 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 Inc. TelcoBridges may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this web site or associated documents. 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 agreement from TelcoBridges.

The information provided in this web site is intended as a guide. No responsibility is implied and the terms of your agreement with TelcoBridges will continue to claim precedence. For the latest detailed engineering specifications, please contact TelcoBridges. TelcoBridges is committed to continually improving product designs, as a result, product specifications may be subject to change without notification.

== Copyright ==

*This web site and its content, as well as any external links to content on TelcoBridges servers, is ©2002-2015 TelcoBridges Inc. All rights reserved.

Support:Forums

2017-04-03T14:31:52Z

Lucas Trottier:

{{DISPLAYTITLE:TelcoBridges Support Forums}}

https://forums.telcobridges.com
 
TelcoBridges forums are for the use of TelcoBridges business partners and customers. They are designed to facilitate discussion regarding the TelcoBridges family of products. The forums are regrouped in 4 categories: General, Media Gateway and Other.
 
By default, guests only have access to the '''About''' forum. Access to other forums requires registration and subsequent authorization by TelcoBridges.
 

=== Request an account ===
Follow the instructions from [https://forums.telcobridges.com/viewtopic.php?f=7&t=1044 this link]
 
=== Login ===
Once your account is created, you will receive an email with your username and password.
* go to https://forums.telcobridges.com
[[File:support_forums_login.png]]
* enter username and password
 
=== Change password ===
* Click on '''User Control Panel'''
[[File:support_forums_user_control_panel.png]]
* Click on '''Profile''' tab, then '''Edit account settings'''
[[File:support_forums_change_password.png]]
 
=== Change timezone ===
* In the '''User Control Panel''', click on the '''Board Preferences''' tab
* Click on ''Edit global settings''
[[File:support_forums_change_timezone.png]]
 
=== Change notifications preferences ===
By default you will not receive any emails when there is a new post in any forums.
 
You have two options:
==== Option A: Receive emails for posts on all forums ====
Change your preferences to get an emails when there is a new post in any forums.
* In the '''User Control Panel''', click on the '''Board Preferences''' tab
* Click on the '''Edit post notification options'''
* Tick '''Yes''' for the '''Send me notice of all posts...'''
[[File:support_forums_post_notifications.png]]
 
==== Option B: Subscribe to a forum ====
Subscribe to forum which you want to follow only.
* Go back to the home page (click on TelcoBridges logo right top)
* Click on the forum you wish to subscribe, for example, the '''Release Status''' forums
[[File:support_forums_release_status_top.png]]
* Scroll down. At the bottom of the page, click on '''Subscribe forum'''
[[File:support_forums_release_status_bottom.png]]

Support:Forums

2017-04-03T14:30:47Z

Lucas Trottier:

{{DISPLAYTITLE:TelcoBridges Support Forums}}

TelcoBridges forums are for the use of TelcoBridges business partners and customers. They are designed to facilitate discussion regarding the TelcoBridges family of products. The forums are regrouped in 4 categories: General, Media Gateway and Other.
 
By default, guests only have access to the '''About''' forum. Access to other forums requires registration and subsequent authorization by TelcoBridges.
 

=== Request an account ===
Follow the instructions from [https://forums.telcobridges.com/viewtopic.php?f=7&t=1044 this link]
 
=== Login ===
Once your account is created, you will receive an email with your username and password.
* go to https://forums.telcobridges.com
[[File:support_forums_login.png]]
* enter username and password
 
=== Change password ===
* Click on '''User Control Panel'''
[[File:support_forums_user_control_panel.png]]
* Click on '''Profile''' tab, then '''Edit account settings'''
[[File:support_forums_change_password.png]]
 
=== Change timezone ===
* In the '''User Control Panel''', click on the '''Board Preferences''' tab
* Click on ''Edit global settings''
[[File:support_forums_change_timezone.png]]
 
=== Change notifications preferences ===
By default you will not receive any emails when there is a new post in any forums.
 
You have two options:
==== Option A: Receive emails for posts on all forums ====
Change your preferences to get an emails when there is a new post in any forums.
* In the '''User Control Panel''', click on the '''Board Preferences''' tab
* Click on the '''Edit post notification options'''
* Tick '''Yes''' for the '''Send me notice of all posts...'''
[[File:support_forums_post_notifications.png]]
 
==== Option B: Subscribe to a forum ====
Subscribe to forum which you want to follow only.
* Go back to the home page (click on TelcoBridges logo right top)
* Click on the forum you wish to subscribe, for example, the '''Release Status''' forums
[[File:support_forums_release_status_top.png]]
* Scroll down. At the bottom of the page, click on '''Subscribe forum'''
[[File:support_forums_release_status_bottom.png]]

Support:Forums

2017-04-03T14:29:43Z

Lucas Trottier:

{{DISPLAYTITLE:TelcoBridges Support Forums}}

TelcoBridges forums are for the use of TelcoBridges business partners and customers. They are designed to facilitate discussion regarding the TelcoBridges family of products. The forums are regrouped in 4 categories: General, Media Gateway and Other.
 
By default, guests only have access to the '''About''' forum. Access to other forums requires registration and subsequent authorization by TelcoBridges.
 

=== Request an account ===
Follow the instructions from [https://forums.telcobridges.com/viewtopic.php?f=7&t=1044 this link]
 
=== Login to your account ===
Once your account is created, you will receive an email with your username and password.
* go to https://forums.telcobridges.com
[[File:support_forums_login.png]]
* enter username and password
 
=== Change your password ===
* Click on '''User Control Panel'''
[[File:support_forums_user_control_panel.png]]
* Click on '''Profile''' tab, then '''Edit account settings'''
[[File:support_forums_change_password.png]]
 
=== Change your timezone ===
* In the '''User Control Panel''', click on the '''Board Preferences''' tab
* Click on ''Edit global settings''
[[File:support_forums_change_timezone.png]]
 
=== Change your notifications preferences ===
By default you will not receive any emails when there is a new post in any forums.
 
You have two options:
==== Option A: Receive emails for posts on all forums ====
Change your preferences to get an emails when there is a new post in any forums.
* In the '''User Control Panel''', click on the '''Board Preferences''' tab
* Click on the '''Edit post notification options'''
* Tick '''Yes''' for the '''Send me notice of all posts...'''
[[File:support_forums_post_notifications.png]]
 
==== Option B: Subscribe to a forum ====
Subscribe to forum which you want to follow only.
* Go back to the home page (click on TelcoBridges logo right top)
* Click on the forum you wish to subscribe, for example, the '''Release Status''' forums
[[File:support_forums_release_status_top.png]]
* Scroll down. At the bottom of the page, click on '''Subscribe forum'''
[[File:support_forums_release_status_bottom.png]]

Support:Forums

2017-04-03T14:28:05Z

Lucas Trottier:

{{DISPLAYTITLE:TelcoBridges Support Forums}}

TelcoBridges forums are for the use of TelcoBridges business partners and customers. They are designed to facilitate discussion regarding the TelcoBridges family of products. The forums are regrouped in 4 categories: General, Media Gateway and Other.
 
By default, guests only have access to the '''About''' forum. Access to other forums requires registration and subsequent authorization by TelcoBridges.
 
Here a the steps to get your account.

=== Request an account ===
Follow the instructions from [https://forums.telcobridges.com/viewtopic.php?f=7&t=1044 this link]
 
=== Login to your account ===
Once your account is created, you will receive an email with your username and password.
* go to https://forums.telcobridges.com
[[File:support_forums_login.png]]
* enter username and password
 
=== Change your password ===
* Click on '''User Control Panel'''
[[File:support_forums_user_control_panel.png]]
* Click on '''Profile''' tab, then '''Edit account settings'''
[[File:support_forums_change_password.png]]
 
=== Change your timezone ===
* In the '''User Control Panel''', click on the '''Board Preferences''' tab
* Click on ''Edit global settings''
[[File:support_forums_change_timezone.png]]
 
=== Change your notifications preferences ===
By default you will not receive any emails when there is a new post in any forums.
 
You have two options:
==== Option A ====
Change your preferences to get an emails when there is a new post in any forums.
* In the '''User Control Panel''', click on the '''Board Preferences''' tab
* Click on the '''Edit post notification options'''
* Tick '''Yes''' for the '''Send me notice of all posts...'''
[[File:support_forums_post_notifications.png]]
 
==== Option B ====
Subscribe to forum which you want to follow only.
* Go back to the home page (click on TelcoBridges logo right top)
* Click on the forum you wish to subscribe, for example, the '''Release Status''' forums
[[File:support_forums_release_status_top.png]]
* Scroll down. At the bottom of the page, click on '''Subscribe forum'''
[[File:support_forums_release_status_bottom.png]]

File:Support forums release status bottom.png

2017-04-03T14:27:56Z

Lucas Trottier:

File:Support forums release status top.png

2017-04-03T14:25:19Z

Lucas Trottier:

File:Support forums post notifications.png

2017-04-03T14:18:38Z

Lucas Trottier:

File:Support forums change timezone.png

2017-04-03T14:06:19Z

Lucas Trottier:

Support:Forums

2017-04-03T13:49:51Z

Lucas Trottier:

File:Support forums change password.png

2017-04-03T13:49:42Z

Lucas Trottier:

Support:Forums

2017-04-03T13:44:03Z

Lucas Trottier:

File:Support forums user control panel.png

2017-04-03T13:42:03Z

Lucas Trottier:

Support:Forums

2017-04-03T13:30:12Z

Lucas Trottier: Created page with "{{DISPLAYTITLE:TelcoBridges Support Forums}} TelcoBridges forums are for the use of TelcoBridges business partners and customers. They are designed to facilitate discussion r..."

File:Support forums login.png

2017-04-03T13:29:54Z

Lucas Trottier:

Support:Submitting An Issue

2017-04-03T13:09:14Z

Lucas Trottier:

{{DISPLAYTITLE:Submitting an Issue to TelcoBridges Support}}

When submitting a problem, your ability to provide relevant information about your system will greatly help the TelcoBridges support team in its efforts to bring to you a quick resolution.

 

== Required information: System configuration ==

Please provide the following required information:

 '''Description of the issue'''
*Describe the issue and clearly as possible and with as much details possible.
*Describe the steps or context in which the issues was experienced.
*Provide steps to reproduce the issue, if possible.
*Tracking number (If one was already provided to you by TelcoBridges TB Support)

 '''System information'''
*Type of TelcoBridges hardware device(s) (ex. [[TMG800]], [[TMG3200]], [[TSBC5000]], [[TMP6400]], etc.)
*Serial numbers of TelcoBridges hardware units (ex. TBxxxxxxx)
*Topology diagram
*Call flow diagram (Direction of calls)
*IP network and connectivity diagram

 '''System configuration / set-up'''
*Configuration summary (ex. SIP to SS7, MGC + H.248, ISDN Monitoring, etc.).
**Provide the system configuration (see [[Troubleshooting_Toolpack#System_configuration_backup|Configuration backup]]).
*Software release number (ex. 2.10.8)

 '''Troubleshooting capture '''
 For troubleshooting, the TelcoBridges support team may require additional traces from the system. See [[Troubleshooting]]
*[[TBReport]]
*[[Using Unique call trace|Call Trace]]
*[[Toolpack Debug Application:Tbsigtrace|Low-level signalling trace]]
*[[VoIP Ethernet Capture|VoIP capture]]
*[[Target_Recording|Recording]]
*[[How_to_troubleshoot_call_routing#Using_the_applications_log_files|Applications logs]]

 

== Logging the issue in TBsupport tracking system ==
Once you have gathered all of the information required above, please log it in the TBsupport tracking system (bugzilla) here: 
[https://support.telcobridges.com https://support.telcobridges.com] 
This will assign to you a tracking number to follow the progress of the issue. Your account e-mail will receive an update on each comment that is logged. 
If you do not have a TBsupport tracking system account, please request one at support@telcobridges.com at the same time as sending the information for the issue.
 

== Providing remote access to your system ==
If you choose to provide TelcoBridges with remote access to your system for the purpose of issue analysis and resolution, please provide the connection Information (SSH, Join.me, VPN, GoToMeeting, etc.)

Category:FAQ

2017-04-03T13:08:16Z

Lucas Trottier:

{{DISPLAYTITLE:Frequently Asked Questions}}

This page contains frequently asked questions (FAQ) regarding the purchase, use, and support of TelcoBridges' products.

If you have a question that you do not find the answer to on this page, please try searching in the search box on the left hand side of the page. If you would like to add content to the FAQ page, please contact us at [mailto:marketing@telcobridges.com marketing].

Support:License server

2017-04-03T13:06:46Z

Lucas Trottier:

{{DISPLAYTITLE:TelcoBridges License Server}}

Our partners can view the list of units they have from TelcoBridges on the license server. For each unit it shows the '''license expiration''' date (if it is a temporary license), and the '''warranty expiration''' date for this unit.
 
Our partners can generate licenses from the license server at this URL:

https://licenses.telcobridges.com

 
For partners who do not have a login for the above site, please contact [mailto:support@telcobridges.com TelcoBridges TB Support]. 

== Retrieve a license ==

For more details use this link: [[Toolpack:Retreiving_a_License_A|Retreiving a License]]

== Upload a license on the system ==

2.7 and previous release: [[Toolpack:Uploading_a_License_A|Upload a license 2.7]] 
2.8, 2.9 and onward: [[Toolpack:Uploading_a_License_B|Upload a license]]

Support:Time tracking tool

2017-04-03T13:06:21Z

Lucas Trottier:

{{DISPLAYTITLE:TelcoBridges Support Time Tracking Tool}}

Every month, TelcoBridges partners receive a report showing the balance of their Support Bank hours. A negative value means that the account is in deficit. In such a case, we invite our Partners to promptly contact a sales representative to acquire new TB support hour banks.

 

To consult their TB Support activities, our partners can access TelcoBridges TB Support Time tracking tool:

https://timetracking.telcobridges.com

 

= Login =

The login/password is the same as that used for license server access. For partners who do not have a login for the above site, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].

 

= Export view =

Once you are logged in, choose the Export tab. This view shows the support Bank hour units withdrawn from your account and also the units deposited to your account.

[[File:Kimai_export_tab.png|1024px]]

==Columns definition ==

{| class="wikitable"
|-
! Column Name !! Definition
|-
| '''Date''' || Date when support was provided
|-
| '''In''' || Start time (EST timezone)
|-
| '''Out''' || End time (EST timezone)
|-
| '''h'm''' || Duration in hours:minutes
|-
| '''Time''' || A chargeable task is rated at '-1' (per hour) and a non-chargeable task is rated at '0'
|-
| '''Rate/Total''' || Number of bank units withdrawn from the support bank account
|-
| '''Customer''' || Customer name
|-
| '''Project''' || Support bank (9-5 or 24-7). See [[TB_Support_A_la_Carte|TB Support A la Carte]] for more information
|-
| '''Task''' || Task that was performed : Configuration, Installation, Troubleshooting, and more.
|-
| '''Comment''' || Provide detail on the the nature of the task that was performed
|}

==Selecting the report date range ==

By default, when you log in, the Date range will show the current month only. Select the report period by changing the start date.

[[File:Kimai_export_date_range.png|1024px]]

 

== Changing the report date format ==

By default, the report ''Dateformat'' is 'd.m.'. To change it and include the year:
# Click the '''clock''' icon ((upper left, just below the Export tab)
# Set the date format to 'D' (m/d/y).

[[File:Kimai_export_dateformat.png|1024px]]

 

== Changing the view filter ==

The view entries can be filtered by Project and by Tasks. You can also choose what type of entries to view. 
'''Note''': '''Expenses''' entries represent TB support bank hours units that have been added to the support account
# Click the '''funnel''' shaped icon (upper left, just below the Export tab)
# Select ''times and expenses'' to view all entries

[[File:Kimai_export_filter.png|1024px]]

 

== Exporting or printing ==

The view entries can be exported to a file or printed (see icons locate at the upper right).

The supported export files are : PDF, XLS and CSV

[[File:Kimai_export_exporting_report.png]]

 

== Suggested export options ==
Make sure to use below options on export to get the full report

[[File:Kimai_export_exporting_options.png|400px]]

 

= Current balance of hours =

# Select the '''report date range with a start date that includes all the entries of your account since its creation'''
# Set the view filter to show all the entries ('times and expenses'')
# Set the view filter to either your 5-9 or 24-7 project (click the funnel shapes icon of the project name to filter)
# Export into a .xls or .csv
# Open the file in your favourite spreadsheet editor and perform a summation on all the entries of the ''Rate/Total'' column
# The summation should match your support account balance

[[Category:Needs_revising]]

Support:Time tracking tool

2017-04-03T13:05:55Z

Lucas Trottier:

{{DISPLAYTITLE:Time Tracking Tool}}

Every month, TelcoBridges partners receive a report showing the balance of their Support Bank hours. A negative value means that the account is in deficit. In such a case, we invite our Partners to promptly contact a sales representative to acquire new TB support hour banks.

 

To consult their TB Support activities, our partners can access TelcoBridges TB Support Time tracking tool:

https://timetracking.telcobridges.com

 

= Login =

The login/password is the same as that used for license server access. For partners who do not have a login for the above site, please contact [mailto:support@telcobridges.com TelcoBridges TB Support].

 

= Export view =

Once you are logged in, choose the Export tab. This view shows the support Bank hour units withdrawn from your account and also the units deposited to your account.

[[File:Kimai_export_tab.png|1024px]]

==Columns definition ==

{| class="wikitable"
|-
! Column Name !! Definition
|-
| '''Date''' || Date when support was provided
|-
| '''In''' || Start time (EST timezone)
|-
| '''Out''' || End time (EST timezone)
|-
| '''h'm''' || Duration in hours:minutes
|-
| '''Time''' || A chargeable task is rated at '-1' (per hour) and a non-chargeable task is rated at '0'
|-
| '''Rate/Total''' || Number of bank units withdrawn from the support bank account
|-
| '''Customer''' || Customer name
|-
| '''Project''' || Support bank (9-5 or 24-7). See [[TB_Support_A_la_Carte|TB Support A la Carte]] for more information
|-
| '''Task''' || Task that was performed : Configuration, Installation, Troubleshooting, and more.
|-
| '''Comment''' || Provide detail on the the nature of the task that was performed
|}

==Selecting the report date range ==

By default, when you log in, the Date range will show the current month only. Select the report period by changing the start date.

[[File:Kimai_export_date_range.png|1024px]]

 

== Changing the report date format ==

By default, the report ''Dateformat'' is 'd.m.'. To change it and include the year:
# Click the '''clock''' icon ((upper left, just below the Export tab)
# Set the date format to 'D' (m/d/y).

[[File:Kimai_export_dateformat.png|1024px]]

 

== Changing the view filter ==

The view entries can be filtered by Project and by Tasks. You can also choose what type of entries to view. 
'''Note''': '''Expenses''' entries represent TB support bank hours units that have been added to the support account
# Click the '''funnel''' shaped icon (upper left, just below the Export tab)
# Select ''times and expenses'' to view all entries

[[File:Kimai_export_filter.png|1024px]]

 

== Exporting or printing ==

The view entries can be exported to a file or printed (see icons locate at the upper right).

The supported export files are : PDF, XLS and CSV

[[File:Kimai_export_exporting_report.png]]

 

== Suggested export options ==
Make sure to use below options on export to get the full report

[[File:Kimai_export_exporting_options.png|400px]]

 

= Current balance of hours =

# Select the '''report date range with a start date that includes all the entries of your account since its creation'''
# Set the view filter to show all the entries ('times and expenses'')
# Set the view filter to either your 5-9 or 24-7 project (click the funnel shapes icon of the project name to filter)
# Export into a .xls or .csv
# Open the file in your favourite spreadsheet editor and perform a summation on all the entries of the ''Rate/Total'' column
# The summation should match your support account balance

[[Category:Needs_revising]]

Support:License server

2017-04-03T13:05:19Z

Lucas Trottier:

{{DISPLAYTITLE:License server}}

Our partners can view the list of units they have from TelcoBridges on the license server. For each unit it shows the '''license expiration''' date (if it is a temporary license), and the '''warranty expiration''' date for this unit.
 
Our partners can generate licenses from the license server at this URL:

https://licenses.telcobridges.com

 
For partners who do not have a login for the above site, please contact [mailto:support@telcobridges.com TelcoBridges TB Support]. 

== Retrieve a license ==

For more details use this link: [[Toolpack:Retreiving_a_License_A|Retreiving a License]]

== Upload a license on the system ==

2.7 and previous release: [[Toolpack:Uploading_a_License_A|Upload a license 2.7]] 
2.8, 2.9 and onward: [[Toolpack:Uploading_a_License_B|Upload a license]]

Support:Contacting TelcoBridges technical support

2017-04-03T13:02:05Z

Lucas Trottier:

{{DISPLAYTITLE:Contacting TelcoBridges technical support}}

Wordwide technical support is available via either of the following channels:

 '''Americas & Europe Technical Support Centre (GMT-05:00,  Montreal, Canada)'''
 Office hours: Monday to Friday from 09:00 to 17:00 Eastern Time

Telephone: '''+1-450-655-8993 x131 or x102 '''

E-mail: [mailto:support@telcobridges.com support@telcobridges.com]

TBsupport tracking system: https://support.telcobridges.com 

Supported languages: English, French, Mandarin, Cantonese 

'''Asia Technical Support Centre (GMT +08:00, Hong Kong)'''
 Office hours: Monday to Friday from 09:00 to 17:00 Hong Kong Time

Telephone: '''+852-3749-9818'''

E-mail: [mailto:support@telcobridges.com support@telcobridges.com]

Supported languages: English, French, Mandarin, Cantonese

 

'''24/7 Support''' '''International''' (Public Holiday and non-office hours) 

Telephone: '''+1-866-438-4703 '''

Supported languages: English

Note: For customers for who have purchased 24/7 TBSupport bank of hours, please contact TBSupport via this 24/7 hotline for emergency

 

'''Instant Messenger/chat (Skype)'''

Send request to [mailto:support@telcobridges.com support@telcobridges.com] for contacts

 
'''Please kindly note that TelcoBridges office is closed during [[support:public_holidays|public holidays]].''' 
'''Please call 24/7 Support International for emergency if you have purchased 24/7 TBSupport bank of hours'''

SNMP

2017-03-23T01:59:33Z

Lucas Trottier: /* External Sources */

The Simple Network Management Protocol (SNMP) is used in network management systems to monitor attached hardware for changes in operation activity. SNMP provides a standardized approach to monitoring and managing network systems.
 For information on configuring your TMedia product to use the SNMP protocol, see the section labeled [[SNMP#Related Tasks|"'''Related Tasks'''"]].
 
== TelcoBridges and SNMP ==
TelcoBridges offers basic support for SNMP versions 1, 2, and 3. '''Toolpack supports SNMP V2 and V3 since release 2.5.80''' (see [[TMG-CONTROL_Version_2.5| Tctrl version history]]). More specifically, this grants users the ability to remotely poll (or GET) system variables, known as Managed Objects, which are represented in files known as MIB modules. TelcoBridges currently offers polling on '''standard''' MIB modules (RTP, SONET, DS1, DS3, ISDN, etc...) and on the TelcoBridges '''privately defined''' module ([[TB-MIB|'''TB-MIB''']]). 
 
== Supported SNMP MIB modules ==
#[http://tools.ietf.org/html/rfc1213 RFC 1213 MIB II (RFC1213-MIB)]
#*All tables of the RFC1213-MIB are supported, '''with the exception of''':
#**ipRouteTable
#**EGP group
#**atTable
#[http://tools.ietf.org/html/rfc1573.txt RFC 1573 Evolution of Interfaces Group of MIB-II (IF-MIB)]
#*The following tables are supported:
#**ifTable
#**ifStackTable
#[http://tools.ietf.org/html/rfc2495 RFC 2495 DS1, J1, E1, DS2, and E2 Interfaces (DS1-MIB)]
#*The following tables of the DS1-MIB are supported:
#**Dsx1ConfigTable
#**Dsx1CurrentTable
#**Dsx1IntervalTable
#**Dsx1TotalTable
#[http://tools.ietf.org/html/rfc2496 RFC 2496 - Definitions of Managed Object for the DS3/E3 Interface Type (DS3-MIB)]
#*The following tables of the DS3-MIB are supported:
#**Dsx3ConfigTable
#**Dsx3CurrentTable
#**Dsx3IntervalTable
#**Dsx3TotalTable
#[http://tools.ietf.org/html/rfc1595 RFC 1595 - Definitions of Managed Object for the SONET/SDH Interface Type (SONET-MIB)]
#*The following tables of the SONET-MIB are supported:
#**sonetMediumTable
#**sonetSectionCurrentTable
#**sonetSectionIntervalTable
#**sonetLineCurrentTable
#**sonetLineIntervalTable
#**sonetFarendLineCurrentTable
#**sonetFarendLineIntervalTable
#**sonetPathCurrentTable
#**sonetPathIntervalTable
#**sonetFarendPathCurrentTable
#**sonetFarendPathIntervalTable
#**sonetVtCurrentTable
#**sonetVtIntervalTable
#**sonetFarendVtCurrentTable
#**sonetFarendVtIntervalTable
#[http://tools.ietf.org/html/rfc2127 RFC 2127 - ISDN Management Information Base using SMIv2 (ISDN-MIB)]
#*The following tables of the ISDN-MIB are supported:
#**isdnBearerGroup
#**isdnSignalingGroup
#[[TB-MIB|Telcobridges Private MIB module (TB-MIB)]]
#*tbHwCommon
#**tbHwIdentTable (Hardware Identification)
#**tbHwVersionTable (Hardware Version)
#**tbHwTempTable (Hardware Temperature)
#**tbHwPowerSupplyTable (Hardware Power Supply)
#**tbHwFanTable (Hardware Fan)
#*tbSwCommon
#**tbFeatureTable (Software Features Supported)
#**tbSwVersionTable (Software Version)
#**tbSwPerfTable (CPU Usage)
#*tbSignaling
#**tbMtp2
#**tbM2pa
#**tbM2ua
#**tbM3ua
#**tbIua
#**tbIsdn
#**tbCas
#**tbSip
#**tbH248
#*tbCalls
#*tbNAP
#*tbHaNp1
#*tbHaApp
#*tbClock

=== SNMP IF-MIB ifTable interface type ===
The table below provides the interfaces type supported by TelcoBridges (IF-MIB ifTable described in [https://tools.ietf.org/html/rfc1573 RFC1573]) with their corresponding description. The ifType are described in Internet Assigned Number Authority (IANA) in [http://www.iana.org/assignments/ianaiftype-mib IANAifType-MIB]
{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"
|-
! IANA ifType
! TelcoBridges Interface description
|-
| ethernetCsmacd(6)
| Baseboard Ethernet interfaces
|-
| ds1(18)
| Trunks Line Interface
|-
| ds3(30)
| DS3 Line Interface
|-
| sonet(39)
| SONET/SDH Line Interface
|-
| sonetPath(50)
| SONET/SDH Line Service PATH (VC4/VC3/STS1/DS3)
|-
| sonetVT(51)
| SONET/SDH Line Service SECTION (VC11/VC12/VT15/VT2)
|-
| isdn(63)
| ISDN Stack
|-
| lapd(77)
| ISDN LAPD Link (Primary)
|-
| lapd(77)
| ISDN LAPD Link (Backup)
|-
| isdn(63)
| IUA Link
|-
| isdn(63)
| IUA Peer
|-
| lapd(77)
| LAPD Link
|-
| ss7SigLink (156)
| SS7 M2PA Link
|-
| ss7SigLink (156)
| SS7 M2UA Link
|-
| ss7SigLink (156)
| SS7 M2UA Peer
|-
| ss7SigLink (156)
| Ss7 M3ua Sap
|-
| ss7SigLink (156)
| Ss7 M3ua Psp
|-
| ss7SigLink (156)
| Ss7 M3ua Psrv
|-
| ss7SigLink (156)
| Ss7 Mtp2 Link
|}

=== SNMP traps ===
The '''SNMP traps''' module of TelcoBridges products monitor the operation status of some MIBS OIDs and generates notifications when the states change. The default monitoring polling period is set to 1 minute. This value can be modified in the [[Configuring_tbSnmpAgent#Configuring_traps|tbSnmpAgent configuration]].

====IF-MIB SNMP Trap/Notification (see RFC1573.txt)====

{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"
|-
! Trap Name
! OID
! OBJECTS
! RELEASE
|-
| linkDown
| 1.3.6.1.6.3.1.1.5.3
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }
| 2.8
|-
| linkUp
| 1.3.6.1.6.3.1.1.5.4
| { ifIndex, ifAdminStatus, ifOperStatus, ifDescr }
| 2.8
|-
| linkDown
| 1.3.6.1.6.3.1.1.5.3
| { ifIndex, ifAdminStatus, ifOperStatus }
| 2.6 and 2.7
|-
| linkUp
| 1.3.6.1.6.3.1.1.5.4
| { ifIndex, ifAdminStatus, ifOperStatus }
| 2.6 and 2.7
|}

====[[TB-MIB|TB-MIB SNMP Trap/Notification]]====

{| cellpadding="0" border="0" style="width: 820px;" class="wikitable"
|-
! Trap Name
! Details
! OID
! OBJECTS
! CONSIDERED AS AN ALARM
! RELEASE
|-
| tbNapAvailability
| The network access point has a new percentage of availability for calls
# For TDM networks (tbNapSignalingType='''isdn'''(1), '''ss7'''(2), '''casr2'''(6)) this means there are a percentage of channels available for calls. ss7 includes sigtran signaling type. 
# For SIP networks (tbNapSignalingType='''sip'''(3)), this means the remote SIP device is answering or not SIP OPTIONS polling messages and calls can be or can`t be made to this network. 
# When using H.248 (tbNapSignalingType='''tdmMedia'''(5), '''voipMedia'''(4)) this means there are TDM channels or RTP ports available or not for calls.
| 1.3.6.1.4.1.21776.1.1.2.1.0.1
| { tbNapName, tbNapSignalingType, tbNapAvailablePercent }
| When tbNapAvailablePercent=0
| 2.8
|-
| tbPwrSupplyState
| The redundant power supply has a new state. tbHwPwrSupplyStatus can be: '''good'''(0) '''failure'''(1)
| 1.3.6.1.4.1.21776.1.1.2.1.0.2
| { tbHwPwrSupplyName, tbHwPwrSupplyStatus }
| When tbHwPwrSupplyStatus=1
| 2.8
|-
| tbNp1State
| The N+1 patch panel has a new state. tbHaNp1FunctionalState can be: '''unknown'''(-1) '''fault'''(0): There is no access to the N+1 patch panel '''unprotected'''(1): Standby unit is not available '''unprotectedSwitched'''(2): Standby unit is active and replaced primary unit is not ready to take over '''healthy'''(3): N+1 unit is normal and standby unit is available '''healthySwitched'''(4): N+1 unit is switched to the standby unit and replaced primary is available
| 1.3.6.1.4.1.21776.1.1.2.1.0.3
| { tbHaNp1Name, tbHaNp1FunctionalState }
| When tbHaNp1FunctionalState=0 OR tbHaNp1FunctionalState=2
| 2.8
|-
| tbAppState
| This toolpack application has a new state. tbHaAppCurrentState can be:<br\>'''unknown'''(100)<br\>'''notRunning'''(101)<br\>'''starting'''(102)<br\>'''ready'''(103)<br\>'''shuttingDown'''(104)<br\>'''goingManagement'''(105)<br\>'''fault'''(106)
| 1.3.6.1.4.1.21776.1.1.2.1.0.4
| { tbHaAppName, tbHaAppCurrentState, tbHaAppHostName }
| When tbHaAppCurrentState=106
| 2.8
|-
| tbAppHaState
| This toolpack high availability application has changed state. tbHaAppHaCurrentState can be:<br\>'''notPresent'''(0)<br\>'''active'''(1)<br\>'''standby'''(2)
| 1.3.6.1.4.1.21776.1.1.2.1.0.5
| { tbHaAppName, tbHaAppHaCurrentState, tbHaAppHostName }
| '''__'''
| 2.8
|-
| tbClkGradeState
| The network synchronization clock from this interface has a new grade. <br\>tbClockType can be:<br\>'''none'''(1)<br\>'''osc'''(2)<br\>'''trunk'''(3)<br\>'''netRef1'''(4)<br\>'''netRef2'''(5)<br\>'''ptmc1'''(6)<br\>'''ptmc2'''(7)<br\>'''ct8a'''(8)<br\>'''ct8b'''(9)<br\>'''mbl'''(10)<br\>'''bits'''(11)<br\>'''ds3'''(12)<br\>'''sonetSdh'''(13)<br\>'''holdover'''(14) tbClockGrade can be:<br\>'''unqualified'''(0)<br\>'''beingQualified'''(1)<br\>'''qualified'''(2)<br\>'''qualifiedForRecovery'''(3)
| 1.3.6.1.4.1.21776.1.1.2.1.0.6
| { tbClockName, tbClockType, tbClockGrade }
| '''__'''
| 2.8
|-
| tbClkActiveState
| This interface has been selected or not to provide the network synchronization clock for the whole system. tbClockActive can be:<br\>'''no'''(0)<br\>'''yes'''(1)
| 1.3.6.1.4.1.21776.1.1.2.1.0.7
| { tbClockName, tbClockType, tbClockActive }
| When tbClockActive=0
| 2.8
|-
| tbIsdnDChannelState
| The signaling channel for this ISDN interface has changed. tbIsdnDChannelUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)
| 1.3.6.1.4.1.21776.1.1.2.1.0.8
| { tbIsdnDescription, tbIsdnDChannelUp }
| When tbIsdnDChannelUp=0
| 2.8
|-
| tbCASPhysicalLineState
| The interface for this CAS stack has changed. tbCasPhysicalLineUp can be:<br\>'''no'''(0)<br\>'''yes'''(1)
| 1.3.6.1.4.1.21776.1.1.2.1.0.9
| { tbCasDescription, tbCasPhysicalLineUp }
| When tbCasPhysicalLineUp=0
| 2.8
|-
| tbSipState
| The SIP stack state has changed. tbSipCurrentState can be:<br\>'''no'''(0)<br\>'''yes'''(1)
| 1.3.6.1.4.1.21776.1.1.2.1.0.10
| { tbSipDescription, tbSipCurrentState }
| When tbSipCurrentState=0
| 2.8
|-
| tbH248MgcState
| The H.248 communication state between this unit and the Media Gateway Controller has changed. tbH248MgcCurrentState can be:<br\>'''up'''(1)<br\>'''down'''(2)<br\>'''unknown'''(3)
| 1.3.6.1.4.1.21776.1.1.2.1.0.11
| { tbH248MgcName, tbH248MgcCurrentState }
| When tbH248MgcCurrentState=2
| 2.8
|-
| tbHostUpdateAvailableState
| The availability state of the host update has changed. tbHostUpdateAvailable can be:<br\>'''false'''(0)<br\>'''true'''(1)<br\>'''notSupported'''(2)<br\>'''unknown'''(3)<br\>'''disabled'''(4)
| 1.3.6.1.4.1.21776.1.1.2.1.0.12
| { tbHostName, tbHostUpdateAvailable }
| '''__'''
| 2.8
|}

 Example of packet capture:
tcpdump port 162 -i mgmt0 -s 0
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode
listening on mgmt0, link-type EN10MB (Ethernet), capture size 65535 bytes
14:08:51.491789 IP 10.7.0.13.37452 > 10.7.0.221.snmptrap: V2Trap(144) system.sysUpTime.0=9546160 S:1.1.4.1.0=S:1.1.5.4
interfaces.ifTable.ifEntry.ifIndex.452160.26=26 interfaces.ifTable.ifEntry.ifAdminStatus.452160.26=1
interfaces.ifTable.ifEntry.ifOperStatus.452160.26=1 S:1.1.4.3.0=E:8072.3.2.10

=== SNMP SET ===
The '''SNMP SET''' command is not supported by TelcoBridges products.

 

== Configuration ==
*[[Toolpack:System_Settings_B#SNMP|Configuring SNMP for version 2.9]]
*[[Toolpack:System_Settings_A#SNMP|Configuring SNMP for version 2.8]]
*[[tbSnmpAgent Configuration|Configuring SNMP for version 2.7]]
*'''Configuring SNMP for version 2.5'''
''The below procedures should be used to support SNMP v1 '''ONLY''' for '''Toolpack system previous to 2.5.80''':
*[[Installing NetSNMP from an External Host]]
*[[TMG SNMP support|How to relay SNMP on TMG products]]
 

== External Sources ==
*[http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol Wikipedia article on SNMP]
*[http://www.net-snmp.org/ NetSNMP implementation of the SNMP protocol]
 

[[Category:Glossary]]
[[Category:Needs revising]]
[[Category:Revise on Major]]

Call Trace

2017-03-23T01:58:53Z

Lucas Trottier: /* Configuration */

Call trace (uct) was created to trace the callflow from any incoming call through the Tmedia system. It allows to see the incoming call, the routing decision, outgoing calls, other outgoing calls if there is route retry, the parameters selected for SIP SDP, the SIP Call-id, the trunk and timeslot chosen for TDM protocols, the termination result code, and more.

It allows to store information for long periods of time and search for calls in history. The last 10,000 call legs (default size) can be seen directly in the web portal. Older logs can be loaded and viewed on the same system, or exported to other systems. Once a specific call has been consulted, it will remain in memory for a longer period of time, so that it can be consulted later on. Calls to view can be filtered according to called number, calling number, Network Access Point (NAP), time of day range, protocol and direction.

''Note: Call Trace is available starting with release 2.6''

== Configuration ==

* Web Portal v2.10
**[[Toolpack:Tsbc_Troubleshooting_A#Call_Trace|Tsbc Call Trace]]
**[[Toolpack:Troubleshooting_C#Call_Trace|Tmedia Call Trace]]
*[[Toolpack:Troubleshooting_B#Call_Trace|Web Portal v2.9: Call Trace]]
*[[Toolpack:Troubleshooting_A#Test_Call|Web Portal v2.8: Call Trace]]
*[[Web_Portal_Tutorial_Guide_v2.7#Troubleshooting|Web Portal v2.7: Call Trace]]
*[[Web_Portal_Tutorial_Guide_v2.6#Troubleshooting|Web Portal v2.6: Call Trace]]

[[Category:Revise on Major]]

Call Trace

2017-03-23T01:45:46Z

Lucas Trottier: /* Configuration */

Call Trace

2017-03-23T01:36:05Z

Lucas Trottier: /* Configuration */

Call trace (uct) was created to trace the callflow from any incoming call through the Tmedia system. It allows to see the incoming call, the routing decision, outgoing calls, other outgoing calls if there is route retry, the parameters selected for SIP SDP, the SIP Call-id, the trunk and timeslot chosen for TDM protocols, the termination result code, and more.

It allows to store information for long periods of time and search for calls in history. The last 10,000 call legs (default size) can be seen directly in the web portal. Older logs can be loaded and viewed on the same system, or exported to other systems. Once a specific call has been consulted, it will remain in memory for a longer period of time, so that it can be consulted later on. Calls to view can be filtered according to called number, calling number, Network Access Point (NAP), time of day range, protocol and direction.

''Note: Call Trace is available starting with release 2.6''

== Configuration ==

*[[Web_Portal_Tutorial_Guide_v2.10#Troubleshooting|Web Portal v2.10: Call Trace]]
*[[Web_Portal_Tutorial_Guide_v2.9#Troubleshooting|Web Portal v2.9: Call Trace]]
*[[Web_Portal_Tutorial_Guide_v2.8#Troubleshooting|Web Portal v2.8: Call Trace]]
*[[Web_Portal_Tutorial_Guide_v2.7#Troubleshooting|Web Portal v2.7: Call Trace]]
*[[Web_Portal_Tutorial_Guide_v2.6#Troubleshooting|Web Portal v2.6: Call Trace]]

Northbound interface:RESTful

2017-02-10T19:44:57Z

Lucas Trottier: Activate configuration

= TelcoBridges HTTP RESTful Northbound Interface =
Introduced in version 2.9, the [http://en.wikipedia.org/wiki/Representational_state_transfer RESTful API] allows the provisioning of a [[Tmedia]] VoIP gateway or a [[Tdev]] development platform. The configuration of the device is seen as collections of resources than can be queried/modified through this interface.

HTTP requests are sent to the [[Toolpack_Application:web_server|web server]] using standard HTTP methods(e.g., GET, PUT, POST, or DELETE). Data exchanged in requests and responses is in [http://en.wikipedia.org/wiki/JSON JSON] format.

== Supported RFCs ==

TelcoBridges supports the following RFCs for RESTful API:

{| border="1"
|-
! Specification
! Supported
|-
| RFC 7159 The JavaScript Object Notation (JSON) Data Interchange Format
| align="center" | Yes
|-
| Extensible Markup Language (XML) 1.0 (Fifth Edition)
| align="center" | No
|-
| RFC 2617 HTTP Authentication: Basic and Digest Access Authentication
| align="center" | Basic Scheme Only
|-
| RFC 2109 HTTP State Management Mechanism
| align="center" | Yes
|}

== REST API overview ==
{| cellpadding="5" border="1" class="wikitable"
! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | Resource
! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | GET
! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | PUT
! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | POST
! width="200" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | DELETE

|-
| valign="top" |
Collection URI <code><nowiki>http://host:port/@[collection_name]/</nowiki></code>
| '''List''' the resources that are part of the collection.
| Not used.
| '''Create''' a new element in the collection.
| Not used.
|-
| valign="top" |
Element URI <code><nowiki>http://host:port/@[collection_name]/@[resource_name]</nowiki></code>
| '''Retrieve''' a JSON representation of the specified member of the collection.
| '''Modify''' the specified member of the collection according to the JSON data in the HTTP request.
| Not used.
| '''Delete''' the specified member of the collection
|-
| valign="top" |
New Element URI <code><nowiki>http://host:port/@[collection_name]/new</nowiki></code>
| '''Retrieve''' a JSON representation of a new element of the collection with default values. This new element is not saved until a POST request is sent to create the element in the collection.
| N/A
| N/A
| N/A
|-
| valign="top" |
Status Element URI <code><nowiki>http://host:port/@[collection_name]/@[resource_name]/status</nowiki></code>
| '''Retrieve''' a JSON representation of the status of an element. This is only valid for elements in the active configuration, and it is not available for all element types.
| N/A
| N/A
| N/A
|}
=== Supported Methods ===

==== GET ====
List elements of a collection
GET /users
<- Content : {"root":{}}
<- Code : HTTP/1.0 200 OK
Read a specific element
GET /users/root
<- Content : {"name":"root","user_group":"Admin","pass":"Not Shown"}
<- Code : HTTP/1.0 200 OK
==== PUT ====
Update a configuration element
PUT /users/root
-> Content : {"pass":"MyNewSecret"}
<- Code : HTTP/1.0 200 OK
Omitted attributes in a PUT are left unchanged on the server.
==== POST ====
Create a configuration element into a collection
POST /users
-> Content : { "name" : "RogerFluffy", "user_group" : "nobody" , "pass" : "xyz" }
<- Code : HTTP/1.0 200 OK
Omitted attributes in a POST are being set to the 'default' value.
==== DELETE ====
Delete a configuration element from a collection
DELETE /users/RogerFluffy
<- Code : HTTP/1.0 200 OK
=== Elements ===
Elements are found under collection URIs. A collection is generally composed of multiple elements, with a different name for each element.
The element name must be provided during the '''POST''':
POST /users
-> Content : { "name" : "RogerFluffy", ... }
<- Code : HTTP/1.0 200 OK

Elements generally have attributes, and can also include collections. For example, for the configuration element ''MyCFG'', we can find the ''routes'' collection using the following URI:
/configurations/MyCFG/routes

=== Collections ===
URI with the plural form generally represent a collection of elements.
A collection can be composed of mutiple elements, or limited to 1.

For example, configuration are found under the following collection URI
/users
Likewise, the list of routes can be found on
/configurations/MyCFG/routes

When the collection is limited to 1 element, the element name is fixed.
For example, only one H.248 stack can be defined, therefore the name is fixed to ''gateway_h248''
The element name must be NOT be provided during the '''POST''':
POST /configurations/MyCFG/h248_stacks
-> Content : { "enabled" : true, "naps" : [ "NAP_TDM", "RTP_NAP"], ... }
<- Code : HTTP/1.0 200 OK

=== Recursivity ===
==== Non-recursive GET requests (default) ====
By default, requests are non-recursive. This means that when a GET request is made on a URI, only objects on that element will be returned.
GET /configurations/NewCFG
<- Content : {"name":"NewCFG", "notes":"This is a new demo configuration", "routes":{}, ... }
In the response, we see two attribute value pairs : '''name''' and '''notes''', along with another object named '''routes'''.
The later is a collection, and should be queried individually to get its sub-elements.
GET /configurations/NewCFG/routes
<- Content : {"Route1":{}, ...}
GET /configurations/NewCFG/routes/Routes1
<- Content : {"name":"Route1", "called":"5551212","calling":"", ...}
==== Recursive GET requests ====
It is possible to get all sub-elements from a GET by using the '''recursive=yes''' attribute on the URI.
GET /configurations/NewCFG?recursive=yes
<- Content : {
"name":"NewCFG",
"notes":"This is a new demo configuration",
"routes": {
"Route1": {
"name":"Route1",
"called":"5551212",
"calling":"", ...
},
"Route2": {
"name":"Route2",
"called":"5551314",
"calling":"", ...
}, ...
}
}
This is also true to get the content of all elements of a collection
GET /users?recursive=yes
<- Content : {
"RogerFluffy":{
"name":"RogerFluffy",
"user_group":"nobody",
"pass":"Not Shown"
},
"root":{
"name":"root",
"user_group":"Admin",
"pass":"Not Shown"
}
}
Note : recursive GET does not apply to status elements.
==== Recursive PUT/POST requests ====
The recursivity of a PUT/POST depends on the content. It is possible to specify the content of all sub-elements under a URI.
For example, to change the complete routing table, we could do something like:
PUT /configurations/NewCFG/routes
-> Content : {
"Route1": {
"name":"Route1",
"called":"5551212",
"calling":"", ...
},
"Route2": {
"name":"Route2",
"called":"5551314",
"calling":"", ...
}, ...
}
}
Or even change a complete configuration in a single PUT
PUT /configurations/NewCFG
-> Content : {
"name":"NewCFG",
"notes":"This is a new demo configuration",
"routes": {
"Route1": {
"name":"Route1",
"called":"6661212",
"calling":"", ...
},
"Route2": {
"name":"Route2",
"called":"6661314",
"calling":"", ...
}, ...
}
}

=== Documentation ===
It is possible to get the documentation for the attributes of an element from a GET by using the '''documentation=true''' attribute on the URI, either for the collection, an element or a new element.
GET /configurations?documentation=true
GET /configurations/NewCFG?documentation=true
GET /configurations/new?documentation=true
-> Content : {
"name": {
"description" : "Name of this configuration.",
"type" : "text",
},
"notes": {
"description" : "Free text field available to add any system/configuration information (this field is ignored by the system)",
"type" : "text",
}, ...
}
}
==== Recursive Documentation ====
It is possible to get documentation recursively by using both the '''documentation=true''' and the '''recursive=yes''' attributes on the URI.
GET /configurations?documentation=true&recursive=yes
-> Content : {
"name": {
"description" : "Name of this configuration.",
"type" : "text",
},
"notes": {
"description" : "Free text field available to add any system/configuration information (this field is ignored by the system)",
"type" : "text",
},
"routes": {
"called": {
"description" : "Called number to match this route. Leave empty to match any called number.",
"type" : "text",
},
"calling": {
"description" : "Calling number to match this route. Leave empty to match any calling number.",
"type" : "6661314",
}, ...
}, ...
}
=== Request Status code ===
The following result class are used to as HTTP status code to indicate the result of request.
* 2XX - success
* 3XX - redirection (304 Not Modified)
* 4XX - client error
* 5XX - server error

In Addition to HTTP status code, every HTTP response also inlcudes a JSON payload with a verbose message.
POST /configurations/MyCFG/h248_stacks
-> Content : { ... }
<- Code : HTTP/1.0 200 OK
<- Content : { "message" : "Tbgw h248 cfg creation failed: Public ip address can't be blank, Public ip address is invalid, Local ip address is invalid, Local ip address When not using virtual ip, an ip address must be entered"}

This ''message'' can be used to find the exact reason why a RESTful API call failed.

=== HTTP headers ===
The following HTTP header should be used in requests:
{| border="1"
|-
! HTTP Header
! Description
|-
| Host
| Mandatory
|-
| Authorization
| RFC2617 WWW Authentication, basic mode. Can be used on each requests, or first request only by using Cookie/Set-Cookie headers
|-
| Cookie
| RFC2109 HTTP Session management
|-
| Content-Type
|"application/json"
|-
| Content-Length
| Length of content for PUT and POST requests
|-
| User-Agent
| Optional
|-
| If-None-Match
| Optional (HTTP ETag/If-None-Match caching mechanism)
|-
| Cache-Control
| HTTP Cache control, use is optional
|-
| Connection
| "keep-alive"
|}

The following HTTP header are to be expected for a server response:
{| border="1"
|-
!HTTP Header
!Description
|-
| Authorization
| RFC2617 WWW Authentication
|-
| Set-Cookie
| RFC2109 HTTP Session management
|-
| Content-Type
| "application/json; charset=utf-8"
|-
| Content-Length
| Length of content
|-
| E-Tag
| Optional (HTTP ETag/If-None-Match caching mechanism)
|-
| Cache-Control
| Optional
|-
|Date
| Can be ignored
|-
| X-Runtime
| Can be ignored
|-
| X-Frame-Option
| To be ignored
|}

== API Access ==
=== HTTP port ===
The HTTP port for RESTful access is the same as for the Web interface. By default, HTTP port is 12358.
Therefore the RESTful URIs should looks something like: ''' <nowiki>http://TMG_IP_ADDR:12358/@[collection_name]/@[resource_name]</nowiki>'''

=== Credentials ===
The credentials (user/password) used to authenticate a RESTful client application are the same as for the WebPortal.
Users can be managed from the Web interface under /users. The same path is used to manage users by the RESTful interface.

= Ruby implementation example =
This ruby script is an example of how to use TelcoBridges RESTful Northbound Interface.
* The script can be executed from any computer having access to the management web interface.
* The script can also be copied on the internal host of a ''T''media and executed from a SSH client (as shown in the examples below using <nowiki>127.0.0.1:12358</nowiki>).

== Download script ==
* [[Media:Httprestapi.rb.gz‎|httprestapi.rb [click to download]]]

== Usage ==
./httprestapi.rb <URI> <user> <password> <http request>

With <URI> = <nowiki>http://ip:port</nowiki>
Example: <nowiki>./httprestapi.rb 'http://127.0.0.1:12358' 'root' 'password' <http request></nowiki>

With <http request> = <GET|PUT|POST|DELETE> <element path> [json | -i jsonfile | -o jsonfile]
-i jsonfile = input json file used for PUT or POST http request
-o jsonfile = output json file used for GET http request

== GET ==
Get the configuration collection list and display the JSON returned in the body of the HTTP response.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations'</nowiki>

Show the use of "recursive=yes" to get all sub-element of configuration. Put the returned JSON in "test_configuration.json" file.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test?recursive=yes' '-o test_configuration.json'</nowiki>

Use "documentation=yes" to return documentation of all attributes of an element. Below example returns documentation for a new route element.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test/routes/new?documentation=yes'</nowiki>

Get request can also be used to retrieve the status of some elements of the '''active''' configuration.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test/naps/xtel/status'</nowiki>

== PUT ==
Modify attributes of an element. Below example renames the route element named "Test" to "NewName".
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' PUT '/configurations/test/routes/test_route' '{"name":"new_route_name"}' </nowiki>

Modify attributes of an element using a JSON file for the HTTP request.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' PUT '/configurations/test/routes/test_route' '-i modified_route.json' </nowiki>

Activate "demo" configuration
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' PUT '/systems/system_1' '{"target_configuration":"demo"}' </nowiki>

== POST ==
Create a new element. Below example add a new route named "xtel_to_SBC_1".
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' POST '/configurations/test/routes' '{"name":"xtel_to_SBC_1","nap":"xtel","remapped_nap":"SBC_1"}' </nowiki>

Create a new element using a JSON file for the HTTP request.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' POST '/configurations/test/routes' '-i new_route.json' </nowiki>

Create a new configuration using a JSON file for the HTTP request.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' POST '/configurations' '-i test_configuration.json' </nowiki>

== DELETE ==
Delete an element. Below example delete the route named "xtel_to_SBC_1".
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' DELETE '/configurations/test/routes/xtel_to_SBC_1' </nowiki>

== Using JSON files ==
=== Modify an element ===
1. Get route configuration in JSON file
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test/routes/test_route' '-o routes.json'</nowiki>
2. Edit JSON file attributes
vi route.json
3. Modify element from JSON file
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' PUT '/configurations/test/routes/test_route' '-i routes.json'</nowiki>

=== Create a new element ===
1. Get an element default attributes value in a JSON file
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test/routes/new' '-o routes.json'</nowiki>
2. Edit JSON file attributes
vi route.json
3. Create new element from JSON file
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' POST '/configurations/test/routes/new_route' '-i routes.json'</nowiki>