Oracle® Enterprise Session Border Controller Web GUI User's Guide
Release S-Cz8.4.0 Enterprise Session Border Controller F30429-05 August 2021 Oracle Enterprise Session Border Controller Web GUI User's Guide, Release S-Cz8.4.0 Enterprise Session Border Controller
F30429-05
Copyright © 2020, 2020, Oracle and/or its affiliates.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle. Contents
About This Guide My Oracle Support viii
Revision History
1 Before You Begin Browser Support 1-1 Internet Protocol Version Support 1-1 Basic Mode Support and Behavior 1-1 RADIUS Server Roles and Access Privileges 1-2
2 Enable the Web GUI for Access Access the Web GUI with HTTPS 2-1 Enable the Web GUI for a New Installation 2-1 Enable the Web GUI for an Existing Installation 2-3 Set Up High Availability 2-3 Simultaneous Logons 2-5 Log On to the Web GUI 2-6 Change the Sign In Password 2-7 Log Off from the Web GUI 2-7
3 Configuration Assistant Operations The Configuration Assistant Work Flow 3-1
4 Dashboard Tab Operations Web GUI Tabs Displays and Operations 4-1 Configuration Search Tool 4-2 Dashboard Controls and Operations 4-3
iii Widget Controls 4-5 About the Add Widgets Page 4-6 Add a Dashboard Widget 4-8 Configure the Data Sampling Settings for a Dashboard Widget 4-9 View A Widget That is Not on the Dashboard 4-9
5 Configuration Tab Operations The Configuration Tab Display 5-1 Configuration Tab Controls 5-2 View the Configuration 5-3 Show or Hide Advanced Configuration Objects in the Navigation Pane 5-4 Configuration Dialogs Behavior 5-6 Controls for Managing Multi-instance Configurations 5-9 Controls for Managing Configuration Lists 5-9 Controls for Sorting Table Rows 5-10 Controls for Showing and Hiding Column Headers 5-11 Configuration Error Messages 5-12 Configuration States and Behavior 5-13 Media Manager Configuration 5-13 Security Configuration 5-14 Session Router Configuration 5-16 System Configuration 5-19
6 Monitor and Trace Tab Operations Monitor and Trace 6-1 SIP Monitor and Trace for Ingress and Egress Messages 6-3 SIP Sessions Summary 6-3 SIP Registrations Summary 6-4 SIP Subscriptions Summary 6-5 SIP Notable Events Summary 6-7 Ladder Diagrams and Display Controls 6-8 Display a Ladder Diagram 6-11 SIPREC Call Data Example 6-15 Hairpin Call Data Example 6-15 Configure SIP Monitoring 6-16 Search for a Report Record 6-17 Export Monitor and Trace Information to a Text File 6-19 Export Report Information to a Text File 6-20
iv 7 Widgets Tab Operations Widgets Access and Behavior 7-1 Media Widgets and Descriptions 7-3 Signaling Widgets and Descriptions 7-4 System Widgets and Descriptions 7-6 Licenses Widget 7-10
8 System Tab Operations Configuration Assistant Operations 8-1 System File Management Types and Descriptions 8-1 Buttons and Controls on File Management Pages 8-10 System Operations Configuration 8-11 Force an HA Switch Over 8-12 System Restart 8-12 Obtain Support Information - Chrome Browser 8-13 Obtain Support Information - Firefox Browser 8-13
A Keyboard Commands and Shortcuts for the E-SBC Web GUI
v About This Guide
About This Guide
The Web GUI Guide provides information about using the Oracle® Enterprise Session Border Controller (E-SBC) from the Web GUI. The Web GUI Guide does not provide configuration instructions or descriptions of the configuration parameters. Use the ACLI Configuration Guide to get the configuration instructions and parameter descriptions.
Note:
The Web GUI displays the E-SBC configuration objects in the same tree-like structure as the ACLI command line. To get instructions for configuring objects by way of the Web GUI, locate the procedure in the ACLI Configuration Guide. In the procedure, transpose the path given for reaching the object from the command line onto the Web GUI to reach the configuration dialog on the Web GUI. Other than the path, the configuration parameters, defaults, and valid values are the same.
Documentation Set The following table describes the documentation set for this release.
ACLI Configuration Contains conceptual and procedural information for Guide configuring, administering, and troubleshooting the E-SBC.
ACLI Reference Guide Contains explanations of how to use the ACLI, as an alphabetical listings and descriptions of all ACLI commands and configuration parameters.
Administrative Security Contains conceptual and procedural information for Guide supporting the Admin Security, Admin Security with ACP, and JITC feature sets on the E-SBC.
Call Traffic Monitoring Contains conceptual and procedural information for Guide configuration using the tools and protocols required to manage call traffic on the E-SBC.
FIPS Compliance Contains conceptual and procedural information about FIPS Guide compliance on the E-SBC.
HMR Guide Contains conceptual and procedural information for header manipulation. Includes rules, use cases, configuration, import, export, and examples.
Installation and Contains conceptual and procedural information for system Platform Preparation provisioning, software installations, and upgrades. Guide
vi About This Guide
Release Notes Contains information about this release, including platform support, new features, caveats, known issues, and limitations.
SBC Family Security Contains information about security considerations and best Guide practices from a network and application security perspective for the Oracle Communications Session Delivery Product family of products.
Time Division Contains the concepts and procedures necessary for Multiplexing Guide installing, configuring, and administering Time Division Multiplexing (TDM) on the Acme Packet 1100 and the Acme Packet 3900.
Web GUI User Guide Contains conceptual and procedural information for using the tools and features of the E-SBC Web GUI.
Related Documentation The following list describes related documentation for the Oracle® Enterprise Session Border Controller. You can find the listed documents on http://docs.oracle.com/en/industries/ communications/ in the "Session Border Controller Documentation" and "Acme Packet" sections.
Document Name Document Description Acme Packet 3900 Hardware Installation Contains information about the components and Guide installation of the Acme Packet 3900. Acme Packet 4600 Hardware Installation Contains information about the components and Guide installation of the Acme Packet 4600. Acme Packet 6100 Hardware Installation Contains information about the components and Guide installation of the Acme Packet 6100. Acme Packet 6300 Hardware Installation Contains information about the components and Guide installation of the Acme Packet 6300. Acme Packet 6350 Hardware Installation Contains information about the components and Guide installation of the Acme Packet 6350. Release Notes Contains information about the current documentation set release, including new features and management changes. ACLI Configuration Guide Contains information about the administration and software configuration of the Service Provider Session Border Controller (SBC). ACLI Reference Guide Contains explanations of how to use the ACLI, as an alphabetical listings and descriptions of all ACLI commands and configuration parameters. Maintenance and Troubleshooting Guide Contains information about SBC logs, performance announcements, system management, inventory management, upgrades, working with configurations, and managing backups and archives.
vii About This Guide
Document Name Document Description MIB Reference Guide Contains information about Management Information Base (MIBs), Oracle Communication©s enterprise MIBs, general trap information, including specific details about standard traps and enterprise traps, Simple Network Management Protocol (SNMP) GET query information (including standard and enterprise SNMP GET query names, object identifier names and numbers, and descriptions), examples of scalar and table objects. Accounting Guide Contains information about the SBC's accounting support, including details about RADIUS and Diameter accounting. HDR Resource Guide Contains information about the SBC's Historical Data Recording (HDR) feature. This guide includes HDR configuration and system-wide statistical information. Administrative Security Essentials Contains information about the SBC's support for its Administrative Security license. SBC Family Security Guide Contains information about security considerations and best practices from a network and application security perspective for the SBC family of products. Installation and Platform Preparation Guide Contains information about upgrading system images and any pre-boot system provisioning. Call Traffic Monitoring Guide Contains information about traffic monitoring and packet traces as collected on the system. This guide also includes WebGUI configuration used for the SIP Monitor and Trace application. FIPS Compliance Guide Contains conceptual and procedural information for configuration using the tools and protocols required to manage call traffic on the SBC. HMR Resource Guide Contains information about configuring and using Header Manipulation Rules to manage service traffic. TSCF SDK Guide Contains information about the client-side SDK that facilitates the creation of secure tunnels between a client application and the TSCF of the SBC. REST API Guide Contains information about the supported REST APIs and how to use the REST API interface.
Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup? ctx=acc&id=docacc. My Oracle Support
My Oracle Support (https://support.oracle.com) is your initial point of contact for all product support and training needs. A representative at Customer Access Support (CAS) can assist you with My Oracle Support registration. Call the CAS main number at 1-800-223-1711 (toll-free in the US), or call the Oracle Support hotline for your local country from the list at http://www.oracle.com/us/support/ contact/index.html. When calling, make the selections in the sequence shown below on the Support telephone menu:
viii About This Guide
1. Select 2 for New Service Request. 2. Select 3 for Hardware, Networking, and Solaris Operating System Support. 3. Select one of the following options: • For technical issues such as creating a new Service Request (SR), select 1. • For non-technical issues such as registration or assistance with My Oracle Support, select 2.
You are connected to a live agent who can assist you with My Oracle Support registration and opening a support ticket. My Oracle Support is available 24 hours a day, 7 days a week, 365 days a year.
Emergency Response In the event of a critical service situation, emergency response is offered by the Customer Access Support (CAS) main number at 1-800-223-1711 (toll-free in the US), or call the Oracle Support hotline for your local country from the list at http://www.oracle.com/us/support/ contact/index.html. The emergency response provides immediate coverage, automatic escalation, and other features to ensure that the critical situation is resolved as rapidly as possible. A critical situation is defined as a problem with the installed equipment that severely affects service, traffic, or maintenance capabilities, and requires immediate corrective action. Critical situations affect service and/or system operation resulting in one or several of these situations: • A total system failure that results in loss of all transaction processing capability • Significant reduction in system capacity or traffic handling capability • Loss of the system's ability to perform automatic system reconfiguration • Inability to restart a processor or the system • Corruption of system databases that requires service affecting corrective actions • Loss of access for maintenance or recovery operations • Loss of the system ability to provide any required critical or major trouble notification Any other problem severely affecting service, capacity/traffic, billing, and maintenance capabilities may be defined as critical by prior discussion and agreement with Oracle.
Locate Product Documentation on the Oracle Help Center Site Oracle Communications customer documentation is available on the web at the Oracle Help Center (OHC) site, http://docs.oracle.com. You do not have to register to access these documents. Viewing these files requires Adobe Acrobat Reader, which can be downloaded at http://www.adobe.com. 1. Access the Oracle Help Center site at http://docs.oracle.com. 2. Click Industries. 3. Under the Oracle Communications sub-header, click the Oracle Communications documentation link. The Communications Documentation page appears. Most products covered by these documentation sets appear under the headings "Network Session Delivery and Control Infrastructure" or "Platforms."
ix About This Guide
4. Click on your Product and then Release Number. A list of the entire documentation set for the selected product and release appears. 5. To download a file to your location, right-click the PDF link, select Save target as (or similar command based on your browser), and save to a local folder.
Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.
x Revision History
The following table shows the dates and descriptions of revisions to the S-Cz8.4.0 Web GUI Guide.
Date Description June 2020 · Initial release September 2020 · Adds enhancements to Web GUI operations. See the Release Notes and the Web GUI User Guide. April 2021 · Adds information about the extensive updates to the look, behavior, and features of the Web GUI.
Note:
This version of the Web GUI User Guide may be less helpful to users of releases S-Cz8.4.0p4 and earlier, due to the changes to the Web GUI.
August 2021 · Updates the "Configuration Assistant Operations" chapter to reflect changes in the Configuration Assistant work flow for SC- z8.4.0p7.
xi 1 Before You Begin
Oracle recommends that you review the following information before using the software.
Note:
This version of the Web GUI User Guide may be less helpful to users of releases S- Cz8.4.0p4 and earlier, due to the many changes to the Web GUI that take effect with the S-Cz8.4.0p5 release.
• Browser Support • Internet Protocol Version Support • Basic Mode Support and Behavior • RADIUS Server Roles and Access Privileges Browser Support
Oracle recommends that you use the latest versions of Google Chrome and Mozilla Firefox, as of the date of this release, for the best user experience. Oracle does not support Internet Explorer 11.
Note:
After upgrading the software, clear the browser cache before using the Web GUI.
Internet Protocol Version Support
The Web GUI supports only IPv4. Basic Mode Support and Behavior
As of the S-Cz8.4.0 release, the Oracle® Enterprise Session Border Controller (E-SBC) no longer supports the Web GUI in Basic Mode. The Web GUI supports only one mode, which is the equivalent of the former Expert mode. If you have a Basic Mode configuration, the system will migrate and preserve your Basic Mode configuration during the upgrade to S-Cz8.4.0.
1-1 Chapter 1 RADIUS Server Roles and Access Privileges
If your E-SBC is in Basic Mode when you log on the first time after you upgrade, the system displays the following message and asks you to confirm.
The Session Border Controller no longer supports the Web GUI in Basic Mode. Click confirm to continue using the Web GUI. Your configuration will be preserved.
Caution:
If you do not confirm, you can no longer use the Web GUI with the S-Cz8.4.0 release.
RADIUS Server Roles and Access Privileges
The Web GUI supports RADIUS authentication functionality similar to a user signing on by way of Secure Shell (SSH) and SSH File Transfer Protocol (SFTP). Available functions depend on the role that you assign to the "userclass" on the RADIUS server. • When you configure the RADIUS server as userclass=admin, the system allows the Administrator full access to all features and functions after logging onto the GUI. • When you configure the RADIUS server as userclass=user, the system limits User access to the following features and functions after signing on to the GUI. – Full access to all System features and functions – Can download the following files in System File Management: * Backup Configuration * Configuration CSV * Local Subscriber Table * Log * Audit Log * Playback Media * Software image * SPL Plug-in (SPL)
Note:
The "User" account cannot upload files in System File Management.
For more information about RADIUS support, see the Administrative Security Guide.
1-2 2 Enable the Web GUI for Access
You must enable access to the Web GUI from the Web server before you can log on and the steps vary depending on whether you want to enable a new Oracle® Enterprise Session Border Controller (E-SBC) or an existing one. To provide secure access, you can enable HTTPS. • Access the Web GUI with HTTPS • Enable the Web GUI for a New Installation • Enable the Web GUI for an Existing Installation • Set Up High Availability • Log On to the Web GUI • Log Off from the Web GUI Access the Web GUI with HTTPS
To provide secure access to the Web GUI from the Web server, you can enable HTTPS by creating a Transport Layer Security (TLS) profile. The Oracle® Enterprise Session Border Controller (E-SBC) does not require either the hardware Security Service Module (SSM) or the software TLS license when configuring certificate record, tls-profile, and tls-global for an HTTPS connection to the Web GUI from the Web server. Note that the E-SBC requires the TLS license when you configure SIP for TLS.
Note:
Virtual machines require the software TLS license.
Enable the Web GUI for a New Installation
To enable the Web GUI on a new Oracle® Enterprise Session Border Controller (E-SBC) installation, use the run setup command from the ACLI command line. After you save and activate the configuration, you can sign on to the Web GUI. Prerequisites • Install the hardware and connect to the E-SBC. See "Getting Started" in the ACLI Configuration Guide" For new installations, use the following procedure to run the Installation Wizard to configure the primary E-SBC and enable the Web GUI. To set up another E-SBC as the secondary peer in a High Availability pair, see Set Up High Availability.
2-1 Chapter 2 Enable the Web GUI for a New Installation
Note:
For existing installations, see Enable the Web GUI for an Existing Installation.
1. In Superuser mode, type run setup, and press Enter. The system displays the following:
------Thank you for purchasing the Oracle Enterprise Session Border Controller. The following short wizard will guide you through the initial setup. A restart will be required to save changes. ------©?© = Help; ©.© = Clear; ©q© = Exit CONFIGURATION WARNING: Proceeding with wizard will result in existing configuration being erased. Erase config and proceed (yes/no) [no] : yes Configuration will be backed up as bkup_setup_wizard_
2. For "Erase config and proceed", type yes, and press Enter. The system displays the following:
GUI ACCESS If you want to the allow GUI to access this SBC, enable this setting. Enable Web GUI with HTTP Connection (yes/no) [yes] :
3. For "Enable Web GUI with HTTP Connection", type yes, and press Enter. The system displays the following:
HIGH AVAILABILITY This SBC may be a standalone or part of a highly available redundant pair. SBC mode 1 - standalone 2 - high availability Enter choice [
4. For "SBC mode", type 1 for a standalone installation or type 2 for a High Availability installation. The system displays the following:
SBC SETTINGS Unique target name of this SBC : IP address on management interface : Subnet mask : Management interface VLAN (0 - 4095) [0] : Gateway IP address :
2-2 Chapter 2 Enable the Web GUI for an Existing Installation
5. Set the values for the E-SBC parameters according to your deployment, and press Enter. The system displays the following:
OC SDM ACCESS SETTINGS Configure the SBC to allow the OC Session Delivery Manager to access it OC SDM access (yes/no) [yes] : no
6. Set access permission to either allow (yes) or prohibit (no) the Oracle Communications Session Delivery Manager to access the SBC, and press Enter. 7. Save and activate the configuration. Enable the Web GUI for an Existing Installation
To enable the Web GUI on an existing Oracle® Enterprise Session Border Controller (E-SBC) installation, use the ACLI command line to set the name of the HTTP server. After you save and activate the configuration, you can sign on to the Web GUI. The following procedure requires Administrator credentials.
Note:
For new installations, see Enable the Web GUI for a New Installation .
1. Go to configure terminal, system, http-server.
# conf t # system # http-server
2. In http-server configuration, in the name parameter, type the name of your HTTP server. 3. Save and activate the configuration. Set Up High Availability
To minimize downtime and service interruptions, you can pair Oracle® Enterprise Session Border Controllers (E-SBCs) for redundancy to provide High Availability (HA). Before you begin, configure a primary E-SBC. Use the following procedure to configure a secondary E-SBC to form an HA pair with a primary E-SBC. 1. In Superuser mode, type run setup, and press Enter. The system displays the following:
------Thank you for purchasing the Oracle Enterprise Session Border Controller. The following short wizard will guide you through the initial set-up. A restart will be required to save changes. ------©?© = Help; ©.© = Clear; ©q© = Exit
2-3 Chapter 2 Set Up High Availability
CONFIGURATION WARNING: Proceeding with wizard will result in existing configuration being erased. Erase config and proceed (yes/no) [no] : yes Configuration will be backed up as bkup_setup_wizard_
2. For "Erase config and proceed", type yes, and press Enter. The system displays the following:
GUI ACCESS If you want to the allow GUI to access this SBC, enable this setting. Enable Web GUI with HTTP Connection (yes/no) [yes] :
3. For "Enable Web GUI with HTTP Connection", type yes, and press Enter. The system displays the following:
HIGH AVAILABILITY This SBC may be a standalone or part of a highly available redundant pair. SBC mode 1 - standalone 2 - high availability Enter choice [
4. For "SBC mode", type 2 for a High Availability installation, and press Enter. The system displays the following:
SBC SETTINGS Unique target name of this SBC [
5. Type the necessary E-SBC settings, and press Enter. The system displays the following:
PEER CONFIGURATION Peer IP address [
2-4 Chapter 2 Simultaneous Logons
Peer target name [
6. Type the IP address and target name of the peer and, press Enter. The system displays the following:
OC SDM ACCESS SETTINGS Configure the SBC to allow the OC Session Delivery Manager to access it. OC SDM access (yes/no) [yes] : no
7. Set access permission to either allow (yes) or prohibit (no) the Oracle Communications Session Delivery Manager to access the SBC, and press Enter. 8. Save and activate the configuration. Simultaneous Logons
The Web GUI allows the User and Administrator to log on simultaneously. Session availability to the User and Admin depends on which type of user is logged on to the session. The following illustrations depict and explain the system behavior when a User and an Administrator log on to a Web GUI session.
Note:
In the illustration where Admin A logged in first, the behavior is as described. If Admin B logs in first, then the system shows the lock message to Admin A. The first Admin to log in acquires the lock.
Up to five users can log onto the same session at the same IP address at the same time. Only one Administrator at a time can have full control of a simultaneous session.
2-5 Chapter 2 Log On to the Web GUI
Log On to the Web GUI
You can log on to the Oracle® Enterprise Session Border Controller (E-SBC) as a User or an as Administrator, depending on your permissions. You need your User name, Password, and optionally your Passcode to log on. The system requires your passcode when two factor authentication is enabled. If your system Administrator configured the optional log on page message, the system displays the message after you enter your log on credentials. After reading the message, click Close, and the system displays the GUI. The first time you log on, the GUI displays the Configuration Assistant.
1. On a PC, open a supported Internet browser. See "Browser Support" in your software version's Release Notes for the list of supported browsers. 2. Start the GUI with either the HTTP or HTTPS log on.
http://
Note:
Whether you log on using HTTP or HTTPS depends on the settings for your deployment.
3. In the Sign In dialog, enter your E-SBC credentials.
4. If your E-SBC requires two-factor authentication, do the following: a. In the log on dialog, enter your passcode. b. In the Confirm dialog, acknowledge the Last Login information. Yes—allows you to login. No—ends the session. 5. Click log on.
2-6 Chapter 2 Log Off from the Web GUI
Note:
If you want to open another Web GUI tab on the same E-SBC in a new tab in the same browser, you can do so without logging on again.
Next Steps • See Configuration Assistant Operations. Change the Sign In Password
Use the Oracle® Enterprise Session Border Controller ACLI to change a User or Administrator sign in password. Use the secret command from the ACLI to change the sign in password for a User and the config password command for an Administrator. For more information about setting passwords, see the Oracle Enterprise Session Border Controller ACLI Configuration Guide. Log Off from the Web GUI
To log off from the Web GUI, click Log Out from the User menu and confirm. 1. On the User menu located in the upper right corner of the Web GUI, click Log Out.
2. In the Confirm dialog, click Yes.
2-7 3 Configuration Assistant Operations
When you first log on to the Oracle® Enterprise Session Border Controller (E-SBC), the system requires you to set the configuration parameters necessary for basic operation. To help you set the initial configuration with minimal effort, the E-SBC 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 E-SBC 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 Configuration Assistant Work Flow
The Oracle® Enterprise Session Border Controller (E-SBC) Configuration Assistant guides you through the minimum number of steps necessary to make the software operational on the E-SBC. 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 Get templates come from the following sources:
3-1 Chapter 3 The Configuration Assistant Work Flow
• Included in the software image. • Upload a configuration from another E-SBC. • 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 Log on to the E-SBC. • Unconfigured system—The system launches the Select Deployment page. • Configured system—Go to the Settings tab and click Configuration Assistant to launch the Select Deployment page.
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 E-SBC 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
3-2 Chapter 3 The Configuration Assistant Work Flow 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.
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 E-SBC.
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 E-SBC)—The Configuration Assistant displays the Apply Confirmation message. Click Reboot. The system applies the configuration and restarts.
3-3 Chapter 3 The Configuration Assistant Work Flow
• 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 E-SBC deployment, you can access more configuration objects from the tabs on the Web GUI. (Configuration, Monitor and Trace, Widgets, and System)
3-4 4 Dashboard Tab Operations
The Oracle® Enterprise Session Border Controller (E-SBC) provides a web-based Dashboard that can display application and system data in Widgets to help you monitor and manage the system. You can add and remove Widgets from the Dashboard, specify their data sampling settings, and export the data.
Topics: • Web GUI Tabs Displays and Operations • Dashboard Controls and Operations • About the Add Widgets Page • View A Widget That is Not on the Dashboard Web GUI Tabs Displays and Operations
The Web GUI displays tabs that you click to display information and perform tasks, such as configuring, managing, and monitoring the system. Each tab displays a unique set of tools to control its operations. The following information describes the operations and tool sets for each tab.
Dashboard Tab The Dashboard tab displays SIP statistics and other information about your Oracle® Enterprise Session Border Controller (E-SBC) through Widgets that display graphs, charts, and tables. The E-SBC provides dozens of Widgets to choose from and the Dashboard can display up to eighteen widgets at a time. You can add and remove the Widgets, as needed. The Dashboard is the default landing page. See Dashboard Controls and Operations
Configuration Tab The Configuration tab displays the Wizards and Commands controls along with lists of configuration objects, grouped in the same tree-like structure as found in the Acme Command Line Interface (ACLI). See Configuration Tab Operations
Monitor and Trace Tab The Monitor and Trace tab displays the call ladders and session details of SIP signaling calls and information about system activities by way of summary reports of filtered SIP data. You can export the ladder diagrams, session details, and summaries from the Monitor and Trace tab. See Monitor and Trace Tab Operations
4-1 Chapter 4 Web GUI Tabs Displays and Operations
Widgets Tab The Widgets tab displays graphical views of System, Media, and Signaling data about the Oracle® Enterprise Session Border Controller. Each Widget corresponds to an ACLI show command. On the Widgets tab, you can click links to the Widgets for viewing and you can add Widgets to the Dashboard and your Favorites list. Widget Tab Operations
System Tab The System tab displays system objects and controls for managing, booting, configuring, and upgrading the system. See System Tab Operations. Configuration Search Tool
The Configuration tab provides two levels of search operations. You can use the Search tool on the Configuration tab to search for configuration objects. Within a multi- instance configuration object, you can use Search to find a specific configuration instance on the list. The Search tool, displayed as a magnifying glass, on the Configuration page header opens the Search text box where you enter the text to search for, such as a configuration object name, an attribute, or value. You can enter the full name of a configuration object to find a specific object or you can enter a phrase to see a list of all objects that contain that phrase. For example, you can enter enable-snmp-auth- traps to find that object or you can enter SNMP to see a list of all configuration objects with SNMP in their name. The Search magnifying glass is located in the middle of the Configuration tab.
When you click the Search tool, the system displays the Configuration Search text box next to the Magnifying Glass, where you enter the configuration object name, attribute, or value that you want to find. When you search for a phrase, rather than a complete object name, the system displays a list of all objects that contain the phrase.
4-2 Chapter 4 Dashboard Controls and Operations
Multi-instance configuration objects display a list of configurations and the table includes a text box for local search within the table. You can enter all or part of the configuration name.
When you search for a particular configuration, the results display only that configuration and the system adds a clear entry icon, displayed as an 'x', to the Search field.
When you click the button, the system resumes displaying all of the configurations on the list. Dashboard Controls and Operations
The Oracle® Enterprise Session Border Controller (E-SBC) can display dynamic data about the system through Widgets that you choose to place on the Dashboard. You can decide which Widgets to display by adding, deleting, and moving them at any time. The Dashboard can display up to 18 Widgets.
4-3 Chapter 4 Dashboard Controls and Operations
Note:
The (E-SBC) collects only SIP data for the Dashboard Widgets, including the default CPU and Memory Widgets. For this reason, you must set up a valid SIP configuration before the E-SBC can display any data on a Dashboard Widget.
The following screen capture shows an example of the Dashboard page and the controls you use to manage the Widgets:
—Shows the device name, the device IP address, and the software build number. When you deploy your SBC in a High Availability (HA) pair, the system identification also states whether the device is the Active or Standby peer.
—Updates the data in all of the Widgets on the Dashboard.
—Resets the Dashboard to display the default Widgets and removes all other Widgets from the Dashboard.
—Displays the list of Widgets that you can add to the Dashboard.
4-4 Chapter 4 Dashboard Controls and Operations
—Displays the list of Widgets that you can add to the Dashboard.
—Tells you that the Widget is blank because there is no data to display. A Widget can display a table, text, a pie graph, or a line graph depending on the type of data and the purpose of the display. For example, the SIP Realms All Widget displays an actionable table and the Recording Widget displays static text. You can access the list of Widgets from the Dashboard page by clicking Add Widget. Most of the Widgets automatically display any available data when you click the name of the Widget, but some Widgets require further input. Such Widgets include a Settings button in their tool bar that launches a parameters dialog were you specify the data to display. For example, the Realm Specifics Widget requires you to set the name of the realm and the auto refresh interval.
Note:
The operation of Widgets, such as those that require the SIP Session module, may affect system performance. The system displays a warning when you add a Widget that may affect performance. Oracle recommends adding such Widgets at a time when the performance impact will not affect service.
The default display includes the following Widgets: • Highest CPU Usage • Current Memory Usage • Historical Memory Usage • Alarms Widget Controls
Each Widget contains the controls that you use to manage its operations, according to the purpose of the Widget. The controls display when you hover over the three ellipses in the upper right corner of the Widget. The following screen capture shows an example of the tool bar that displays in a Widget. In the Widget, you can hover over the control for a description.
4-5 Chapter 4 About the Add Widgets Page
The following information describes the Widget controls.
1. Refresh—Updates the data in the Widget. 2. Settings—Displays the dialog where you set the data sampling parameters for the Widget. When you click the icon, the Widget displays the Settings dialog, where you can set the auto-refresh interval and other parameters that apply to the particular Widget. Widgets can display up to 100 data samples in intervals of 1 hour, 1 minute, or 1 second. 3. Export—Downloads the data displayed in the Widget. 4. Remove—Removes the Widget from the Dashboard. When you remove all Widgets from the Dashboard, the GUI displays the following message: " Your Dashboard is empty, please add a Widget or reset to restore the original Dashboard." 5. Maximize—Displays the Widget in full-screen size. 6. Show Information—Describes the data display. For example, in the Current Memory Usage Widget, the information icon says, "Pie graph displays current percentage of free and allocated memory." About the Add Widgets Page
After you click either the +Widget button or the Add Widget card on the Dashboard, the Web GUI displays the Add Widget page. On the Add Widget page, you can search for Widgets to add to the Dashboard and you can see which Widgets exist on the Dashboard. You can also see descriptions of the Widgets and change the display from card view to list view. The following screen capture shows the default view of the Add Widgets page, called card view.
4-6 Chapter 4 About the Add Widgets Page
In the top row of the preceding screen capture, the Alarms card and the Licenses card each display a green circle around a check mark. The check mark means that those Widgets currently display on the Dashboard. The following screen capture shows the list view of the Add Widgets page.
In the preceding screen capture, the Alarms row and the Licenses row each display a green circle around a check mark in the column between the Widget and Description. The check mark means that those Widgets currently display on the Dashboard.
Action Controls on the Banner Regardless of which view you choose, the banner displays the following controls.
• Search—Click to display the Search field, where you enter the name of a Widget.
• Card view—Click to display the card view.
4-7 Chapter 4 About the Add Widgets Page
• List view—Click to display the list view.
• Close—Click to close the Add Widgets page.
Search Filters Regardless of which view you choose, the Add widgets page displays the following search filters.
• All widgets—Click to see a list of all Widgets in alphabetical order.
• System—Click to see only a list of System-related Widgets.
• Media—Click to see only a list of Media-related Widgets.
• Signaling—Click to see only a list of Signaling-related Widgets.
• In Use—Click to see a list of Widgets currently displayed on the Dashboard.
Note:
All of the lists display a scroll bar when the list exceeds the page space.
Add a Dashboard Widget
You can add up to eighteen Widgets to the Web GUI Dashboard to display SIP and System statistics to help you monitor and manage the system. The system does not require a re-boot after performing the following procedure. The system adds the Widget to the Dashboard right away. 1. Access the Dashboard page and click either the + Widgets button or the +Add Widgets tile. The E-SBC displays the Add Widget dialog in card view. 2. On the Add Widget page, use the filters or scroll to the widget you want to add. 3. Do one of the following:
4-8 Chapter 4 View A Widget That is Not on the Dashboard
• In card view, click Add on the card. • In list view, click Add in the Command column. The system displays the newly added Widget on the Dashboard right away. Next Steps: • See "Configure Data Sampling Settings for a Dashboard Widget." Configure the Data Sampling Settings for a Dashboard Widget
To display SIP and System statistics on a Dashboard Widget, the system requires a setting for how often to refresh the display. You can use the default interval or select one from the Auto-refresh interval drop-down list on the Widget. • Confirm that the Widget that you want to configure is on the Dashboard. If not, see Add a Dashboard Widget. Some Widgets also display the Table Name drop-down list, where you can set the data sampling frequency. For example, you might configure the Widget to refresh the display every 40 seconds and to display the data samples in one minute increments. 1. Click the Dashboard tab. 2. On the Widget, hover over the ellipses to display the toolbar, and click the Settings icon. 3. Select a Widget display refresh frequency from the Auto-Refresh Interval (seconds) drop down list. 4. If the Widget displays the Table Name drop-down list, select a data sampling increment for the Widget display. Valid values: Seconds | Minutes | Hours. 5. Click OK. 6. Click Close. View A Widget That is Not on the Dashboard
The Dashboard is limited to displaying a maximum of eighteen widgets. If your Dashboard is fully populated with Widgets and you want to see a Widget that is not on the Dashboard, use the Widgets link on the Monitor and Trace page.
1. Access Widgets: Widgets tab. 2. In the navigation pane, click the name of the Widget that you want to see. The system displays the Widget. 3. Optional—Add the widget to the Dashboard, if the Dashboard is not fully populated.
4-9 5 Configuration Tab Operations
The Oracle® Enterprise Session Border Controller (E-SBC) Web GUI provides access to the dialogs and controls that you need to set up, administer, and maintain the configuration objects used on your session border controller through the Configuration tab.
Note:
The Web GUI Guide does not provide instructions for setting up the configuration objects. Use the ACLI Configuration Guide to get the instructions by transposing the path given to reach the object in the ACLI onto the Web GUI and you will reach the configuration dialog.
Topics: • The Configuration Tab Display • Media Manager Configuration • Security Configuration • Session Router Configuration • System Configuration The Configuration Tab Display
The Configuration tab displays configuration objects in the navigation pane organized much like they are on the ACLI command line. When you click a top-level object in the navigation pane, the center pane displays the sub-objects in alphabetical order. You can also click the twister by the high-level object in the navigation pane to display an alphabetical list of the sub-objects in the navigation pane. The Configuration tab header displays the system identification at the left end of the banner and the Notifications alarm and the User menu at the right end of the banner. Below the banner, the page displays the controls for View Configuration, Search, Discard, Verify, and Save.
5-1 Chapter 5 The Configuration Tab Display
See Configuration Tab Controls. Configuration Tab Controls
The Configuration tab displays controls to help you find, review, and work with the configurations that you set on the Oracle® Enterprise Session Border Controller.
Device Name IP Address Build Number—Use to identify the system and the software version. When you deploy your SBC in a High Availability (HA) pair, the system identification also states whether the device is the Active or Standby peer. View Configuration—Use to see the configuration Inventory, Editing Configuration Short, Running Configuration Short, Configuration Version, and Realm Specifics. Search—Use to find and display configuration objects to edit. The first time you place the cursor in the search field, the Web GUI displays a drop-down list of all the configuration objects in alphabetical order. You can refine your search by entering a parameter, an attribute, a value, or an object. When you use Search and switch to another tab, the system retains the search criteria when you return to the Configuration tab. Discard—Use to undo all configuration changes made in the current session. The system can only discard the changes that you saved. It cannot discard any changes that you activated. Verify—Use to validate the configuration is valid before saving.
5-2 Chapter 5 The Configuration Tab Display
Save—Use to save the current configuration session. Upon Save, the system displays a prompt with a choice of whether or not to activate the configuration. If you do not activate the configuration, you can continue to make changes and Save again. When finished, you can save and activate all of the configuration changes. View the Configuration
When you want to see aggregated information about the configuration on the Oracle® Enterprise Session Border Controller (E-SBC), click View Configuration on the Configuration tab. The Web GUI displays the Configuration Inventory page by default with tabs for the other views. The following screen capture shows the default landing page after you click View Configuration.
View Configuration Tabs Inventory—Shows the Element list, Running Count, Changes Not Activated Total Count, Changes Not Activated Added Total Count, Changes Not Activated Modified Count, and Changes Not Activated Deleted Count. Editing Configuration Short—View only the modified attributes in the editing configuration. Running Configuration Short—View only the modified attributes in the running configuration. Configuration Version—View the configuration version number table, which shows both the Current Version and the Running Version. Realm Specifics—Set the realm parameter and auto refresh interval.
Controls Each tab, except for Realm Specifics, displays a set of controls in the upper right corner. The following list includes all of the available controls, but note that the controls vary per tab.
5-3 Chapter 5 The Configuration Tab Display
Refresh—Use to manually refresh the data on the tab. Settings—Use to set the Auto Refresh Interval and to enable the option to Show Only Differences. Download—Use to download data to the Configuration Inventory. Description—Use to see a description of the view. Show or Hide Advanced Configuration Objects in the Navigation Pane
Each category of configuration objects includes additional objects that are not required to complete a basic configuration. Such objects are called Advanced objects, which you use to customize your configuration. If you do not need to see the advanced objects, you can hide them from view with the Show All toggle located at the bottom of the navigation pane. The Show All toggle affects all categories of configuration objects. You can toggle between show and hide at anytime. The following screen capture shows the navigation pane with the Show All toggle in the hide position. In this example, media-manager displays only five configuration objects because the Advanced configuration objects are hidden.
5-4 Chapter 5 The Configuration Tab Display
The following screen capture shows the navigation pane with the Show All toggle in the Show All position. The Web GUI displays the advanced elements in italics.
5-5 Chapter 5 The Configuration Tab Display
Configuration Dialogs Behavior
Drop-Down Lists To make configuration easier, the Web GUI displays drop-down lists for selecting values for configuration parameters. Drop-down lists behave in the following ways: System Populated—The system populates the list. You can only select an item that exists on the list and you cannot edit the list. For example, the system populates the list for the Strategy parameter in the Add Session Group configuration dialog.
5-6 Chapter 5 The Configuration Tab Display
User Populated—You can populate the list by configuring the objects in advance or by entering text in the field. For example, in the Add Realm configuration, the Ice Profile parameter can display a drop-down list of Ice Profiles. You create the list by configuring one or more profiles in the Ice Profile configuration.
In Realm Config, the system displays the name of each Ice profile that you created in the Ice Profile drop-down list. You can either select an entry from the list or enter the name of one that you plan to create.
5-7 Chapter 5 The Configuration Tab Display
Note:
Some configuration parameters allow you to select multiple items from the drop-down list.
Options Fields Options fields require you to enter each option separately with a delimiter between options. Without delimiters the system considers all of the entries as one, which can lead to unpredictable behavior. The Options text box accepts commas, semi-colons, full stops, and parens as delimiters. To add one option: Type the name of the option.
Click outside of the text box and the GUI sets the option in its own tab.
To add multiple options: Type the name of each option, separated with either the comma, semi-colon, or space characters. The following example shows commas as the delimiters.
Click outside of the text box and the GUI sets each option as a separate tab.
5-8 Chapter 5 The Configuration Tab Display
If you have a list of options in a text document and they are delimited with a comma, semi- colon, full stop, or parens, you can copy the list into the Options field and the system will add each option as a separate tab as soon as you click outside of the tab. To delete an Option, click the X on the tab.
Unsaved Changes Persistence While working in a configuration dialog, you can switch to another tab before you save the changes you made and expect your work to persist when you return to the dialog. Controls for Managing Multi-instance Configurations
Some configuration objects allow you to create multiple instances of the configuration, which the system displays in a list on the configuration object landing page. You can manage multi- instance configuration objects with the buttons and controls displayed on the landing page and within the configuration dialog. Buttons display at the top of the dialog and controls display when you right-click elements of the configuration in the list. Controls for Managing Configuration Lists
Web GUI configuration pages display controls for managing lists of multi-instance configurations. You can use certain controls to affect multiple instances, while others can affect only one instance at a time. When you select an operation that the system cannot perform on multiple instances, the GUI instructs you to select one instance at a time for the operation.
Global Controls At the top of a multi-instance configuration list, the Web GUI displays the controls for managing the list. The Add, Delete All, Download, and Upload controls (1., 2., 3., and 4. in the following screen capture) are always active. You must select a configuration before the Edit, Copy, and Delete controls (5., 6., and 7. in the following screen capture) become active.
1. Add—Click to add a configuration instance to the list. 2. Delete All—Click to delete all instances. You do not need to select the instances, just click the Delete All icon.
5-9 Chapter 5 The Configuration Tab Display
3. Upload—Click to upload one or more CSV configuration files to the configuration displayed. 4. Download—Click to download one or more configurations to a CSV file. 5. Edit—Click to edit the selected configuration. 6. Copy—Click to copy the selected configuration. 7. Delete—Click to delete the selected configuration.
Row Controls You can also access the Edit, Copy, and Delete controls from a row in the list. Either click the ellipses or right-click the row. When you right-click, the menu also includes the sorting choices.
Controls for Sorting Table Rows Controls for Showing and Hiding Column Headers Controls for Sorting Table Rows
You can set the order of the instances displayed in a multi-instance configuration list to either ascending or descending alphabetically. Right-click the list, and the system displays the control menu that includes Sort. Click Sort, and click either Sort Ascending or Sort Descending.
5-10 Chapter 5 The Configuration Tab Display
You can also set the sort order by clicking the arrow in the column header.
Controls for Showing and Hiding Column Headers
Each multi-instance configuration list supports a unique array of column headers and you can choose the ones that you want displayed and hidden. Right-click a column header to display the list of column headers that is available for the table displayed.
5-11 Chapter 5 The Configuration Tab Display
Note:
The same list displays regardless of which column you click.
Configuration Error Messages
If you save a configuration that contains errors, the system displays the following error message: There were errors! Are you sure you want to activate the configuration? The system displays a list of errors at the bottom the page. Click an error to go to the location in the configuration where the error occurred and edit the configuration as needed.
Severity Identifies the level of severity that the Oracle Enterprise Session Border Controller assigns to the error. Valid values are: • ERROR—Means that the issue identified in the Message column is not correctly configured or it does not exist. You can still verify, save, and activate the configuration if this severity exists. • WARNING—Means that the configuration contains invalid information for the element field identified in the Message column. You can still verify, save, and activate the configuration if this severity exists. • CRITICAL—Means that a critical error occurred in the configuration and you cannot verify, save, or activate until the error is corrected. The Message column indicates the element field where the error has occurred.
Message Identifies the element field where the error, warning, or critical error occurred, and the reason for the error.
Object Identifies the element and the field for that element where the error occurred.
5-12 Chapter 5 Media Manager Configuration
Attribute Identifies the attribute within the element where the error occurred. Name
Other Identifies any other pertinent information relating to the error. Configuration States and Behavior
The Oracle® Enterprise Session Border Controller (E-SBC) uses three states of memory to manage configuration changes, which allows you to make changes and decide when you want them to take effect. At any time, the following three versions of the configuration can exist on the E-SBC. • Editing—The editing configuration is the version that you are making changes to from the Web GUI. The editing version is stored in the E-SBC volatile memory. The editing version cannot survive a system restart. • Saved—The saved configuration is the version of the editing configuration that the system copies into the non-volatile memory when you click Save on the Web GUI. The changes do not take effect on the E-SBC until you activate the saved configuration. Note that the system does not load the saved, but unactivated, configuration as the running configuration upon restart. The Saved configuration requires activation, first. • Running configuration—The running configuration is the configuration that the system is using. When you activate the saved configuration it becomes the running configuration. Most configuration changes can take effect upon activation. Some configuration changes require a system restart. Upon restart, the system loads the running configuration. The process for saving and activating a configuration, includes the following steps. 1. OK—All configuration dialogs display an OK button that saves changes to the editing memory. If you restart before the next step, the E-SBC does not save the changes. 2. Verify—(Optional) Oracle recommends verifying the validity of the configuration before saving because saving shows any errors after saving. Verify displays the configuration changes and any errors found, before saving. 3. Save—The Save button on the Web GUI toolbar verifies the configuration, saves the current configuration to the last-saved configuration, and displays errors. Save stores the configuration on the E-SBC. The system displays any errors at the bottom of the Configuration page. 4. Activate—After you finish making one or more configuration changes, OK and Save from the last configuration dialog that you need to edit at this time. The system displays the Confirmation dialog containing the Activate button. When you click Activate, the E- SBC activates all of the saved configuration changes and saves the new configuration to the running configuration. If you cancel the activation function, the E-SBC saves the configuration in a file and does not change the running configuration. You can continue to make changes to the configuration. Media Manager Configuration
Use the Media Manager configuration object to define the settings for the media steering functions performed by the Oracle® Enterprise Session Border Controller (E-SBC), including timer limits, logging, and trust levels.
5-13 Chapter 5 Security Configuration
You can configure the following Media Manager objects from the Configuration tab on the Web GUI. See the documentation specified in the following list for explanations of these configuration objects and how to set their parameters.
Codec Policy Create a codec policy to specify allowed codecs, the order of codecs, and codecs to add on egress. See "Codec Policy Configuration" in the ACLI Configuration Guide.
DNS ALG Configure and enable DNS ALG constraints. See the "DNS ALG Constraints Service Name Configuration" section of the "Application Gateway Services" chapter in the ACLI Configuration Guide.
DNS Config Configure the DNS ALG service. See "DNS Configuration" in the ACLI Configuration Guide.
ICE Profile Configure ICE profile. See "Configure ICE Profile" in the ACLI Configuration Guide.
Media Manager Configure media steering functions. See "Creating Steering Pools for Multiple Interface Realms" in the ACLI Configuration Guide.
Media Policy Configure a media policy and ToS settings. See "Packet Marking Configuration" in the ACLI Configuration Guide.
MSRP Config Configure and enable MSRP. See "RCS Services" in the ACLI Configuration Guide.
Playback Config Configure media use for playback. See "Local Media Playback" in the ACLI Configuration Guide.
Realm Config Configure a realm for media management. See "Realms and Nested Realms" in the ACLI Configuration Guide.
Realm Group Configure realm groups for local media playback. See "Configuring Realm Groups" in the ACLI Configuration Guide.
RTCP Policy Configure an RTCP policy. See "Configuring RTCP Generation" in the ACLI Configuration Guide.
Static Flow Configure static network traffic flows. See "Static Flows" in the ACLI Configuration Guide.
Steering Pool Specify one or more ports for steering media flows. See "Steering Pools" in the ACLI Configuration Guide.
TCP Media Profile Configure the TCP media profile and profile entries. See "Configure TCP Media Profile" in the ACLI Configuration Guide. Security Configuration
The Oracle® Enterprise Session Border Controller (E-SBC) can provide security for VoIP and other multi-media services. E-SBC security includes access control, DoS attack, and overload protection to help secure service and protect the network infrastructure. E-SBC security lets legitimate users place a call during attack conditions, while protecting the service itself.
5-14 Chapter 5 Security Configuration
E-SBC security includes the numerous features and architecture designs of the Net-SAFE framework. Net-SAFE is a requirements framework for the components required to provide protection for the E-SBC, the service provider's infrastructure equipment (proxies, gateways, call agents, application servers, and so on), and the service itself. You can configure the following Security objects from the Configuration tab on the Web GUI. See the documentation specified in the following list for explanations of these configuration objects and how to set their parameters. audit-logging Configure the size, location, and conditions that trigger the transfer of logs to the specified location. See "Configure the Audit Log" in the "Audit Log" chapter in the Administrative Security Guide. auth-params Configure authentication protocol, strategy, and servers. See the "Authentication and Authorization" section in the "Access" chapter in the Administrative Security Guide. authentication Configure RADIUS and TACACS authentication. See "RADIUS Authentication" and "TACACS+" in the ACLI Configuration Guide. authentication Reserved for future use. profile certificate record Create a certificate record for either a CA or end entity. See "Certificate Configuration Process" in the ACLI Configuration Guide. data-flow Specify the pass-through data-traffic processing when using IKE. See "data-flow" in the ACLI Reference Guide. dpd-params Enable one or more sets of DPD Protocol paramters. See "dpd-params" in the ACLI Reference Guide. ike-access-control Define the whilte list, balcklist, and DDoS paramters for the ike-interface that uses this parameter. See "ike-access-control" in the ACLI Reference Guide. ike-accounting- Specify the IKE accounting parameters. param ike-certficate- Specify the public certificate that authenticates a specific IKEv2 identity, profile as well as one or more CA certficates used to validate a certficate offered by a remote peer. See "ike-certficate-profile" in the ACLI Reference Guide. ike-config Define a single, global Internet Key Exchange (IKE) configuration object. See "ike-config" in the ACLI Reference Guide. ike-interface Create multiple OKE-enabled interfaces. See "ike-interface" in the ACLI Reference Guide. ike-sainfo Enable the negotiation and establishment of IPSec tunnels. See "ike- sainfo" in the ACLI Reference Guide. local-address- Create local address pools to provide a local (internal) address in pool resonse to remote requests for IP addresses. See "local-address-pool" in the ACLI Reference Guide. tunnel-orig- Define a single, remote IKEv2 peer. See "tunnel-orig-params" in the ACLI params Reference Guide.
5-15 Chapter 5 Session Router Configuration
ipsec-global- Configure the parameters governing system-wide IPSec functions and config behavior, including IPSec redundancy. See "ipsec-global-config" in the ACLI Reference Guide.
security- Configure a security association on the Oracle Session Border Controller. association See "security-association-manual" in the ACLI Reference Guide.
secutiy-policy Define multiple polciy instances with each polidy defining match criteria and an operational action performed on matching traffic flows. See "security-policy" in the ACLI Reference Guide.
dtls-srtp-profile Configure the key exchange and DTLS handshake on a media session, the role the SBC negotiates when offered alternatives, and the crypto suites to use. See the "Configure DTLS SRTP Profile" section in the "Advanced Media Termination Support" chapter of the ACLI Configuration Guide.
media-sec-policy Define a policy that affects inbound and outbound traffic. See "media-sec- policy" in the ACLI Reference Guide.
sdes-profile Configure the paramater values offered and accepted during SDES negotiation. See "sdes-profile" in the ACLI Reference Guide.
sipura-profile Specify the materials (certficated, protocol suites, and so on) the support cryptographci operations. See "sipura-profile" in the ACLI Reference Guide.
password -policy Create a password policy. See the "Password Policy" section in the "Access" chapter in the Administrative Security Guide.
security-config Configure security for VoIP and other multimedia services. See the "Security" chapter in the ACLI Configuration Guide.
ssh-config Configure the system for an SSH connection. See "SSH Remote Connections" in the ACLI Configuration Guide.
ssh-key Add or upload an SSH key. See "SSH Remote Connections" in the ACLI Configuration Guide.
tls-global Configure session caching to allow a previously authenticated client to re- connect with the unique session identifier from the previous session. See "TLS Session Caching Configuration" in the ACLI Configuration Guide.
tls-profile Create a profile to define communications security for running SIP over TLS. See "Configure a TLS Profile" in the ACLI Configuration Guide. Session Router Configuration
You can configure the following Session Router objects from the Configuration tab on the Web GUI. See the documentation specified in the following list for explanations of these configuration objects and how to set their parameters.
Access Control Configure a static or dynamic access control list. See the Security Guide and "System Access Control" in the ACLI Configuration Guide.
5-16 Chapter 5 Session Router Configuration
Allowed Elements Configure an allowed elements profile to configure SIP Allowlist Profile which, control the passage of unknown headers and parameters in request and response traffic. Includes the Rule Sets sub- object. See the "Allowlist Lists for Managing Incoming SIP Headers and Parameters" section of the "Admission Control and QoS" chapter in the ACLI Configuration Guide.
Class Policy Configure a classification profile policy. See "Using Class Profile for Packet Marking", " Class Profile and Class Policy Configuration", and " Applying a Class Policy to a Realm" in the ACLI Configuration Guide.
Diameter Configure diameter manipulation rules. See the "Diameter Rf Manipulation Accounting" chapter in the Accounting Guide.
Enforcement Configure an enforcement profile. See "SIP Enforcement Profile Profile and Allowed Methods" in the ACLI Configuration Guide.
ENUM Config Configure an ENUM server. See "ENUM Server", and other ENUM topics in the ACLI Configuration Guide.
Filter Config Configure a custom filter for SIP monitor and trace. See the "SIP Monitor and Trace" section of the "Introduction to SIP Monitor and Trace" chapter in the ACLI Configuration Guide.
H323 Config Configure and enable an H.323 protocol. See the "Signaling" chapter in the ACLI Configuration Guide.
H323 Stack Configure an H.323 stack. See the "Signaling" chapter in the ACLI Configuration Guide.
Home Subscriber For future use. Not supported at this time. Server
HTTP ALG Configure an HTTP proxy. See "Dynamic ACL for the HTTP- ALG" in the See the "Signaling" chapter in the ACLI Configuration Guide.
LDAP Config Configure and enable an LDAP server. See the "Active Directory- based Call Routing" section of the "Session Routing and Load Balancing" chapter in the ACLI Configuration Guide.
Local Policy Configure a session request routing policy. See "The Role of Local Policy" and "Configuring the Local Policy Attribute" in the ACLI Configuration Guide.
Local Response Configure a local SIP response map. See "Add a Local Map Response Map" in the ACLI Configuration Guide.
Local Routing Configure the parameters for the local routing table. See the Config "Using the Local Route Table for Routing" section of the "Session Routing and Load Balancing" chapter in the ACLI Configuration Guide.
Media Profile Configure a media profile and apply it to a media type. See the various "Media Profile Configuration" topics throughout the ACLI Configuration Guide.
5-17 Chapter 5 Session Router Configuration
Net Management Configure and enable network management controls. See Control "Network Management Controls" in the ACLI Reference Guide.
Response Map Configure a SIP response map. See "Add a Local Response Map" in the ACLI Configuration Guide.
Service Health Configure a service tag list to indicate the Session Agent Group assigned to the interface on the E-SBC.
Session Agent Configure and enable a session agent. See "Session Agent Configuration" and "Configuring a Session Agent" in the ACLI Configuration Guide.
Session Agent ID Configure the SIP header and the parameter within the specified Rule header to use to identify the Session Agent.
Session Configure and enable session constraints. See "Aggregate Constraints Session Constraints Configuration" in the ACLI Configuration Guide.
Session Group Configure a session agent group. See the "Session agent Groups" section of the "Session Routing and Load Balancing" chapter in the ACLI Configuration Guide.
Session Recording Configure a session recording server group. See the Group "Configuring SIPREC" section of the "Selective Call Recording SIPREC" chapter in theCall Traffic Monitoring Guide.
Session Recording Configure and enable a session recording server. See the Server "Configuring SIPREC" section of the "Selective Call Recording SIPREC" chapter in theCall Traffic Monitoring Guide.
Session Timer Configure a session timer profile. See "Sip-Config option Profile session-timer-support" and "ACLI Configuration" in the ACLI Configuration Guide.
Session Translation Configure the translation rules for calling and called numbers. See the session translation topics in the "Number Translation" chapter of the ACLI Configuration Guide.
SIP Advanced Configure logging of specific SIP requests by criteria. See Logging "Advanced Logging" in the "Maintenance and Troubleshooting" chapter of the ACLI Configuration Guide.
SIP Config Configure and enable signaling and session management. See the "SIP Signaling Services" chapter of the ACLI Configuration Guide.
SIP Feature Configure SIP option tag parameters. See "SIP Options Tag Handling" in the "SIP Signaling Services" chapter of the ACLI Configuration Guide.
SIP Feature Caps Configure to support SRVCC handover and other ATCF functionality. See "sip-feature-caps" in the ACLI Reference Guide.
SIP Interface Configure and enable a SIP interface. See "SIP Interface Configuration" in the ACLI Configuration Guide.
5-18 Chapter 5 System Configuration
SIP Manipulation Configure SIP manipulation. See "Configuring SIP Manipulations" in the "SIP Signaling Services" chapter of the ACLI Configuration Guide.
SIP Monitoring Configure and enable SIP monitor and trace features. See the "Introduction to SIP Monitor and Trace" chapter in the Call Traffic Monitoring Guide.
SIP Recursion Configure a recursion policy. See the "SIP Configurable Route Policy Recursion" section of the "SIP Signaling Services" chapter of the ACLI Configuration Guide.
Surrogate Agent Configure a surrogate agent. See the Surrogate Agents topics in the "SIP Signaling Services" chapter of the ACLI Configuration Guide.
Survivability Configure and enable survivability. See the "Remote Survivability" chapter in the ACLI Configuration Guide.
Translation Rules Configure and apply session translation rules to an agent and a realm. See the "Translation Rules" section of the "Number Translation" chapter in the ACLI Configuration Guide. System Configuration
You can configure the following System objects from the Configuration tab on the Web GUI. See the documentation specified in the following list for explanations of these configuration objects and how to set their parameters.
Capture Receiver Enable and configure a capture receiver. See the "Capture Receiver" section of the ACLI Reference Guide.
Fraud Protection Enable and configure fraud protection. See the "Telephony Fraud Protection" section of the "System Configuration" chapter in the ACLI Configuration Guide.
Host Route Add one or more host routes. See the "Host Routes" section of the "System Configuration" chapter in the ACLI Configuration Guide.
HTTP Client For future use. Not supported at this time.
HTTP Server For future use. Not supported at this time.
Network Interface Add one or more network interfaces. See the "Network Interfaces" section of the "System Configuration" chapter in the ACLI Configuration Guide.
Network Parameters Configure SCTP and TCP parameters for the network. See the "Stream Control Transfer Protocol Overview" and "System TCP Keepalive Settings" sections of the "System Configuration" chapter in the ACLI Configuration Guide.
NTP Config Add one or more NTP servers and authentication servers. See the "NTP Synchronization" section of the "System Configuration" chapter in the ACLI Configuration Guide.
5-19 Chapter 5 System Configuration
Phy Interface Add one or more physical interfaces. See the "Phy Interfaces" section of the "System Configuration" chapter in the ACLI Configuration Guide.
Redundancy Config Enable redundancy and add one or more peers. See the "SIP Server Redundancy" section of the "SIP Signaling Services" chapter in the ACLI Configuration Guide.
SNMP Address Add one or more SNMP addressees. See "SNMP-Address-Entry" in Entry the ACLI Reference Guide.
SNMP Community Add and specify one or more Simple Network Management Protocol (SNMP) communities. See "SNMP v1 v2 Community Configuration" in the ACLI Configuration Guide and "SNMP-Community" in the ACLI Reference Guide.
SNMP Group Entry Add one or more SNMP groups. See "SNMP-Group-Entry" in the ACLI Reference Guide.
SNMP User Entry Add one or more SNMP users. See "SNMP-User-Entry" in the ACLI Reference Guide.
SNMP View Entry Add one or more SNMP views. See "SNMP-View-Entry" in the ACLI Reference Guide.
SPL Config Add an SPL option and one or more plug-ins. See the "SPL Plug-in Language" chapter in the ACLI Configuration Guide.
System Access List Add one or more system access lists. See "System Access List" in the ACLI Reference Guide.
System Config Configure the system settings for MIBS, SNMP functions, syslog servers, comm monitor, and more. See the "System Configuration" chapter in the ACLI Configuration Guide.
TDM Config Enable and configure Time Division Multiplexing (TDM). See the Time Division Multiplexing Guide. For the Acme Packet 1100, only.
Threshold Crossing Configure an alarm threshold type to indicate the resource to monitor. Alert See "Configurable Alarm Thresholds and Traps" section in the "System Configuration" chapter in the ACLI Configuration Guide.
Trap Receiver Add one or more trap receivers. See "Trap Receiver" in the ACLI Reference Guide.
5-20 6 Monitor and Trace Tab Operations
The Monitor and Trace tab displays links to tools that help you see system and session data on the Oracle® Enterprise Session Border Controller (E-SBC). The Monitor and Trace link provides summary reports that include session data, ladder diagrams of call and media flows, and Quality of Service statistics.
Topics: • Monitor and Trace Monitor and Trace
The Monitor and Trace tab displays the results of filtered SIP session data from the Oracle® Enterprise Session Border Controller in categorical lists. Each of the lists displays the results in a common log format for local viewing, which you can export as HTML and text files. When you click the Monitor and Trace tab, the Web GUI displays links to the available lists in the navigation pane and defaults to Sessions. In the white space below the list, the GUI displays the total number of entries in the list and the numbers of the entries currently in view. The counter is dynamic and changes the enumeration as you scroll through the list. The following screen capture shows the Monitor and Trace default display.
Monitor and Trace supports the following summary reports. • SIP Sessions Summary • SIP Registrations Summary • SIP Subscriptions Summary • SIP Notable Events Summary Each summary provides sorting, searching, paging, and exporting functionality, as well as a ladder diagram view where you can see a session summary, session details, and QoS statistics. You can choose which columns that you want each summary list to display by right clicking any column header and selecting column names from the pop-up list. The available column names vary according to the list type.
6-1 Chapter 6 Monitor and Trace
Monitor and Trace can store messages per session and it can store cumulative sessions across all report types. When the sessions maximum is reached, the system removes the oldest call and adds the newest call. • On systems with less than 4GB of RAM, the system can store: – 50 messages – 2,000 sessions • On systems with more than 4GB of RAM, the system can store: – 50 messages – 4,000 sessions The call database does not persist when you change the number of rows in a Ladder Diagram and Save and Activate the change. The system can perform live paging from Monitor and Trace tables.
Note:
Only one user at a time can view Monitor and Trace information. Monitor and Trace does not support multiple, simultaneous viewers.
6-2 Chapter 6 Monitor and Trace
SIP Monitor and Trace for Ingress and Egress Messages
SIP Monitor and Trace operations allow the Oracle® Enterprise Session Border Controller (E- SBC) to monitor SIP sessions in your network. The system processes SIP Monitor and Trace data on incoming messages first, and then sends the data out on outgoing messages. This process allows the E-SBC to capture SIP Monitor and Trace data for display in the Web GUI. The E-SBC captures a SIP message in ingress, applies the Header Manipulation Rules (HMR) that you configured, and applies the Session Plug-in Language (SPL). When the E- SBC sends the message on egress, the E-SBC applies the SPL, applies the HMR, and sends out the captured SIP message.
SIP Sessions Summary
The SIP Sessions Summary is a SIP session summary of all logged call sessions on the Oracle® Enterprise Session Border Controller (E-SBC). When you enable Lightweight Directory Access Protocol (LDAP) on the Active Directory, LDAP session messages may also display. The columns that display on the Sessions Summary page depend on the columns that you specified in the "Customizing the Page Display" procedure. The following table describes the columns on the SIP Session Summary page.
Start Time Timestamp of the first SIP message in the call session.
State Status of the call or media session. Valid values are: INITIAL—Session for which an INVITE or SUBSCRIBE was forwarded. EARLY—Session that received the first provisional response (1xx other than 100). ESTABLISHED—Session for which a success (2xx) response was received. TERMINATED—Session that ended by receiving or sending a BYE for an “Established” session or forwarding an error response for an “Initial” or "Early" session. The session remains in the terminated state until all the resources for the session are freed up. FAILED—Session that failed due to a 4xx or 5xx error code.
6-3 Chapter 6 Monitor and Trace
Call ID Identification of the call source. Includes the phone number and source IP address.
Request URI Uniform Resource Identifier (URI) formatted string that identifies a resource by way of a protocol, name, location, and any other applicable characteristic that is sent by the E-SBC in REQUEST headers.
From URI URI formatted string that identifies the call source information.
To URI URI formatted string that identifies the call destination information.
Ingress Realm Name of the inbound realm.
Egress Realm Name of the outbound realm.
Duration Amount of time, in seconds, that the call or media event was active.
Notable Event Indicates if a notable event has occurred on the call session. Valid values are: Short Session—Sessions that do not meet a minimum configurable duration threshold. Session dialogue, captured media information, and termination signalling. Any event flagged as a short session interesting event. Local Rejection—Sessions locally rejected at the E-SBC for any reason, for example, Session Agent (SA) unavailable, no route found, SIP signaling error, and so on. Session dialogue, capture media information, and termination signaling. Any event flagged as a local rejection interesting event.
Session ID Identification assigned to the call session.
Ingress Src Addr Source IP address of the incoming call or media event.
Egress Dest Destination IP address of the outgoing call or media event. Addr
Calling Pkts Number of calling packets.
Called Pkts Number of called packets.
Calling R Calling packets R-Factor calculation.
Called R Called packets R-Factor calculation.
Calling MOS Calling packets Mean Opinion Score (MOS) calculation.
Called MOS Called packets Mean Opinion Score (MOS) calculation.
Ingress Src Port Source port of the incoming call or media event.
Object ID ID number of the object in a row. Use to aid troubleshooting. SIP Registrations Summary
The SIP Registrations Summary displays a summary of all logged SIP registrations sessions on the Oracle® Enterprise Session Border Controller (E-SBC). The columns that display on the Registrations Summary page depend on the columns you selected in the "Customizing the Page Display" procedure.
6-4 Chapter 6 Monitor and Trace
The following table describes the columns available on the Registrations Summary page.
Start Time Timestamp of the first SIP message in the call session.
Call ID Identification of the call source. Includes the phone number and source IP address.
From URI URI formatted string that identifies the call source information.
To URI URI formatted string that identifies the call destination information.
Local Expires The current setting for the expiration of a registration request sent from the Integrated Media Gateway (IMG) to a Remote SIP User Agent. Default: 3600 seconds.
Remote Expires The current setting for the expiration of a registration request sent from the Remote SIP User Agent to the Integrated Media Gateway (IMG). Default: 3600 seconds.
Ingress Realm Incoming realm name.
Egress Realm Outgoing realm name.
Notable Event Indicates a notable event that occurred on the call session. Valid value: local rejection - Sessions locally rejected at the E-SBC for any reason (for example, Session Agent (SA) unavailable, no route found, SIP signalling error, etc.); Session dialogue, capture media information and termination signalling; Any event flagged as a local rejection interesting event
Session ID Identification assigned to the call session.
Ingress Src Addr Source IP address of the incoming call or media event.
Egress Dest Addr Destination IP address of the outgoing call or media event.
Request URI Uniform Resource Identifier (URI) formatted string that identifies a resource with the protocol, name, location, and any other applicable characteristic. The SBC only sends the URI in REQUEST headers.
Object ID ID number of the object in a row. Use to aid troubleshooting. SIP Subscriptions Summary
The SIP Subscriptions Report displays a summary of all logged SIP subscription sessions on the Oracle® Enterprise Session Border Controller (E-SBC). The columns that display on the Subscription Report page depend on the columns you selected in the "Customizing the Page Display" procedure. The following table describes the columns on the Subscriptions Report page.
Start Time Timestamps of the first SIP message in the call session.
Call ID Identification of the call source. Includes the phone number and source IP address.
From URI URI formatted string that identifies the call source information.
To URI URI formatted string that identifies the call destination information.
6-5 Chapter 6 Monitor and Trace
Events Specific subscribe event package that was sent from an endpoint to the destination endpoint. Applicable event packages include the following: Conference—Event package that allows users to subscribe to a conference Uniform Resource Identifier (URI). Consent—pending additions - Event package used by SIP relays to inform user agents about the consent-related status of the entries to be added to a resource list. Dialog—Event package that allows users to subscribe to another user, and receive notifications about the changes in the state of the INVITE-initiated dialogs in which the user is involved. Message—summary - Event package that carries message-waiting status and message summaries from a messaging system to an interested User Agent (UA). Presence—Event package that conveys the ability and willingness of a user to communicate across a set of devices. A presence protocol is a protocol for providing a presence service over the Internet or any IP network. Reg—Event package that provides a way to monitor the status of *all* the registrations for a particular Address of Record (AoR). Refer—Event package that provides a mechanism to allow the party sending the REFER to be notified of the outcome of a referenced request. Winfo—Event package for watcher information. It tracks the state of subscriptions to a resource in another package. Vvq-rtcpx—Event package that collects and reports the metrics that measure quality for RTP sessions.
Expires The current setting for the expiration of a registration request. Default: 3600 sec.
Ingress Incoming realm name. Realm
Egress Outgoing realm name. Realm
Notable Indicates that a notable event occurred on the call session. Valid value is: Event local rejection - Sessions locally rejected at the E-SBC for any reason (for example, Session Agent (SA) unavailable, no route found, SIP signaling error); Session dialogue, capture media information and termination signaling; Any event flagged as a local rejection interesting event
Session ID Identification assigned to the call session.
State Status of the call or media session. Valid values are: INITIAL—Session for which an INVITE or SUBSCRIBE was forwarded. EARLY—Session that received the first provisional response (1xx other than 100). ESTABLISHED—Session for which a success (2xx) response was received.
6-6 Chapter 6 Monitor and Trace
TERMINATED—Session that ended by receiving or sending a BYE for an “Established” session or forwarding an error response for an “Initial” or "Early" session. The session remains in the terminated state until all the resources for the session are freed up. FAILED—Session unsuccessful due to a 4xx or 5xx error code.
Ingress Src Source IP address of the incoming call or media event. Addr
Egress Dest Destination IP address of the outgoing call or media event. Addr
Request URI Uniform Resource Identifier (URI) formatted string that identifies a resource by way of a protocol, name, location, and any other applicable characteristic, and is sent by the E-SBC in REQUEST headers.
Object ID ID number of the object in a row. Use to aid troubleshooting. SIP Notable Events Summary
The SIP Notable Events Summary contains all logged sessions that have a notable event on the Oracle® Enterprise Session Border Controller (E-SBC) associated with the session. The columns that display on the Notable Events Summary page depend on the columns that you selected in the "Customizing the Page Display" procedure. The following table describes the columns that Notable Events Summary page can display.
Start Time Timestamp of the first SIP message in the call session.
State Status of the call or media event session. Valid values: INITIAL—Session for which an INVITE or SUBSCRIBE was forwarded. EARLY—Session received the first provisional response (1xx other than 100). ESTABLISHED—Session for which a success (2xx) response was received. TERMINATED—Session that has ended by receiving or sending a BYE for an “Established” session or forwarding an error response for an “Initial” or Early session. The session remains in the terminated state until all the resources for the session are freed up. FAILED Session that has failed due to a 4xx or 5xx error code.
Call ID Identification of the call source. Includes the phone number and source IP address.
Request URI Uniform Resource Identifier (URI) formatted string that identifies a resource through a protocol, name, location, and any other applicable characteristic, and is sent by the E-SBC in REQUEST headers.
From URI URI formatted string that identifies the call source information.
To URI URI formatted string that identifies the call destination information.
Ingress Realm Name of the inbound realm.
6-7 Chapter 6 Monitor and Trace
Egress Realm Name of the outbound realm.
Notable Event Indicates if a notable event has occurred on the call session. Valid values: short session—Sessions that don’t meet a minimum configurable duration threshold; Session dialogue, captured media information and termination signalling; Any event flagged as a short session interesting event. local rejection—Sessions locally rejected at the E-SBC for any reason (for example, Session Agent (SA) unavailable, no route found, SIP signalling error, etc.); Session dialogue, capture media information and termination signaling; Any event flagged as a local rejection interesting event.
Session ID Identification assigned to the call session.
Ingress Src Source IP address of the incoming call or media event. Addr
Ingress Src Source port of the incoming call or media event. Port
Egress Dest Destination IP address of the outgoing call or media event. Addr
Object ID ID number of the object in a row. Use to aid troubleshooting. Ladder Diagrams and Display Controls
A ladder diagram is a graphical representation of the flow of call and media packets on ingress and egress routes through the Oracle® Enterprise Session Border Controller (E-SBC). Viewing ladder diagrams can help you with troubleshooting and system monitoring. The Web GUI can display ladder diagrams for each of the summary reports available through Monitor and Trace. The E-SBC can store up to 4,000 calls on a system with more than 4GB of memory and up to 2,000 calls on a system with less than 4GB of memory. A ladder diagram can display up to 999 rows, but the relationship to stored calls is inverse. The more calls you want to store, the fewer rows the ladder diagram can display. The more rows you want to see per call, the fewer the number of calls the E-SBC can store. You can control the number of rows to display by setting the Ladder Diagram Rows parameter in the SIP Monitoring configuration under Session Router. To display one or more ladder diagrams, select one or more rows in the Session, Registrations, Subscriptions, or Notable Events lists and click Ladder Diagram. The Web GUI adds a tab to the top of the page for each ladder diagram. Click the tabs to see the ladder diagrams.
Note:
You can also right-click a row and click Ladder Diagram on the pop-up menu or click the ellipses at the beginning of a row and click Ladder Diagram on the pop-up menu.
The following illustration shows a sample ladder diagram with notations about the controls for viewing and exporting.
6-8 Chapter 6 Monitor and Trace
Ladder diagrams contain the following sections. Session Summary—Displays session data. Use the [+] and [-] controls to toggle between show and hide. The default is hide. Ladder Diagram—Displays SIP message and call flow information. Hover over a line in the ladder diagram to see more information about the highlighted flow. QoS Stats—Displays Quality of Service (QoS) information. Use the [+] and [-] controls to toggle between show and hide. The default is hide. You must enable Quality of Service (QoS) on your system to see the QoS Statistics information. The following screen capture shows an example of a ladder diagram as initially displayed with the Session Summary and QoS Stats sections hidden.
The following screen capture shows an example of an E-SBC ladder diagram with the Session Summary and QoS sections expanded. This screen capture also shows an example of the pop-up that displays detailed SIP Message Details when you hover over a row in the diagram.
6-9 Chapter 6 Monitor and Trace
Note:
The E-SBC captures SIP messages, applies the Header Manipulation Rules (HMR) that you configured on the E-SBC, and applies the Session Plug-in Language (SPL) to that message. When the E-SBC sends the message, it applies the SPL, the HMR, and sends the captured SIP message. When viewing the session detail on a Ladder Diagram, the HMR and SPL information may be present.
Ladder Diagram Controls Ladder diagrams display the following controls at the bottom of the page. Refresh—Use to refresh the data in the ladder diagram. Export diagram—Use to export the ladder diagram to an HTML file. Export session details—Use to export the session details to a text file.
Close and Remove Ladder Diagram Tabs To remove an individual tab you can either click the X on the tab or right-click and click Remove on the pop-up menu. To remove all tabs, right-click a tab and click Close All on the pop-up menu.
6-10 Chapter 6 Monitor and Trace
Display a Ladder Diagram
You can display a ladder diagram of call and media flow data from the Sessions, Registrations, Subscriptions, and Notable events lists in Monitor and Trace. Each list page displays a table, where each row represents one session. You can view a ladder diagram for each session with the following procedure. The Monitor and Trace tab can display multiple ladder diagrams in separate tabs. You can either select multiple rows from the list initially or repeat the procedure later to display more ladder diagram tabs. 1. Access the Monitor and Trace tab. 2. On the Monitor and Trace tab, select one of the following lists: • Sessions • Registrations • Subscriptions • Notable Events 3. On the list page, do one of the following : • Double click a row. • Select one or more rows and click Ladder Diagram. The Web GUI adds one or more tabs above the list that you can click to view the contents. 4. (Optional)—On the ladder diagram, click the [+] to expand the Session Summary and QoS Stats sections. 5. (Optional)—Refresh the diagram, export the diagram, or export the session details, using the buttons at the bottom of the page.
Session Summary
To see a Session Summary, open a ladder diagram from a record in a Summary report and click the [+] control that precedes "Session Summary" at the top of the page. Monitor and Trace displays the session data and statistics. The following screen capture shows a sample Session Summary page generated from a selected item on a ladder diagram.
The following table describes each field in the Session Summary report.
State Status of the call or media session. Valid values are:
6-11 Chapter 6 Monitor and Trace
INITIAL—Session for which an INVITE or SUBSCRIBE was forwarded. EARLY—Session received the first provisional response (1xx other than 100). ESTABLISHED—Session for which a success (2xx) response was received. TERMINATED—Session that has ended by receiving or sending a BYE for an “Established” session or forwarding an error response for an “Initial” or Early session. The session remains in the terminated state until all the resources for the session are freed up. FAILED—Session that has failed due to a 4xx or 5xx error code.
Duration Amount of time, in seconds, that the call or media session was active.
From URI URI formatted string that identifies the call source information.
To URI URI formatted string that identifies the call destination information.
Ingress Src Source IP address and port number of the incoming call or media IP:Port session.
Egress Src IP: Source IP address and port number of the outgoing call or media Port session.
Ingress Dest Destination IP address and port number of the incoming call or media IP:Port session.
Egress Dest IP: Destination IP address and port number of the outgoing call or media Port session.
Ingress Realm Incoming realm name.
Egress Realm Outgoing realm name.
Ingress Network Name of the incoming network interface on the Oracle® Enterprise Intf Session Border Controller (E-SBC).
Egress Network Name of the outgoing network interface on the E-SBC. Intf
Ingress Transport Protocol type used on the incoming call or media session. Valid values are User Datagram Protocol (UDP) or Transport Control Protocol (TCP).
Egress Transport Protocol type used on the outgoing call or media session. Valid values are User Datagram Protocol (UDP) or Transport Control Protocol (TCP).
Display a Session Summary
You can view data and statistics about a call or media session by displaying the Session Summary from a ladder diagram.
1. Under the Monitor and Trace tab, select one of the following summaries: • Sessions • Registrations
6-12 Chapter 6 Monitor and Trace
• Subscriptions • Notable Events 2. On the Summary page, select a row in the table and right-click. 3. On the pop-up menu, click Ladder Diagram. 4. (Optional)—On the ladder diagram, click the [+] to expand the Session Summary section.
QoS Statistics
The Quality of Service (QoS) Stats section of the Session Summary displays information about the quality of the service for a selected call session or media event. To see the QoS statistics, open a ladder diagram from a record in a Summary report and click the [+] control that precedes "QoS Statistics" at the bottom of the page. Expand QoS Stats section with the [+} control.
The following table describes each column in the QoS Stats report.
Flow ID ID number assigned to the call session or media event flow of data.
Direction The direction of the call or media event flow. CALLING—egress direction CALLED—ingress direction
Total Pkts Total number of data packets received on the interface during the active call Received session or media event.
Total Octets Total number of octets received on the interface during the active call session Received or media event.
RTCP Real-time Transport Control Protocol—used to send control packets to participants in a call.
Pkts Lost Number of RTCP data packets lost on the interface during the active call session or media event.
Avg Jitter Average measure of the variability, called jitter, over time of the RTCP packet latency across a network. A network with constant latency has no jitter. Jitter is referred to as Packet Delay Variation (PDV). It is the difference in the one- way end-to-end delay values for packets of a flow. Jitter is measured in terms of a time deviation from the nominal packet inter-arrival times for successive packets.
Max Jitter Maximum measure of the variability, called jitter, over time of the RTCP packet latency across a network. A network with constant latency has no variation jitter.
6-13 Chapter 6 Monitor and Trace
Avg Latency Average observed one-way signaling latency during the active window period. This is the average amount of time the signaling travels in one direction.
Max Latency Maximum observed one-way signaling latency during the sliding window period. This is the maximum amount of time the signaling travels in one direction.
RTP Real-Time Transport Protocol—a standard packet format for delivering audio and video over the internet.
Pkts Lost Number of RTP data packets lost on the interface during the active call session or media event.
Avg Jitter Average measure of the variability, called jitter, over time of the RTP packet latency across a network. A network with constant latency has no jitter. Jitter is referred to as Packet Delay Variation (PDV). It is the difference in the one- way end-to-end delay values for packets of a flow. Jitter is measured in terms of a time deviation from the nominal packet inter-arrival times for successive packets.
Max Jitter Maximum measure of the variability, called jitter, over the time of the RTP packet latency across a network. A network with constant latency has no jitter.
QoE Quality of Experience—measurement used to determine how well the network is satisfying the end user's requirements.
R-Factor Rating Factor—An average Quality of Service (QoS) factor observed during the active window period. QoS shapes traffic to provide different priority and level of performance to different data flows. R-Factors are metrics in VoIP that use a formula to take into account both user perceptions and the cumulative effect of equipment impairments to arrive at a numeric expression of voice quality. This statistic defines the call or transmission quality, which is expressed as an R factor.
MOS Mean Opinion Score (MOS) score—MOS is a measure of voice quality. MOS provides a numerical indication of the perceived quality of the media received after being transmitted and eventually compressed using Codecs.
Display QoS Statistics
When you want to view QoS statistics for a call or media flow session, you can do so from a ladder diagram in Monitor and Trace. 1. Under the Monitor and Trace tab, select one of the following summaries: • Sessions • Registrations • Subscriptions • Notable Events 2. On the Summary page, select a row in the table and right-click. 3. On the pop-up menu, click Ladder Diagram. 4. On the ladder diagram, click the [+] to expand the QoS Stats section.
6-14 Chapter 6 Monitor and Trace
SIPREC Call Data Example
The following example shows SIP Monitor and Trace output for a call with media forwarded by way of SIPREC.
Hairpin Call Data Example
The following example shows SIP Monitor and Trace output for a hairpin call. The Media Flow Hairpin indication is highlighted.
6-15 Chapter 6 Monitor and Trace
Configure SIP Monitoring
You must enable SIP Monitoring and configure the options for displaying session data and notable event data on the Monitor and Trace page. • Configure any filters that you want, if you don't want to monitor all SIP traffic. See "Filter Configuration." The only required setting is State, which enables SIP Monitoring. You can optionally monitor all filters and you can specify one or more filters to monitor. You can specify a time for short session duration monitoring and you can configure interesting events to monitor.
1. Access SIP Monitoring: Configuration, Session Router, SIP Monitoring. 2. On the SIP Monitoring page, do the following.
Match Any Select to monitor all SIP traffic. Default: Disabled. Filter
State Select to enable SIP monitoring.
Short Session Enter a value, in seconds, for the maximum session duration of a Duration short session. Default: 0. Range 0-999999999.
Monitoring Create a global list of monitoring filters. Filters
Interesting Create a global list of interesting events to monitor. Events Click Add, and do the following: • Type—Select an event type from the drop-down list. Default: None. Valid values: Short Session, Local Rejection. • Trigger Threshold—Set the number of events required to occur in within the trigger window before the system starts monitoring. Default: 0. Range: 0-999999999. • Trigger Timeout—Set the amount of time, in seconds, that the monitoring persists. Default: 0. Range: 0-999999999, • Click OK. The system displays the SIP monitoring page.
3. Click OK. 4. Save the configuration. • View the SIP Session Summary and SIP Notable Event Summary on the Monitoring tab.
6-16 Chapter 6 Monitor and Trace
Search for a Report Record
Use the Search button at the top of the report page to help you find a specific record in an Oracle® Enterprise Session Border Controller (E-SBC) Monitor and Trace report. Search allows you to specify criteria for the search. You can specify a value for any or all of the fields in the Search field. The search process searches for records with all of the values you specify and displays only the records with those values. When you perform a Global Search and specify values in other fields, the search process searches the other specified fields first and then filters on the Global Search field. • If you specify the “*” character in a search string, the search is performed on that exact string. For example, if you search for “123*45”, the search shows results for all strings containing “123*45”. • You can use quotes (“ “) to specify a search. For example, you can enter Smith and the search finds all of the records that match Smith, such as: John Smith field
1. On any reports page, click Search and do the following in the Search Filter dialog.
Global Search— Enter the URI formatted string of the call source information you Search all are searching. Valid values: alpha-numeric characters. For parameters in all example, sipp From URI—Search Enter the URI formatted string that contains a protocol, name, on the From-URI location, or any other applicable characteristic, that is sent by the header. E-SBC in the FROM header. Valid values: alpha-numeric characters. For example, sip:[email protected]:5060. Request URI— Enter the URI formatted string that contains a protocol, name, Search on the location, or any other applicable characteristic, that is sent by the Request-URI E-SBC in the REQUEST header. Valid values: alpha-numeric header. characters. For example, sip:[email protected]:5060. To URI—Search on Enter the URI formatted string of the call destination information the To-URI header. you want to find. Valid values: alpha-numeric characters. For example, sut Start Date— Search • Enter a starting date to search on in the first text box in the from messages that format YYYY-MM-DD (where Y =year, M=month, and D=day). start at the specified For example, 2012-04-15 would search for all records ending date and time. on April 15, 2012. Valid values: numeric characters only. • Enter a start time to search on in the last three text boxes in the format HH mm ss (where H=hour, m=minutes, and s=seconds). For example, 01 30 45 would search for all records starting at 1:30 and 45 seconds. Valid values: numeric characters only. 6-17 Chapter 6 Monitor and Trace End Date—Search • Enter an end date to search on in the first text box in the format from messages that YYYY-MM-DD (where Y =year, M=month, and D=day). For end at the specified example, 2012-04-15 would search for all records starting on date and time. April 15, 2012. Valid values: numeric characters only. • Enter an end time to search on in the last three text boxes in the format HH mm ss (where H=hour, m=minutes, and s=seconds). For example, 01 30 45 would search for all records ending at 1:30 and 45 seconds. Valid values: numeric characters only. Session ID—Search Enter the ID of the call session you want to search. Valid values: on the monitored alpha-numeric characters. For example, [email protected]. SIP session ID, as shown in the Summary table. In Call ID—Search Enter the ID of the incoming call (phone number and source IP on the SIP call ID of address). Valid values: alpha-numeric characters. For example, the initial received [email protected]. request. Out Call ID—Search Enter the ID of the outgoing call (phone number and IP address). on the SIP call ID of Valid values: alpha-numeric characters. For example, the first routed [email protected]. request. State (with result Enter the status of the call session with the result code for which code)—Search on you want to search. Result codes can range from 1xx to 5xx. For the state of the call, example, terminated-200, or failed-400. Case-sensitive. Valid as shown in the values: Summary table. • INITIAL— Notable Event— Select the notable event that you want to find. Valid values: Search on a notable • any event—Search displays any notable event that was stored event type that you in memory. select from the drop-down list. • short session—Search displays only records that indicate a short-session duration occurred. • local rejection— Search displays only records that indicate a local-rejection occurred. In Realm—Search Enter the name of the realm to which the incoming call belongs. the realm from Valid values: alpha-numeric characters. For example, access. which the initial request was received. 6-18 Chapter 6 Monitor and Trace Out realm—Search Enter the name of the realm to which the outgoing call belongs. the realm to which Valid values: alpha-numeric characters. For example, backbone. the first routed request was sent. Destination Agent— Enter the name of the session agent (SA) on the incoming call Search on the name session. Valid values: alpha-numeric characters. For example, of the session agent SA1. from which the initial request was received. Destination Session Enter the name of the session agent (SA) on the outgoing call Agent—Search on session. Valid values: alpha-numeric characters. For example, the realm to which SA2. the first routed request was sent. Ingress Destination Enter the source IP address of the SA that accepted the incoming Address—Search call session. You must enter the IP Address in dotted decimal on the IP address format (0.0.0.0). For example, 172.45.6.7. from which the initial request was received. Egress Destination Enter the destination IP address of the SA that accepted the Address—Search outgoing call session. You must enter the IP Address in dotted on the IP address to decimal format (0.0.0.0). For example, 172.64.56.7. which the initial request was sent. In Network Interface Enter the incoming core network interface that connects the E-SBC —Search on the IP to your network. You must enter the IP Address in dotted decimal address on which format (0.0.0.0). For example, 192.45.6.7. the initialƒ request was received. Out Network Enter the outgoing network interface that connects theE-SBC to Interface—Search the outside network. You must enter the IP Address in dotted on the IP address decimal format (0.0.0.0). For example, 192.45.6.8. that was the source for the routed request. 2. Click Search. Export Monitor and Trace Information to a Text File Monitor and Trace allows you to export Monitor and Trace information to a text file from the Sessions, Registrations, Subscriptions, and Notable Events Reports. To export report information, do one of the following: • Select a row and click one of the export buttons displayed above the report list. • Select a row, right click, and click an export operation on the menu. • Click the ellipses on a row and click an export operation on the menu. 6-19 Chapter 6 Monitor and Trace The following list describes the export commands. Diagram Exports all of the information in the Ladder Diagram (Session Summary, SIP Message Details, and QoS statistics), to an HTML file format. Session Exports detailed information about the SIP messages and media Details events in the Ladder Diagram associated with the selected session, to a file in text format. Summary Exports all logged session summary records to a file in text format. Export Report Information to a Text File To export information from a Monitor and Trace report to a text file: Note: The GUI exports Ladder Diagrams as HTML files. 1. Access the Monitor and Trace tab. 2. On the Monitor and Trace page, select a report type. 3. On the report Summary page for the selected report type, select a report from the list, right-click, and click one of the following: • Click Export diagram. • Click Export session details. • Click Export summary. The system downloads the report in a file at the bottom of your screen. 6-20 7 Widgets Tab Operations The Web GUI displays the Widgets tab, which you can use to access graphical views of System, Media, and Signaling data about the Oracle® Enterprise Session Border Controller. Each Widget corresponds to an ACLI show command. On the Widgets tab, you can click links to the Widgets for viewing and you can add Widgets to the Dashboard and your Favorites list. Topics: • Widgets Access and Behavior Widgets Access and Behavior The Widgets tab displays links to the lists of Media, Signaling, and System Widgets in the navigation pane. The navigation pane also includes a link to Favorites, where you can create a list of Widgets that you view often. The center pane displays links to the individual Widgets corresponding to the category link you clicked in the navigation pane. You can click a link in the center pane to see the corresponding data. To see the list of Widgets available for a category, click the twister to the right of the category in the navigation pane and the system displays the list. The following screen capture show the Media category expanded to show the list of available Widgets. 7-1 Chapter 7 Widgets Access and Behavior To see the data that a Widget displays, click the Widget in either the navigation pane or the center pane. The system displays the data in the center pane. The following screen capture shows an example of the Media Classify Widget data display. Each Widget contains the controls that you need to manage the particular Widget, according to the purpose of the Widget. The controls display in the upper right corner of the Widget. To learn what each control does, hover over the control. The following list describes the Widget controls. 1. Refresh—Updates the data in the Widget. 2. Settings—Displays the dialog where you set the data sampling parameters for the Widget. When you click the icon, the Widget displays the Settings dialog, where you can set the auto-refresh interval and other parameters that apply to the particular Widget. 7-2 Chapter 7 Widgets Access and Behavior 3. Export—Sends the data to the location you specify. 4. Add—Adds this Widget to the Dashboard. 5. Favorites—Adds this Widget to your Favorites list in the navigation pane on the Monitor and Trace page. 6. Show Information—Describes the data display. For example, in the Current Memory Usage Widget, the information icon says, "Pie graph displays current percentage of free and allocated memory." Media Widgets and Descriptions The following table lists all of the Media widgets in the left column. The middle column displays the corresponding ACLI show command. The right column describes the data that the Widget displays. Widget Show Command Description Media Classify show media classify Displays network processor statistics. Media Host Stats show media host-stats Displays statistics for the host processor, including the number and types of packets received at a specific port. MBCD Acls show mbcd acls Displays Middlebox Control Daemon (MBCD) Access Control statistics. MBCD All show mbcd all Displays related to many of the show MBCD sub-commands. The widget shows only those MBCD messages that show statistics. MBCD Errors show mbcd errors Displays MBCD error statistics. MBCD Realms show mbcd realms Displays statistics of all MBCD realms. MBCD Statistics show mbcd statistics Displays information related to media flows established by the MBCD task. NAT By Index show nat by-index Displays the specified range of entries in the NAT table, with a maximum of 5024 entries. The default range is 1-200. The range corresponds to the line numbers in the table, not to the number of the entry. NAT in Tabular show nat in-tabular Displays a specified range of entries in the NAT table. Realm Specifics realm-specifics Displays all realm-specific configuration based on the specified realm-id. Realm Summary show realm Displays the realm summary statistics. Xcode Codecs show xcode codecs Displays counts of codec pairs and ptime transrating in use. Xcode Load show xcode load Displays the transcoding resources in use. 7-3 Chapter 7 Widgets Access and Behavior Widget Show Command Description Xcode Xlist show xcode xlist Displays the XCode Xlist. Signaling Widgets and Descriptions The following table lists all of the Signaling widgets in the left column. The middle column displays the corresponding ACLI show command. The right column describes the data that the Widget displays. Widget Show Command Description DNS show dns Displays statistics for the DNS configuration. ENUM show enum Displays ENUM statistics. Fraud Protection All show fraud-protection all Displays all Fraud Protection entries. Fraud Protection Blocklist show fraud-protection blocklist Displays the Fraud Protection blocklist entries. Fraud Protection Rate limit show fraud-protection rate limit Displays the Fraud Protection rate limit list entries. Fraud Protection Re-direct show fraud-protection redirect Displays the Fraud Protection redirect list entries. Fraud Protection Allowlist show fraud-protection allowlist Displays the Fraud Protection allowlist entries. Fraud Protection All Matches show fraud-protection all Displays the Fraud Protection matches-only match-only entries. Fraud Protection Blocklistlist show fraud-protection blocklist Displays the Fraud Protection Matches matches-only blocklist match-only entries. Fraud Protection Rate Limit show fraud-protection rate limit Displays the Fraud Protection Matches matches-only rate limit match-only entries. Fraud Protection Redirect show fraud-protection redirect Displays the Fraud Protection Matches matches-only redirect match-only entries. Fraud Protection Allowlist show fraud-protection allowlist Displays the Fraud Protection Matches matches-only allowlist match-only entries. Fraud Protection Summary show fraud-protection stats Displays the Fraud Protection summary. H323d show h323d Displays H323 statistics. LDAP show ldap Displays LDAP statistics. LRT show lrt Displays the Local Routing Table statistics. Recording show rec Displays SIP REC statistics for the Recording Agent. Registration by Realm show registration sipd by Displays calls that registered realm through a specified ingress realm for which you want to view cache information. Registration H323 d show registration h323d Displays H323d registrations. Registration SIP show registration SIP Displays SIP registrations. Registration Statistics show registration statistics Displays a table of counters showing the total and periodic number of registrations by protocol. 7-4 Chapter 7 Widgets Access and Behavior Widget Show Command Description Sessions show sessions Displays the session capacity for license and session use. Agent Details show sipd agents Displays statistics related to defined DIP session agents. Agent Groups show sipd groups Displays cumulative information for all session agent groups. Agent Individual show sipd agents 7-5 Chapter 7 Widgets Access and Behavior Widget Show Command Description SIP Realms All show sipd realms Displays realm statistics related to SIP processing. SIP Realms Individual show sipd realms System Widgets and Descriptions The following table lists all of the System widgets in the left column. The middle column displays the corresponding ACLI show command, when there is one. The right column describes the data that the Widget displays. Widget Show Command Description Accounting show accounting Displays a summary of statistics for configured external accounting servers. ACL show acl all Displays cumulative and per- interface statistics on ACL traffic and drops, displaying Recent, Total, and PerMax counts. The display also separates traffic from trusted from untrusted sites. Alarms show alarms Displays existing alarms and allows you to clear them. Authentication RADIUS show radius all Displays the status of established RADIUS accounting connections. Authentication TACACS show tacacs stats Displays statistics related to communications between the E-SBC and configured TACACS servers . Communications Monitor show comm-monitor errors Displays Communications Errors Monitor aggregate error statistics information. 7-6 Chapter 7 Widgets Access and Behavior Widget Show Command Description Communications Monitor show comm-monitor internal Displays Communications Internal Monitor aggregate internal statistics information. Communications Monitor Stats show comm-monitor stats Displays statistics related to connections between the E- SBC Communications Monitor probe and any configured Communications Monitor servers. Editing Configuration show configuration Displays the current editing configuration. Editing Configuration Short show configuration short Displays only the parameters that you modified in the editing configuration. Configuration Inventory show configuration inventory Displays the editing and running configuration inventory of all configured elements. Running Configuration show running-config Displays the current running configuration. Running Configuration Short show running-config short Displays only the parameters that you modified in the running configuration. Configuration Version show version Displays the configuration version number table. Highest Task CPU Usage No show command Displays a line graph with 5-10 tasks with the highest CPU usage in percent, during a specific period of time. Highest Task CPU Usage No show command Displays a table with 5-10 tasks with the highest CPU usage in percent, during a specific period of time. Current Disk Usage Pie Graph No show command Displays the current disk usage in a pie graph. Current Disk Usage Table No show command Displays the current disk usage in a table. Features show features Displays the features that are currently enabled, based on added licenses. Interfaces show interfaces Displays all of the information concerning the rear interfaces. Interfaces Brief show interfaces brief Displays key running statistics about the rear interfaces in one graphic. Interface Mapping show interface mapping Displays the configured physical interfaces with their MAC addresses and label. Virtual Interfaces show virtual interfaces Displays the virtual interfaces for signaling services. Wancom show Wancom Displays negotiated duplex mode and speed for all system control interfaces. 7-7 Chapter 7 Widgets Access and Behavior Widget Show Command Description ARP Info show arp info Displays the current Internet- to-Ethernet address mappings in the ARP table. ARP Statistics show arp statistics Displays ARP statistics. ARP Summary show arp Displays the current Internet- to-Ethernet address mappings in the ARP table. IP Connections show ip connections Displays all TCP and UDP connections. Neighbor Table show neighbor table Displays the IPv6 neighbor table and validates that an entry for the link local address exists and that the gateway uses that MAC address. Routes show routes Displays the current system routing table. IP Summary show ip Displays IP statistics. IP TCP show ip tcp Displays all TCP statistics. IP UDP show ip udp Displays all UDP statistics. Licenses license Displays existing licenses and allows you to add or delete them. Current Memory Usage No show command Displays the current percentage of free and allocated memory in a pie graph. Current Memory Usage No show command Displays the current percentage of free and allocated memory in a table. Historical Memory Usage No show command Displays a line graph of the kilobytes of free and allocated memory over a period of time. Historical Memory Usage No show command Displays a table of the kilobytes of free and allocated memory over a period of time. Memory Summary show memory Displays statistic related to the memory. Platform All show platform all Displays full platform information. Platform CPU load show platform cpu-load Displays current CPU load. Platform Errors show platform errors Displays service pipe write errors. Platform Limits show platform limits Displays platform related limits. PROM Info show prom info all Displays all available PROM information. Temperature show temperature Displays the temperature in Celsius for all components with temperature sensors. Processes show processes Displays statistics for all active processes. 7-8 Chapter 7 Widgets Access and Behavior Widget Show Command Description SNMP Community Table show snmp-community-table Displays all information for configured SNMP communities including requests and responses for each community. Trap Receiver show trap-receiver Displays trap receiver information for each configured SNMP community. SPL Memory show spl memory Displays SPL memory for each task SPL engine. SPL Options show spl-options Displays information on all SPL options. SPL Statistics show spl statistics Displays statistics for all tasks. SPL Version show spl Displays the version of the SPL engine. System Health show health Displays the system health table for HA pairs. TDM Channels show tdm channels Displays the TDM b and d channel configurations. TDM Dialplan show tdm dialplan Displays the TDM dial plan configuration. TDM Spans show tdm spans Displays the TDM spans configuration. TDM Status show tdm status Displays the status of TDM operations. Clock show clock Displays the current date and time. NTP Server show ntp server Displays information about the quality of the time used for offset and the delay measurement maximum error bounds. NTP Status show ntp status Displays information about configuration status, NTP daemon synchronization, NTP synchronization in process, and if NTP is not responding. Time Zone show timezone Displays the time zone. Clock UTC show clock utc Displays the current date and time in Coordinated Universal Time (UTC). Uptime show uptime Displays information about the length of time the system has been running in days, hours, and seconds. Also displays the current date and time information. User Management show users Displays a table that lists all users currently logged on to the system. Version Boot show version boot Displays the boot version. Version CPU show version cpu Displays the CPU version. 7-9 Chapter 7 Widgets Access and Behavior Widget Show Command Description Version Hardware show version hardware Displays the hardware version. Version Image show version image Displays the image version. Version Summary show version Displays the Operating System version information, including the OS version number, the manufacturing date of the current version, and other details. Licenses Widget The Licenses widget on the Web GUI provides a workspace where you can view, add, and delete Oracle® Enterprise Session Border Controller (E-SBC) licenses. On the Widgets tab, click System and then click Licenses. The following screen capture shows and example of the Licenses page, which displays the license name, the entitled number of sessions, the installation date, the begin date, and the expire date. The License widget includes the same toolbar in the top, right-hand corner that Widgets on the Dashboard display. Note that the License widget does not include the Settings icon and the Auto-refresh function because these operations do not apply to licenses. The Licenses page displays a list of your E-SBC licenses with the following information. License The name of the license. Session Count The number of session entitlements for the license. Install Date The date when the license is added to the system. Begin Date The date when the license begins service. Expire Date The date when the license ends service. If you want to see the details of a particular license, click the twister by the license name to expand the view to show all of the details, which display in text below the selected license. The text states the number of allowed sessions and lists all of the features included in the license. The following screen capture shows an example of license details. 7-10 Chapter 7 Widgets Access and Behavior When you click License, the system displays the License dialog, where you enter the license serial number. When you select a license from the Licenses list and click the delete icon, the system displays the delete Confirmation dialog. The Set License function, located under System Operations on the System tab, links to the License widget so you can view your licenses from the Set License dialog. After launching Set License, use the "View current license information" button in the Set License dialog to see a view-only list of your E-SBC licenses. The only operations allowed in view mode are Refresh and Download. 7-11 8 System Tab Operations The System tab provides links to system-wide file management and configuration dialogs for the Oracle® Enterprise Session Border Controller (E-SBC). When you first configure the E- SBC, you need to set boot parameters and licenses, for example. After running the E-SBC, you might want to see Audit Logs or add an SPL Plug-in, for example. The System tab divides such tasks into groups called File Management and System Operations. Each group displays links to tasks you might want to perform. Topics: • Configuration Assistant Operations • System File Management Types and Descriptions • System Operations Configuration • Force an HA Switch Over • System Restart • Obtain Support Information - Chrome Browser • Obtain Support Information - Firefox Browser Configuration Assistant Operations When you first log on to the Oracle® Enterprise Session Border Controller (E-SBC), the system requires you to set the configuration parameters necessary for basic operation. To help you set the initial configuration with minimal effort, the E-SBC 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 E-SBC 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 System File Management Types and Descriptions After using the Oracle® Enterprise Session Border Controller (E-SBC), you might want to view and manage some of the system-wide files. For example, you might want to see the 8-1 Chapter 8 System File Management Types and Descriptions Audit Log or refresh the Fraud Protection Table. You can find links to such tasks under the File Management heading on the System tab. The following screen capture shows the list of File Management links on the System tab. The following table lists the file type, formats, and description of the files you can manage from the System tab. File Type Format Description Audit 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. 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. Configuration Template .gz Upload, download, and delete configuration templates. Fraud Protection Table .gz, .gzip, .xml Contains fraud protection files that you can upload, download, delete, or open to modify. 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. 8-2 Chapter 8 System File Management Types and Descriptions File Type Format Description 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. Playback Media Any media format valid in an Contains call progress RTP audio stream 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 .bz or .tar Contains bootable images. 8-3 Chapter 8 System File Management Types and Descriptions File Type Format Description SPL Plug-in .lua or .spl 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. N o t e : B e f o r e y o u s e l e c t t h e A c ti v a t e o p ti o n d u ri n 8-4 Chapter 8 System File Management Types and Descriptions File Type Format Description g t h e u p l o a d , c o n fi r m t h a t t h e f o ll o w i n g c o n d it i o n i s m e t. Y o u m u s t a d d 8-5 Chapter 8 System File Management Types and Descriptions File Type Format Description a S e s s i o n B o r d e r C o n t r o ll e r P r o g r a m m i n g L a n g u a g e ( S P L ) p l u g - i n fi 8-6 Chapter 8 System File Management Types and Descriptions File Type Format Description l e t o t h e s p l- c o n fi g e l e m e n t b e f o r e t h e s y s t e m c a n e x e c u t e t h e p l u g - 8-7 Chapter 8 System File Management Types and Descriptions File Type Format Description i n . T h e s y s t e m i g n o r e s a n y S P L p l u g - i n t h a t e x i s t s i n t h e / c o d e / s p 8-8 Chapter 8 System File Management Types and Descriptions File Type Format Description l d ir e c t o r y t h a t i s n o t i n c l u d e d i n t h e s p l- c o n fi g e l e m e n t. 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. 8-9 Chapter 8 System File Management Types and Descriptions Control Description 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. The only non- alphabetical characters allowed in file names for upload are parens, full stop, and space. The system verifies that the file name syntax is correct before uploading and displays an error message when the syntax is incorrect. 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). Download Download a single file or a group of selected 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 Delete a single file or a group of selected files from the E-SBC. Delete All (Log files, only.) Deletes all Log files from the E-SBC. Buttons and Controls on File Management Pages Each File Management page displays a set of buttons and controls for managing the information. The buttons and controls that display vary according to the purpose of the page. The following tables show you which buttons and controls apply to each file type. File Management Buttons The following table provides a quick reference for finding which buttons apply to the system files that you can manage. Table 8-1 File management buttons available by file type Refres Upload Backu Add Delete Delete Downl Downl Restor h p All oad oad All e Backup √ √ √ √ √ √ Configu √ √ ration CSV Local √ √ Route Table 8-10 Chapter 8 System Operations Configuration Table 8-1 (Cont.) File management buttons available by file type Refres Upload Backu Add Delete Delete Downl Downl Restor h p All oad oad All e Fraud √ √ √ Protecti on Table Log √ √ √ Audit √ Log Playbac √ √ k Media Softwar √ √ e Image SPL √ √ Plug-in Configu √ √ √ √ ration Templat e System Operations Configuration When configuring the Oracle® Enterprise Session Border Controller (E-SBC), you must configure certain settings that affect the system globally. For example, boot parameters and licenses. You can find links to such tasks under the System Operations heading on the System tab. The following screen capture shows the list of System Operations links on the System tab. The following table describes the configurations you can set from the System tab. Configuration Description Set Boot Parameters Specify the boot file and the boot parameters. 8-11 Chapter 8 Force an HA Switch Over Configuration Description Set Entitlements Set the number of sessions that a license entitles you to, and enable advanced features. Set Initial Configuration Configure a new E-SBC or reconfigure an existing one. Includes configuring High Availability. Set License Enter the license number for a feature that requires a license. Set Login Banner Customize the text on the Web GUI log on banner. Set Time Zone Set the time zone for the deployment. Upgrade Software Upload a newer version of the software. 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. Click Force HA switchover. The system displays the Confirm dialog. 3. Click Confirm. 4. On the Force HA switch over page, click Switch to standby. The system performs the role change. System Restart You can manually restart 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 restart completes. When the restart completes, the active and standby systems each display the log on screen and you must manually log on to each system. 8-12 Chapter 8 Obtain Support Information - Chrome Browser Note: When you restart the system from the Web GUI, the Web GUI is unavailable until the restart completes. When you perform a restart from the Web GUI The system behaves and no boot is in process and the system is not the GUI session closes and the system displays switching over to the standby system of an HA the Log On screen. You cannot log on to the Web pair, GUI until the restart completes on the E-SBC. and a restart is already in progress, the system displays a message stating that a restart cannot occur. The first restart must complete before another restart is initiated. and the active system is currently switching over to the system displays a message stating that a the standby system in an HA environment, restart 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 - Chrome Browser 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. (Optional)To 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 tab, Support Information. 2. Click Support Information. The system displays the confirmation dialog. 3. Click Confirm. The system generates the file. 4. The browser asks you to do one of the following: The system generates and saves the file to the Download directory or to another location that you specify. 8-13 A Keyboard Commands and Shortcuts for the E-SBC Web GUI You can use the following keyboard commands and shortcuts to navigate and operate the Oracle® Enterprise Session Border Controller (E-SBC) Web GUI. Navigate between screen elements Action Keyboard Command Behavior Navigate forward between Tab Navigate top to bottom and left screen elements. to right between tab groups. Navigate backwards between Shift+Tab Navigate bottom to top and right screen elements. to left between tab groups. Navigate within screen elements Action Keyboard Shortcut Behavior Navigation within a tab group. Up Arrow or Down Arrow Highlight the component in the direction of the arrow. Navigate drop-down lists Action Keyboard Shortcut Behavior Trigger a drop-down list. Up Arrow or Down Arrow Highlight the option item in the direction of the arrow. When the drop-down is not open, expand the drop-down list. Select a drop-down element Enter Select the highlighted choice from the drop-down list. Close the drop-down list Esc Collapse the drop-down list. When the drop-down is closed, do nothing. The focus on drop-down list Tab In Move the focus to the previous or next selected item. Select many Action Keyboard Shortcut Behavior Select box in a select many Left Arrow or Right Arrow Move the focus to the previous component. or next selected item. Selected item with remove icon Backspace or Delete Remove the selected item. in a select many component. A-1 Appendix A When the focus is on a table column header Keyboard Shortcut Behavior Tab Navigate to next the focusable element on the page (outside table). Shift+Tab Navigate to previous the focusable element on the page (outside table). Down Arrow Move the focus to the first row. Left Arrow Move the focus to the previous column header. When there is no previous column, do nothing. Right Arrow Move the focus to the next column header. When there is no next column, do nothing. Home Move the focus to the first column header. End Move the focus to the last column header. When the focus is on a cell in a table Keyboard Shortcut Behavior Tab When the focus is on a row and the row is actionable, Tab moves the focus to the next the focusable element within the row. When the focus is already on the last the focusable element, the focus wraps to the first the focusable element in the row. Shift+Tab When the focus is on a row and the row is actionable, Shift+Tab moves the focus to the previous the focusable element within the row. When the focus is already on the first the focusable element, the focus wraps to the last the focusable element in the row. Down Arrow Move the focus to the next row. Shift+Down Arrow Select and move the focus to the next row, if the row is selectable. Up Arrow Move the focus to the previous row. When already at the first row, move to the column header. Home Move the focus to the first row. End Move the focus to the last row. Space Select a row, if the row is selectable. Enter If the table edit Mode is row Edit, then make the current row editable. When the table edit Mode is none, toggle the current row to actionable mode if there exists a tabbable element in the row. Once toggled to the actionable mode, the focus moves to be first tabbable element in the row. A-2 Appendix A When the cell in focus is in an editable row Keyboard Shortcut Behavior Tab Move the focus to the next editable cell or the focusable element in the row. When the focus is on the last editable cell or the focusable element in the row, make the next row editable and move the focus to the first editable cell or the focusable element in the next row. When the focus is on the last editable cell or the focusable element in the last row, move the focus to the next the focusable element on the page (outside of the table). Shift+Tab Move the focus to the previous editable cell or the focusable element in the row. When the focus is on the first editable cell or the focusable element in the row, make the previous row editable and move the focus to the last editable cell or the focusable element in the previous row. When the focus is on the first editable cell or the focusable element in the first row, move the focus to the previous the focusable element on the page (outside of the table). Enter Make the next row editable and move the focus to the editable cell in current column in the next row. When enter is pressed when in the last editable row, make it read only. Shift+Enter Make the previous row editable and move the focus to the editable cell in current column in the previous row. When enter is pressed when in the last editable row, make it read only. F2 Toggle the current row between editable and read only. Esc Make the current row read only. Sort on a column Action Keyboard Shortcut Behavior Sort on a column. Enter When the column is sortable it will sort the column, or else do nothing. Access a context menu Action Keyboard Shortcut Behavior To access context menu. Shift+F10 Opens the context menu when it is available on the focused component. A-3 Appendix A Move a scroll bar in a table Action Keyboard Shortcut Behavior Scroll Up Arrow or Down Arrow Moves the scroll bar in the direction of the arrow. When the focus is on any Shift + Up Arrow or Down Moves the scroll bar in the other component, to scroll. Arrow direction of the arrow. When the focus is on a collapsible header Keyboard Shortcut Behavior Space or Enter Toggle disclosure state. Tab Navigate to the next collapsible header and when there is none, go to the next element on the page. Shift+Tab Navigate to the previous collapsible header and when there is none, go to the previous element on page. Up Arrow or Left Arrow (Right Arrow in RTL) Move the focus to the previous collapsible header with wrap around. Down Arrow or Right Arrow (Left Arrow in Move the focus to the next collapsible header RTL) with wrap around. Home Move the focus to the first collapsible header. End Move the focus to the last collapsible header. When the focus is on a button Keyboard shortcut Behavior Enter or Space Push the button or Toggle the button or Open the menu depends on type of button. Esc Closes the menu. When the focus is on a chart Keyboard shortcut Behavior Tab Move the focus to next element. Shift + Tab Move the focus to previous element. Up Arrow Move the focus and selection to the previous data item. Down Arrow Move the focus and selection to the next data item. Left Arrow Move the focus and selection to the previous data item on the left. Right Arrow Move the focus and selection to the next data item on the right. Page Up Pan up when scrolling is enabled. Page Down Pan down when scrolling is enabled. A-4 Appendix A Keyboard shortcut Behavior Enter Drill down on a data item, categorical axis label, or legend item when drilling is enabled. When the focus is on check box set Keyboard Shortcut Behavior Tab In Set the focus to the first item in the focusable check box in the check box set. Disabled check boxes are not focusable. If hints, Help Instruction, or messages exist in a note window, pop up the note window. When the focus is on a check box Keyboard Shortcut Behavior Space Toggles the check box. When the check box is unselected, it will select it and vice versa. Tab Sets the focus to the next the focusable check box in the check box set. Disabled check boxes are not the focusable. When the target is the last the focusable check box in the check box set, the focus goes to the next the focusable item after the check box group. Shift+Tab Sets the focus to the previous focusable check box in the check box set. Disabled check boxes are not the focusable. If the target is the first focusable check box in the check box set, the focus goes to the previous focusable item before the check box group. When working in a dialog Action Keyboard shortcuts Behavior When the focus is on a dialog Esc Close the dialog. When the focus is on a dialog Enter or Space Close the dialog. close icon When the focus is on a file picker Keyboard shortcut Behavior Enter Launch the browser©s file picker. When the focus is on a date input element Keyboard shortcut Behavior Down Arrow or Up Arrow Shows the calendar grid and moves the focus into the expanded grid. Esc Close the grid. A-5 Appendix A Keyboard shortcut Behavior Tab In Set the focus to the input. If hints, title or messages exist in a note window, pop up the note window. When the focus is on a picker Keyboard shortcut Behavior Enter Select the currently the focused day. Up Arrow Move up in the grid. Down Arrow Move down in the grid. Right Arrow Move right in the grid. Left Arrow Move left in the grid. Esc Close the grid. Home Move the focus to first day of the month. End Move the focus to last day of the month. Page Up Switch to previous month. Page Down Switch to next month. Alt + Page Up Switch to previous year. Alt + Page Down Switch to next year. Ctrl + Alt + T Places the focus on Today button if it exists. When working with input number elements Keyboard Shortcut Behavior Enter or Tab Submit the value you typed in the input field. Tab In Set the focus to input. Show user assistance text. This may be inline or in a note window depending upon the theme and property settings. Up Arrow Increment the number. Down Arrow Decrement the number. When working with other input elements Action Keyboard shortcut Behavior When the focus is on input Tab In Set the focus to the input. password element Show user assistance text. This may be inline or in a note window depending upon theme and property settings. When the focus is on input text Tab In Set the focus to the input. element Show user assistance text. This may be inline or in a note window depending upon theme and property settings. A-6 Appendix A Action Keyboard shortcut Behavior When the focus is on input Down Arrow or Up Arrow Shows the time picker and time element moves the focus into the expanded time picker. When the focus is on input Tab In Set the focus to the input. If time element hints, title or messages exist in a note window, pop up the note window. When the focus is on a Help icon Keyboard shortcut Behavior Enter If there is a URL associated with the Help icon, navigate to the URL. Tab In Show the help definition in a pop up. When the focus is on a list item Keyboard shortcut Behavior F2 Enters Actionable mode. This enables keyboard action on elements inside the item, including navigate between the focusable elements inside the item. Esc Exits Actionable mode. Tab When in Actionable Mode, navigates to next the focusable element within the item. When the last the focusable element is reached, shift the focus back to the first the focusable element. When not in Actionable Mode, navigates to next the focusable element on a page outside of List View. Shift+Tab When in Actionable Mode, navigates to previous the focusable element within the item. When the first the focusable element is reached, shift the focus back to the last the focusable element. When not in Actionable Mode, navigates to previous the focusable element on a page outside of List View. Down Arrow Move the focus to the item below. Up Arrow Move the focus to the item above. Left Arrow When the display is in card layout, move the focus to the item on the left. Right Arrow When the display is in card layout, move the focus to the item on the right. Shift+Down Arrow Extend the selection to the item below. Shift+Up Arrow Extend the selection to the item above. Shift+Left Arrow When the display is in card layout, extend the selection to the item on the left. Shift+Right Arrow When the display is in card layout, extend the selection to the item on the right. Shift+F10 Launch the context menu when there is one associated with the current item. A-7 Appendix A Keyboard shortcut Behavior Enter Selects the current item. No operation when the item is already selected. Space Toggles to select and deselect the current item. When previous items are selected, deselects them and selects the current item. Shift+Space Selects contiguous items from the last selected item to the current item. Ctrl+Space Toggles to select and deselect the current item while maintaining previous selected items Ctrl+X Marks the selected items to move if drag and drop reorder is enabled. Ctrl+C Marks the selected items to copy if drag and drop reorder is enabled. Ctrl+V Paste the items that are marked to directly before the current item or as the last item if the current item is a folder. When the focus is on a group item Keyboard shortcut Behavior Left Arrow Collapse the current item if it is expanded and is collapsible. For non-hierarchical data, do nothing. Right Arrow Expand the current item if it has children and is expandable. For non-hierarchical data, do nothing. When the focus is on menu item Keyboard shortcut Behavior Enter or Space Invoke the focused menu item©s action. Up Arrow Move the focus to the previous menu item, wrapping around at the top. Dow Narrow Move the focus to the next menu item, wrapping around at the bottom. Home Move the focus to the first menu item. End Move the focus to the last menu item. Esc Close the menu and move the focus to the launcher when the focus is on top level menu. When working with a JET Component or HTML Element having a JET Context Menu Keyboard Shortcut Behavior Shift + F10 Open the context menu A-8 Appendix A When working with message elements Action Keyboard Shortcut Behavior When the focus is on a message Esc Close the message. When the focus is on a Message Enter or Space Close the message. Close Icon When the focus is within Tab or Shift + Tab Navigate the content of the Messages messages region. When the focus is within F6 Moves the focus back to the last Messages the focused element outside the messages region. When the focus is within Esc Moves the focus back to the last Messages the focused element outside the messages region. When the focus outside F6 Move the focus to the first Messages message within the more recently disclosed messages region. When the focus is on a navigation list item Keyboard shortcut Behavior Enter or Space Selects list item. Up Arrow Moves the focus to the previous visible list item. Down Arrow Moves the focus to the next visible list item. Right Arrow (Left Arrow in RTL) For horizontal navigation list, moves the focus to the next visible item. Left Arrow (Right Arrow in RTL) For horizontal navigation list, moves the focus to the previous visible item. Home Moves the focus to the first visible list item. End Moves the focus to the last visible list item. F2 When the focus is on a list item, pressing F2 makes its contents accessible using TAB. Esc When F2 mode is enabled, press Esc to exit F2 mode. Shift +Tab Move the focus to a hierarchical menu button. Applicable only for a sliding navigation list and when a hierarchical menu button is enabled. When working with other navigation list elements Action Keyboard shortcut Behavior When the focus is on navigation Right Arrow (Left Arrow in RTL) When the focus is on a collapsed Group Item node, expands the sub list. When the focus is on navigation Left Arrow (Right Arrow in RTL) When the focus is on an Group Item expanded node, collapses the sub list. A-9 Appendix A Action Keyboard shortcut Behavior When the focus is on List Item in Esc Applicable only for a sliding sublist navigation list. When the focus is in a sub list, closes the sublist and moves the focus to the parent list item. When the focus is on Enter Open menu. Note: This target is Hierarchical Menu button visible only for a Sliding Navigation List. When the focus is on Tab Moves the focus to the current Hierarchical Menu button list item. Note: This target is visible only for a Sliding Navigation List. When the focus is on Shift + Tab Moves the focus to the Previous Hierarchical Menu button Icon. Note: This target is visible only for a Sliding Navigation List. When the focus is on Previous Enter Collapses the sublist and slides Icon or List Header to the parent list. Note: This target is visible only for a Sliding Navigation List. When the focus is on Previous Tab Moves the focus to the Icon or List Header Hierarchical Menu button. Note: This target is visible only for a Sliding Navigation List. When working with page control elements Action Keyboard shortcut Behavior When the focus is Page Tab in Set the focus to the input. Control When the focus is on Arrow Tab Set the focus to the first, Page Navigation previous, next, or last page arrow. When the focus is on Tab Set the focus to the page link. Numbered Page Links When the focus is within a pop up or on a pop up launcher Keyboard shortcut Behavior Tab or Shift Tab Navigate the content of the pop up. Close the open pop up if there are no tab stops in the pop up. F6 Move the focus to the launcher for a pop up with mode-less modality. Close the open pop up if the modality is modal. Esc Close the open pop up. F6 Move the focus to the first tab stop within the open pop up. If there is not a tab stop within the content, the focus is established on the pop up. A-10 Appendix A When the focus is on a radio button Keyboard shortcut Behavior Up Arrow Select the previous input in the group. Down Arrow Select the next input in the group. Tab In Set the focus to the checked radio input. When hints, title or messages exist in a note window, pop up the note window. When the focus is on a rating gauge Keyboard shortcut Behavior Enter Submit the current value of the gauge. Tab Move the focus to the next element and submit the current value of the gauge. Shift + Tab Move the focus to the previous element. Up Arrow Increase the gauge©s transient value. Sets the value after using Enter or Tab to submit. Down Arrow Decrease the gauge©s transient value. Sets the value after using Enter or Tab to submit. Left Arrow Decrease the gauge©s transient value in left-to- right locales. Increase the gauge©s transient value in right-to-left locales. Sets the value after using Enter or Tab to submit. Right Arrow Increase the gauge©s transient value in left-to-right locales. Decrease the gauge©s transient value in right-to-left locales. Sets the value after using Enter or Tab to submit. When working with a row expander element Action Keyboard shortcut Behavior When the focus is on a Row or Ctrl + Right Arrow Expand. Cell with RowExpander. When the focus is on a Row or Ctrl + Left Arrow Collapse. Cell with Row Expander. When the focus is on an Icon. Enter Expand or Collapse. When working with single-select elements Action Keyboard shortcut Behavior When the focus is on a single- Enter Select the highlighted choice select option item from the drop-down. When the focus is on a single- Enter Set the input text as the value. select input field When the focus is on a single- Up Arrow or Dow Narrow Highlight the option item on the select drop-down drop-down list in the direction of the arrow. If the drop-down is not open, expand the drop-down list. A-11 Appendix A Action Keyboard shortcut Behavior When the focus is on a single Esc Collapse the drop-down list. If select drop-down the drop-down is already closed, do nothing. On Tab in single select Tab In Set the focus to the Select. If hints, title or messages exist in a note window, pop up the note window. When the focus is on a status meter gauge Keyboard shortcut Behavior Enter Submit the current value of the gauge. Tab Move the focus to the next element and submit the current value of the gauge. Shift + Tab Move the focus to the previous element. Up Arrow Increase the gauge©s transient value. Sets the value after using Enter or Tab to submit. Dow Narrow Decrease the gauge©s transient value. Set the value after using Enter or Tab to submit. Left Arrow Decrease the gauge©s transient value in left-to- right locales. Increase the gauge©s transient value in right-to-left locales. Sets the value after using Enter or Tab to submit. Right Arrow Increase the gauge©s transient value in left-to- right locales. Decrease the gauge©s transient value in right-to-left locales. Sets the value after using Enter or Tab to submit. When working with a switch thumb element Action Keyboard shortcut Behavior When the focus is on Switch Enter or Space Toggle the switch value. Thumb When Switch Thumb is target Tab in Set the focus to the thumb. If hints, title or messages exist in a note window, pop up the note window. When the focus is on list items Keyboard shortcut Behavior Enter or Space Selects list item. Up Arrow Moves the focus to the previous visible list item. Dow Narrow Moves the focus to the next visible list item. Right Arrow(Left Arrow in RTL) For a horizontal tab bar, the focus moves to next visible item. Left Arrow(Right Arrow in RTL) For a horizontal tab bar, the focus moves to previous visible item. A-12 Appendix A Keyboard shortcut Behavior Home Moves the focus to the first visible list item. End Moves the focus to the last visible list item. F2 When the focus is on a list item, pressing F2 makes its contents accessible using TAB. Esc When F2 mode is enabled, press Esc to exit F2 mode. Ctrl+X Marks the current item to move when reorderable is enabled. Ctrl+V Paste the items that are marked to directly before the current item. DELETE Delete the current item. Enter or Space Open menu. Note: This is applicable only for Horizontal Tab Bar, when overflow is set to pop up. When navigating text area Action Keyboard shortcut Behavior On tabbing in text area Tab In Set the focus to the text area. Show user assistance text. This may be inline or in a note window depending upon theme and property settings. When the focus is on text area MacOS : Return Insert a new line. Used for a Windows : Enter plain text area or a nested text area where Enter is not used by the parent component for other purposes. When the focus is on text area MacOS: Option + Return Insert a new line. This is used for Windows: Alt + Enter cases where Enter is used by the parent component, such as a text area in a table, where Enter will go to the cell below in an editable table. When the focus is on a train Keyboard shortcut Behavior Tab Move the focus to the next selectable step. Shift + Tab Move the focus to the previous selectable step. Enter Select the focused step. When the focus is on a tree view item Keyboard shortcut Action Tab Navigates to next the focusable element on page. Shift+Tab Navigates to previous the focusable element on page. Dow Narrow Moves the focus to the item below. A-13 Appendix A Keyboard shortcut Action Up Arrow Moves the focus to the item above. Left Arrow On an expanded item, collapses the item. Otherwise, move the focus to the item above. The action is swapped with the Right Arrow in RTL locales. Right Arrow On a collapsed item, expands the item. Otherwise, move the focus to the item below. The action is swapped with the Left Arrow in RTL locales. Shift + Dow Narrow Extends the selection to the item below. Applicable only when the multiple or last item selection is enabled. Shift + Up Arrow Extends the selection to the item above. Only applicable if the multiple or last item selection is enabled. Space Toggles the selection of the current item and deselects the other items. Enter Selects the current item and deselects the other items. No operation when the current item is already selected. Ctrl + Space/Enter / CMD + Space/Enter Toggles the selection of the current item, while maintaining previously selected items. Only applicable if the multiple or last item selection is enabled. Shift + Space/Enter Selects contiguous items from the last selected item to the current item. Only applicable if the multiple or last item selection is enabled. Ctrl + A / CMD+A When the selection Mode is multiple, selects all selectable nodes. When the focus is on an action card Keyboard shortcut Action Enter or Space Invoke the card action. F2 Enters Actionable mode, which enables keyboard action on elements inside the item, including navigate between focusable elements inside the item. Esc Exits Actionable mode. Tab When in Actionable Mode, navigates to next focusable element within the item. When you reach the last focusable element, shift focus back to the first focusable element. When not in Actionable Mode, navigates to the next focusable element on the page (outside List View). Shift+Tab When in Actionable Mode, navigates to the previous focusable element within the item. When you reach the first focusable element, shift focus back to the last focusable element. When not in Actionable Mode, navigates to the previous focusable element on the page (outside List View). A-14