Backup support
The backup mechanisms and tools vary from vendor to vendor. This page details which systems UCentric supports auditing via backup for along with the supported backup formats and methods for each
New ‘backup’ methods are being added all the time. Please return to this page to find the latest information and compatability.
Alcatel/Lucent
There are two Alcatel systems we can audit OXE and OXO (OmniPCX Enterprise and Office), these systems may use the OXO Connect Management Console or OmniVista (4760 or 8770) tools to export data. The method used will depend on the tool the partner or customer has access to.
Alcatel OmniPCX Enterprise (OXE) - OmniVista
For Alcatel OmniPCX Enterprise using the OmniVista tool we support data extracted in CSV/Tab format as shown in the image below, this can collected using the export function in OmniVista. Please contact us for further assistance in collecting this.
Alcatel OmniPCX Office (OXO) - OMC/OXO Managment Console
For Alcatel OmniPCX Office using the OMC/OXO Managment Console tool please see guidance below for how to collect the data.
In OMC, expand the Import/Export option and select Import/Export Data
For each file shown in the Data Type dropdown, click File and provide the file with a name, then click Export
Collect each of the exported files in the root of a zip file, this can then be imported into UCentric via the Web Interface or the Zero-touch interface.
Asterisk/FreePBX (and derivatives)
First of all, obtain a backup through the web portal for the Asterisk/FreePBX by selecting the top menu, then click “Admin” and select “Backup & Restore”
Select “Add Backup”
Under “Add Backup” Give the backup a name and a description.
Under “Storage” click the drop-down menu and select the file storage location you can access (create one if none are shown)
Click “Submit” in the lower right corner of the page. Doing so will return you to the “Backup & Restore” page.
Running the backup
On the “Backup” tab of the “Backup & Restore” page click the “play” icon under the “Actions” heading.
You will be presented with a scrolling log of the backup in real time. Depending on the size and complexity of your PBX this may take some time.
When your backup is complete, a blue banner stating “Your backup has finished” will briefly appear. If you happen to miss this banner look for a line stating “Finished saving to selected filestore locations” in the log.
Select “Close” on the log display
Downloading the Backup
On the “Backup & Restore” page select the “Restore” tab and click the “Download” icon in the “Actions” field of the “Restore from local cache” block.
Cisco (& Broadworks)
CUCM
The Cisco CUCM decoder utilises the “BATS backup” capability of the CUCM. To obtain and import a BATS backup, follow these steps.
Login to the Cisco Unified Administration
Login into the “Cisco Unified CM Administration” portal from a Web Browser, note: Firefox is recommended for older Cisco CUCM’s due to HTML compatibility issues on other browsers.
Creating the backup
Select the “Export” function from “Bulk Administration” in the top menu
Enter a suitable name for the backup and press “Submit”
You should see the following message appear in the status panel
Check Scheduler
Go to the Scheduler to ensure that the backup job in progress
If the job says “Hold”, activate it by ticking the checkbox and clicking on “Activate Selected”
If the job appears to get stuck on “Pending”, us the “Cisco Unified Serviceability” interface and ensure that the AXL, BPS and TAPS services are all activated (Note: this requires Admin access)
When completed, the status will change
Downloading the backup
Select “Upload/Download” files in the “Bulk Administration” menu.
Enter the prefix you entered in 2.2 and click on “Find”
Select the backup and click on “Download Selected”
Finally, save the file on your local system to use as an import to UCentric Voice Audit.
Cisco backups performed from the standard web portal for the Cisco CUCM. This generates a .tar file.
CUCM CDR Data
If you want to capture actual usage of the CUCM, you can also capture the CDR data at the same time and UCentric will process this when combined with a BATS backup.
Login to the Cisco Unified Serviceability
Login into the “Cisco Unified Serviceability” portal from a Web Browser, note: Firefox is recommended for older Cisco CUCM’s due to HTML compatibility issues on other browsers.
Then select “CDR Analysis and Reporting” from the “Tools” menu.
This will open a new window, select “Export CDR/CMR” from the “CDR” menu
Select the date range (ideally more than 3 months) and click “Export to File”
This will then display the following:-
Right-click and save both files then click on “Close”
If you want this processed and added automatically to a Cisco Audit, ensure that you create a new .zip file, and include the Cisco CUCM backup (in it’s original .tar or .tar.gz format) and this export with any filename, providing it ends with .cdr.txt
Cisco Unity (Voicemail)
Use an account that has administrator access to the Cisco Web Interface and navigate to the Cisco Unity Connection Administration section.
On the lef-hand side tree view, locate Tools → Bulk Administration Tool
This page allows you to export the unity data, you need to select Export as your Operation. Selecting Users with Mailbox as your Object Type.
Once you have browsed and defined a filename, you can Submit to start the export process.
The CSV file that is generated can be included with a CUCM audit in order to identify users with voice mail requirements.
If you want this included automatically in a Cisco Audit, ensure that you create a new .zip file, and include the Cisco CUCM backup (in it’s original .tar or .tar.gz format) and this export with any filename, but with the suffix .unity.txt
To automatically include both CDR and Unity voice mail files in a single audit with a Cisco CUCM, create a new .zip file, and include all 3 files, ensuring that the the CUCM is in it’s original .tar (or .tar.gz) form, and that the CDR and Unity files are named as above.
The .zip file should containsomething like this:-
CiscoTestSystem2132132123.tar
MyUnityExport1231231.unity.txt
CDRData43243243243.cdr.txt
Cisco CME (Call Manager Express)
For call manager express you can use the CME GUI and select “Administration -> Save Router Config”
BroadWorks (Broadsoft)
Cisco Broadworks can be audited via two methods, these are:
Using a tool called EMU if the customer has access which can then produce a (Broadsoft) JSON backup.
A direct connection to BroadSoft using the OCI-P protocol. This relies on the customer providing the URL to the XSP server and a group admin and password for each account that requires auditing.
Avaya
Avaya CM/Aura
Avaya CM/Aura can be audited via an applet provided by MIT or via collecting exports from the Avaya System Administration tool (ASA) and importing them. Please contact in order to use the applet or follow below guidance for collection of Avaya exports from ASA.
Avaya ASA Export Guide
Install ASA v6 (or latest version) + service pack (if not already installed)
Create an empty folder on your Desktop with the name of the site (e.g. “MIT Test”)
Connect to your Avaya and select the “Advanced” panel on the left, then click on “Export Data”
Repeat this step for every form available, select the form from the list
Then click next then click the >> so that all fields are in the right-hand box
Then click Next and then click on the three dots next to the filename and select your folder on the desktop, leaving the filename as-is.
Then click Next, Next, Finish and repeat this for all forms in the list.
You can see the progress in the “Schedule” tab at the bottom of panel. Wait until all jobs are completed. Note: Errors will occur for unlicensed or missing options – Ignore this.
Select “Advanced” then “Report”
Repeating this step for this list of reports (Paste each of these into the selection box as not all are listed in the drop-down)
display system-parameters customer-options
list hunt-group
list call-forwarding
list registered-ip-stations
Select the report from the list and choose“Export screen capture to file”
Select the 3 dots next to the filename and use same folder as before
Once all files have been captured. Zip the folder up and this can then be used with the SPA/ZT tool.
Avaya - IP Office
Perform a backup as described here: https://pbxbook.com/ipoffice/iposcimp.html
Login to IP Office Manager
Click on File ➤ Import/Export ➤ Export...
Select the Check Box for All of the configuration, and click OK as shown below.
Avaya BCM
The Notel/Avaya BCM audit can be imported from either an Excel config file that looks like this:-
Microsoft Teams, Lync/Skype for Business
In order to perform an Audit of Microsoft Teams, you must have Administrator rights to both Teams and Office 365 as the audit is performed by using a PowerShell script.
Copy the UCentricTeams.ps1 script to a working folder, then open an Administrator PowerShell prompt at the same location
Type .\UCentricTeams.ps1 and press enter
When prompted, type R and press enter
If the script fails to run or warns about PSGallery being untrusted then you will need to run the following command:
Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted
Re-run the script from step 2.
Log into Teams with your Admin credentials
You may be asked to login a 2nd time for the Office 365 account if they differ
Once completed, you’ll see “Finished!” in the command window
There will be a zip file in the form “UCentric Teams yyyymmddhhmmss.zip” created in the folder. This is the file you drop onto UCentric SPA/ZT UCentric ZT/SPA - User Manual
Please contact support@mit-tech.co.uk for details on how to Audit Skype For Business / Lync
Mitel
Aastra MX-One
Aastra MX-One backups/exports should contain the most if not all of the files listed in the below table, some files may be empty or missing if the related config doesn’t exist on the PBX.
Files should be zipped up into a single file for processing in the the UCentric ZT or Web portal.
Description | Filename | Notes |
System details | ts_about |
|
Exchange details | exchange_info |
|
Media Gateways / LIMS | trsp_connection |
|
Board list | board_list |
|
DECT boards | dect_cfp |
|
Board versions | board_sw |
|
Speedials | ADCDP |
|
Personal Speedials | ADIDP |
|
Analog Extensions | EXDDP |
|
IP Extensions | ip_extension_info |
|
Key System Directory | KSDDP |
|
ISDN Directory | ITDAP |
|
Keys | KSFKP |
|
Extension list | extension |
|
Key System Categories | KSCAP |
|
Directory names | name1 | Main directory file |
Directory names | NIINP1 | Read in addition to name1 as different systems split directory files |
Directory names | NIINP2 | Read in addition to name1 as different systems split directory files |
Directory names | NIINP3 | Read in addition to name1 as different systems split directory files |
Directory names | NIINP4 | Read in addition to name1 as different systems split directory files |
Directory names | NIINP5 | Read in addition to name1 as different systems split directory files |
Directory names | NIINP6 | Read in addition to name1 as different systems split directory files |
Diversion (Call forward) | diversion |
|
Hunt Groups | GHDAP |
|
Pickup Groups | GPDAP |
|
Licenses | license |
|
Bridged Extensions | parallel_ringing |
|
Trunks | ROEDP |
|
Voicemail Pilot | VMGEP |
|
DECT Extensions | dect_extension |
|
MiCollab / MiCC
Backups are achieved through importing standard ‘backups’ downloaded through the MiVoice Connect, MiCollab and MiCC application web portals.
MiVoice Connect (Previously Shoretel)
You will need to be a MiVoice Connect System Administrator and have the credentials to login to the MiVoice Connect System
Procedure 1:
Login to the MiVoice Connect HQ server either directly or using Remote Desktop Connection
Navigate to "Drive:\Shoreline Data\Database\SnapShot"
Sort the view by "Date Modified" and take the "SnapShotMM-DD-YYYY XXXXXX.sql.gz" file that is most recent.
Alternatively:
Procedure 2: (Run Backup on Demand)
Navigate to C:\program files<x86>\ shoreline communications\ shoreware server\MySQL\MySQL server\Examples
Run the backup config.bat file. This will create a new “.sql” file under C folder
Get the “.sql” file for generating audit and migration reports
Mitel 3300 / Legacy MiVB
Backups are achieved through manually exporting the following forms manually, and exporting them from the Mitel Application portal to a CSV file (one for each section) – then zipping them up into a single file for processing
System Options System Capacity Users and Services Configuration Feature Access Codes System Speed Calls Personal Ring Groups Hunt Groups Ring Groups Pickup Groups Paging Groups Call Forwarding Profile DND | Default Account Codes Independent Account Codes System Account Codes Inward Dialling Modification Outward Dialling Modification Trunk Attributes ICP/PBX Network Elements IP/XNET Trunk Groups All IP Telephones Hardware Modules Hardware Compute Cards System IP Properties Network Elements | ACD Agents IDs ACD Agent Skill Groups ACD Express Groups ACD paths ACD Path interflow dialling lists ACD Remote Agent Subgroups Default CESID L2 to CESID CESID Assignment | ARS Call Progress Tone Detection ARS Digit Modification ARS Maximum Dialled Digits ARS Routes ARS Route Lists ARS Route Plans ARS Digits Dialled ARS Leading Digits ARS Node Identities Analog Trunks + Trunk Groups Digital Trunks DID Ranges for CPN Substitution |
Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:
Audit.exe Live MiVB2 -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.zip”
A full guide for this can be found here: Auditing a Mitel 3300 using CSV backups
Unify (& Siemens)
Siemens/Unify HiPath/HiCom
Siemens/Unify HiPath’s can be audited from what is called a “Regen” or “LastLoad” file. Both are .txt files and look something like this:-
Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:
Audit.exe Live HiPath -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.txt”
Unify OpenScape OSV
OSV can be imported from a ZIP file that contains .cfg and .csv files for the OSV configuration. It needs at a minimum:-
uc_users.csv UC Users
mediatrix.csv Mediatrix Servers
????_bgl_????.txt Main location devices
DLS-export.csv SIP + Keys
mlhg_??????.csv Hunt groups
export_all.txt Main configuration file
In addition the .cfg files for each gateway will enable UCentric to accurately audit the entire solution.
Then import the zip file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:
Audit.exe Live OSV -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.zip”
OpenScape Business (OSBiz)
OSBiz can be imported from a standard OSBiz XML input/export file.
It should appear in this form:
<?xml version="1.0" encoding="UTF-8"?> <osbiz> <general> <xml_file_version>1.0</xml_file_version> <system_type>OSBiz S</system_type> <system_mode>UC Suite</system_mode> <system_in_network>false</system_in_network> </general> <basic> <gateway> <customer_name>Test In House</customer_name> <contract_number/> <system_name>Test</system_name> <gateway_location/> <contact_address/> <system_country>United Kingdom</system_country> <brand>OpenScape Business</brand> <international_prefix>00</international_prefix> <national_prefix>0</national_prefix> <country_code>44</country_code> <local_area_code/> <pabx_number/> <node_id>0</node_id> <continuous_tone>true</continuous_tone> </gateway>
NEC NEAX
NEC NEAX systems can be imported from a Standard XLSX backup that has the following tabs:-
You can import the XLSX file into UCentric from within the site manager, Zero-Touch SPA
NEC/Philips Sopho/IS3000
IS3000/Sopho systems can be audited via a backup import with some additional pre-import steps. The backup file supported is usually a rar file that contains .POM files.
A .POM file viewer app must be used to carry out the steps below before importing the file into UCentric.
Extract the “.POM” files from an archive into their own folder.
Open the LLxxxx.POM file in the POM view program
Click “File”, “Report” and select “Full Report”, “Report in XML” and “all in one file (is3000.xml)”
NOTE: The iS3000.xml file will be created in the XML subdirectory of wherever your POM file is located.
Once you have the XML file, you can use the UCentric Zero Touch (SPA) interface or standard web interface to add a new site/import the file like any other audit.
Index
Version | Date | Comment |
---|---|---|
Current Version (v. 20) | Jul 01, 2024 16:29 | Paul McGuinness |
v. 44 | Nov 20, 2024 11:48 | Sean Millar |
v. 43 | Oct 16, 2024 17:05 | Sean Millar |
v. 42 | Oct 16, 2024 17:02 | Sean Millar |
v. 41 | Oct 09, 2024 14:35 | Sean Millar |
v. 40 | Sept 13, 2024 13:43 | Sean Millar |
v. 39 | Sept 13, 2024 13:41 | Sean Millar |
v. 38 | Sept 13, 2024 13:37 | Sean Millar |
v. 37 | Sept 12, 2024 21:38 | Sean Millar |
v. 36 | Sept 12, 2024 21:34 | Sean Millar |
v. 35 | Sept 12, 2024 21:17 | Sean Millar |
v. 34 | Sept 12, 2024 20:47 | Sean Millar |
v. 33 | Sept 12, 2024 20:43 | Sean Millar |
v. 32 | Sept 12, 2024 20:38 | Sean Millar |
v. 31 | Aug 28, 2024 17:54 | Sean Millar |
v. 30 | Aug 28, 2024 17:49 | Sean Millar |
v. 29 | Aug 28, 2024 17:46 | Sean Millar |
v. 28 | Aug 28, 2024 13:42 | Sean Millar |
v. 27 | Aug 28, 2024 13:41 | Sean Millar |
v. 26 | Aug 28, 2024 13:40 | Sean Millar |
v. 25 | Aug 22, 2024 15:12 | Liam McGuinness |
v. 24 | Aug 05, 2024 08:56 | Paul McGuinness |
v. 23 | Aug 01, 2024 13:53 | Liam McGuinness |
v. 22 | Aug 01, 2024 09:50 | Paul McGuinness |
v. 21 | Jul 31, 2024 11:33 | Liam McGuinness |
v. 20 | Jul 01, 2024 16:29 | Paul McGuinness |
v. 19 | Feb 15, 2024 17:14 | Sean Millar |
v. 18 | Dec 12, 2023 14:35 | Paul McGuinness |
v. 17 | Dec 05, 2023 18:08 | Sean Millar |
v. 16 | Nov 22, 2023 17:17 | Sean Millar |
v. 15 | Nov 22, 2023 17:16 | Sean Millar |
v. 14 | Oct 25, 2023 11:35 | Paul McGuinness |
v. 13 | Oct 25, 2023 11:25 | Paul McGuinness |
v. 12 | Sept 28, 2023 10:55 | Sean Millar |
v. 11 | Aug 23, 2023 11:26 | Paul McGuinness |
v. 10 | Aug 22, 2023 09:31 | Paul McGuinness |
v. 9 | Aug 07, 2023 16:21 | Sean Millar |
v. 8 | Jul 18, 2023 15:58 | Paul McGuinness |
v. 7 | Jan 27, 2023 14:44 | Sean Millar |
v. 6 | Jan 27, 2023 14:43 | Sean Millar |
v. 5 | Jan 13, 2023 17:35 | Sean Millar |
v. 4 | Oct 06, 2022 16:31 | Sean Millar |
v. 3 | Oct 06, 2022 13:59 | Sean Millar |
v. 2 | Oct 06, 2022 13:29 | Sean Millar |
v. 1 | Oct 06, 2022 10:26 | Sean Millar |