1. Web GUI User's Guide
  2. Configuration Assistant Operations

3 Configuration Assistant Operations

When you first log on to the Oracle® Enterprise Session Border Controller (ESBC), the system requires you to set the configuration parameters necessary for basic operation. To help you set the initial configuration with minimal effort, the ESBC provides the Configuration Assistant to lead you through the configuration process. The Configuration Assistant asks you questions based on a selectable template and uses your answers to set the necessary parameters. You can use the Configuration Assistant for the initial set up as well as for subsequent changes that you want to make to the basic configuration.

The ESBC provides many additional configurable features and functions that do not require configuration to get the system running initially. You can configure the additional features and functions through the Dashboard, Configuration, Monitor and Trace, Widgets, and System tabs on the Web GUI after running the Configuration Assistant. You can also edit any of the settings, including those for the initial configuration, through the Web GUI tabs without running the Configuration Assistant again. If you want to re-run the Configuration Assistant as an easier way to update the configuration than to navigate through the configuration object tree, click the Configuration Assistant button on the System tab in the Web GUI.

Topics

The Configuration Assistant Work Flow

The Oracle® Enterprise Session Border Controller (ESBC) Configuration Assistant guides you through the minimum number of steps necessary to make the software operational on the ESBC. Each step requires you to enter information or make a choice based on a configuration template that you choose before beginning the configuration work flow.

While the steps displayed in the work flow may vary from one template to another, the behavior and process for using the Configuration Assistant is consistent. Regardless of the template you choose, the Configuration Assistant informs you of any prerequisites that you need to address and allows you to review the configuration and make changes before you Activate the configuration. Go to https://www.oracle.com/technical-resources/documentation/acme-packet.html and see "Configuration Assistant Templates" to get detailed instructions for each template available.

Note:

After activating the configuration, you can access more configuration objects from the tabs on the Web GUI to customize your deployment.
The process for using the Configuration Assistant includes the following steps.

Acquire a Template to Use

You can get templates from the following sources:
  • Included in the software image.
  • Upload a configuration from another ESBC.
  • Download the latest Oracle Template Package from Oracle and save it to /code/configAssistantUploads. Use this method to get updated templates. Available as a compressed file (template-package.tar.gz), the download overwrites the existing templates and re-populates the Select a PBX Template and SIP Template lists.

Save the uploaded or downloaded template locally. You will select it in the Select a Deployment step.

Launch the Configuration Assistant

Caution:

Running the Configuration Assistant removes all of the configuration on the ESBC, including the High Availability (HA) configuration. You must reconfigure HA after running the Configuration Assistant.
Log on to the ESBC.
  • Unconfigured system—For Web GUI users, the system launches the Select Deployment page. For ACLI Users, run run configuration-assistant.
  • Configured system—For Web GUI users, go to the Settings tab and click Configuration Assistant to launch the Select Deployment page. For ACLI Users, run run configuration-assistant.

Select a Template or Configuration for Deployment

On the Select Deployment page, select a template by one of the following methods:
  • Select a template from the Select a PBX Template list and one from the Select a SIP Trunk Template list. Oracle populates the lists from the software image for the release, which may contain many templates.
  • Upload a configuration from another ESBC and drag-and-drop the configuration file into the Upload a Configuration field.
  • Download the latest Oracle Template Package from Oracle and drag-and-drop the package file into the Upload a Template Package field.

When you click Next, the Configuration Assistant displays the Notes page.

Review the Notes

The Notes page displays Warnings, Prerequisites, and Recommendations that you might need to address before proceeding.

When you click Next, the Configuration Assistant does the following:
  • With no prerequisites to address—The Configuration Assistant displays the first page of the configuration work flow.
  • With prerequisites to address—The Configuration Assistant displays the Let's Configure Prerequisites for SBC page.

Configure the Prerequisites

The template you select may require prerequisites to complete before performing the configuration. When the system detects prerequisites that you need to address, the Configuration Assistant displays the Let's Configure the Prerequisites for SBC page. The page displays Yes-No toggles for some prerequisites, for example to enable Transcoding, and text entry fields for others, for example Session Capacity. Click Apply to set the prerequisites. If any of the prerequisites requires a reboot, the system displays a confirmation message about the need to reboot. Click Confirm to proceed.

After the reboot the Configuration Assistant re-starts with the most recently selected template and allows you to proceed with the configuration, if all the prerequisites are satisfied. If not, the Configuration Assistant displays the Let's Configure the Prerequisites for SBC page again and the process repeats.

Note:

If you Cancel before the reboot, the Configuration Assistant closes. When you open the Configuration Assistant again, in either the current session or a new one, the system displays a reminder to reboot.

Perform the Configuration

The configuration work flow starts on a page named for the template you chose. For example: Configuration Assistant-Zoom Phone Network, as shown in the header of the following screen capture. Use the Back and Skip buttons to move to configuration pages you want to see. You can also click a page number to see that page.

This screen capture shows the breadcrumbs of a typical configuration work flow. Each of the numbers in a circle represents a configuration page. The darkened circle is the active page. The buttons shown at each end of the work flow are used to go backwards or to skip ahead.

The page displays numbers and titles across the top in a progression. Each number represents a configuration page. A typical work flow begins with configuring the PBX side followed by the SIP Trunk side. You must complete all of the pages for a new configuration, but you can use the Skip button to move ahead when revisiting an existing configuration. You can use the Back button in either a new or existing configuration.

Review the Configuration

After you complete last step of the Configuration Assistant, click Review to see the Summary page. From the Summary page, you can edit any of the preceding pages by clicking the Edit button displayed on each summary section.

Note:

You may need to scroll to see all of the sections.

If you chose CSR as the certificate provisioning type, the Configuration Assistant displays the Certificate Signing Request on the Review page. Copy or download the CSR and send it to the Certificate Authority.

From the Summary page, you can download and save the configuration you created. For example, you might want it for backup or to upload to another ESBC.

Apply the Configuration

When you are ready to Save and Activate the configuration, click Apply. The Configuration Assistant displays the Epilogue page, which may list actions you need to perform for the PBX side, the SIP Trunk side, or both sides before applying the configuration. After you resolve any outstanding PBX or SIP Trunk actions, click Confirm.
  • First-time configuration (new ESBC)—The Configuration Assistant displays the Apply Confirmation message. Click Reboot. The system applies the configuration and restarts.
  • Previous configuration—The Configuration Assistant displays the Apply Confirmation message. Click Reboot. The system erases the previous configuration, applies the new configuration, and restarts.

Address the Post-Configuration Tasks

If you chose CSR as the certificate provisioning type, import the certificate after the system restarts. Go to Security, certificate-record, and upload the certificate.

  • Downloaded CSR record—The name of the certificate-record must be the name of the downloaded file minus the .csr extension. For example, suppose the downloaded CSR file name is TeamsCSR.csr. The name to enter in the certificate-record configuration is TeamsCSR.
  • Copied CSR record—The CSR tab on the Summary Review page displays the CSR file name, for example, Teams CSR.csr. The name to enter in the certificate-record configuration is TeamsCSR.

Optional—If you want to customize your ESBC deployment, you can access more configuration objects from the tabs on the Web GUI. (Configuration, Monitor and Trace, Widgets, and System)