Messaging Server Administrator's Guide: SNMP MIB

The Netscape Management Information Base (MIB) for Messaging Server stores the server information that administrators manage through the Simple Network Management Protocol (SNMP).

This appendix describes the Messaging Server SNMP MIB and provides its complete text. For information about SNMP in Netscape Messaging Server, see Using SNMP on Unix Platforms.

This appendix contains the following sections:

About the Messaging Server MIB

How the MIB Is Activated

Format of MIB Entries

Description of the MIB File

The Messaging Server MIB

About the Messaging Server MIB

The Messaging Server Management Information Base (MIB) is a private SNMP MIB module designed for Netscape Messaging Server.

Using SNMP with network management software, such as HP OpenView, server administrators can manage Netscape Messaging Server as a network element, performing remote monitoring and data exchange between servers. The SNMP MIB allows the server to monitor server statistics, query static variables, and notify the management station of Messaging Server events.

Each installation of SNMP has its own MIB, a database or information store with a tree-like hierarchy that contains definitions of managed objects, or variables, that store network information for the server. The most general information about the network is at the top level of the hierarchy. Each level below contains information that describes specific parts of the network. For detailed information about MIB structure, see RFC 1155.

Messaging Server's private Messaging Server MIB file, named netscape-mail.mib, contains the definitions for variables that store network information for Messaging Server. The MIB is installed during Messaging Server installation in the ServerRoot/plugins/snmp directory. It is a subtree under the object identifier (OID) enterprises 1450, which is the Netscape OID.

You can view the information in the Messaging Server MIB through two SNMP tables, using a program such as HP OpenView. The tables display both SNMP static variables and MTA variables. For information about these variables, see MIB Variables.

For detailed information about the MIB in SNMP, version 1, see RFC 1212 and RFC 1215.

Note: The Messaging Server MIB supports a subset of the objects defined by the MADMAN MIB, as described in RFC 1566. For further information about this subset, contact the Netscape Server Group.

How the MIB Is Activated

To activate the MIB, you must first install the SNMP master agent for the server and then enable the SNMP subagent, which calls the MIB.

The master agent exchanges information between the network management station (NMS) and its subagents. For more information about the master agent, see the documentation for the Netscape Administration Server.

Once you have installed the master agent, you enable the SNMP subagent. The master agent asks the subagent for information, and the subagent queries the variables defined in the MIB. For more information about the subagent, see The Messaging Server Subagent.

Format of MIB Entries

The MIB file contains the definitions for managed objects, or variables, that store network information for the server. Each variable definition includes the variable name, its data type and read/write access level, a brief description, and a permanent object identifier. All MIB objects are defined using Abstract Syntax Notation One (ASN.1).

This sample entry shows the definition for the nsmailEntityDescr variable:

nsmailEntityDescr OBJECT-TYPE / object type

           SYNTAX      DisplayString (SIZE (0..255))      / syntax

ACCESS read-only / read/write access level

STATUS mandatory / status

DESCRIPTION / description

"A general textual description of the Netscape Mail Server."

           ::= { nsmailEntityInfo 1 }  / object identifier

This definition contains the following information:

The variable name, in this case nsmailEntityDescr, which is of OBJECT-TYPE.

Syntax gives the abstract data type of the variable object type in ASN.1 notation. For example, the Syntax of the nsmailEntityDescr variable is DisplayString (SIZE (0..255)). See Syntax Types.

Access gives the read/write access level to the variable. Possible access levels are read-only, read-write, write-only, or not-accessible. The access level to all Messaging Server MIB elements is either read-only, like that of the nsmailEntityDescr variable, or not-accessible.

Status tells whether the element is mandatory, optional, or obsolete. The Status for all Messaging Server MIB elements is mandatory, or required for the server.

Description is a text description of the element, enclosed in quotes. For example, the description of the nsmailEntityDescr variable is "A general textual description of the Netscape Mail Server."

Object Identifier is an assigned name that serves as a permanent identifier for each managed object in the MIB name tree in its namespace. Objects in SNMP are hierarchical; the object identifier is a sequence of labels that represents the object in the hierarchy. For example, nsmailEntityDescr is identified as nsMailEntityInfo 1. This means that it has the label 1 in the subtree nsMailEntityInfo. nsMailEntityInfo, in turn, has the label 1 in the nsmail subtree.

Syntax Types

The Syntax line of the MIB entry gives the abstract data type of the variable, which must resolve to an instance of an ASN.1 syntax type. These types are defined in various Network Working Group Requests for Comments (RFCs); their definitions are imported into the MIB file, as described in MIB Imports List.

Table C.1 lists the data types used in the Messaging Server MIB, with descriptions, import sources, and examples from the MIB.

Table C.1 Data Types of Messaging Server MIB Variables


Data type	Description and import	Example
Counter32	32-bit unsigned long; increases to a maximum value, then restarts from zero. Imported from SNMPv2-SMI.	mtaReceivedMessages
DisplayString	Human-readable ASCII string with length of 0 to 255 characters. Imported from SNMPv2-TC.	nsmailEntityDescr
Gauge32	32-bit unsigned long; can increase or decrease between set values. Imported from SNMPv2-SMI.	mtaStoredMessages
INTEGER	Integer.	mtaId
MtaEntry	Table format for MTA data retrieval; defines an entry in the MTAtable. Defined in the Messaging Server MIB.	mtaEntry
SEQUENCE OF MtaEntry	Constructor type that generates a table using the specified list constructor; here, it generates the MTA table using the MtaEntry type. Defined in ASN.1.	mtaTable

Description of the MIB File

The MIB file is organized into several main parts:

MIB Imports List. The MIB imports list tells the sources of the object and data type definitions used in the MIB.

Module Definition. The module defines the current subtree. It contains organization information and a description of the MIB.

MIB Variables. MIB variables store the basic information required for network management.

MIB Traps. A MIB trap is a message sent by the server to alert the NMS about a server event.

MIB Imports List

The Imports list at the beginning of the MIB file gives the sources of the object and data type definitions used in the MIB. For example, the Counter32 and Gauge32 data type definitions are imported from the SNMPv2-SMI module. For the text of the import section, see the Imports list in The Messaging Server MIB.

Module Definition

The module defines the current subtree that is being described by the MIB file. It contains organization information and a description of the MIB. The Messaging Server MIB names the Netscape Communications Corporation as its organization, gives the company name and address as its contact information, and provides a text description of the MIB. The Messaging Server OID is defined as netscape 5. For the text of the module definition, see The Messaging Server MIB.

MIB Variables

The MIB defines a number of managed objects, or variables, which have names and values. Variables store information required for network management. You can view the data stored in MIB variables using a program such as HP OpenView.

Messaging Server MIB variables are organized into data for two tables.

The static variables table provides basic information about the Messaging Server installation. See Static Variables.

The MTA Table and MTA variables store information specific to the MTA (Message Transfer Agent). See MTA Table for Server Statistics.

Static Variables

The static variables table provides basic information about the Messaging Server installation, such as the version number, the physical location of the server, and contact information. Static variable values are set during server installation and cannot be updated while the server is running.

Table C.2 lists static variables alphabetically by name, with descriptions and examples.

Table C.2 Quick Reference to MIB Attributes: Static Variables


Attribute	Description	Examples
nsmailEntityContact	Contact person for Messaging Server at this installation, usually a server administrator.	John Smith (jsmith@acme.com)
nsmailEntityDescr	Text description of Messaging Server.	Netscape Messaging Server
nsmailEntityLocation	Physical location of Messaging Server, usually a street address.	999 Worldend Rd.
nsmailEntityName	Name assigned to Messaging Server at this installation; should match the link on the Administration Server selection page for Messaging Server.	MTA-40
nsmailEntityOrg	Organization using Messaging Server, usually a department or company name.	Acme Corp.
nsmailEntityVers	Version of Messaging Server that is installed.	4.1

MTA Table for Server Statistics

The MTA Table and MTA variables store information specific to the MTA (Message Transfer Agent), such as the number and volume of messages sent, received, or stored.

The MTA is a program for message routing and delivery. Several MTAs can cooperate in getting messages for the intended recipient. Messages are either delivered to the local message store by the MTA or routed to another MTA for remote delivery.

Table C.3 lists MTA MIB variables alphabetically by name, with descriptions.

Table C.3 Quick Reference to MIB Attributes: MTA Table


Attribute	Description
mtaId	Identifier of the MTA for this installation. Since only one Netscape Messaging Server can be installed, this attribute can have only one value.
mtaReceivedMessages	Total number of messages received since MTA initialization.
mtaReceivedRecipients	Number of recipients for all messages received since MTA initialization.
mtaReceivedVolume	Total volume of messages received since MTA initialization, in kilo-octets.
mtaStoredMessages	Total number of messages stored in the MTA.
mtaStoredRecipients	Number of recipients for all messages stored in the MTA.
mtaStoredVolume	Total volume of messages stored in the MTA, in kilo-octets.
mtaTransmittedMessages	Total number of messages transmitted since MTA initialization.
mtaTransmittedRecipients	Number of recipients specified in all messages transmitted since MTA initialization.
mtaTransmittedVolume	Total volume of messages transmitted since MTA initialization, in kilo-octets.

MIB Traps

A MIB trap is a message from the server that notifies the NMS of server events. Messaging Server MIB traps notify the NMS when the server may be down, does not respond to polling, or has restarted.

The SNMP trap is an example of managed device-initiated communication. For more information, see Communication Between the NMS and the Managed Device.

Each trap sends additional MIB information about the server when it reports an event. The following example shows the information sent with the nsMailServerDown trap: Netscape Messaging Server's general description, version number, location, and contact information.

nsmailEntityDescr, nsmailEntityVers,
nsmailEntityLocation, nsmailEntityContact

Note: To make sure that traps are sent to the NMS, you must set the correct community and trap destination information through the Administration Server. See the documentation for the Administration Server.

Table C.4 lists traps alphabetically by name, with descriptions.

Table C.4 Quick Reference to MIB Attributes: Traps


Trap	Description
nsMailServerDown	Messaging Server may be down. Sends general description, version number, location, and contact information for the server at the time of the event.
nsMailServerNoResponse	Messaging Server does not respond to its polls, but may still be up and working. Sends general description, version number, location, and contact information for the server at the time of the event.
nsMailServerStart	Messaging Server starts or restarts. Sends general description, version number, and location of the server at the time of the event.

The Messaging Server MIB

For your convenience, this section includes the text of the Messaging Server MIB.

SNMP MIB

Netscape Messaging Server 4.1

This file contains Netscape Messaging Server's Simple Network
Management Protocol (SNMP) Management Information Base (MIB).

NSMAIL-MIB DEFINITIONS ::= BEGIN

IMPORTS

MODULE-IDENTITY, OBJECT-TYPE, OBJECT-IDENTITY

Counter, IpAddress, TimeTicks

FROM RFC1155-SMI

DisplayString, TimeInterval

FROM SNMPv2-TC

TRAP-TYPE

                      FROM RFC-1215;

           netscape OBJECT IDENTIFIER ::= { enterprises 1450 }

nsmail MODULE-IDENTITY

LAST-UPDATED "9706021700Z"

ORGANIZATION "Netscape Communications Corp."

CONTACT-INFO "Netscape Communications Corp.

501 E. Middlefield Rd.

Mountain View, CA 94043"

           DESCRIPTION          "A private MIB module for Netscape

Messaging Server"

           ::= { netscape 5 }

-----

-- Static variables

-----

           nsmailEntityInfo OBJECT IDENTIFIER ::= { nsmail 1 }

nsmailEntityDescr OBJECT-TYPE

               SYNTAX     DisplayString (SIZE (0..255))

ACCESS read-only

STATUS mandatory

DESCRIPTION "A general textual description

of the Netscape Mail Server."

               ::= { nsmailEntityInfo 1 }

nsmailEntityVers OBJECT-TYPE

               SYNTAX     DisplayString (SIZE (0..255))

ACCESS read-only

STATUS mandatory

DESCRIPTION "The Version of the Netscape Mail Server."

               ::= { nsmailEntityInfo 2 }

nsmailEntityOrg OBJECT-TYPE

               SYNTAX     DisplayString (SIZE (0..255))

ACCESS read-only

STATUS mandatory

DESCRIPTION "Organization responsible for Netscape

Mail Server at this installation."

               ::= { nsmailEntityInfo 3 }

nsmailEntityLocation OBJECT-TYPE

             SYNTAX     DisplayString (SIZE (0..255))

ACCESS read-only

STATUS mandatory

DESCRIPTION "Physical location of this entity

                           (Netscape Mail Server). For example:

hostname, building number,

lab number, etc."

               ::= { nsmailEntityInfo 4 }

nsmailEntityContact OBJECT-TYPE

              SYNTAX      DisplayString (SIZE (0..255))

ACCESS read-only

STATUS mandatory

              DESCRIPTION "Contact person(s) responsible for the

Netscape Mail Server at this

installation, together with

information on how to contact."

               ::= { nsmailEntityInfo 5 }

nsmailEntityName OBJECT-TYPE

               SYNTAX     DisplayString (SIZE (0..255))

ACCESS read-only

STATUS mandatory

DESCRIPTION "Name assigned to this entity at the

installation site."

               ::= { nsmailEntityInfo 6 }

-----

-- mta table for statistic information

-----

mtaTable OBJECT-TYPE

SYNTAX SEQUENCE OF MtaEntry

ACCESS not-accessible

STATUS mandatory

               ::= { nsmail 2 }

mtaEntry OBJECT-TYPE

SYNTAX MtaEntry

ACCESS not-accessible

STATUS mandatory

               INDEX     { mtaId }

               ::= { mtaTable 1 }

           MtaEntry     ::= SEQUENCE {

mtaReceivedMessages Counter32,

mtaStoredMessages Gauge32,

mtaTransmittedMessages Counter32,

mtaReceivedVolume Counter32,

mtaStoredVolume Gauge32,

mtaTransmittedVolume Counter32,

mtaReceivedRecipients Counter32,

mtaStoredRecipients Gauge32,

mtaTransmittedRecipients Counter32,

mtaId INTEGER

mtaReceivedMessages OBJECT-TYPE

SYNTAX Counter32

ACCESS read-only

STATUS mandatory

DESCRIPTION "The total number of messages received

since MTA Initialization."

               ::= { mtaEntry 1 }

mtaStoredMessages OBJECT-TYPE

SYNTAX gauge32

ACCESS read-only

STATUS mandatory

DESCRIPTION "The total number of messages currently

stored in the MTA."

               ::= { mtaEntry 2 }

mtaTransmittedMessages OBJECT-TYPE

SYNTAX Counter32

ACCESS read-only

STATUS mandatory

DESCRIPTION "The total number of messages

transmitted since MTA Initialization."

               ::= { mtaEntry 3 }

mtaReceivedVolume OBJECT-TYPE

SYNTAX Counter32

ACCESS read-only

STATUS mandatory

DESCRIPTION "The number of msgs (in kilo-octets

received since MTA Initialization."

               ::= { mtaEntry 4 }

mtaStoredVolume OBJECT-TYPE

SYNTAX Gauge32

ACCESS read-only

STATUS mandatory

DESCRIPTION "The total number of msgs

                             (in kilo-octets) currently stored

in the MTA."

               ::= { mtaEntry 5 }

mtaTransmittedVolume OBJECT-TYPE

SYNTAX Counter32

ACCESS read-only

STATUS mandatory

DESCRIPTION "Number of msgs, in kilo-octets,

transmitted since MTA initialization."

               ::= { mtaEntry 6 }

mtaReceivedRecipients OBJECT-TYPE

SYNTAX Counter32

ACCESS read-only

STATUS mandatory

DESCRIPTION "The number of recipients specified

in all messages received since MTA

Initialization. Recipients this MTA

had no responsibility for are not counted."

               ::= { mtaEntry 7 }

mtaStoredRecipients OBJECT-TYPE

SYNTAX Gauge32

ACCESS read-only

STATUS mandatory

DESCRIPTION "The total number of recipients

specified in all messages currently

stored in the MTA. Recipients this MTA

had no responsibility for are not counted."

               ::= { mtaEntry 8 }

mtaTransmittedRecipients OBJECT-TYPE

SYNTAX Counter32

ACCESS read-only

STATUS mandatory

DESCRIPTION "The number of recipients specified in

all messages transmitted since MTA

Initialization. Recipients this MTA

had no responsibility for are not counted."

               ::= { mtaEntry 9 }

DESCRIPTION The id of the MTA as configured."

               ::= { mtaEntry 10 }

-----

-- Traps

-----

nsMailServerDown TRAP-TYPE

ENTERPRISE netscape

VARIABLES { nsmailEntityDescr, nsmailEntityVers,

nsmailEntityLocation,

nsmailEntityContact }

DESCRIPTION This trap is generated whenever the

agent detects the Netscape Mail

                                 Server to be (potentially) Down."

               ::= 5001

nsMailServerStart TRAP-TYPE

ENTERPRISE netscape

VARIABLES { nsmailEntityDescr, nsmailEntityVers,

nsmailEntityLocation }

DESCRIPTION "This trap is generated whenever

the agent detects the Netscape

                                Mail Server to have (re)started."

               ::= 5002

nsMailServerNoResponse TRAP-TYPE

ENTERPRISE netscape

VARIABLES { nsmailEntityDescr, nsmailEntityVers,

nsmailEntityLocation,

nsmailEntityContact }

DESCRIPTION "This trap is generated whenever the

agent detects the Netscape Mail Server

not responding to its polls. This

TRAP is different from the

'nsMailServerDown' TRAP, as the

Netscape Mail Server is still

potentially up, serving its main

purpose. But, the SNMP data collection

entity has most likely gone down."

               ::= 5003

END