Page History

The Call Accounting Manager (CAM) generates Call Detail Records (CDRs) and supports accounting events event logging to on the

• Administrator
• Operator
• FieldService
• Guest
• SecurityAuditor
• Calea

Since the RADIUS protocol does not provide a means to assign users to a group, the implementation currently hard codes every RADIUS authenticated user to the Administrator group.

For detailed information on RADIUS authentication, refer to Configuring SBC for RADIUS Authentication.

Viewing Billing Records 

As calls traverse the

You may also view billing records (and other logs) from the EMA Platform Mode. Refer to Administration - Accounting and Logs for more information.

, CDRs are generated and stored in the /var/log/sonus/sbx/evlog directory. You can view these CDR by looking at files with the “.ACT” extension. It is useful to view the ACT logs during call debugging (to get the originating trunk group, calling and called numbers, codec used, etc.). You can also view billing records (and other logs) while in EMA Platform Mode. Refer to Administration - Accounting and Logs for more information. 

1. Local hard disk—If accounting is enabled, then ASCII records are always written to the local disk.
2. An external server, for example: 
   1. To a DSI-L0 server—If configured, the ASCII records can be transferred to an external

      Spacevars
      0 company

       DSI server using SFTP.
   2. To an external billing server in an IMS network via the Rf Interface.
3. RADIUS server—RADIUS accounting records can be generated and sent to an external RADIUS server.

Call Detail Record Format

This section describes the ASCII and streaming Call Detail Record (CDR) format.

Various

For GW-GW calls on the

Call Detail Record Format

This section describes the ASCII and streaming Call Detail Record (CDR) format.

For more information on known limitations, refer to the applicable release notes at SBC Release Information page.

Accounting File Version

The CAM version of the SBC Core release V08.01.00 is 93.00.00 (major CAM version is 93, minor CAM version is 0, a special CAM version is 0). The associated hexadecimal format of the CAM file version is 005D0000, displayed as 005D0000 in ASCII CAM file header as follows

Sonus Networks, Inc.00000000FF6000005D0000000000000128V08.01.00R000 0000000000000000000000000000ACT2019082617203000000000000000

File Header

Every event log file, including accounting logs, contains a file header. This header consists of a 128-character string terminated by a carriage return. Each field in the event log file header is defined in the following table:

For more information on known limitations, refer to the applicable release notes at SBC Release Information page.

Accounting File Version

The CAM version of

Sonus Networks, Inc.00000000FF600000540000000000000060V05.01.00 00000000000000000000000000000000000ACT2014112715113200000000000000.

File Header

Every event log file, including accounting logs, contains a file header. This header consists of a 128-character string terminated by a carriage return. Each field in the event log file header is defined in the following table:

File Footer

The one line footer, below, is appended to each log file (including accounting logs) when the file is closed under controlled conditions.

DDMMYYYY HHMMSS: File administratively closed.

Controlled conditions include CLI commands (for example, set oam eventLog typeAdmin acct rolloverAction...) and automatic roll-overs when maximum file size is reached.

When an uncontrolled file closure occurs, such as an

How to Set Up SFTP from SBC to a CDR Server

If the CDR server is configured,

To create the CDR server, use the following command syntax:

Renaming Open Accounting Files

The SBC includes the ability to rename a currently-open accounting file using a known suffix to make it easily identifiable by external applications. To activate this feature, simply enable the flag “Rename Open Files” using EMA GUI or CLI. 

CLI syntax example:

% set oam 

eventLog 

typeAdmin 

acct renameOpenFiles enable

Once this flag is enabled, on the next accounting file open activity, the suffix .OPEN is appended to the filename using the format <shelf><sequence number>.ACT.OPEN (currently open files are not affected).

For example, as accounting file 1000099 is created with this feature already enabled, the file is named “1000099.ACT.OPEN”.

For configuration details, refer to:

• CLI: Event Log - CLI
• EMA: Event Log - Type Admin

Accounting File Roll-Over

The 

When accounting file names reach the maximum value of 1FFFFFF.ACT, the next file name rolls over to 1000001.ACT. Use the “Rename Open Files” flag to rename the most recent accounting file with the ”ACT.OPEN” extension. This flag is accessible from the EMA at “System Configuration” > “CDR and Servers” tab.

Global Charge Reference

The Global Charge Reference (GCR) feature allows correlation of calls across networks where the calls are originated from and terminated at different third-party devices. The GCR field is populated in the CDRs of the SBC if the GCR is received in a gateway protocol message from a GSX9000.

The GSX9000 receives or generates the GCR parameter through an ISUP parameter. The GCR is used in conjunction with SIP call-id’s to associate calls that interwork between SIP and ISUP protocols across multiple network devices.

How to Set Up SFTP from the SBC to a CDR Server

If a CDR server is configured, the 

1. To create a CDR server, use the following command syntax:

   Code Block
   language none
   % set oam accounting cdrServer admin [primary | [primary | secondary] connectionTimeout <numeric: 15 to 600 seconds> filePrefix <name of SBC> ipAddress <ip address> password <password for ftp user> path <directory to ftp to> transferTimeout <numeric: 15 to 600 seconds> username <username of ftp user>

   Span

   An example to show the CDR server configuration and check the configuration is as follows:

   Code Block
   language none
   admin@SBC01> config admin@SBC01% set oam accounting cdrServer admin primary connectionTimeout 15 filePrefix SBC01 ipAddress 10.10.211.10 password sonus path /export/home/SBC01ACTrecs/ transferTimeout 15 username root admin@SBC01% commit admin@SBC01% quit admin@SBC01> show table oam accounting cdrServer admin FILE CONNECTION TRANSFER TYPE IP ADDRESS USERNAME PASSWORD PATH PREFIX TIMEOUT TIMEOUT -------------------------------------------------------------------------------------------------------------- primary 10.10.211.10 root $3$qaO71mBy8l8= /export/home/SBC01ACTrecs/ SBC01 15 15 [ok][2013-10-02 06:14:49] admin@SBC01>

   Span

2. Initially, the accounting field is not set to ftp or automatically roll over. Use the following command to view Rollover setting settings for accounting (See "acct" row in the example):

   Div
   class pdf6pttext
   Code Block language none admin@SBC01>> show table oam eventLog typeAdmin MESSAGE MESSAGE ROLLOVER FILE RENAME DISK FILE SYSLOG SYSLOG SYSLOG RENAMESYSLOG FILE FILE QUEUE SAVE FILTER ROLLOVER START ROLLOVER ROLLOVER WRITE SYSLOG OPEN SYSLOG REMOTETHROTTLE EVENT REMOTELOG SERVER REMOTE OPENREMOTE TYPE STATE COUNT SIZE SIZE TO LEVEL TIME INTERVAL ROLLOVER TYPE ACTION MODE INTERVAL ROLLOVER TYPESTATE ACTION FILES MODE LIMIT STATE VALIDATION HOSTNO PROTOCOL PORT FILES ---HOST ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- system enabled 1632 160002048 3210 disk info - major - 0 nonrepetitive stop default disabled disabled 5000 disabled server1 0.0.0. debug enabled 32 2048 10 disk major - 0 nonrepetitive stop default disabled disabled 0.0.0.0- tcp disabled 514 server1 disabled debug0.0.0. trace enabled 1632 160002048 3210 disk info - 0 nonrepetitive stop default disabled 0.0.0.0disabled tcp- 514 disabled trace server1 enabled 16 0.0.0. acct 16000enabled 32 2048 disk info -10 disk major - 0 nonrepetitive stop default disabled 0.0.0.0disabled tcp- 514 disabled disabled acct server1 0.0.0. security enabled 1632 640002048 3210 disk info major - 0 nonrepetitive stop optimizedefault disabled 0.0.0.0disabled tcp- 514 disabled disabled security server1 enabled 16 0.0.0. audit 16000enabled 32 disk 2048 major 10 - disk info - 0 nonrepetitive stop default disabled disabled 0.0.0.0- tcp disabled 514 server1 disabled audit0.0.0. packet enabled 32 2048 10 disk infomajor - 0 nonrepetitive stop default disabled disabled 0.0.0.0- tcp disabled 514 server1 disabled packet0.0.0. memusage enabled 32 2048 10 disk major 10 - disk major - 0 nonrepetitive stop default disabled disabled 0.0.0.0- tcp disabled 514 server1 disabled0.0.0. [ok][2013-10-02 06:41:58]

   Span

3. To create the accounting file rollover and ftp, use the following command syntax:

   Code Block
   language none
   % set oam eventLog typeAdmin acct rolloverStartTime <CCYY-MM-DDTHH:MM:SS> rolloverInterval <number of seconds between each file rollover> rolloverType repetitive rolloverAction start where 'T' in 'DDTHH' is a constant used to indicate the Time follows.

   Span

   An example of the configuration and display of the accounting file rollover and ftp is as follows:

   Div
   class pdf6pttext
   Code Block language none admin@SBC01%% set oam eventLog typeAdmin acct rolloverStartTime 20132018-1009-02T0613T06:30:00 rolloverInterval 900500 rolloverType repetitive rolloverAction start [ok][20132018-1008-0213 0612:4158:2511] [edit] admin@SBC01%admin@SBXUK11-1% commit Commit complete. [ok][20132018-1008-0213 0612:4158:2814] [edit] admin@SBC01% quit admin@SBC01> admin@SBXUK11-1% exit > show table oam eventLog typeAdmin MESSAGE FILE FILE SYSLOG SYSLOG RENAME SYSLOG RENAMEDISK FILE FILE QUEUE SAVE FILTER ROLLOVER START ROLLOVER ROLLOVER WRITE SYSLOG REMOTEOPEN REMOTE THROTTLE REMOTE EVENT OPENLOG TYPE STATE COUNT SIZE SIZE TO LEVEL TIMEROLLOVER START TIME INTERVAL ROLLOVER TYPE ACTION MODE STATE STATE FILES HOST LIMIT PROTOCOL PORT FILES VALIDATION ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- system system enabled 32 2048 10 disk major - 0 nonrepetitive stop default disabled disabled 5000 disabled debug enabled 1632 160002048 3210 disk infomajor - - 0 nonrepetitive stop default disabled 0.0.0.0disabled tcp - 514 disabled debugtrace enabled 1632 160002048 3210 disk info - 0 nonrepetitive stop default disabled 0.0.0.0disabled tcp - 514 disabled traceacct enabled 1632 160002048 3210 disk infomajor -2018-09-13T06:30:00-00:00 500 repetitive start default 0 disabled disabled - nonrepetitive stop default disabled 0.0.0.0 tcpdisabled security enabled 32 2048 51410 disabled acct disk major enabled - 16 64000 32 disk info 2013-10-02T06:30:00 900 0 repetitive startnonrepetitive stop optimize disabled default 0.0.0.0 disabled tcp disabled - 514 disabled securityaudit enabled 1632 160002048 3210 disk majorinfo - 0 nonrepetitive stop default disabled 0.0.0.0disabled tcp- 514 disabled auditpacket enabled 32 2048 10 disk major info- - 0 nonrepetitive stop default disabled 0.0.0.0disabled tcp - 514 disabled packetmemusage enabled 32 2048 10 disk major - 0 nonrepetitive stop default disabled 0.0.0.0disabled tcp - 514 disabled [ok][2013-10-02 06:41:58]

   Span

4. View CDR Server status using the following command:

   Code Block
   language none
   admin@SBC01> show table oam accounting cdrServer status SUCCESSFUL FAILED PENDING TYPE STATE PROGRESS TRANSFERS TRANSFERS TRANSFERS ------------------------------------------------------------- primary active done 3 0 0 [ok][2013-10-02 07:27:19]

   Span

5. Verify that the files were transferred to the FTP server by logging in to the CDR server and executing the following command:

   Code Block
   language none
   ftp server: root@hostname # pwd /export/home/SBC01ACTrecs root@hostname # ls -l total 708 -rw-r--r-- 1 root other 346730 Oct 2 06:45 SBC01.20131002064500.1000022.ACT -rw-r--r-- 1 root other 175 Oct 2 07:00 SBC01.20131002070000.1000023.ACT -rw-r--r-- 1 root other 175 Oct 2 07:15 SBC01.20131002071500.1000024.ACT root@hostname #

   Span

6. Execute the following command to view the successful and failed CDR file transfer:

   Code Block
   language none
   % show table oam accounting cdrServer status SUCCESSFUL FAILED PENDING TYPE STATE PROGRESS TRANSFERS TRANSFERS TRANSFERS --------------------------------------------------------- primary active done 2 0 0 secondary standby idle 0 7 0

SBC Standard Attributes

CDR Server Remote Port Configuration

The 

 supports transferring call accounting files (.ACT) to a CDR server through a user-configured port. The 

 also supports using Secure Shell (SSH) public keys instead of password to authenticate with the remote CDR server.

Use the following parameters within CDR server configuration to set up remote port and ssh key based authentication:

• cdrPort
• useSshKeyFile 


• generateSshPublicKeys

To generate a new SSH public key, execute the following command:

% request oam accounting cdrServer admin primary generateSshPublicKeys

The generated SSH public key must be installed on CDR server to use ssh key based authentication from SBC. The SSH public key must be copied to the remote CDR server file /home/<user>/.ssh/authorized_keys. If the private key is compromised, the key must be re-generated. Once the key is re-generated, the CDR server must be updated with the new key.

Configuring the CDR Server Remote Port

When downloading billing records (or other logs), you must use port 2024 to SFTP files from the 

% set oam accounting cdrServer admin primary cdrPort 2024

1. Enabling SSH Key Based Authentication
2. Generating the SSH Public Key
3. Copying and Installing the SSH Public Key to CDR Servers

Anchor
Configuring SBC to Use SSH Key Based Authentication Configuring SBC to Use SSH Key Based Authentication

Enabling SSH Key Based Authentication

To enable SSH key based authentication, execute the following command:

% set oam accounting cdrServer admin primary useSshKeyFile Enable

Anchor
Generating the SSH Public Key Generating the SSH Public Key

Generating the SSH Public Key

To generate a new SSH public key, execute the following command:

% request oam accounting cdrServer admin primary generateSshPublicKeys
result success
reason 
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDclSOlVfVmmhatw5bDQRk7AaYvCRUUfHHbSvkCBb4T8zYdJ8JNw15rMSKk9hEkVdtEEZRJU4Q97C+3LbPknZrIMM+zmSRYmh2/LkGAlydSJ+sPe9i7zWFOLYeA3gitaKJSPgSjdb4WGgDq686Ei4yup9xYDbT8wAcosQsf3tfbqH2GetNJ8tAs3KjRi7FPhH1hHdXVyH0yW1mdGlMYvoFUeFCRjhE81oJhy2jMTJD9T3eQiJo4NZQZYOgALMQPi8fxaAgnuWmvrejNTn/PgRyGpQEs7HFHkX5zHW5M74PU/Z3S3Y2uSZlYrCQRf9Y2mUiK5R40bjsKz4TqIP5LfzhX
[ok]

Anchor
Copying and Installing the SSH Public Key to CDR Servers Copying and Installing the SSH Public Key to CDR Servers

Copying and Installing the SSH Public Key to CDR Servers

The SSH public key is copied to the remote CDR server file /home/<user>/.ssh/authorized_keys.

For configuration details, refer to Accounting - CLI.

RADIUS Accounting Support

Remote Authentication Dial In User Service (RADIUS) is

1. Local hard disk—If accounting is enabled, then ASCII records are always written to the local disk.
2. An external server:
   
   1. To DSI-L0 server—If configured, the ASCII records are transferred to the external Sonus DSI server through SFTP.
   2. To external billing server from IMS network via Rf Interface.
3. RADIUS server—RADIUS accounting records can be generated and sent to an external RADIUS server.

Accounting File Roll-Over

The

When accounting file names reach the maximum value of 1FFFFFF.ACT, the next file name rolls over to 1000001.ACT. Use the “Rename Open Files” flag to rename the most recent accounting file with the ”ACT.OPEN” extension. This flag is accessible from the EMA at “System Configuration” > “CDR and Servers” tab.

Global Charge Reference

The Global Charge Reference (GCR) feature allows correlation of calls across networks where the calls are originated from and terminated at different third-party devices. The GCR field is populated in the CDRs of the SBC if the GCR is received in a gateway protocol message from a GSX9000.

The GSX9000 receives or generates the GCR parameter through an ISUP parameter. The GCR is used in conjunction with SIP call-id’s to associate calls that interwork between SIP and ISUP protocols across multiple network devices.

RADIUS Support

RADIUS is a standardized protocol for supporting Authentication, Authorization, and Accounting (AAA) management in a distributed client-server architecture. The

The following message types are supported by RADIUS protocol:

• Accounting Request
• Accounting Response
• Access-Request
• Access-Accept
• Access-Reject

The accounting request and its response for a transaction methodology is described below.

-server architecture. The 

The following accounting message types are supported by RADIUS protocol:

• Accounting Request
• Accounting Response

The process for sending accounting requests and responses is described below.

• The
 sends an accounting-request with Accounting-Status-Type value "Accounting-on". At a later time, this transaction informs the server about the new accounting client that will send the accounting messages to the NAS/resource usage by user.
• When the

  Spacevars
  0 product

   connects the call, the accounting starts. The accounting-request contains the Accounting-Status-Type with the value "Start". The "Start" records contains the following:
• User identification
• Network address
• Point of attachment
• Unique session identifier
• Next, the

  Spacevars
  0 product

   records the status change by NAS to the RADIUS server for this active session. The  sends an accounting-request now contains the with Accounting-Status-Type with the value "Interim". The interim record usually conveys the current session duration and information on the current data usage.
• When the user network access is closed, the NAS issues a final Accounting Stop record to the RADIUS server, providing the information on the final usage in the terms of the following:
• Time
• Packets transferred
• Data transferred
• Reason for disconnect
• Other information related to the call
• Accounting-on". At a later time, this transaction informs the server about the new accounting client that will send the accounting messages to the NAS/resource usage by user.
• When the

  Spacevars
  0 product

   connects the call, the accounting starts. The accounting-request contains the Accounting-Status-Type with the value "

• Start". The "Start" records contains the following:
• User identification
• Network address
• Point of attachment
• Unique session identifier
• Next,

To configure up to three RADIUS servers per

• the

  Spacevars
  0 product

Renaming Open Accounting Files

The SBC includes the ability to rename a currently-open accounting file using a known suffix to make it easily identifiable by external applications. To activate this feature, simply enable the flag “Rename Open Files” using EMA GUI or CLI. 

CLI syntax example:

% set oam eventLog typeAdmin acct renameOpenFiles enable

Once this flag is enabled, on the next accounting file open activity, the suffix .OPEN is appended to the filename using the format <shelf><sequence number>.ACT.OPEN (currently open files are not affected).

For example, as accounting file 1000099 is created with this feature already enabled, the file is named “1000099.ACT.OPEN”.

For configuration details, refer to:

• CLI: Event Log - CLI
• EMA: Event Log - Type Admin

Rf Interface Support

The

The

For more details, refer to Rf Interface Support page in the Managing Billing Records section.

CDR Server Remote Port Configuration

The 

The following parameters are added in CDR server configuration to set remote port and ssh key based authentication:

• cdrPort
• useSshKeyFile


• generateSshPublicKeys

To generate a new SSH public key, execute the following command:

% request oam accounting cdrServer admin primary generateSshPublicKeys

The generated SSH public key must be installed on CDR server to use ssh key based authentication from SBC. The SSH public key must be copied to the remote CDR server file /home/<user>/.ssh/authorized_keys. If the private key is compromised, the key must be re-generated. Once the key is re-generated, the CDR server must be updated with the new key.

Configuring CDR Server Remote Port

% set oam accounting cdrServer admin primary cdrPort 2024

1. Enabling SSH Key Based Authentication
2. Generating the SSH Public Key
3. Copying and Installing the SSH Public Key to CDR Servers

•  records the status change by NAS to the RADIUS server for this active session. The accounting-request now contains the Accounting-Status-Type with the value "Interim". The interim record usually conveys the current session duration and information on the current data usage.
• When the user network access is closed, the NAS issues a final Accounting Stop record to the RADIUS server, providing the information on the final usage in the terms of the following:
• Time
• Packets transferred
• Data transferred
• Reason for disconnect
• Other information related to the call

The Accounting-Request contains the Accounting-Status-Type with the value "Stop". The primary purpose of this data is to bill the user. The data is also used for statistical purposes and for general network monitoring.

SBC Standard Attributes

The 

Rf Interface Support

The

The

For more details, refer to Rf Interface Support.

Generating CDRs in Q-SBC Format

By default, the SBC Core generates CDRs in the standard SBC Core (former Sonus) format. For deployments that require it, users with admin privileges can configure the SBC Core to generate CDRs in the format of the (former GENBAND) Q-series SBCs. Similar to SBC Core CDRs, the Q-SBC format is an ASCII-format text file with multiple records per file. When you enable the Q-SBC format, the SBC Core populates CDR log files according to the mapping shown in the Q-SBC to SBC Core CDR Mapping table. Refer to Generating CDRs in Q-SBC Format for more information

To enable SSH key based authentication, execute the following command:

% set oam accounting cdrServer admin primary useSshKeyFile Enable

To generate a new SSH public key, execute the following command:

% request oam accounting cdrServer admin primary generateSshPublicKeys
result success
reason 
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDclSOlVfVmmhatw5bDQRk7AaYvCRUUfHHbSvkCBb4T8zYdJ8JNw15rMSKk9hEkVdtEEZRJU4Q97C+3LbPknZrIMM+zmSRYmh2/LkGAlydSJ+sPe9i7zWFOLYeA3gitaKJSPgSjdb4WGgDq686Ei4yup9xYDbT8wAcosQsf3tfbqH2GetNJ8tAs3KjRi7FPhH1hHdXVyH0yW1mdGlMYvoFUeFCRjhE81oJhy2jMTJD9T3eQiJo4NZQZYOgALMQPi8fxaAgnuWmvrejNTn/PgRyGpQEs7HFHkX5zHW5M74PU/Z3S3Y2uSZlYrCQRf9Y2mUiK5R40bjsKz4TqIP5LfzhX
[ok]

The SSH public key is copied to the remote CDR server file /home/<user>/.ssh/authorized_keys.

For configuration details, refer to Accounting - CLI.