Widgets

For each show command that you can use from the ACLI to see System, Media, and Signaling data about the Oracle Enterprise Communications Broker (OECB), the system provides a corresponding Widget on the Web GUI. Widgets display the data in a graphical or textual format.

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 either the navigation pane on the Monitoring tab or from the Home 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 display 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:

You must set up a valid SIP configuration before the OECB can display any SIP data in a Widget, including the default Widgets.

The following tables list and describe the Widgets in the same order as they are displayed on the Web GUI.

System

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 OECB and configured TACACS servers .
Communications Monitor Errors show comm-monitor errors Displays Communications Monitor aggregate error statistics information.
Communications Monitor Internal show comm-monitor internal Displays Communications Monitor aggregate internal statistics information.
Communications Monitor Stats show comm-monitor stats Displays statistics related to connections between the OECB 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.
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.
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.
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.

Media

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.
Xcode Xlist show xcode xlist Displays the XCode Xlist.

Signaling

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 Black list show fraud-protection blacklist Displays the Fraud Protection blacklist 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 White List show fraud-protection white list Displays the Fraud Protection white list entries.
Fraud Protection All Matches show fraud-protection all matches-only Displays the Fraud Protection match-only entries.
Fraud Protection Blacklist Matches show fraud-protection blacklist matches-only Displays the Fraud Protection blacklist match-only entries.
Fraud Protection Rate Limit Matches show fraud-protection rate limit matches-only Displays the Fraud Protection rate limit match-only entries.
Fraud Protection Redirect Matches show fraud-protection redirect matches-only Displays the Fraud Protection redirect match-only entries.
Fraud Protection White List Matches show fraud-protection white list matches-only Displays the Fraud Protection white list 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 realm Displays calls that registered 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.
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 <agent name> Displays statistics related to the specified SIP session agent.
Client Trans show sipd client Displays statistics for SIP client events when the SBC is acting as a SIP client in the B2BUA role.
SIP Codecs show sipd codecs Displays codec usage for a realm.
SIP Errors show sipd errors Displays statistics for SIP media event errors.
Interface Individual show sipd interface Displays SIP interface statistics for the specified realm.
Interface Summary show sipd interface Displays all SIP interface statistics.
Method Ack show sipd ack Displays all SIP ACK method statistics.
Method Bye show sipd bye Displays the SIP BYE method statistics.
Method Cancel show sipd cancel Displays all SIP CANCEL method statistics.
Method Info show sipd info Displays the SIP INFO method statistics.
Method Invite show sipd invite Displays the SIP INVITE method statistics.
Method Message show sipd message Displays the SIP MESSAGE statistics.
Method Notify show sipd notify Displays the SIP NOTIFY statistics.
Method Options show sipd options Displays the SIP OPTIONS statistics.
Method Prack show sipd prack Displays the SIP PRACK method statistics.
Method Publish show sipd publish Displays the SIP PUBLISH method statistics.
Method Refer show sipd refer Displays the SIP REFER method statistics.
Method Register show sipd register Displays the SIP REGISTER method statistics.
Method Subscribe show sipd SUBSCRIBE Displays the SIP SUBSCRIBE method statistics.
Method Update show sipd update Displays the SIP UPDATE method statistics.
SIP Realms All show sipd realms Displays realm statistics related to SIP processing.
SIP Realms Individual show sipd realms <realm name> Displays realm statistics related to SIP processing for the specified realm.
SIP Redundancy show sipd redundancy Displays information about SIP redundancy.
Server Trans show sipd server Displays statistics for SIP server events when the SBC acts as a SIP server in the B2BUA role.
SIP Sessions All show sipd sessions all Displays all SIP sessions currently on the system.
SIP Sessions show sipd sessions Displays the number of sessions and dialogs in various states for the Period and Lifetime spans.
SIP Status show sipd status Displays information about SIP transactions.

Agent Status Widget

The GUI contains a widget for displaying the status of session-agents. The widget is available from the Statistics Portal.

The columns of each row display both configured and runtime information.

  • Name
  • IP Address
  • State
  • Active Calls - inbound
  • Active Calls - outbound
  • Round-Trip-Time

Because the number of session-agents might be very large, the use of paging, searching, and sorting is utilized.

User Management Interface

Grid widget

Name IP Address State Active Calls (Inbound) Active Calls (Outbound) RTT (ms)
SBC 1 192.168.1.1 IN-SERVICE 1000 1000 10
SBC 2 192.168.1.2 OUT-OF-SERVICE 0 0 0
SBC 3 172.16.1.1 IN-SERVICE 30 30 123

Performance

This Widget does not impact signaling performance, but may occasionally become unresponsive.

Broker Lookup Widget

The GUI displays a widget for performing a broker lookup. The Broker Lookup widget tests how a call is processed, based on the current dial plan, agent, and routing configuration. You enter the FROM_URI, REQUEST_URI, and Source Agent for the call and click Begin to execute the test. The widget displays all possible ways that a call with those parameters can be processed, including all hops and their associated costs.

Requirements

The Broker Lookup widget uses the Settings Panel and the Results Panel. In the Settings Panel, you enter the From-URI and Request-URI information. You can also select Source Agent information. The GUI displays the results of the lookup in the results window.

Results Analysis

The following diagram displays examples of the Dial Plan Lookup and Agent Lookup results from the Broker Lookup widget.

The text that follows this image describes its contents and meaning.

The following lists describe the results shown in the preceding examples.

Dial Plan Lookup Results

  • Universal Number—The complete universal (usually E.164) called number that the Dial Plan engine found for the information you entered.
  • Destination Context—The Dialing Context associated with the universal number.
  • Result Type—Indicates the certainty of the result. There are three possible values:
    • Best—The result is either the only result found, or is the best match. This is the universal number that will be called.
    • Ambiguous—This dial plan result conflicts with other dial plan results. The Oracle Enterprise Communications Broker (OECB) cannot route the call because the intended destination is unclear. If a result is ambiguous, there are other ambiguous results as well, and no result can be labeled as 'Best'.
    • None—This dial plan result does not conflict with others, but it is not the best result and will not be used. Another result is listed as 'Best'.

Agent Lookup Results

  • Unlabeled column—Indicates whether the row refers to the source or destination agent.
  • Number—The calling or called number, respectively, that was used to look up the agent.
  • Agent—The agent that was found for this number.
  • Agent Source—The source from which the agent was found. The OECB tries to find the agent associated with this number using the following methods in order:
    • 1. User DB
    • 2. LDAP
    • 3. URI Host (taken from the From-URI)
    • 4. Inbound Session-Agent (only applies to source agent)

Routing Lookup Results

  • Each route can be one of the following types:

    • Implicit—Routing directly to the given Request-URI.
    • Configured—A route that you configured.
    • Default—A route that you configured that matches any incoming call. For example, a route with all fields configured as asterisks.
  • This is the cost based on the routing configuration.
  • This is a visual diagram of the route, in which each individual hop is displayed as bold text, and the cost incurred by routing the call to each given hop is displayed as a box with an arrow through it.

Performance

This Widget does not impact signaling performance, but may become unresponsive.

License Widget

The License widget on the Web GUI provides a workspace where you can view, add, and delete Oracle Enterprise Communications Broker (OECB) licenses.

From the Widgets tab on the Web GUI, the system displays the Licenses page when you click Widgets, System, Licences.

The Licenses page displays a list of your OECB licenses with the following information.

If you want to see the details of a particular license, click the show-hide toggle by the license name to expand the view to show all of the details. The following illustration shows an example of license details.

This image is a screen capture showing a sample display of license details the SBC displays when you choose to view the license details. Details include the license type, session count, installation date, begin date, and expiration date..

The Licenses widget provides the controls to Add and Delete licenses.

When you click Add, the system displays the Set license dialog.

When you select a license from the Licenses list and click Delete, the system displays the delete Confirmation dialog.

The License widget includes the Refresh, Download, Add to Dashboard, Pin to Favorites, and Help icons, familiar from other widgets, in the top, right-hand corner. 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 Set License wizard is linked to the License widget, so that you can view your licences from the wizard. After launching the Set License wizard, use the "View current license information" link in the Set License dialog to see a view-only list of your OECB licenses.

This image is a screen capture of the Set License dialog showing the link you can click to view a list of your current licenses.

The only operations allowed in view mode are Refresh and Download.

Registration Cache Dashboard Widget

The dashboard displays the SIP Registarions Cache widget for registration cache entries. The registration cache is implemented in the SIP tasks. The dashboard widgets back-end is implemented in web tasks. The SIP task will walk all SIP users, using the new users SPL API. The entire registration cache is displayed. This information will be packaged and sent back to the web task. The response will be parsed in the web task and returned to the user in the form of a widget. Multiple (AOR) contacts are displayed with the same user name, different contacts.

Widget Columns

The SIP registration cache table displays the following information.

Performance

This widget will not impact signaling performance, bit it may become unresponsive.