Cisco CDR Reporting & Analytics | Installation Notes

Cisco Unified Border Element (CUBE)

If you use CUBE in your environment, contact us about pulling its CDR and syslog data into our app today so you can troubleshoot issues beyond what’s purely in CallManager.

In the more specific case where your calls travel directly from CUBE to CUCM, the app will actually stitch the records together. the end result is almost as though the CUBE legs were just additional legs in the CallManager CDR
 

(One note on SFTP vs FTP: If your CUBE version is 14.6 or newer, you will be able to use SFTP (as specified below). If however you have an older CUBE version that’s OK — just contact us and we can walk you through the older FTP steps. )
 

Steps to configure the file accounting server

Log into the router with an account with administrative permissions. Then, run the below listed commands to set up gw-accounting to file, change the cdr-format to detailed”, configure the FTP server information, and tell the system to flush new data to file once per minute. 
 

In the below, adjust 10.0.0.1 to be the IP/​dns name of your ftp server and the sftpusername and sftppassword to be the username and password for the ftp user. The cube_​ that’s after the IP address in the example is quite important and should not be omitted. It is there to ensure that the filenames are prefixed with the word cube” so we can more easily identify them in the next step, creating the input.

enable
configure terminal
gw-accounting file
cdr-format detailed
primary sftp 10.0.0.1/cube_ username sftpusername password sftppassword
maximum cdrflush-timer 1
end

This configuration accepts many of the default settings for buffer sizes and the number of reattempts. If you have any troubles at this layer, or if you’d like to confirm those settings more thoroughly, please see Cisco’s documentation on configuring file accounting. 

Install the Sideview apps

You will need two extra apps but they are both quite small. 

  1. our TA_​cube” app, aka the Supporting Add-on for CUBE”, available on Splunkbase here.
  2. our SA_​cube” app, aka the Supporting App for CUBE”, also available on Splunkbase. Note this latter app is available under a time-limited trial license.

Why are there two? Basically it makes app installation and updates easier for Splunk admins. 

The TA must be deployed on your forwarder(s) if you intend to use the cube_​cdr” or cube_​cdr_​compact” sourcetypes. However note that the TA must also be deployed on your Splunk Indexers if you intend to use the cube_​syslog” sourcetype. Thus if you intend to ingest both CUBE CDR and Syslog events, you will need this TA in both places. I know we just said we were making life easier for Splunk admins, but packaging three apps would be lunacy.

The SA_​cube app is the simpler one — it goes on the Search Head tier. 

Last but not least if you are just running a single Standalone Splunk instance that’s fine — just install both apps on it and move on. 

Create a new Splunk input

We will now create a new batch” input for the CUBE CDR files, similar to the ones you created for CUCM CDR and CMR.

Important note: this input will be set up to delete the files from disk as they go into Splunk. If you need this to not happen, please see the notes at the end of this section.

All these steps happen in your FTP server’s Splunk Universal Forwarder’s configuration files:

1) Create the monitor input by adding this config to an inputs.conf file located at “$SPLUNK_​HOME/​etc/​apps/​TA_​cube/​local/inputs.conf”. This file should exist already, but if it does not, you may need to create the folder local” and the file itself. Make sure the user Splunk runs under has permissions to this file and folder.

If your Universal Forwarder is on Windows, the contents of your inputs.conf will look like this:

[batch://D:\path\to\files\cube_*]
index = cisco_cdr
sourcetype = cube_cdr
move_policy = sinkhole

If your Universal Forwarder is on Linux or Unix, the input will look like this:

[batch:///path/to/files/cube_*] 
index = cisco_cdr
sourcetype = cube_cdr 
move_policy = sinkhole 

It is critical that no mistakes be made here. Only the path (after batch://”) and possibly the index need editing. All else should be left exactly as it is. Use the examples as a reference to make sure you are using the right number and direction of slashes/​backslashes, too.

NOTE: As mentioned above, this is a sinkhole input, and it will delete each file matching the filename cube_​* as it indexes it. Any existing csv files that exist in this directory that start with cube_​will be indexed and deleted almost immediately, and any new files written to here will be indexed and deleted as they arrive. If you have other intentions for these files besides putting them in Splunk, please contact us, and we can help you come up with another solution.

NOTE ALSOIn older releases the configuration for CUBE was packaged inside the cisco_​cdr app and TA_​cisco_​cdr apps, and so if your colleagues deployed CUBE back then the data input may well be over in the TA_​cisco_​cdr app’s local directory.

Next Steps

Contact us to set up a Webex! We can help confirm everything is working properly and help you start using this data.

 

If you have any comments at all about the documentation, please send them to docs@​sideviewapps.​com.

Related

Installation Notes
Installation Notes

Have your cake and eat it too!  Trust Webex with your calls, but pull all the metadata into Sideview's app in Splunk, for ad-hoc investigation, charting and flexible dashboards.

Installation Notes
Installation Notes