ss7boost_cli

Overview

The ss7boost_cli program provides the human, or command line interface for interacting with ss7boost. There is a packet interface between ss7boost_cli and ss7boost. This arrangment allows ss7boost to run in a higher priority than the ss7boost_cli program which a typical sytems engineering practice.

Contents

Installation


The ss7boost_cli program is copied to /usr/local/ss7box during normal SMG installation or upgrade. The steps are:

  1. cp <SMG installation directory>/new/ss7boost_cli /usr/local/ss7box
  2. cp <SMG installation directory>/new/ss7boost_cli.conf /usr/local/ss7box

Configuration


The /usr/local/ss7boost_cli.conf file and the [CLI] section of ss7boost.conf contain the configurable parameters for ss7boost_cli.

Operation


  1. cd /usr/local/ss7box
  2. Examine the usage message displayed by ss7boost:
    [mike01@ws1 cli]$ ./ss7boost_cli
    Xygnada Technology, Inc. ss7boost Command Line Interface, Version: 0.0.3
    
            ERROR: no function specified
    
            Usage: <path>/ss7box_cli <parms>
    
                    <parms>::= [--help | --vers | <function-spec>]
                    <function-spec>::= [<log-verbose>|<log-cdr>|<testcall>|<ckt>|<prt-isup>]
                    <log-verbose>::= [<log-verbose-on> | <log-verbose-off>]
                    <log-verbose-on>::= --log-verbose on <verbose-group>
                    <log-verbose-off>::= --log-verbose off
                    <verbose-group>::= [0..UINT32_MAX]
                    <log-cdr>::= --log-cdr [on | off]
                    <testcall>::= --testcall <span> <chan> <calling-num> <called-num>
                    <ckt>::= [<ckt-report>|<ckt-block>|<ckt-unblock>|<ckt-reset>]
                    <ckt-report>::= --ckt-report <span> <chan>
                    <ckt-block>::= --ckt-block <span> <chan>
                    <ckt-unblock>::= --ckt-unblock <span> <chan>
                    <ckt-reset>::= --ckt-reset <span> <chan>
                    <prt-isup>::= --prt-isup [on | off]
                    <span>::= --span [0..<max_span>|all]
                    <chan>::= --chan [0..<max_chan>|all]
                    <max_span>::= 8
                    <max_chan>::= if span is T1 - 23; if span is E1 - 31
                    <calling-num>::= --clg <telephone-number>
                    <called-num>::= --cld <telephone-number>
                    <telephone-number>::= up to 31 digits

Verbose Logging

  • Using the "-v" option when starting ss7boost activates verbose logging. The CLI command allows verbose logging control regardless of the use of the "-v" option when starting ss7boost.
  • Verbose logging applies to the messages in the Verbose Groups described in ss7boost.conf.
  • To turn on verbose logging:
    cd /ss7box
    ./Tail
    ./ss7boost_cli --log-verbose on <vgi>
    where vgi are Verbose Group Indicators
  • To turn off verbose logging:
    ./ss7boost_cli --log-verbose off

Test Call

For specifiying a particular span/chan to be used in a call from a specific number to a specific number. This tool allows you to specify a call trigger by called/calling numbers. The triggering call will use the specified span/chan.
  1. Tail the /var/log/messages file with the -f option - or use the ."/Tail" script.
  2. Use the "./ss7boost_cli --log-verbose on 1" script to turn on verbose reporting with group 1 messages (refer to Verbose Group Indicators).
  3. Make a call from to 2266 from 12345678 and ensure the call works
  4. Enter "./ss7boost_cli --testcall --span 0 --chan 23 --cld 2266 --clg 12345678" to set the testcall trigger.
  5. Make a call from to 2266 from 12345678
  6. Observe in the messages file that the call is placed on span 0 channel 23.
  • The testcall tool only works with outbound calls. It does not work with inbound calls.
  • The testcall trigger is one-shot. Once it hits, the trigger is cleared. Making a second call immediately after the triggering test call results in the system reverting to its normal CIC hunt method.
  • There is only one trigger defined. Running the testcall script twice without making the test call results in the last run of the script defining the test call trigger.
  • The command sets up up the trigger in ss7boost. When the live call comes through ss7boost matching the trigger criteria (called/calling numbers), then the testcall span/chan will be assigned, if possible, to the call.
  • Be sure to use ss7boost numbering for span/chans. There are four different ways to specify the same e1 and timeslot:
    1. ss7boost numbering from ss7boost.conf
    2. wanpipeX and timeslot
    3. E1 or T1 identifier from switch and timeslot
    4. CIC (same on both sides of trunk group)

Here is the /var/log/messages output for the test described above:
Jul 26 20:59:53 b2 ss7boost_i_0.2.40.v[10090]: 
C:testcall trigger set:called_no/calling_no/span/chan follow:2266:12345678:0:29

A call to 2266 from 12345678 is made and following output is logged:
Jul 26 21:00:09 b2 ss7boost_i_0.2.40.v[10090]: 
I:sb_send_isup.c:send_iam_to_ss7box:call setup id follows:2
Jul 26 21:00:09 b2 ss7boost_i_0.2.40.v[10090]: 
I:dir OUTB span 0 chan 29 cpcstate 0 csupid 2 tg 0 cic 30

Note that span 0 chan 29 is used

ISUP Decode Printing to File (not working at this time)

Results are printed to /usr/local/ss7box.
  • Turn on: ./ss7boost_cli --prt-isup on
  • Turn off: ./ss7boost_cli --prt-isup off

CDR Logging

Refer to the User Manual for the Remote CDR Event Logger. CDR Logging can also be controlled in ss7boost.conf.
  • Turn on: ./ss7boost_cli --log-cdr on
  • Turn off: ./ss7boost_cli --log-cdr off

Circuit Status Report

Use this command to create a status report for one, all, or a group of circuits.

Single Circuit Report

./ss7boost_cli --ckt-report --span 0 --chan 3

All Circuits Report

./ss7boost_cli --ckt-report --span all --chan all

Single Span All Circuit Report

./ss7boost_cli --ckt-report --span 1 --chan all

Report

[root@localhost ss7box]# ./ss7boost_cli --ckt-report --chan all --span all
ckt-report begin
   span:  0  chan cfg inuse inrst rhb lhbs lhbm lhbc lhbr rmb lmb
              0   n   -     -     -   -    -    -    -    -   -
              1   Y   n     n     n   n    n    n    n    Y   n
              2   Y   n     n     n   n    n    n    n    Y   n
              3   Y   n     n     n   n    n    n    n    Y   n

Circuit Blocking

This command allow the user to control local maintenance blocking of circuits.
  • A circuit that is hardware blocked can be maintenance blocked as well.
  • Maintenance blocking status is preserved across restarts of ss7boost.

Circuit Unblocking

This command allow the user to control local maintenance unblocking of circuits.
  • A circuit that is hardware blocked can be maintenance unblocked, but the circuit cannot be used until the hardware block is removed.
  • Maintenance blocking status is preserved across restarts of ss7boost.

Created by: mike last modification: Tuesday 30 of October, 2007 [14:38:54 UTC] by mike

The original document is available at http://www.ss7box.com/tiki-index.php?page=ss7boost_cli