Skip Headers
Oracle® Communications Service Broker Integration Guide
Release 5.0

Part Number E15187-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
View PDF

4 Monitoring Service Broker with SNMP

This chapter describes how to use Simple Network Management Protocol (SNMP) to monitor Oracle Communications Service Broker.

About Service Broker SNMP

You can monitor Oracle Communications Service Broker with enterprise-wide network management systems using the Simple Network Management Protocol (SNMP). The Service Broker supports SNMP Version 1 (SNMPv1), SNMP Version 2 (SNMPv2c), and SNMP Version 3 (SNMPv3).

SNMP management is based on the agent/manager model. The agent resides on the managed resource and provides information to one or more remote managers. In a Service Broker domain monitored by SNMP, an agent runs on each Signaling server and Processing server.

An SNMP agent provides information to managers by responding to queries or by sending unsolicited notifications (traps). SNMP queries can retrieve information on Service Broker activities, such as the number of SIP transactions processed and the length of time a module has been running.

The SNMP agent generates a trap when it detects certain predefined events or conditions on the system. For example, the Service Broker agent can send a trap when the server starts up or when an application error occurs. Traps are sent to any SNMP manager that you configure as a trap destination. In the configuration, you specify the target IP address and listening port of the remote SNMP manager.

By default, the Service Broker SNMP agent sends notifications as SNMPv2 traps. However, it can send SNMPv1 traps and SNMPv3 traps as well. Furthermore, you can define trap-forwarding groups with different SNMP versions, enabling the agent to send traps to multiple destinations in the format appropriate for each.

A management information base (MIB) module defines the properties of the system that are subject to SNMP monitoring. The MIB helps automate the discovery of the properties (or managed objects) by the MIB browser or management system.

Accessing the Service Broker MIB

The Service Broker MIB modules are:

The MIB module files are included in the Oracle Communications Service Broker 5.0 Media Pack.

Note:

Service Broker MIB objects are read-only. You cannot modify a Service Broker configuration using SNMP.

About Service Broker SNMP Object Identifiers

Each managed object defined in a MIB has a unique object identifier (OID). An OID consists of a series of dot-delimited numbers, as shown in Figure 4-1.

Figure 4-1 Elements of an OID

OID elements in a MIB file.

All OIDs for Service Broker objects have the same root ID (1.3.6.1.4.1) and Oracle enterprise ID (111). The remaining parts of the OID identify the product group (Service Delivery Platform (SDP) in this case) and the object ID, which may be qualified by an object group.

For example, the OID for the object group relating to statistics on SIP activity is:

sipNetworkChannelStatistics: 1.3.6.1.4.1.111.18.5

A managed object within the sipNetworkChannelStatistics group that provides statistics for TCP connections is:

sipNetworkChannelStatisticsTcpConnections: 1.3.6.1.4.1.111.18.5.4

You can use a MIB browser to view the structure and contents of the Service Broker MIB modules, including information on each managed object, such as its OID, syntax, and status.

Service Broker Managed Objects

The Service Broker MIB modules define both queriable objects and traps. Queriable objects provide extensive information on the activities of Service Broker and its components, including those of Interworking Modules, the Orchestration Engine, the Diameter adaptor, and management components.

Traps provide information on events associated with Service Broker. Supported traps are:

Configuring SNMP

You configure the Service Broker SNMP service using SNMP configuration MBeans (see "SNMP Configuration MBeans").

You can access the SNMP configuration MBeans using the Scripting Engine or JMX.

The Scripting Engine is a system administration command-line tool that you can use to invoke Service Broker MBeans. You create a script for each configuration MBean that you want to invoke and provide the script file as a parameter when running the Scripting Engine. See "Using Scripts for Configuration and Management" in Oracle Communications Service Broker System Administrator's Guide for information about using the Scripting Engine and creating configuration scripts.

To configure the Service Broker SNMP agent, follow these general steps:

  1. For each Processing or Signaling Server, use the SnmpConfigTypeMBean to define agent properties, including its listening port, SNMP version, and logging level. At a minimum, you need to enable the agent using this MBean.

  2. If desired, specify access control restrictions applicable to SNMP queries using AccessControlTableTypeMBean. The MBean includes the community string required for access and IP filtering settings.

  3. Specify trap destinations using v1V2TrapForwardingTableTypeMBean or v3TrapForwardingTableTypeMBean. If desired, add multiple destinations, each with its own security properties or SNMP version.


SNMP Configuration MBeans

This section describes the MBeans and settings you use to configure the SNMP service.

Figure 4–2 shows the hierarchy of the SNMP configuration MBeans. Under the root configuration MBean are MBeans for configuring access control tables, SNMPv1 and SNMPv2 trap destinations, and SNMPv3 trap destinations.

Figure 4-2 SNMP Configuration MBean Hierarchy

SNMP Configuration MBean Hierarchy

SnmpConfigTypeMBean

SnmpConfigTypeMBean is the root MBean for SNMP configuration. This MBean holds the basic configuration settings for the agent.

Factory Method

Created automatically.

JAR File

oracle.axia.snmp-version.jar

where version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.config.beans.snmp

Object Name

oracle:name=oracle.axia.snmp,name0=SnmpConfig,type=oracle.axia.cm.ConfigurationMBean,version=1.0.0.0

Number of Allowed Occurrences

Maximum: 1

Attributes

enabled

Boolean value that indicates whether the SNMP agent is active. Required. Possible values are:

  • true: Enables the SNMP agent.

  • false: Disables the SNMP agent.

By default, the agent is disabled.

port

The port number on which the Service Broker SNMP agent listens for queries from managers. Required. Conventionally, SNMP agents listen for requests on port 161. The default value is 8001.

version

The SNMP version to use for the agent. Required. The default version is SNMPv2. Possible values are:

  • V1: Sets the SNMP version to SNMPv1.

  • V2c: Sets the SNMP version to SNMPv2c, or Community-Based Simple Network Management Protocol version 2.

  • V3: Sets the SNMP version toSNMPv3.

loggingLevel

The SNMP agent logging level as an integer. Required. Possible values are from 1 through 6, with the values corresponding to the following logging levels:

  • 1: Only fatal events are logged.

  • 2: Error-level events.

  • 3: Warning-level events.

  • 4: Informational-level events.

  • 5: Debugging-level events.

  • 6: Trace-level events.

Operations

You can add or remove instances of AccessControlTableMBean, v1V2TrapForwardingTableMBean, and v3TrapForwardingTableMBean using the following operations.

addAccessControlTableType

Creates an instance of AccessControlTableTypeMBean. The access control table contains authentication settings for SNMP query requests.

removeAccessControlTable

Removes an instance of AccessControlTableMBean.

addV1V2TrapForwardingTable

Creates an instance of v1V2TrapForwardingTableMBean. The MBean contains settings that control the SNMPv1 and SNMPv2 traps sent by the Service Broker agent.

removeV1V2TrapForwardingTable

Removes an instance of v1V2TrapForwardingTableMBean.

addV3TrapForwardingTable

Creates an instance of v3TrapForwardingTableMBean. The MBean contains settings that control the SNMPv1 and SNMPv2 traps sent by the Service Broker agent.

removeV3TrapForwardingTable

Removes an instance of v3TrapForwardingTableMBean.


AccessControlTableTypeMBean

AccessControlTableTypeMBean specifies access control restrictions applicable to SNMP queries to SNMP agents. The agent can authenticate requests based on the community string provided in the request or by the IP address of the manager. This access control mechanism applies to SNMPv1 and SNMPv2.

Factory Method

SnmpConfigType.addAccessControlTableType()

JAR File

oracle.axia.snmp-version.jar

where version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.config.beans.snmp

Object Name

oracle:name=oracle.axia.snmp,name0=SnmpConfig,name1=snmpSet[n],type=oracle.axia.cm.ConfigurationMBean,version=1.0.0.0

where n is an index.

Number of Allowed Occurrences

Minimum: 0; No maximum

Attributes

aclCommunity

The community string required for query access. Required. In SNMP, the community string is used to establish trust between the agent and manager.

aclAccess

The authorization level for SNMP managers who match this community. Required. Possible values are

  • 0: No access.

  • 1: Read-only access.

Since the Service Broker SNMP MIB defines all objects as read-only, option 2, read-write, is not supported.

aclManagers

The IP address or host name of managers who are allowed to access the agent. Required.

Requests that provide the correct community string but originate from a source IP not specified in this parameter are blocked. Use 0.0.0.0 as the IP address to allow access to any manager who provides a matching community string, or provide a specific IP address. Use semi-colons (;) to separate multiple addresses.

Operations

None


v1V2TrapForwardingTableTypeMBean

v1V2TrapForwardingTableTypeMBean specifies trap forwarding settings for SNMPv1 or SNMPv2 trap destinations. You must configure this MBean for each SNMP manager to which you want to send SNMPv1 or SNMPv2 traps from the SNMP agent.

Factory Method

SnmpConfigType.addV1V2TrapForwardingTableType()

JAR File

oracle.axia.snmp-version.jar

where version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.config.beans.snmp

Object Name

oracle:name=oracle.axia.snmp,name0=SnmpConfig,name1=snmpSet[n],type=oracle.axia.cm.ConfigurationMBean,version=1.0.0.0

where n is an index.

Number of Allowed Occurrences

Minimum: 0; No maximum

Attributes

managerHost

The IP address or host name of the SNMP manager to which the agent sends SNMPv1 or SNMPv2 traps. Required.

managerPort

The port number on which the SNMP manager listens for traps. Conventionally, managers listen for traps on port 162. Required.

version

The SNMP protocol version to use for the traps. Required. Possible values are:

  • 1: Sets the SNMP version to SNMPv1.

  • 2: Sets the SNMP version to SNMPv2c, or Community-Based Simple Network Management Protocol version 2.

  • 3: Sets the SNMP version to SNMPv3.

community

The community string for the trap destination manager. The community string is used to establish trust between the agent and manager.

timeout

The notification transmission timeout period, in milliseconds. If the time expires, the agent considers the transmission to have failed and may re-attempt the transmission based on the retries value.

retries

The number of attempts that the agent makes to send a notification. If set to 0 or the maximum number or retries has been reached, the notification is not re-attempted and the notification is considered to have failed.

Operations

None


v3TrapForwardingTableTypeMBean

v3TrapForwardingTableTypeMBean specifies destinations for SNMPv3 traps.

SNMPv3 provides enhanced security capabilities over versions 1 or 2 of SNMP. Accordingly, this MBean contains additional security-related settings.

Factory Method

SnmpConfigType.addV3TrapForwardingTableType()

JAR File

oracle.axia.snmp-version.jar

where version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.config.beans.snmp

Object Name

oracle:name=oracle.axia.snmp,name0=SnmpConfig,name1=snmpSet[n],type=oracle.axia.cm.ConfigurationMBean,version=1.0.0.0

where n is an index.

Number of Allowed Occurrences

Minimum: 0; No maximum

Attributes

managerHost

The IP address or hostname of the SNMP manager to which the agent sends SNMPv3 traps. Required.

managerPort

The port number on which the SNMP manager listens for traps. Conventionally, managers listen for traps on port 162. Required.

version

The SNMP protocol version to use for the traps. Required. Possible values are:

  • 1: Sets the SNMP version to SNMPv1.

  • 2: Sets the SNMP version to SNMPv2c, or Community-Based Simple Network Management Protocol version 2.

  • 3: Sets the SNMP version to SNMPv3.

community

The community string for the trap destination manager. The community string is used to establish trust between the agent and manager.

userName

The string specifying the user name of the manager user.

userSecModel

An integer value that specifies the manager's user security model. The only value supported by the Service Broker SNMP agent is 3, which specifies USM (User Security Model).

securityLevel

An integer that indicates which security features are applied to the message. You can require authentication and encryption of the trap content. Set the level using one of these options:

  • 1: Without authentication and without privacy (noAuthNoPriv).

  • 2: With authentication, but without privacy (authNoPriv).

  • 3: With authentication and with privacy (authPriv).

userContextName

A string specifying the context of the manager user.

timeout

The notification transmission timeout period, in milliseconds. If the time expires, the agent considers the transmission to have failed, and may re-attempt the transmission based on the retries value.

retries

The number of attempts that the agent makes to send a notification. If set to 0 or the maximum number or retries has been reached, the notification is not re-attempted and the notification is considered to have failed.

Operations

None