Interoperability with SNMP-aware management clients

The SS7 SGC stack includes an SNMP agent, for interoperability with external SNMP-aware management clients. The SGC SNMP agent provides a read-only view of SGC statistics and alarms (through SNMP polling), and supports sending SNMP notifications related to SGC alarms and notifications to an external monitoring system.

In a clustered environment, individual SGC nodes may run their own instances of the SNMP agent, so that statistics and notifications can still be accessed in the event of node failure. Each node is capable of running multiple SNMP agents with different user-defined configuration.

Tip For detailed information about SGC exposed statistics, please see Statistics. For details about SGC alarms and notifications, please see Alarms and Notifications.
Note
Attribute modification restrictions

  • Attributes marked "When SNMP node disabled" can only be modified if the associated SNMP node is currently disabled.

  • Attributes marked "Any time with immediate effect" may be modified at any time and changes will take immediate effect.

  • Attributes marked "Any time, changes applied after SNMP node restart" may be modified at any time. However, the changes will not be applied until the associated SNMP node(s) have been restarted.

SNMP configuration

Each snmp-node configuration object represents an SNMP agent running as part of a particular SGC node. Exposed configuration allows a single SNMP agent to support a single version of the SNMP protocol. Currently supported SNMP versions are 2c and 3. Multiple snmp-nodes (SNMP agents) can run within a single SGC node. In a clustered environment, each newly created snmp-node is automatically connected to the existing target-address and usm-user.

snmp-node

snmp-node represents an SNMP agent running as part of a particular SGC node.

Attribute name Attribute description Default Modification

oname

object name

dependencies

number of items which depend on this object

Read-only

enabled

is object enabled

false

Any time with immediate effect

active

is object active

Read-only

node

SGC node where the object is used

When SNMP node disabled

transport-type

Comma separated list of SNMP address type(s) to configure this node for (supported values: UDP, TCP)

UDP

When SNMP node disabled

port

local SNMP listening port

When SNMP node disabled

host

local SNMP listening bind address

127.0.0.1

When SNMP node disabled

community

When the snmp-version is v2c this is the community for read operations. When the snmp-version is v3 this is the USM user (community) for read operations.

public

When SNMP node disabled

snmp-version

SNMP version (supported values: v3, v2c)

v2c

When SNMP node disabled

extended-traps

whether extended traps (and informs) should be generated by this node. Extended traps/informs include a longer description field, plus cause, effect and action fields which can result in an SNMP PDU up to 1400 octets long. A value of false here will exclude these fields, resulting in traps under 484 octets long.

true

When SNMP node disabled

engine-id

the SNMPv3 engine ID. This is a hex string with length between 5 and 32 octets inclusive (10 to 64 nibbles).

When SNMP node disabled
Note The JMX Object name for snmp-node is SGC:type=snmp,category=snmp-node.

target-address

target-address is cluster wide and represents an SNMP notification target (defines where SNMP notifications will be sent and which protocol version is used).

Attribute name Attribute description Default Modification

oname

object name

dependencies

number of items which depend on this object

Read-only

transportDomain

SNMP transport domain

(SNMP transport protocol supported values: TcpIpv4, UDP, TcpIpv6, UdpDns, UdpIpv6, UdpIpv4, TcpDns)

In order for notifications to be emitted, the chosen transport domain must be compatible with one of the the selected transport-type values in snmp-node. i.e. UdpIpv4 cannot be used if the transport-type is set to TCP, but may be used if the transport-type is UDP,TCP or UDP.

UDP

Any time, changes applied after SNMP node restart

target-host

target host address

Any time, changes applied after SNMP node restart

target-port

target port

162

Any time, changes applied after SNMP node restart

timeout

timeout value (in units of 0.01 seconds) after which unacknowledged SNMP notifications (type inform) will be retransmitted

200

Any time, changes applied after SNMP node restart

retries

number of retransmissions of unacknowledged SNMP notifications (type inform)

1

Any time, changes applied after SNMP node restart

community

When the snmp-version is v2c this is the community for this notification. When the snmp-version is v3 this identifies the USM user (community) to use to determine the authentication and privacy configuration for this notification.

public

Any time, changes applied after SNMP node restart

notifyType

SNMP notification mechanism

(supported values: trap — asynchronous unacknowledged notification,
inform — asynchronous acknowledged notification)

trap

Any time, changes applied after SNMP node restart

snmp-version

SNMP version

(supported values: v3, v2c)

v2c

Any time, changes applied after SNMP node restart
Note The JMX Object name for target-address is SGC:type=snmp,category=target-address.

usm-user

usm-user is cluster wide and represents the SNMP v3 USM user and authentication details.

Note The USM username parameter is configured in the community configuration attribute.
Attribute name Attribute description Default Modification

oname

object name

dependencies

number of items which depend on this object

Read-only

authProto

The authentication protocol.

(supported values: SHA, MD5, NONE)

Supported privacy/authentication combinations are: noAuthNoPriv, authNoPriv and authPriv.

SHA

Any time, changes applied after SNMP node restart

authPassphrase

The authentication protocol passphrase. May be omitted if authProto is NONE, otherwise must be set to a minimum of 8 characters.

Any time, changes applied after SNMP node restart

privProto

The privacy protocol.

(supported values: AES192, DES, DES3, AES256, NONE, AES128)

Supported privacy/authentication combinations are: noAuthNoPriv, authNoPriv and authPriv.

DES

Any time, changes applied after SNMP node restart

privPassphrase

The privacy protocol passphrase. May be omitted if privProto is NONE, otherwise must be set to a minimum of 8 characters.

Any time, changes applied after SNMP node restart

community

The SNMPv3 USM user. Named community for backwards compatibility reasons.

public

Any time, changes applied after SNMP node restart
Note The JMX Object name for usm-user is SGC:type=snmp,category=usm-user.

SGC Stack MIB definitions

MIB definitions for the SGC stack are separated into three files:

  • COMPUTARIS-MIB — basic OID definitions used by the SGC stack

  • OPENCLOUD-OCSS7-MIB — the Metaswitch enterprise MIB definition and OCSS7 System OIDs

  • CTS-SGC-MIB — SNMP managed objects and SNMP notifications used by the SGC stack.

Tip MIB definitions are also included in the SGC Stack release package under ./doc/mibs/

SNMP managed objects

Managed objects defined in CTS-SGC-MIB can be separated in two groups:

Statistics managed objects

Here are the managed objects representing SGC statistics:

Symbolic OID Numerical OID Equivalent Statistics attribute

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcAssociationTable

.1.3.6.1.4.1.35787.1.1.1

AssociationInfo

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcAsStateTable

.1.3.6.1.4.1.35787.1.1.2

AsInfo

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcLocalSsnTable

.1.3.6.1.4.1.35787.1.1.3

LocalSsnInfo

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcTcapConnectionTable

.1.3.6.1.4.1.35787.1.1.4

TcapConnInfo

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcDpcStatusTable

.1.3.6.1.4.1.35787.1.1.5

DpcInfo

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcGtRoutingTable

.1.3.6.1.4.1.35787.1.1.6

OgtInfo

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcPcRoutingTable

.1.3.6.1.4.1.35787.1.1.7

PcInfo

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcRemoteSsnTable

.1.3.6.1.4.1.35787.1.1.8

RemoteSsnInfo

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcHealthTable

.1.3.6.1.4.1.35787.1.1.9

HealthInfo

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcSccpStatsTable

.1.3.6.1.4.1.35787.1.1.10

SccpStats

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcSccpErrorStatsTable

.1.3.6.1.4.1.35787.1.1.11

SccpErrorStats

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcTcapStatsTable

.1.3.6.1.4.1.35787.1.1.12

TcapStats

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcObjects.sgcTcapErrorStatsTable

.1.3.6.1.4.1.35787.1.1.13

TcapErrorStats

Alarms managed objects

Here are the managed objects representing SGC alarms:

Symbolic OID Numerical OID Equivalent Alarms MBean

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents.sgcActiveAlarmsTable

.1.3.6.1.4.1.35787.1.2.5

alarm-table

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents.sgcEventHistoryTable

.1.3.6.1.4.1.35787.1.2.6

alarm-history

SNMP notifications

The MIB defined in CTS-SGC-MIB specifies two notification types that can be emitted by SGC:

  • SGC Alarm — emitted whenever an SGC Alarm is raised

  • SGC Notification — emitted whenever an SGC Notification is emitted.

Notifications can be raised in either basic format or extended format.

Here are the notification types emitted by SGC:

Symbolic OID Numerical OID

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents.sgcAlarm

.1.3.6.1.4.1.35787.1.2.2

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents.sgcNotification

.1.3.6.1.4.1.35787.1.2.3

Here is the content of SGC-emitted SNMP notifications:

Symbolic OID Numerical OID Details

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcEventId

.1.3.6.1.4.1.35787.1.2.4.2

unique SGC notification / alarm identifier

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcTimestamp

.1.3.6.1.4.1.35787.1.2.4.3

time the of SGC alarm / notification

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcAlarmName

.1.3.6.1.4.1.35787.1.2.4.4

name of the SGC alarm / notification type

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcAlarmSeverity

.1.3.6.1.4.1.35787.1.2.4.5

SGC alarm / notification severity

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcAdditionalInfo

.1.3.6.1.4.1.35787.1.2.4.6

comma-separated list of SGC Alarm / Notification type specific attribute=value pairs;
this set of attributes depends on SGC Alarm / Notification type and is described in
Alarm Types and Notification Types

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcAlarmMessage

.1.3.6.1.4.1.35787.1.2.4.7

short decription of the alarm or notification

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcAlarmDescription

.1.3.6.1.4.1.35787.1.2.4.8

(extended format only)
long description of the alarm

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcAlarmCause

.1.3.6.1.4.1.35787.1.2.4.9

(alarms only)
(extended format only)
possible causes of the alarm

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcAlarmEffect

.1.3.6.1.4.1.35787.1.2.4.10

(alarms only)
(extended format only)
possible consequences of the alarm

.iso.org.dod.internet.private.enterprises. ctsRegMIB.ctsObjects.sgcEvents. sgcAlarmObjects.sgcAlarmAction

.1.3.6.1.4.1.35787.1.2.4.11

(alarms only)
(extended format only)
remedial action to be taken
Previous page Next page