FREESWITCH-MIB

All MIBs › FREESWITCH-MIB

Organization: www.freeswitch.org

Last Updated: 2011-01-17

Category: Domain: Telephony/VoIP, Domain: VoIP/Telephony

Description: FreeSWITCH open-source telephony platform MIB providing SNMP management objects for VoIP call sessions, channels, and system performance monitoring.

Start monitoring vendor-neutral, standards-based MIB, any SNMPv3-capable network device (SNMP engine identity/boot/clock status) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

What Is FREESWITCH-MIB?

FREESWITCH-MIB is a private enterprise MIB for FreeSWITCH, the open-source VoIP/telephony switching platform used to route calls, host conferences, and run SIP-based communication services. It exposes objects covering software identity and versioning, active session and channel counts, and rate-based performance metrics on the running softswitch. Because it reports uptime, current and peak session/call rates, sessions-per-second load, and per-module identifiers (e.g. mod-sofia, mod-skinny), it is squarely a software/process health monitoring MIB rather than a hardware one, letting operators watch for overload, crashes, or module failures on the media server. It has no formal dependency on other standard MIBs, being a self-contained vendor extension tied to the FreeSWITCH core engine. It is typically deployed on Linux servers running FreeSWITCH in call centers, PBX replacements, or SIP trunking gateways where SNMP polling supplements the platform's native event system. Engineers can download the FREESWITCH-MIB file directly to load it into their MIB browser.

IPNetwork Monitor allows you to monitor SNMP objects defined in FREESWITCH-MIB. Use the built-in SNMP Monitoring Browser to explore available variables, view their current values and descriptions, and select the objects you want to monitor. You can then create SNMP monitors, configure thresholds, and receive alerts when monitored values change.

Supported Devices

FreeSWITCH softswitch/PBX server
VoIP/SIP media gateway

Monitoring Examples

An admin would poll currentSessions and currentCalls against maxSessions/maxSessionsPerSecond to detect approaching capacity limits, and compare sessionsPerSecond to peakSessionsPerSecondFiveMin to spot traffic spikes or abnormal call storms. uptime combined with sessionsSinceStartup reveals whether the process recently restarted (a crash indicator) versus steady long-term operation. versionString and uuid help correlate alerts to a specific FreeSWITCH build and instance across a cluster.

What Can Be Monitored

current active sessions
current calls in progress
sessions per second (current/peak)
maximum session capacity
system uptime
software version

Imported Objects

From INET-ADDRESS-MIB

InetAddress
InetAddressType

From SNMPv2-SMI

Counter32
Counter64
Gauge32
Integer32
MODULE-IDENTITY
OBJECT-TYPE
TimeTicks
enterprises

From SNMPv2-TC

DateAndTime
DisplayString

How to Use in IPNetwork Monitor

Example using sessionsSinceStartup OID:

Select a FreeSWITCH softswitch/PBX server (VoIP/SIP media gateway) as the target host to create a monitor — the SNMP service should be up and running on it. Click New Monitor, then check SNMP Custom on the Favorites tab, click Next, and confirm the host. On the next page, click Select... to open the built-in SNMP MIB Browser and type sessionsSinceStartup into the Find box to locate it in the OID tree, then select it and click OK. It reports the number of sessions since FreeSWITCH process was started. On the monitor's Main parameters page you can set the target's SNMP port (default 161), credentials, polling interval, and other settings — see the SNMP Monitor help for details. On the State conditions and Alerting tabs, configure when the monitor should change state and trigger an alert; since this is a Counter32-type OID, Value bounds is the most useful condition here — trigger an alert if the counter increases sharply between polls relative to its normal baseline, since an unexpected spike often reflects a real change in traffic or activity. Click Finish to create the monitor; you can adjust any parameter later.

OIDs

OID symbolic	OID numeric	Type	Access	Description
freeswitch	1.3.6.1.4.1.27880			This file defines the private FreeSWITCH SNMP MIB extensions.
core	1.3.6.1.4.1.27880.1
identity	1.3.6.1.4.1.27880.1.1
STR versionString	1.3.6.1.4.1.27880.1.1.1	DisplayString	read-only	FreeSWITCH version as a string
STR uuid	1.3.6.1.4.1.27880.1.1.2	DisplayString	read-only	FreeSWITCH core UUID
systemStats	1.3.6.1.4.1.27880.1.2
TIK uptime	1.3.6.1.4.1.27880.1.2.1	TimeTicks	read-only	FreeSWITCH process uptime in hundredths of seconds
C32 sessionsSinceStartupEx	1.3.6.1.4.1.27880.1.2.2	Counter32	read-only	Number of sessions since FreeSWITCH process was started
G32 currentSessions	1.3.6.1.4.1.27880.1.2.3	Gauge32	read-only	Currently active sessions
G32 maxSessions	1.3.6.1.4.1.27880.1.2.4	Gauge32	read-only	Maximum permissible active sessions
G32 currentCalls	1.3.6.1.4.1.27880.1.2.5	Gauge32	read-only	Currently active calls
G32 sessionsPerSecond	1.3.6.1.4.1.27880.1.2.6	Gauge32	read-only	Current sessions per second
G32 maxSessionsPerSecond	1.3.6.1.4.1.27880.1.2.7	Gauge32	read-only	Maximum permissible sessions per second
G32 peakSessionsPerSecond	1.3.6.1.4.1.27880.1.2.8	Gauge32	read-only	Peak sessions per second
G32 peakSessionsPerSecondFiveMin	1.3.6.1.4.1.27880.1.2.9	Gauge32	read-only	Peak sessions per second last 5 minutes
G32 peakSessions	1.3.6.1.4.1.27880.1.2.10	Gauge32	read-only	Peak sessions
G32 peakSessionsFiveMin	1.3.6.1.4.1.27880.1.2.11	Gauge32	read-only	Peak sessions last 5 minutes
channelList	1.3.6.1.4.1.27880.1.9		not-accessible	A table containing a list of active channels
channelEntry	1.3.6.1.4.1.27880.1.9.1		not-accessible	A channel entry
I32 chanIndex	1.3.6.1.4.1.27880.1.9.1.1	Integer32	read-only	Channel SNMP index.
STR chanUUID	1.3.6.1.4.1.27880.1.9.1.2	DisplayString	read-only	Channel UUID.
STR chanDirection	1.3.6.1.4.1.27880.1.9.1.3	DisplayString	read-only	Channel direction.
DAT chanCreated	1.3.6.1.4.1.27880.1.9.1.4	DateAndTime	read-only	Channel creation timestamp.
STR chanName	1.3.6.1.4.1.27880.1.9.1.5	DisplayString	read-only	Channel name.
STR chanState	1.3.6.1.4.1.27880.1.9.1.6	DisplayString	read-only	Channel state.
STR chanCIDName	1.3.6.1.4.1.27880.1.9.1.7	DisplayString	read-only	Channel caller ID name.
STR chanCIDNum	1.3.6.1.4.1.27880.1.9.1.8	DisplayString	read-only	Channel caller ID number.
IPt chanInetAddressType	1.3.6.1.4.1.27880.1.9.1.9	InetAddressType	read-only	Channel originator's IP address type (IPv4 or IPv6).
IP chanInetAddress	1.3.6.1.4.1.27880.1.9.1.10	InetAddress	read-only	Channel originator's IP address.
STR chanDest	1.3.6.1.4.1.27880.1.9.1.11	DisplayString	read-only	Channel destination.
STR chanApplication	1.3.6.1.4.1.27880.1.9.1.12	DisplayString	read-only	Channel application.
STR chanAppData	1.3.6.1.4.1.27880.1.9.1.13	DisplayString	read-only	Channel application data.
STR chanDialplan	1.3.6.1.4.1.27880.1.9.1.14	DisplayString	read-only	Channel dialplan.
STR chanContext	1.3.6.1.4.1.27880.1.9.1.15	DisplayString	read-only	Channel dialplan context.
STR chanReadCodec	1.3.6.1.4.1.27880.1.9.1.16	DisplayString	read-only	Channel read codec.
G32 chanReadRate	1.3.6.1.4.1.27880.1.9.1.17	Gauge32	read-only	Channel read samples per second.
G32 chanReadBitRate	1.3.6.1.4.1.27880.1.9.1.18	Gauge32	read-only	Channel read bits per second.
STR chanWriteCodec	1.3.6.1.4.1.27880.1.9.1.19	DisplayString	read-only	Channel write codec.
G32 chanWriteRate	1.3.6.1.4.1.27880.1.9.1.20	Gauge32	read-only	Channel write samples per second.
G32 chanWriteBitRate	1.3.6.1.4.1.27880.1.9.1.21	Gauge32	read-only	Channel write bits per second.
mod_sofia	1.3.6.1.4.1.27880.1001
mod_skinny	1.3.6.1.4.1.27880.1002

RFC description

Private SNMP MIB extensions for FreeSWITCH modular media switching and soft-switch applications.

Start monitoring FreeSWITCH softswitch/PBX server (VoIP/SIP media gateway) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

Download FREESWITCH-MIB