wiki:AdminGuides/TelnetCommands

Telnet Commands

Aswitch offers simple telnet based command set to monitor its status and issue control commands

Command list

Available commands:
  h          - command help
  r          - registered users
  c          - calls
  reload     - reload configuration
  rotatelog  - rotate log file
  mod[ules]  - list modules with DID numbers
  mon[itor]  - monitor mode
  rad[ius]   - radius statistics
  clearstats - clear all statistics
  q[uit]     - quit

Command description

list registered users

command
r
availability
version 2.0.4

Shows currently registered users in aswitch. The result is following row:

1234567890|10.1.1.2|sip/sip:1234567890@10.1.1.2|2013-09-10 10:05:24.397966

Fields separated by pipe |:

field1
username
field2
IP address
field3
Location URI
field4
Expiration time

list calls

command
c
availability
version 2.0.4

Shows current calls, active and inactive. The result is following row:

For call which is active connected:

131234567-10001|2013-09-10 10:02:50.013461|0012127773456|1

Fields separated by pipe |:

field1
call billing ID. Contains unix time stamp of engine start time (runid) and internal call ID separated by dash (-)
field2
call setup time
field3
dialled number
field4
call type, internal (1 - standard call, 2 - IVR call)

reload configuration

command
reload
availability
version 2.2.0

Reloads configuration. Most of system run time settings can be reloaded by this command. However, there are still many settings which require aswitch restart. Consult support for current status of this command

rotate log file

command
rotatelog
availability
version 2.2.0

Renames current log file by appending time string and creates new blank log file. The format of the old filename is:

aswitch.log.20130726134612

The string after last dot represents time of rotating as YYMMDDHHMMSS. In the case command is issued more than once in the given second, the rotation will fail and error message will be displayed. Retry again.

list modules

command
mod or modules
availability
version 2.2.8

Lists loaded aswitch modules and statically linked DID numbers if any. Example:

Name                  DID number(s) 
====                  ============= 
test                : 123, 456 
std_switch          : Undefined 
ivr_switch_1        : Undefined 
ani_callback        : Undefined 
balance             : 999111, 999112 

Interactive monitor mode

command
mon or monitor
availability
version 2.2.10

Enters into interactive mode where several system parameters are displayed live, with 1 second interval. Requires user confirmation to enter the mode:

hit <enter> to start monitor, ctrl+] and then q to quit

After confirming, the system will start to print:

calls | reg | radque 
   0  |  5  |     0 
calls | reg | radque 
   4  |  5  |     0 

Currently monitored attributes are:

calls
number of calls, active and setup
reg
number of registrations
radque
RADIUS queue length (number in requests in outgoing RADIUS queue)

To stop interactive mode, press CTRL + ]. The press q to quit telnet server.

RADIUS statistics

command
rad or radius
availability
version 2.2.10

Shows radius statistics. Example:

queue: 0 
auth requests sent: 12219 received: 12219 lost: 0 (100.00 %) average 87.414 ms
acct requests sent: 31079 received: 31079 lost: 0 (100.00 %) average 59.172 ms
queue
number of requests in outgoing RADIUS queue
auth requests
statistics about sent authorization requests
acct requests
statistics about sent accounting requests

Clear statistics

command
clearstats
availability
version 2.2.10

Clears all statistics data

Quit telnet

command
q or quit
availability
version 2.0.4
Last modified 4 years ago Last modified on Sep 10, 2013, 10:47:49 AM