1. Web GUI Guide
  2. System Tab Operations

5 System Tab Operations

The System tab on the Web GUI provides the following ways to manage files on the system:

  • File Management—Displays a list of file types and a set of controls to Refresh, Upload, Download, Backup, Restore, and Delete files.
  • Set Boot Parameters—Use the Web GUI to set boot parameters, instead of the ACLI command line.
  • Upgrade Software—Verify the health of the system software, for example, synchronization health, configuration version, and disk usage. Configure the upload method, browse to the software file to upload, and opt to automatically reboot the system after the upgrade.
  • Force HA Switchover—Manually place the system in the standby state.
  • Reboot—Manually reboot the system at any time.
  • Support information—Generate a file that displays troubleshooting information that you can save and send to Oracle Customer Support.

System File Management Types and Descriptions

You can manage Oracle® Enterprise Session Border Controller (E-SBC) system and configuration files from the Web GUI on the System tab under File Management.

The following table describes the system file types that you can manage.

File Type Format Description
Backup Configuration .gz Contains a backup of the E-SBC software configuration. You can apply this file to restore a previous configuration.
Configuration CSV .csv Contains Comma Separated Value configuration files that you can upload.
Local Route Table (LRT) .xml, .gz Contains the Local Routing Table (LRT) file that you can apply to theE-SBC. The LRT is an in-memory table that contains IP addresses that the local router recognizes. It calculates the destinations of messages it is responsible for forwarding.
Fraud Protection Table .gz, .gzip, .xml Contains fraud protection files that you can upload, download, delete, or open to modify.
Log Text

Contains Log files with information about the various aspects of the E-SBC. For example, information logged about the ACLI, SIP, or H323.

Note: Only the Download and Delete functions are applicable to log files on the E-SBC.

Audit Log Text Contains a list of files that log system events.
Playback Media Any media format valid in an RTP audio stream

Contains call progress playback files. The E-SBC can use these files in generated media streams.

Note: The media files are raw binary files that contain data for the codec that you want played in the media stream. The E-SBC plays the data on the first audio flow in the Session Description Protocol (SDP).

Software Image .gz, .bz Contains bootable images.
SPL Plug-in .lua Contains a Session Plug-in Language (SPL) file that you can apply to the E-SBC to incorporate additional functionality. The SPL file contains a programming language capable of performing various tasks by utilizing APIs and callbacks in the E-SBC.

The following table lists and describes the file management controls that display in the system file type dialogs, according to the supported behavior for the file type.

Control Description
Refresh Updates the screen to display the latest data.
Add (Fraud Protection files, only.) Adds a new Fraud Protection file.
Upload Uploads a file from your server or PC to the E-SBC. The LRT, SPL, and backup configuration upload process provides the option of dynamically applying these files to the E-SBC.
Download All (Log files, only.) Downloads all Log files from the E-SBC to your local server or PC (typically to the download directory on your system).
Backup Creates a file that contains a backup of the device software configuration. You can apply this file to restore a previous configuration.
Restore (Backup configuration files, only.) Restores and applies a Backup configuration file to the E-SBC.
Delete Deletes the file type from the E-SBC.
Delete All (Log files, only.) Deletes all Log files from the E-SBC.

Manage Files

You can manage system files from the Web GUI on the File Management page.

Note:

You can activate an LRT file or an SPL file dynamically during an upload. You can also immediately apply a backup configuration file during the upload process.
  1. Access File Management: System, File Management.
  2. On the System page, in the navigation pane, click File Management.
  3. Select a file to view from the list.
    The system displays the file.
  4. Use the controls on the tool bar to manage the file.

Upload a File

You can upload the following file types from your local server or PC to the Oracle® Enterprise Session Border Controller (E-SBC).

Note:

The Log and Audit Log files do not support uploading.
File Type File Format Directory
Backup Configuration .gz /code/bkups
Configuration CSV .csv
Local route table (LRT) .xml.gz /code/gzConfig
Fraud protection table .gz, .gzip, .xml /code/fpe
Playback media Any media format valid in an RTP audio stream /code/media
Software image .bz, .tar or no extension specified /code/images
SPL Plug-on (SPL) .lua, .spl /code/spl

The file extension must be applicable to the file type you select. For example, an SPL Plug-in file requires the .lua extension

You can dynamically activate the Local route table and SPL Plug-in during the upload process.

You can immediately restore a backup configuration file after an upload is complete.

Note:

You cannot upload log files.
  1. Access File Management: System, File management.
  2. On the File management page, select the type of file you want to upload.
  3. In the Name column, select the file you want to upload.
  4. Click Upload.
  5. In the Upload file dialog, do the following:
    1. Click Browse.
    2. Select the file that you want to upload.
    3. Optional. For the Backup configuration file, select Restore the configuration after upload to apply a previous backed up configuration file immediately to the after the upload is complete.
    4. Optional. For the Local route table file type, select Activate the LRT file after upload to apply the LRT upon upload.
    5. Optional. For a Fraud protection file, select Activate the file after upload to apply the file upon upload.
    6. Optional. For the SPL Plug-in file type, select Activate the SPL file after upload to apply the SPL file upon upload.
    7. Click Upload.

Download a File

Procedure and conditions for downloading from the Oracle® Enterprise Session Border Controller (E-SBC).

You can download any of the following file types from your local server or PC to the E-SBC:

  • Backup configuration
  • CSV file
  • Local route table (LRT)
  • Fraud protection table
  • Log
  • Playback media
  • Software image
  • SPL Plug-in (SPL)
  1. Access File Management: System, File management.
  2. On the File Management page, select the type of file you want to download from the File type list.
  3. Place your cursor on the row of the file that you want to download.

    Note:

    For Log file types, you can select multiple log files to download, or place a checkmark in the box to the left of the Name column heading to select all log files to download. When downloading multiple log files, the File Management GUI compresses the files into one .tar file and downloads that file to your local server or PC.
  4. Right-click the selected row, and click Download.
  5. Do one of the following:
    • Click Open with and select the application to open the file.
    • Click Save file to save the file to your local server or PC.
  6. Click OK.
    The system downloads the file to the folder on your local server or PC where your Browser sends all downloads (typically your “Download” folder) or opens (decompresses) the file type on your local server or PC (typically in the “Download” folder).

Delete a File

The following information describes the procedure and conditions for deleting a file from the Oracle® Enterprise Session Border Controller (E-SBC).

You can delete any of the following file types from your local server, PC, and the E-SBC:

  • Backup configuration Software image
  • CSV
  • Local route table (LRT)
  • Fraud protection table
  • Log
  • Playback media
  • Software image
  • SPL Plug-in (SPL)

Note:

You can only delete multiple files at the same time when the GUi displays the Delete All button. For example, on the log file page.
  1. Access File Management: System, File Management.
  2. From the File Management list, select the type of file that you want to delete.
  3. Put your cursor in the row of the file you want to delete, and right-click.
    Note: If the GUI does not display a menu upon right-click, use the Delete All control located above the list of files.
  4. Click Delete. The system displays following message.
    Are you sure you want to delete the file?
  5. Click Delete.

Back Up a Configuration File

You can back up a configuration file from the Oracle® Enterprise Session Border Controller (E-SBC) to your local server or PC. Back up allows you to save configurations that you can restore to the E-SBC at a later time.

  1. Access File Management: System, File Management.
  2. Select a file from the list in the table.
  3. Click Backup.
  4. Click OK.
    The system adds the file to the Backup Configuration table.

Restore a Configuration File

You can restore a backed up configuration file to the Oracle® Enterprise Session Border Controller (E-SBC).

  1. Access File Management: System, File Management.
  2. On the File Management page, select Backup Configuration.
  3. Select a back up, and right-click.

    Note:

    Restore activates only when you select a back up file.
  4. Click Restore.
    The GUI displays a confirmation dialog.
  5. Click Restore.
    The system downloads the back up file to the E-SBC. The E-SBC re-boots and restores the configuration from the back up file.

Force an HA Switch Over

You can manually initiate a High Availability (HA) switch over from the Web GUI to reverse the roles of the active and standby peers in an HA pair.

  • The Oracle® Enterprise Session Border Controller (E-SBC) from which you initiate the switch over must be in one of the following states: active, standby, or becoming standby.
  • A manual switch over to the active state is allowed on an E-SBC only in the standby or becoming standby state when it has achieved full media, signaling, and configuration synchronization.
  • A manual switch over to the active state is allowed on an E-SBC only in the standby or becoming standby state when it has a health score above the value that you configured for the threshold.

The following procedure forces the E-SBCs in an HA pair to trade roles. The active system becomes the standby, and the standby system becomes active.

  1. Access Force HA Switchover: System, Force HA switchover.
  2. On the Force HA switch over page, click Switch to standby.
    The system performs the role change.

System Reboot

You can manually reboot the Oracle® Enterprise Session Border Controller (E-SBC) from the Web GUI. If you have a High Availability (HA) deployment, connectivity to the standby E-SBC stops until the reboot completes.

When the reboot completes, the active and standby systems each display the log on screen and you must manually log on to each system.

Note:

When you reboot the system from the Web GUI, the Web GUI is unavailable until the reboot completes.
When you perform a reboot from the Web GUI The system behaves
and no boot is in process and the system is not switching over to the standby system of an HA pair, the GUI session closes and the system displays the Log On screen. You cannot log on to the Web GUI until the reboot completes on the E-SBC.
and a reboot is already in progress, the system displays a message stating that a reboot cannot occur. The first reboot must complete before another reboot is initiated.
and the active system is currently switching over to the standby system in an HA environment, the system displays a message stating that a reboot cannot occur because the HA switch over is underway. The standby E-SBC is updating and getting its configuration from the active E-SBC.

Obtain Support Information

You can manually generate a file by way of the Web GUI that contains troubleshooting information. You can save the file and send it to Oracle Customer Support.

  1. Access Support Information: System, Support Information.
  2. In the Confirm dialog, click Confirm.
    The system generates the file.
  3. The browser asks you to do one of the following:
    • Open the file—Select the browser and click OK, select the tool and click OK. The GUI displays the file.
    • Save the file—Click OK. The GUI saves the file.
  4. Click OK.
    The system downloads the file to the specified location.

Upgrade Software

You can upgrade the Oracle® Enterprise Session Border Controller (E-SBC) software from the System tab. The system requires a reboot after the upgrade.

  1. Access Upgrade Software: System, Upgrade Software.
  2. In the Upgrade Software dialog, click Verification, and do the following:
    • View the health score.
    • Click View Health Information, and confirm that the system components are synchronized.
    • Click View Configuration Version, and note the Current Version and Running Version.
    • Click View Disk Usage, and confirm that the system has enough free space.
  3. Select one of the following upload methods.
  4. Select a file to upload.
  5. (Optional) Select Reboot after upload.
  6. Click Complete.
    • If you did not select Reboot after upload, the system displays a message stating that a reboot is required for the changes to take effect.
    • If you selected Reboot after upload, the system displays a message stating that it is about to reboot.
  7. Click OK.
    If you selected Reboot after upload, the system reboots.