In this section:

 Use this section to upload application and license files to the SBC.

File Upload

The File Upload tool allows you to upload application files to SBC. These files must be available in your local drive for easy access and faster upload. You can upload the following file types:

File TypesFile ExtensionsDescription
SBC Application Files
  • .qcow2
  • .sha256
  • .signature
  • .tar.gz

Use the SBC Application files to upgrade or perform a fresh SBC installation.

Note: The SBC does not support EMA upload of .qcow2 files for an upgrade or installation.

SBC Configuration Files
  • .cli
  • .template

SBC configuration files

SBC Back-up Files.tar.gzBackup files that are uploaded to the SBC from an external source.
License Files.xmlList of SBC Licenses
Announcement Files.wavShort audio files to use when the SBC sends the 183 Session Progress in a SIP call
Certificate Files
  • .der
  • .p12
  • .pem
  • .pfx
  • Files with .der extension are digital certificate files created in the Distinguished Encoding Rules (DER) format. These files contains a binary representation of the certificate, and are commonly used for storing X.509v3 certificates in public key cryptography.
  • Files with .p12 and .pfx extension are files that bundle a private key with its X.509 certificate.


Note

The SBC allows you to upload only the allowed filed types, and also places restrictions on the file names. Such measures are implemented to secure the SBC from malicious file uploads. To know more about the allowed file types and file name restrictions, see the Restrictions on File Properties section.

Note

To know more about uploading announcement files, refer to System Administration - Manage Announcements. 

On the SBC main screen, go to Administration > System Administration > File Upload. The File Upload screen is displayed.

File Upload Screen

The File Upload screen consists of the following panes:

  • Upload Queue: This pane allows you to add files from your desired location and upload the same to SBC.
  • Files on SBC: This pane lists all the recently uploaded files to SBC with the size of each file.
  • Software Packages on SBC: This pane lists the currently installed/available SBC package along with the size of the package.

By default, only ten entries are displayed in all the panes. You can choose the number of files to view under the Show entries drop-down box.

To Add and Upload Files on the SBC

Note

While uploading large files, EMA may timeout. To prevent EMA from timing out before the file is uploaded, use one of the following ways:


To add files to the SBC, perform the following:

  1. Click Add Files to Queue.

    Adding Files to Queue Selection

    The File Upload window displays.

  2. Browse and select the file for packaging from your local system or remote server.

    Adding Files to Queue Screen

  3. Click Open to upload the selected file.
    The uploaded files are displayed in the Upload Queue list. The Upload Queue list displays the file name and size for each file that is queued for upload.

    File Upload Queue

  4. Click Upload All Files to upload the all files from the Upload Queue list to the SBC.

    Warning

    Do not close the screen or browser until the file upload is complete. Similarly, if you perform any other operations on the EMA, this will abort the file upload.

    Note

    To abort the uploading process, click the Delete icon against the file which you want to remove. The file uploading process stops. 

    File Upload Progress

    Note

    While uploading the file or package:

    • The file upload status is shown on the Upload Queue list. 
    • If there are any errors during an upload, the error message is also displayed on the Upload Queue list.


    Once the upload progress reaches 100%, the files gets listed in the Files on SBC pane and the packages get listed in Software Packages on SBC pane. The size of each file and the package is also displayed.

    File Upload Installed Package

     
    Note

    Proceed to any of the following pages based on your requirement:

    To Install SBC 5400/7000 Application: Installing SBC Application.

    To Upgrade SBC 5400/7000 Application: Upgrading SBC Application using EMA Platform Mode.

    To Install SBC 5400 Application: SBC 5400 - Installing Application.

Restrictions on File Properties

The File Upload window in the EMA navigation path Administration > System Administration > File Upload is enhanced to accept files with very specific properties. This enhancement removes the vulnerability of the SBC and the associated network against uploading and executing malicious files. Upload files with the following properties:

  • Files with the following extensions, provided they simultaneously satisfy the other criteria mentioned in this bullet list:
    • xml
    • wav
    • template
    • cli
    • pem
    • p12
    • signature
    • qcow2
    • sha256
    • tar.gz
    • der
  • The length of the filename is less than or equal to 100 characters.
  • The filename does not start with the "." (period) character.
  • The filename matches with certain accepted patterns, as defined in a regular expression implemented internally.


Note

Even if a malicious executable file is bundled in a tar.gz file with an acceptable file name/properties and is uploaded, the SBC does not executes such files due to mismatch in the sha256 checksum of the uploaded file and the corresponding genuine version. 

Note

Do not use multiple dots (".") in the filenames that you upload. The only dots allowed are the ones used for filename extension.

For example, sbc-1.2.3-package.tar.gz is not allowed, but sbc-1_2_3-package.tar.gz is allowed.

This rule applies only for files that you customize and upload to the SBC. However, this rule does not apply to the following files provided by Ribbon (filenames provided are only for illustration, and the actual filenames will vary based on the release version):

  • sbc-V09.02.00-R000.x86_64.sha256
  • sbc-V09.02.00-R000.x86_64.signature
  • sbc-V09.02.00-R000.x86_64.tar.gz
  • sbc-V09.02.00R000-connexip-os_05.00.00-R000_1_amd64.qcow2


Examples

Given below are some examples of allowed and disallowed attempts of file uploads:

  • File with one of the several acceptable extensions:

    Example - Allowed File Extension

  • File with an unacceptable extension:

    Example - Disallowed File Extension

  • Length of filename exceeds 100 characters:

    Example - Fiole Name Exceeding 100 Characters

  • Filename starts with ".":

    Example - File Name starts with "."

  • Filename does not match accepted pattern:

    Example: File Name does not Match Acceptable Regex Pattern

To Add and Upload SBC Application Back-up Files on the SBC

To add the Application Back-up files to SBC:

  1. Click Add Files to Queue. The File Upload window is displayed providing you an option to choose the desired file the external location.

  2. Select the back-up file and click Open to add the file to the queue. The selected file is visible in Upload Queue panel in the File Upload window.

    Caution

    All the back-up files should start with the naming convention:

    • config_<System_Name>_<File_Name>, and should end with .tar.gz

    or

    • auto_backup_config_<System_Name>_<File_Name>, and should end with .tar.gz

    For example, config_SBC001_BackupFile1.tar.gz or auto_backup_config_SBC001_BackupFile1.tar.gz.

  3. Click Upload All Files to upload all the files listed in the Upload Queue panel to SBC.

    Note

    The .tar.gz files gets uploaded to /var/log/sonus/evlog/config directory of the SBC.

  4. Navigate to Administration > System Administration > Backup/Restore. The recently upload back-up file(s) is listed at the top of the list in Last Backup panel.
  5. Click Yes for the "Backup The Current System?" question. The SBC gets restored to match the back-up file content.

To Delete Files from Upload Queue

To delete a file from the Upload Queue list, perform the following:

  1. In the Upload Queue list, click  option against the respective file. A delete confirmation dialog appears.

    Deleting File from File Upload Screen

  2. Click Delete to remove the entry from the Upload Queue pane.

    Note

    You can delete any entry in the Upload Queue pane before you click Upload All Files. 

To Delete Files from Files on SBC Pane

To delete a file from Files on SBC pane, perform the following:

  1. In the Files on SBC pane, click  option against the respective file. A delete confirmation dialog appears.

    Deleting File from File Upload Screen

  2. Click Delete to remove the entry from the Files on SBC pane.

To Delete Software Packages on SBC Pane

To delete a file from Software Packages on SBC pane, perform the following:

  1. In the Software Packages on SBC pane, click  option against the respective package. A delete confirmation dialog appears.

    Deleting File from File Upload Screen

  2. Click Delete to remove the package from the Software Packages on SBC pane.

    Once the SBC Software Package is removed, there is no way to retrieve the same. You have to re-upload the package.