This document describes the Oracle Scripted Vendor Knowledge Module (OracleSVKM), a declarative monitoring and alerting solution for Oracle Session Border Controllers (SBCs).
Introduction
Architectural Overview
OracleSVKM is implemented as a layered architecture to ensure correctness, repeatability, and operational safety.
Architecture layers:
• Setup / Remove (ACK rules)
• Collection Layer
• Poller Definition Layer
• Trap Definition Layer
• Alignment Layer
Operational Capabilities
OracleSVKM provides automated discovery, proactive monitoring, and intelligent alerting for Oracle SBC environments. The solution minimizes operational risk while reducing manual configuration.
Operational Safety and Maintainability
All behavior is declarative and centrally managed. Extensions can be made without code changes, ensuring long-term maintainability.
Installation Instructions
Prerequisites
Go to target RIG and verify that the module Knowledge Script is selected.
- RIG version must 2025.X, if not then RIG must be upgraded to a 2025.1 or above version.
- Select RIG>Module Configuration
- Verify that module is selected
- If not, then select and the click Apply at top of menu
- RIG must be restarted to apply change
- Replace log4j2.xml that contains ScriptedVKM logger
Importing SVKM
- OracleSVKM must be downloaded to your PC or cloud and accessible from RIG>File Manager
- On main menu select Configure
- Select Knowledge Scripts
- In right pane right click and select Import
- File manger window will open to your PC, find OracleSBC and select
- This will take a few minutes since this script is rather complex.
Control Agent Creation
- Select Health>Agent and in all Agent window, right-click
- Name can be anything but here is an example
- IP address should be none
- SNMP needs a value so us V1 and I use a string to try to stop someone from deleting accidentally
- When finished select OK
Control Agent Properties
The Oracle SBC is a carrier-grade Session Border Controller used to secure, control, and interconnect real-time communications such as SIP voice, video, and messaging. It sits at the network edge between different domains (enterprise ↔ service provider, SIP trunk ↔ PBX, VoIP ↔ IMS, etc.)
In the design above a customer want different folders, different SBC.txt files and different SBC_Poller files. This can be accomplished easily by identifying different property files in control agents.
Four properties need to be added. Right click on control agent and select Edit
- Select Properties at top of agent edit menu
- Select Add
The standard file names are column B and additional control agent are Column C. There is no limit to amount of control agents and combinations of files
Name | Default | Example |
filelocation | SBC.txt | ECB.txt |
folder | OracleSBC | OracleECB |
pollerlocation | SBC_Pollers.csv | ECB_Pollers.csv |
traplocation | SBC_traps.csv | ECB_traps.csv |
Folder Name is configurable and any name can be used just realize that the RIG will create that folder and put all the SBC agents in that folder.
You can also rename SBC_pollers.csv and SBC_traps.csv and load those CSV files int root directory of RIG. The scripts will look for all these files in any directory under the RIG root directory.
Loading Files into RIG
Three files need to be transferred from your PC to the RIG root directory by default but as mentioned above they can be put in any other directory under root. The three files are SBC.txt, SBC_pollers.csv and SBC_traps.csv. The names of these files can be changed and loaded as case agnostic.
Running Script
- Right click on Control Agent and select Associate Knowledge Script
- Select SBC Onboarding
- Select Add and script will move from left side pane to right side pane
- Select Done at bottom of pane
- Select VKM Collectionsat top of right pane
- Nine collections will run and status should be Success
- The cron is set to run once a day but this can be adjusted if required
- Here’s how it breaks down Cron (Quartz’s 6-field syntax):
- Seconds = 0
- Minutes = 0
- Hours = 0
- Day of month = *
- Month = *
- Day of week = ?
Onboarding Complete
- Folder should be created
- Agents should be in folder
- Poller should be in agents
SBC.txt
- This is a text file but could be build as csv if large quantity of SBC and saved as text.
- Used to create agent using SNMP V1, V2 or S3
- Suggest location is root directory of RIG but the script will find it in any sub-directory of RIG root directory
- “#” sigh prefacing means line is comment and will be ignored
- Format is Agent Name, IP Address, SNMP Community string
- Format examples
- #SBC_Oli,127.0.0.1,V2C,n3ct4r
- #SBC_East_V2,192.168.10.10,V2C,public
- SBC_NY_AuthPriv,192.168.10.12,V3,secureUser/SHA/authPass123/AES/privPass456
- #SBC_LA_AuthNoPriv,192.168.10.13,V3,readonly/SHA/authOnlyPass
- SBC_Test_V3None,192.168.10.14,V3,anonymous
SBC_pollers.csv
- This is a seven column CSV file that will build pollers in Script
- Columns (case is ignored)
- Alignment script
- realm
- session
- Sysstorage
- envTemp
- envFan
- envPower
- cert
- POLLERTYPE
- table
- scalar
- POLLFUNCTION
- realmSessionCount
- SessionAgentActive
- devicePing
- RealStatsCurrentActiveSessionsIn
- RealStatsCurrentActiveSessionsOut
- SipSAStatsCurrentActiveSessionsInbound
- SipSAStatsCurrentActiveSessionsOutbound
- SysVolumeTotalSpace
- SysVolumeAvailSpace
- StorageAvailablePercent
- EnvMonTemperatureState
- EnvFanStatus
- SecurityCertExpire ( not all SBC support)
- EnvMonPowerSupplyState
- OID
- Base OID for walk to get poller detail
- Most times it is the OID for name of poller
- DESCRIPTIONSUFFIX
- OID pulls name and then this suffix is added to description
- i.e. Main Fan current state of the fan being instrumented
- THRESHOLDS
- Value returned by poller
- Each value separated by “|”
- Each threshold separated by “;”
- Matching type
- EQUALS
- ALWAYS
- NOTEQUALS
- LESSTHAN
- GREATERTHAN
- GREATEROREQUALS
- LESSOREQUALS
- Samples
8 | EQUALS | powerSupplyCritical | Power Supply not functioning | 5;7 | EQUALS | powerSupplyNotPresent|Power Supply not present| 1;6 | EQUALS | powerSupplyMajor | Power Supply Shutdown| 4; 5| EQUALS | powerSupplyCritical | power Supply Critical | 5;4 | EQUALS | powerSupplyMajor|Power Supply Major|4;3|EQUALS|powerSupplyMinor|powerSupply Minor|3;2|EQUALS|powerSupplyNormal|powerSupply normal|1
SBC_traps.csv
- This is a nine column CSV
- Columns are:
- Enabled
- Y
- N
- Trap Name
- OID
- Description
- Parameter Value Field
- Parameter that contains alert from OID
- Native Alert
- Alert level from OID definitions
- Clear For
- If clear OID, the OID it is clearing used for acknowledgement
- Threshold Block
- Not used presently
- Ignore Flag
- IGNORE discard the alarm silently
- Blank is process normally
- Enabled
Core Components
SetupRemoveScript (ACK Rules)
Purpose
Installs and removes SNMP acknowledgement rules to correctly correlate create and clear traps.
Inputs and Requirements
• VKM framework access
• gxEvent command channel
• Oracle SBC trap definitions
Processing Logic
Creates ACK entries mapping clear traps to create traps, enforces deviceName constraint, sets MERGE or REPLACE behavior, and removes only owned ACK rules on teardown.
Outputs
ACK table entries with device-scoped correlation.
Downstream Dependencies
Required by SBC_traps.csv for correct alert lifecycle.
AgentCreation
Purpose
Creates or audits SBC agents based on SBC.txt.
Inputs and Requirements
• SBC.txt
• File system access under user.dir
Processing Logic
Parses SBC.txt, audits or creates agents, assigns folder and source tag.
Outputs
AGENT_NAME, IPADDRESS, SNMP_VERSION, COMMUNITY_STRING
Downstream Dependencies
Required by all downstream collections and alignments.
Collections
SessionAgentsCollection
Purpose
Discovers Session Agents configured on the SBC.
Inputs and Requirements
• SBC.txt
• SNMP access
Processing Logic
SNMP walk of session agent OID, parses indices and names.
Outputs
SESSION_AGENT_NAME, INDEX
Downstream Dependencies
Consumed by SessionAlignment.
IfTableCollection
Purpose
Discovers network interfaces.
Inputs and Requirements
• SBC.txt
• SNMP IF-MIB
Processing Logic
SNMP walk of ifDescr, filters loopback, extracts indices.
Outputs
IF_DESCR, INDEX
Downstream Dependencies
Consumed by InterfacesAlignment.
RealmsCollection
Purpose
Discovers SBC realm configuration.
Inputs and Requirements
• SBC.txt
• SNMP realm OID
Processing Logic
SNMP walk to retrieve realm names and indices.
Outputs
REALM_NAME, INDEX
Downstream Dependencies
Consumed by RealmAlignment.
SysStorageSpaceCollection
Purpose
Discovers SBC system storage volumes.
Inputs and Requirements
• SBC.txt
• SNMP storage OID
Processing Logic
SNMP walk of storage volume table, parses volume names.
Outputs
SYSTEM_VOLUME_NAME, INDEX
Downstream Dependencies
Consumed by StorageAlignment.
EnvFanCollection
Purpose
Discovers fan hardware components.
Inputs and Requirements
• SBC.txt
• SNMP fan OID
Processing Logic
SNMP walk of fan table, binds results to AGENTINDEX.
Outputs
FAN_NAME, INDEX
Downstream Dependencies
Consumed by EnvFanAlignment.
EnvTemperatureCollection
Purpose
Discovers temperature sensors.
Inputs and Requirements
• SBC.txt
• SNMP temperature OID
Processing Logic
SNMP walk of temperature sensor table.
Outputs
TEMP_SENSOR_NAME, INDEX
Downstream Dependencies
Consumed by EnvTemperatureAlignment.
EnvPowerCollection
Purpose
Discovers power supply components.
Inputs and Requirements
• SBC.txt
• SNMP power OID
Processing Logic
SNMP walk of power supply table.
Outputs
POWER_SUPPLY_NAME, INDEX
Downstream Dependencies
Consumed by EnvPowerAlignment.
SecurityCertExpireCollection
Purpose
Discovers security certificates and expiry dates.
Inputs and Requirements
• SBC.txt
• SNMP certificate OIDs
Processing Logic
SNMP walk to discover certificates, SNMP GET for expiry timestamps.
Outputs
CERT_NAME, INDEX, EXPIRY_DATE
Downstream Dependencies
Consumed by SecurityCertAlignment and certificate alerts.
Alignment Scripts (All)
Purpose
Bind collected inventory to pollers and traps.
Inputs and Requirements
• Inventory tables
• SBC_Pollers.csv
• SBC_traps.csv
Processing Logic
Iterates inventory, instantiates pollers idempotently based on ALIGNMENT.
Outputs
Poller instances bound to indices.
Downstream Dependencies
Final step before runtime monitoring.