SNMP Configuration¶

This chapter provides a detailed list of the Simple Network Management Protocol (SNMP) objects as described in the custom management information base (MIB).

SNMP provides a framework for monitoring and managing devices or processes on a local-area network or a wide-area network. There are no restrictions on the types of devices that can be managed using SNMP. However, each device must provide a description of its management objects and an interface between the management system and the internal implementation of each object.

Objects provide mapping between internal representations of operating parameters and statistics within each device or process and graphical representations of the operating status of devices or processes on the network management station. Objects are used to retrieve or change values using GetRequest, GetNextRequest, or SetRequest. SNMP allows only these basic operations, along with some trap operations, for any object in managed entities.

SNMP Components¶

MIB - A text file that contains a description of each managed object and is typically used as a reference document when developing code for managing SNMP agents. The MIB is also loaded into the network management station (NMS) to provide definitions of the objects that have been implemented on a given device.
SNMP Agent - One or more remote entities that provide the interface between known management objects and the internal implementation of these objects for the device or process being managed.
Protocol - Description of how encoded information is to be carried by network packets to and from management stations and SNMP agents.
UDP Network Stack - Resides over the physical transport layer.
Network management station (NMS) - Provides an operator interface to the SNMP agents that are being managed.

Note

SNMP can also be carried over Transmission Control Protocol (TCP). However, nearly all implementations use the User Datagram Protocol (UDP) network layer as an SNMP message transport mechanism.

Note

Evolve SNMP implementation adheres to the SNMP v2c and v3 standards. The system is configured to use v2c by default, and v3 support can be set up if required. Contact Customer Support for more information.

SNMP Objects¶

All of the MIB files should be uploaded to your SNMP v2c-compatible NMS. The following are provided in the /usr/sipxpress/doc file:

SIP-COMMON-MIB (RFC 4780)
SIP-SERVICE-MIB (RFC 4780)
SIP-TC-MIB (RFC 4780)
SIP-UA-MIB (RFC 4780)
NETWORK-SERVICES-MIB (RFC 2788)
M3UA-MIB (draft-ietf-sigtran-m3ua-mib-07)
XPRESSWORKX-PLATFORM-MIB (private)

The following tables list and describe the objects and notifications (traps) that are available in the XPRESSWORKX-PLATFORM-MIB.

Note

The access types are Read Only (RO) and Not Accessible (NA).

*Platform Configuration Objects*¶
SNMP Object	Access	Syntax	Description
ptiXprsPlatCfgIP	RO	Integer	IP address
ptiXprsPlatPort	RO	Integer	Port, if applicable
ptiXprsPlatProcess	RO	String	Entity or process
ptiXprsPlatSIPServiceOperStatus	RO	Integer	Current operational state of the SIP application
ptiXprsPlatNotifyText	RO	String	Text containing notify event details

*Platform Statistics Objects*¶
SNMP Object	Access	Syntax	Description
ptiXpressPlatformStatsTable	NA	Sequence	Common usage statistics objects applicable to Platform entities. Each row represents those objects for a particular Platform entity present in this system. These entities can be application servers or media servers. The instances of entities are uniquely identified by applIndex.
ptiXpressPlatformStatsEntry	NA	Sequence	A row of common usage statistics
ptiXprsPlatStatsName	RO	String	Name of the entity to which the statistics in the row apply
ptiXprsPlatStatsStartTime	RO	String	Start time of statistics collection
ptiXprsPlatLastChangeTime	RO	String	Last time the row of statistics objects was updated
ptiXprsPlatActive	RO	Counter 32	Total active resources at the time of the query
ptiXprsPlatProvisioned	RO	Counter 32	Total provisioned resources at the time of the query
ptiXprsPlatRequests	RO	Counter 64	Total number of incoming requests for resources
ptiXprsPlatFailedRequests	RO	Counter 64	Total number of failed resource requests
ptiXprsPlatLifeSpan	RO	Counter 64	Total time over which statistics gathering has taken place
ptiXprsPlatLifeCount	RO	Counter 64	Total number of statistics events over the life span
ptiXprsPlatStatsStarted	RO	String	Start and end times of the Platform

*Platform Server Objects*¶
SNMP Object	Access	Syntax	Description
ptiXpressPlatformServerTable	NA	Sequence	Table of application server and media server details
ptiXpressPlatformServerEntry	NA	Sequence	Row of entries that apply to each server entity. There can be more than one for each server. For example, multiple xtml or application servers on one system.
ptiXpressPlatformName	RO	String	Name of the Platform server
ptiXpressPlatformType	RO	String	Server type (application server or media server)
ptiXpressPlatformStartTime	RO	String	Start date and time of the Platform server
ptiXpressPlatformStarted	RO	String	Start date and time of the Platform server
ptiXpressPlatformAppServer	RO	String	ID of the application server
ptiXpressPlatformApplication	RO	String	Name of the running application
ptiXpressPlatformStatus	RO	String	Status of the running application
ptiXpressPlatformSessions	RO	String	Number of sessions provisioned for the application
ptiXpressPlatformIterations	RO	String	Number of iterations provisioned for the application
ptiXpressPlatformIterationsCompleted	RO	String	Number of iterations competed by the application

*Platform Notification Objects*¶
SNMP Object	Access	Syntax	Description
ptiXprsPlatNotifySSN	RO	String	Subsystem number as a hex string
ptiXprsPlatNotifySSNStatus	RO	Integer	Subsystem number status: `prohibited(0)` `allowed(1)` `undefined(2)`
ptiXprsPlatNotifyPC	RO	String	Point code as a hex string
ptiXprsPlatNotifyPCStatus	RO	Integer	Point code status indicator: `sccp_prohibited(1)` `congested(2)` `allowed(3)` `undefined(4)`
ptiXprsPlatNotifyASP	RO	String	ASP ID
ptiXprsPlatNotifyASPStatus	RO	Integer	ASP status indicator: `connection_not_established(0)` `connection_setup_in_progress(1)` `connection_established(2)` `connection_congested_1(3)` `connection_congested_2(4)` `connection_congested_3(5)` `connection_alive(6)`
ptiXprsPlatNotifySGP	RO	String	SGP name
ptiXprsPlatNotifySGPStatus	RO	Integer	SGP status indicator

SNMP Notifications¶

SNMP notifications, or traps, are sent to the NMS and can help you determine the status of the system.

ptiXprsPlat911CallFailed: Indicates that a 911 call has failed.

ptiXprsPlatACDControllerFailed: Provides details when the ACD controller fails.

ptiXprsPlatAlertLogErrors: Indicates that there are errors in the Oracle alert log.

ptiXprsPlatArchiveFull: Indicates that the Oracle archive is full.

ptiXprsPlatArchLogDirFull: Indicates that the Oracle archive log directory is full.

ptiXprsPlatASPStatus: Indicates the network status of an ASP change.

ptiXprsPlatBackupFailed: Provides details when a backup fails.

ptiXprsPlatConferenceControllerFailed: Provides details when the conference controller fails.

ptiXprsPlatConferenceController2Failed: Provides details when the conference controller fails.

ptiXprsPlatClusterStatusChange: Indicates that the HA status of a system has changed.

ptiXprsPlatClusterStatusEvent: Indicates that a HA event has occurred.

ptiXprsPlatCoreFound: Indicates that a new core file has been found.

ptiXprsPlatDBConnectivityError: Indicates that there was a problem connecting to the Oracle database.

ptiXprsPlatDiskFailed: Provides the name of the system that has had a failed disk.

ptiXprsPlatHAStatusChange: Provides the name of the system performing the HA status change notify.

ptiXprsPlatLicenseExpired: Provides the name of the system that has an expired license. It can also contain the name of the application if it is an application license.

ptiXprsPlatLicenseExpires: Provides the name of the system that has a license that expires soon. It also contains the number of days until expiration.

ptiXprsPlatLicenseInvalid: Provides the name of the system that has been found to have an invalid license.

ptiXprsPlatLicenseUpdated: Provides the name of the system that had its license file updated.

ptiXprsPlatLoadAvgExceeded: Indicates that the Oracle system load average has been exceeded.

ptiXprsPlatLOGERROR: Provides details of syslog errors.

ptiXprsPlatLoggerQueueReadError: Indicates that the ps-logger process had a message queue read error.

ptiXprsPlatLoggerQueueSizeExceeded: Indicates that the ps-logger queue size has been exceeded.

ptiXprsPlatLoggerSEGV: Indicates that ps-logger has thrown a segv.

ptiXprsPlatMediaInterfaceDown: Indicates that the media interface on an SIP soft media server system is down.

ptiXprsPlatMediaInterfaceUp: Indicates that the media interface on an SIP soft media server system is up.

ptiXprsPlatNICStatusChange: Provides the name of the system that had an ifconfig change.

ptiXprsPlatNotify1: Notify 1

ptiXprsPlatNotify2: Notify 2

ptiXprsPlatNotify3: Notify 3

ptiXprsPlatObjectsCannotExtend: Indicates that Oracle objects cannot extend.

ptiXprsPlatOpenSwitchDown: Provides the name of the system that has detected an OpenSwitch down event.

ptiXprsPlatOpenSwitchUp: Provides the name of the system that has detected an OpenSwitch up event.

PtiXprsPlatPCStatus: Indicates a point code status change.

ptiXprsPlatProvisioningControllerFailed: Provides details when the provisioning controller fails.

ptiXprsSGPStatus: Indicates the network status of an SGP change.

ptiXprsPlatSIPServiceOperStatusNotify

Indicates the current operational state of the SIP application and causes a notification when the state changes. The following values can display:

1 - application operating normally and processing SIP messages
2 - application unable to process SIP messages
3 - application in test mode and may not process SIP messages
4 - operation status of the application cannot be determined
5 - application manually prevented from processing SIP messages
6 - application booting and will soon process SIP messages

PtiXprsPlatSSNStatus: Indicates a subsystem number status change.

ptiXprsPlatSystemDegraded: Provides the name of the system that has gone into a degraded state.

ptiXprsPlatSystemStarted: Provides the name of the system that just started.

ptiXprsPlatSystemStopped: Provides the name of the system that just stopped.

ptiXprsPlatTablespaceFull: Indicates that the Oracle table space is full.

ptiXprsPlatVMailAccountsThreshold`: Indicates that the CGServer voice mail accounts are close to maximum capacity.

ptiXprsPlatVMailDiskFull: Indicates that the CGServer voice mail server disk is full.

ptiXprsPlatVMailStatusChange: Indicates a CGServer voice mail server status change.

ptiXprsPlatVolumeManagerDisabled: Provides the name of the system that has a volume manager problem.

ptiXprsPlatWebBrokerFailed: Provides details when the web broker fails.

Using the Evolve IMSWorkX Console as an SNMP Management Station¶

This section provides information about setting up and using the Evolve IMSWorkX Console as the SNMP management client.

First, install the appropriate version of the Console and ensure that the system on which it is installed has the IP address specified in the snmpd.conf file.

For more information, see Installing Evolve IMSWorkX Console.

By default, the Console monitors port 1162 for SNMP traps. If required, this port can be changed in the console.properties file for the current user.

When a trap is received by the Console, a tone is played and the TRAP window appears, showing each trap received on a separate line in red text. To acknowledge the trap, right-click on the line and click Acknowledge.