Administration

UCX Administration
  • System Tools, UCX Administration
System Tools – Backup/Restore

Backup

The UCX Backup procedures do not include InfinityOne related data (configuration or chat history, etc.) other than the phone settings for extensions assigned to InfinityOne users. This must be done through the InfinityOne administration interface. Refer to InfinityOne – Backup and Restore and ensure that you perform backups of InfinityOne on a regular basis.

System specific information like Network Parameters, Admin password, Time Settings, Security certificates and License are not backed up nor restored. Other configuration information that are not backed up and restored include: Remote SMTP and Fax Clients.

The following checks are performed prior to allowing the backup to proceed:

  1. Backups are disallowed when free space in the backup directory is less than 100 MB.
  2. Backups are disallowed when there is insufficient free space in the backup directory to create the required temporary files and the backup file.
  3. Backups to USB drive formatted to FAT32 are disallowed if the generated backup file size is over 2 GB.

To create a backup of your UCX system configuration data, perform the following steps:

  1. From the System tab, select System Tools
  2. From the left hand menu select Backup/Restore
  3. The Backup List page shows all the completed backups (if any)
  4. Press the New Backup button to proceed to the page that shows the backup options
    Rls70BackupRestoreMain.png
  5. Select the options that you want included in the backup. You can select items from the following categories:
    • Asterisk
    • Databases
    • Addons
    • GUI
    • Endpoint
    • Fax

    Rls70NewBackupOptions.png

    Before starting the backup operation, please review the amount of data listed for the Call Recordings and Voicemails options. If the size of call recordings and/or voicemails is in gigabytes, the backup operation is likely to take a long period of time (for large data sets even several hours). If the data size is very large, either exclude these options from the backup or make sure you can wait for the completion of the lengthy operation.

    Call Recordings and Voicemails options are automatically disabled if it uses more than 1.8 GB of space in the backup file.

  6. Press the Process button to start the backup operation
  7. Depending on the selected options, the backup operation can take certain amount of time. Wait for the backup operation to complete
  8. Once the backup is completed, press the Back button to return to the Backup List page
    Rls70NewBackupComplete.png
  9. The completed backup will be listed with the corresponding date and size
  10. The backup can be downloaded to your PC by clicking on the Backup Name link
    If the backup file size exceeds 500 MB, the download link is disabled. Backup files exceeding 500 MB can be downloaded using a SCP client (e.g. WinSCP). Backup files are located in the /var/www/backup directory on the UCX.
  11. To delete a backup file, select the checkbox beside the filename and press the Delete button.
USEFUL TIP

Backups can also be invoked from the UCX Command Line Interface (CLI). This requires logging into the UCX with an SSH connection via an application such as PuTTy and logging in with the Admin account credentials.
At the command line prompt, type ucxcli_backup. The backup will be performed and appear in the UCX Administration GUI as if it was an automated back up (i.e. no Voicemail or Call Recordings). The backup process will provide real-time feedback of the progress until it is complete and the command prompt will be displayed.

Restore

To restore your UCX system’s configuration data from a backup file, perform the following steps:

  1. From the System tab, select System Tools
  2. From the left hand menu, select Backup/Restore to show the Backup List page
  3. Locate the backup that you want to restore in the list of available backup files (use navigation controls at the top or bottom if the list exceeds a single page)
  4. Press the Restore button beside the selected backup file to start the restore operation
  5. Select the required restore options.  We recommend using the Select All Options check box to restore all configuration data.
  6. If the configuration data for a certain option does not exist in your backup (e.g. MDSE Configuration), the option will be automatically deselected and disabled.

SysToolsBackupRestore1stRestore.png

NOTE

Depending on the amount of data that is to be restored, the operation can take certain amount of time. Wait for the operation to complete. We recommend that you reboot your UCX system once the restore operation is completed.

IMPORTANT

Unless you want to restore only one or a few specific options that do not require other related options, we strongly recommend you to restore the entire backup to ensure consistency of configuration data after the restore! You can safely exclude the Call Recordings and/or Voicemails options.

If you do not have the license for an application, the data for that application will not be restored, even if it exists in the backup. For example, if you backed up MDSE data on a system with MDSE license, then tried to restore on another system without the license, the MDSE data will not be restored.

If you have data in your backup file for an optional package, when you restore the data, make sure the system has the same packages installed.

System specific information like Network Parameters, Admin password, Time Settings, Security certificates and License are not backed up nor restored. Other configuration information that are not backed up and restored include: Remote SMTP and Fax Clients.

Uploading a Backup File

You have the option of uploading a backup file from your own device (i.e. your PC or a locally attached USB drive) prior to starting the Restore process.

  1. From the System tab, select System Tools
  2. From the left hand menu, select Backup/Restore to show the Backup List page
  3. Click on the Upload button
    Rls70BackupRestoreMain.png
  4. Click on Choose File
    Rls70BackupUploadChooseFile.png
  5. The system will prompt with a standard operating system file selection dialog box to select the file you wish to upload
  6. Select the appropriate .tar file and click Open
  7. The UCX will show the chosen file in the Backup File to Upload field
  8. Click on Upload File
    Rls70BackupUploadChosen.png
  9. When the upload is complete the UCX will provide a Information message indicating the backup file has successfully uploaded
    Rls70BackupUploaded.png

FTP Transfer

You can move backup files from your UCX system to an FTP server (or vice versa) using a simple drag and drop approach.

To move backup files from your UCX system to an FTP server (or from an FTP server back to your UCX system), perform the following steps:

  1. From the System tab, select System Tools
  2. From the left hand menu, select Backup/Restore
  3. Press the FTP Transfer button
  4. On the right side, enter required information about the FTP server and user credentials
  5. Press the Save button to establish a connection with the FTP server
  6. After the connection with the FTP server is successfully established, drag files between the Local area (i.e., your UCX system) and the FTP Server area as desired. After moving each file, you should wait for the confirmation that the file was successfully transferred.
  7. Once finished, press the Back button to exit the FTP Transfer page

Rls70BackupFTPServer.png

IMPORTANT

If the FTP server software is not running on the system with the configured FTP Server IP address, pressing the FTP Transfer button may result in a very long time-out before the attempt to establish a connection with the FTP server is aborted. If your browser appears to be "frozen" after you pressed the FTP Transfer button, you must wait for approximately 1 minute for the page to be displayed.

Set Automatic Backup

You can schedule automatic periodic backups of your UCX system’s configuration.

Note that Voicemail and Call Recordings are excluded from automatic backups.

You can select one of the following periodic backup options:

  • Daily
  • Weekly
  • Monthly

When automatic backups are enabled, the backup process is started at 23:59 on the day that corresponds to the selected option:

  • Each day for the Daily option
  • Sunday for the Weekly option
  • 28th of the month for the Monthly option

To configure automatic backups of your UCX system configuration data, perform the following steps:

  1. From the System tab, select System Tools
  2. From the left hand menu, select Backup/Restore
  3. In the drop-down list box beside the Set Automatic Backup button, select the desired frequency of automatic backups (Disabled, Daily, Weekly or Monthly)
  4. Press the Set Automatic Backup button to save the configuration

Rls70SetAutoBackup1.png

Select Location

By default, the location for the backup file is set to Hard Drive. To change the backup file location to USB Drive, perform the following steps:

  1. Connect the physical USB drive to a USB port on your computer
  2. Create a directory (folder) labeled backup in the root directory.
    The USB drive MUST have a directory labeled ‘backup‘ on it.
  3. Remove the USB drive from your computer and connect it to a USB port on the UCX system
  4. Go to UCX Administration
  5. From the System tab, select System Tools
  6. From the left hand menu, select Backup/Restore
  7. In the drop-down list box beside the Select Location button, select the desired location (USB Drive or Hard Drive)
  8. Press the Select Location button to save the configuration

Rls70SelectBackupRestoreLocation.png

NOTE

The USB Drive option can be selected only when a USB drive with the required backup directory is connected to the UCX system. Once you remove the physical USB drive from the UCX system, the configuration will automatically revert back to Hard Drive.

Backups to USB drive formatted to FAT32 are disallowed if the generated backup file size exceeds 2 GB.

Supported File Systems

For the USB attached storage device (flash memory or an external hard drive), the following file systems are supported:
  1. Windows file systems
    • FAT32
    • NTFS
    • exFAT (beginning with UCX 7.0)
  2. Linux file systems
    • ext2
    • ext3
    • ext4

Note that USB drives are partitioned using either Master Boot Record (MBR) or GUID Partition Table (GPT) styles. If the UCX software does not recognize a USB drive properly formated using the file systems noted above, verify that the drive is partitioned using MBR. This can be done using the Windows Disk Management interface (or other methods).

  1. Insert the USB drive in a Windows laptop.
  2. Right-click the Windows Disk Management (diskmgmt.msc) console
  3. Right-click the disk in the console (not the partition) and select Properties, then navigate to the Volumes tab
  4. In the Disk Information section, verify that the Partition Style is identified as Master Boot Record (MBR)
  5. If it is GUID Partition Table (GPT) then it may be necessary to change the USB drive to one that is already formated using MBR or take steps to convert the USB drive to MBR style.

Contents