new modem mib document
Jim Barnes <barnes@xylogics.com> Mon, 17 January 1994 16:46 UTC
Received: from ietf.nri.reston.va.us by IETF.CNRI.Reston.VA.US id aa00503; 17 Jan 94 11:46 EST
Received: from CNRI.RESTON.VA.US by IETF.CNRI.Reston.VA.US id aa00498; 17 Jan 94 11:46 EST
Received: from apache.telebit.com by CNRI.Reston.VA.US id aa14185; 17 Jan 94 11:46 EST
Received: from america.Sunnyvale.Telebit.CO (america-bb.sunnyvale.telebit.com) by apache (4.1/SMI-4.1/Telebit-Apache-Brent-930718) id AA13153 to ietf-archive@cnri.reston.va.us; Mon, 17 Jan 94 08:33:53 PST
Received: from apache by america.Sunnyvale.Telebit.COM (4.0/america.telebit.com-DBC-930718) id AA13728 to modemmgt@apache.Sunnyvale.Telebit.COM; Mon, 17 Jan 94 08:33:48 PST
Received: from atlas.xylogics.com by apache (4.1/SMI-4.1/Telebit-Apache-Brent-930718) id AA13150 to modemmgt@Telebit.COM; Mon, 17 Jan 94 08:33:18 PST
Received: from spock.xylogics.com by atlas.xylogics.com with SMTP id AA20798 (5.65c/UK-2.1-931222); Mon, 17 Jan 1994 11:37:34 -0500
Received: by spock.xylogics.com id AA07757 (4.1/UK-2.1-921215); Mon, 17 Jan 94 11:30:31 EST
Message-Id: <7757.9401171630@spock.xylogics.com>
Sender: ietf-archive-request@IETF.CNRI.Reston.VA.US
From: Jim Barnes <barnes@xylogics.com>
Date: Mon, 17 Jan 1994 11:30:30 -0500
X-Mailer: Mail User's Shell (7.1.0 4/25/90)
To: modemmgt@telebit.com
Subject: new modem mib document
draft Modem MIB January 14, 1994
Modem MIB
<draft-ietf-modemmgt-mdmmib-01.txt>
January 14, 1994
Jim Barnes, Les Brown, Rick Roysten, Steven Waldbusser
Status of this Memo
This document is an Internet Draft. Internet Drafts are working
documents of the Internet Engineering Task Force (IETF), its Areas, and
its Working Groups. Note that other groups may also distribute working
documents as Internet Drafts.
Internet Drafts are valid for a maximum of six months and may be
updated, replaced, or obsoleted by other documents at any time. It is
inappropriate to use Internet Drafts as reference material or to cite
them other than as a "work in progress".
Expires July 14, 1994 [Page 1]
draft Modem MIB January 14, 1994
1. Introduction
This memo defines an experimental portion of the Management Information
Base (MIB) for use with network management protocols in the Internet
community. In particular, it describes managed objects used for
managing dial-up modems and similar dial-up devices. This MIB module
provides a set of objects that are the minimum necessary to provide the
ability to monitor and control those devices, and is consistent with the
SNMP framework and existing SNMP standards.
Expires July 14, 1994 [Page 2]
draft Modem MIB January 14, 1994
2. The SNMPv2 Network Management Framework
The SNMPv2 Network Management Framework consists of four major
components. They are:
o RFC 1442 which defines the SMI, the mechanisms used for describing
and naming objects for the purpose of management.
o RFC 1213 defines MIB-II, the core set of managed objects for the
Internet suite of protocols.
o RFC 1445 which defines the administrative and other architectural
aspects of the framework.
o RFC 1448 which defines the protocol used for network access to
managed objects.
The Framework permits new objects to be defined for the purpose of
experimentation and evaluation.
2.1. Object Definitions
Managed objects are accessed via a virtual information store, termed the
Management Information Base or MIB. Objects in the MIB are defined
using the subset of Abstract Syntax Notation One (ASN.1) defined in the
SMI. In particular, each object object type is named by an OBJECT
IDENTIFIER, an administratively assigned name. The object type together
with an object instance serves to uniquely identify a specific
instantiation of the object. For human convenience, we often use a
textual string, termed the descriptor, to refer to the object type.
Expires July 14, 1994 [Page 3]
draft Modem MIB January 14, 1994
3. Definitions
Modem-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
experimental, Counter32, Integer32
FROM SNMPv2-SMI
DisplayString, TruthValue, TimeInterval FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP
FROM SNMPv2-CONF;
mdmMIB MODULE-IDENTITY
LAST-UPDATED "9401160000Z"
ORGANIZATION "IETF Modem Management Working Group"
CONTACT-INFO
" Steven Waldbusser
Postal: Carnegie Mellon University
4910 Forbes Ave
Pittsburgh, PA, 15213
Tel: 412-268-6628
Fax: 412-268-4987
E-mail: waldbusser@cmu.edu"
DESCRIPTION
"The MIB module for management of dial-up modems."
::= { experimental 49 }
mdmMIBObjects OBJECT IDENTIFIER ::= { mdmMIB 1 }
Expires July 14, 1994 [Page 4]
draft Modem MIB January 14, 1994
-- conformance information
mdmConformance OBJECT IDENTIFIER ::= { mdmMIB 2 }
mdmGroups OBJECT IDENTIFIER ::= { mdmConformance 1 }
mdmCompliances OBJECT IDENTIFIER ::= { mdmConformance 2 }
-- compliance statements
mdmCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for SNMPv2 entities which
implement the modem MIB."
MODULE -- this module
MANDATORY-GROUPS { mdmIDGroup, mdmLineInterfaceGroup,
mdmDTEInterfaceGroup, mdmCallControlGroup,
mdmStatisticsGroup }
::= { mdmCompliances 1 }
Expires July 14, 1994 [Page 5]
draft Modem MIB January 14, 1994
-- units of conformance
mdmIDGroup OBJECT-GROUP
OBJECTS { mdmIDManufacturerOID, mdmIDProductDetails }
STATUS current
DESCRIPTION
"A collection of objects that identify the manufacturer and
model information for a modem."
::= { mdmGroups 1 }
mdmLineInterfaceGroup OBJECT-GROUP
OBJECTS { mdmLineCarrierLossControl, mdmLineCarrierLossTime,
mdmLineCompressionEfficiency, mdmLineCapabilitiesID,
mdmLineCapabilitiesEnableRequested,
mdmLineCapabilitiesEnableGranted }
STATUS current
DESCRIPTION
"A collection of objects that describe the configuration and
state of the modem's line interface."
::= { mdmGroups 2 }
mdmDTEInterfaceGroup OBJECT-GROUP
OBJECTS { mdmDTEActionOnDTROnToOff, mdmDTEActionOnDTROffToOn,
mdmDTESyncTimingSource, mdmDTESyncAsyncMode,
mdmDTEInactivityTimeout }
STATUS current
DESCRIPTION
"A collection of objects that describe the configuration and
state of the modem's DTE interface."
::= { mdmGroups 3 }
mdmCallControlGroup OBJECT-GROUP
OBJECTS { mdmCCAutoAnswerEnable, mdmCCRingsBeforeAnswer,
mdmCCCallSetUpFailTimer, mdmCCCallProgressDetect,
mdmCCResultCodeEnable, mdmCCEscapeAction,
mdmCCCallDuration, mdmCCConnectFailReason,
mdmCCCurrentLineRate, mdmCCModulationSchemeUsed,
mdmCCErrorControlUsed, mdmCCCompressionTypeUsed,
mdmStoredDialStringIndex, mdmStoredDialString }
STATUS current
DESCRIPTION
"A collection of objects that describe the configuration of
call control capabilities on the modem and the status of
calls placed with this modem."
::= { mdmGroups 4 }
Expires July 14, 1994 [Page 6]
draft Modem MIB January 14, 1994
mdmStatisticsGroup OBJECT-GROUP
OBJECTS { mdmStatsIncomingConnectionRequests,
mdmStatsIncomingConnectionFailures,
mdmStatsIncomingAbnormalTerminations,
mdmStatsOutgoingConnectionRequests,
mdmStatsOutgoingConnectionFailures,
mdmStatsOutgoingAbnormalTerminations,
mdmStatsConnectionTimeouts, mdmStatsCarrierLossDisconnects,
mdmStatsRingNoAnswers, mdmStatsDTERingNoAnswers,
mdmStatsSyncLostEvents, mdmStatsRetrains,
mdmStats2400OrLessConnections, mdmStats2400To14400Connections,
mdmStatsGreaterThan14400Connections,
mdmStatsErrorControlledConnections,
mdmStatsCompressedConnections,
mdmStatsSentOctets, mdmStatsReceivedOctets,
mdmStatsSentDataFrames, mdmStatsReceivedDataFrames,
mdmStatsResentFrames, mdmStatsErrorFrames }
STATUS current
DESCRIPTION
"A collection of objects that describe the state of calls on
this modem."
::= { mdmGroups 5 }
mdmNumber OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of modem rows in the modem table. This value
defines the maximum value of the mdmIndex object."
::= { mdmMIBObjects 1 }
-- The modem ID table.
mdmIDTable OBJECT-TYPE
SYNTAX SEQUENCE OF MdmIDEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The base table for the modems managed by this MIB. The
mdmLineTable, mdmDTEInterfaceTable, mdmCallControlTable, and
mdmStatsTable all augment the rows defined in this table."
::= { mdmMIBObjects 2 }
mdmIDEntry OBJECT-TYPE
Expires July 14, 1994 [Page 7]
draft Modem MIB January 14, 1994
SYNTAX MdmIDEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Entries in this table are created only by the agent. One
entry exists for each modem managed by the agent."
INDEX { mdmIndex }
::= { mdmIDTable 1 }
MdmIDEntry ::= SEQUENCE {
mdmIndex Integer32,
mdmIDManufacturerOID OBJECT IDENTIFIER,
mdmIDProductDetails DisplayString
}
mdmIndex OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique number for each modem that ranges from 1 to
mdmNumber. The value must remain constant at least from one
re-initialization of the network management agent to the
next."
::= { mdmIDEntry 1 }
mdmIDManufacturerOID OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This value is intended to identify the manufacturer, model,
and version of this modem. This may be used to identify the
existance of enterprise specific functions and behaviours."
REFERENCE
"V.58 attribute manufacturerID subfield ManufacturerOI"
::= { mdmIDEntry 2 }
mdmIDProductDetails OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..79))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual description of this device, including the
manufacturer's name, modem model name, hardware revision,
Expires July 14, 1994 [Page 8]
draft Modem MIB January 14, 1994
firmware revision, and optionally, its serial number. The
exact format of this description is defined by the vendor.
This description may only contain characters from the NVT
ASCII character set."
REFERENCE
"V.58 attribute manufacturerID subfield productDetails"
::= { mdmIDEntry 3 }
-- The modem Line Interface Table
mdmLineTable OBJECT-TYPE
SYNTAX SEQUENCE OF MdmLineEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The modem Line Table augments the modem ID table."
::= { mdmMIBObjects 3 }
mdmLineEntry OBJECT-TYPE
SYNTAX MdmLineEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Entries in this table are created only by the agent. One
entry exists for each modem managed by the agent."
AUGMENTS { mdmIDEntry }
::= { mdmLineTable 1 }
MdmLineEntry ::= SEQUENCE {
mdmLineCarrierLossControl TruthValue,
mdmLineCarrierLossTime Integer32,
mdmLineCompressionEfficiency Integer32
}
mdmLineCarrierLossControl OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"If true, the associated mdmLineCarrierLossTime is consulted
to determine the duration of carrier loss to accept without
hanging up. If false, the modem will not hang up upon loss
of carrier. If set to false, this can be useful to make the
modem tolerant of very poor lines, with the disadvantage
that no notification is made of an unproductive or
Expires July 14, 1994 [Page 9]
draft Modem MIB January 14, 1994
disconnected line."
DEFVAL { true }
::= { mdmLineEntry 1 }
mdmLineCarrierLossTime OBJECT-TYPE
SYNTAX Integer32 (1..254)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Duration in 10ths of a second the modem waits after loss of
carrier before hanging up. This allows the modem to
distinguish between a momentary lapse in line quality and a
true disconnect and can be useful to tune the tolerance of
the modem to lines of poor quality."
REFERENCE "V.58 lineSignalFailDisconnectTimer"
::= { mdmLineEntry 2 }
mdmLineCompressionEfficiency OBJECT-TYPE
SYNTAX Integer32 (0..65535)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of bytes transferred into the compression
encoder divided by the number of bytes transferred out of
the encoder, multiplied by 100 for either the current or
last call."
REFERENCE "V.58 compressionEfficiency"
::= { mdmLineEntry 3 }
mdmLineCapabilitiesTable OBJECT-TYPE
SYNTAX SEQUENCE OF MdmLineCapabilitiesEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A list of protocol capabilities for this modem."
::= { mdmMIBObjects 4 }
mdmLineCapabilitiesEntry OBJECT-TYPE
SYNTAX MdmLineCapabilitiesEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A listing of a protocol that this modem is capable of.
Entries in this table are created only by the agent. One
entry exists for each protocol that the modem is capable of,
Expires July 14, 1994 [Page 10]
draft Modem MIB January 14, 1994
regardless of whether that protocol is enabled or not.
This table is useful for providing an inventory of the
capabilities on a modem, and allowing the manager to enable
or disable capabilities from the menu of available
possibilities. Row creation is not required to enable or
disable capabilities."
INDEX { mdmIndex, mdmLineCapabilitiesIndex }
::= { mdmLineCapabilitiesTable 1 }
MdmLineCapabilitiesEntry ::= SEQUENCE {
mdmLineCapabilitiesIndex Integer32,
mdmLineCapabilitiesID OBJECT IDENTIFIER,
mdmLineCapabilitiesEnableRequested INTEGER,
mdmLineCapabilitiesEnableGranted INTEGER
}
mdmLineCapabilitiesIndex OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique index for this capabilities entry."
::= { mdmLineCapabilitiesEntry 1 }
mdmLineCapabilitiesID OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An identifier for this capability. Standard protocol
capabilities will have identifiers registered in this
document or other companion standards documents.
Proprietary protocol capabilities will be registered by
their respective organization. All capabilities, standard
or vendor-specific, shall be registered in this table."
::= { mdmLineCapabilitiesEntry 2 }
mdmLineCapabilities OBJECT IDENTIFIER ::= { mdmLineCapabilitiesTable 2 }
mdmLineCapabilitiesV22 OBJECT IDENTIFIER ::= { mdmLineCapabilities 1 }
mdmLineCapabilitiesV22bis OBJECT IDENTIFIER ::= { mdmLineCapabilities 2 }
mdmLineCapabilitiesV32 OBJECT IDENTIFIER ::= { mdmLineCapabilities 3 }
mdmLineCapabilitiesV32bis OBJECT IDENTIFIER ::= { mdmLineCapabilities 4 }
mdmLineCapabilitiesV34 OBJECT IDENTIFIER ::= { mdmLineCapabilities 5 }
mdmLineCapabilitiesV42 OBJECT IDENTIFIER ::= { mdmLineCapabilities 6 }
Expires July 14, 1994 [Page 11]
draft Modem MIB January 14, 1994
mdmLineCapabilitiesV42bis OBJECT IDENTIFIER ::= { mdmLineCapabilities 7 }
mdmLineCapabilitiesMNP4 OBJECT IDENTIFIER ::= { mdmLineCapabilities 8 }
mdmLineCapabilitiesMNP5 OBJECT IDENTIFIER ::= { mdmLineCapabilities 9 }
mdmLineCapabilitiesV29 OBJECT IDENTIFIER ::= { mdmLineCapabilities 10 }
mdmLineCapabilitiesV33 OBJECT IDENTIFIER ::= { mdmLineCapabilities 11 }
mdmLineCapabilitiesBell208 OBJECT IDENTIFIER ::= { mdmLineCapabilities 12 }
mdmLineCapabilitiesEnableRequested OBJECT-TYPE
SYNTAX INTEGER {
disabled(1),
optional(2),
preferred(3)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The requested configuration of this capability. If this
value is 'disabled(1)', this is a request to disable this
protocol. If this value is 'preferred(3)', this is a
request to enable this protocol, and to prefer it in any
negotiation over other appropriate protocols that have a
value of 'optional(2)'."
DEFVAL { preferred }
::= { mdmLineCapabilitiesEntry 3 }
mdmLineCapabilitiesEnableGranted OBJECT-TYPE
SYNTAX INTEGER {
disabled(1),
optional(2),
preferred(3)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The actual configuration of this capability. The agent
shall attempt to set this as close as possible to the
associated mdmLineCapabilitiesEnableRequested value. The
agent shall make this determination in an implementation-
specific manner that may take into account the configuration
of other capabilities or other considerations. The modem
will choose in an implementation-specific manner between
multiple mutually-exclusive capabilities that each have the
same (non-disabled) value. However, the modem must prefer
all capabilities with a value of 'preferred(3)' over all
capabilities with a value of 'optional(2)'."
Expires July 14, 1994 [Page 12]
draft Modem MIB January 14, 1994
::= { mdmLineCapabilitiesEntry 4 }
-- DTE Interface Table
mdmDTEInterfaceTable OBJECT-TYPE
SYNTAX SEQUENCE OF MdmDTEInterfaceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The modem DTE Interface Table augments the modem ID table."
::= { mdmMIBObjects 5 }
mdmDTEInterfaceEntry OBJECT-TYPE
SYNTAX MdmDTEInterfaceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Entries in this table are created only by the agent. One
entry exists for each modem managed by the agent."
AUGMENTS { mdmIDEntry }
::= { mdmDTEInterfaceTable 1 }
MdmDTEInterfaceEntry ::= SEQUENCE {
mdmDTEActionOnDTROnToOff INTEGER,
mdmDTEActionOnDTROffToOn INTEGER,
mdmDTESyncTimingSource INTEGER,
mdmDTESyncAsyncMode INTEGER,
mdmDTEInactivityTimeout Integer32
}
mdmDTEActionOnDTROnToOff OBJECT-TYPE
SYNTAX INTEGER {
ignore(1),
escapeToCommandMode(2),
disconnectCall(3),
resetModem(4)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Defines the action the modem will take when DTR drops.
If the value is set to ignore(1), the modem takes no action
when DTR drops. Typically, mdmDTEActionOnDTROffToOn would
Expires July 14, 1994 [Page 13]
draft Modem MIB January 14, 1994
also be set to ignore(1) if this object is set to ignore(1).
If the value is escapeToCommandMode(2), the modem enters
command mode. If the value is disconnectCall(3), the
current call (if any) is terminated. If the value is
resetModem(4), the current call (if any) is terminated and
the modem is reset."
DEFVAL { disconnectcall }
::= { mdmDTEInterfaceEntry 1 }
mdmDTEActionOnDTROffToOn OBJECT-TYPE
SYNTAX INTEGER {
ignore(1),
enableDial(2),
autoAnswerEnable(3),
establishConnection(4)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Defines the action the modem will take when DTR is raised.
If the value is set to ignore(1), the modem takes no action
when DTR is raised. Typically, mdmDTEActionOnDTROnToOff
would also be set to ignore(1) if this object is set to
ignore(1).
If the value is set to enableDial(2), the modem prepares to
dial an outgoing call. The number to dial still must be
specified (???). If the value is set to
autoAnswerEnable(3), the modem will be configured to answer
any incoming call. If the value is set to
establishConnection(4), the modem dials a number that has
been previously stored in NVRAM.(???)
Immediately after any reset or power-on of the modem, if the
DTR is high, the action specified here will be executed."
DEFVAL { autoAnswerEnable }
::= { mdmDTEInterfaceEntry 2 }
mdmDTESyncTimingSource OBJECT-TYPE
SYNTAX INTEGER {
internal(1),
external(2),
loopback(3),
Expires July 14, 1994 [Page 14]
draft Modem MIB January 14, 1994
network(4)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The clock source for synchronous transmissions. If set to
internal(1), the modem is the clock source and sends the
clock signals to the DTE. If set to external(2), the
transmit clock signals are provided by the DTE. If
loopback(3), the modem receiver clock is used for the
transmit clock. If network(4), the clock signals are
supplied by the DCE interface.
If the modem is not in synchronous mode, setting this object
will have no effect on the current operations of the modem."
REFERENCE "V.58 transmitClockSource"
DEFVAL { internal }
::= { mdmDTEInterfaceEntry 3 }
mdmDTESyncAsyncMode OBJECT-TYPE
SYNTAX INTEGER {
async(1),
sync(2),
syncAfterDial(3)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The operational mode of the modem. If the value is
syncAfterDial(3), the modem will accept commands in
asynchronous mode and change to synchronous mode to pass
data after a dial sequence has been executed."
DEFVAL { async }
::= { mdmDTEInterfaceEntry 4 }
mdmDTEInactivityTimeout OBJECT-TYPE
SYNTAX Integer32 (0..65535)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The amount of idle time in minutes that the modem will wait
before disconnecting a connection. When a call is connected
and no data is transferred (continuous marking condition) on
both circuits 103 and 104 for the specified time, the DCE
disconnects the call. If the value is 0, no idle disconnect
Expires July 14, 1994 [Page 15]
draft Modem MIB January 14, 1994
will occur. This function applies to start/stop switched
operations only."
REFERENCE "V.58 inactivityTimerSelect"
DEFVAL { 0 }
::= { mdmDTEInterfaceEntry 5 }
-- The Call Control Table
mdmCallControlTable OBJECT-TYPE
SYNTAX SEQUENCE OF MdmCallControlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The modem Call Control Table augments the modem ID table."
::= { mdmMIBObjects 6 }
mdmCallControlEntry OBJECT-TYPE
SYNTAX MdmCallControlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Entries in this table are created only by the agent. One
entry exists for each modem managed by the agent."
AUGMENTS { mdmIDEntry }
::= { mdmCallControlTable 1 }
MdmCallControlEntry ::= SEQUENCE {
mdmCCAutoAnswerEnable TruthValue,
mdmCCRingsBeforeAnswer Integer32,
mdmCCCallSetUpFailTimer Integer32,
mdmCCCallProgressDetect INTEGER,
mdmCCResultCodeEnable INTEGER,
mdmCCEscapeAction INTEGER,
mdmCCCallDuration Integer32,
mdmCCConnectFailReason INTEGER,
mdmCCCurrentLineRate Integer32,
mdmCCModulationSchemeUsed OBJECT IDENTIFIER,
mdmCCErrorControlUsed OBJECT IDENTIFIER,
mdmCCCompressionTypeUsed OBJECT IDENTIFIER
}
mdmCCAutoAnswerEnable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
Expires July 14, 1994 [Page 16]
draft Modem MIB January 14, 1994
DESCRIPTION
"Determines whether or not this modem will automatically go
offhook and answer the call when it detects a ring signal.
In TIA-602, mdmCCAutoAnswerEnable and mdmCCRingsBeforeAnswer
are controlled by register S0, where a value of zero
disables auto answer."
REFERENCE "V.58 autoAnswerEnable"
DEFVAL { false }
::= { mdmCallControlEntry 1 }
mdmCCRingsBeforeAnswer OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Determines which ring the modem will answer the phone on
when mdmCCAutoAnswerEnable is set to enable. In TIA-602,
mdmCCAutoAnswerEnable and mdmCCRingsBeforeAnswer are
controlled by register S0, where a value of zero disables
auto answer."
REFERENCE "V.58 ringsBeforeAnswer"
DEFVAL { 1 }
::= { mdmCallControlEntry 2 }
mdmCCCallSetUpFailTimer OBJECT-TYPE
SYNTAX Integer32 (0..255)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This parameter specifies the amount of time, in seconds,
that the modem shall allow between either answering a call
(automatically or manually) or completion of dialing, and
establishment of a connection with the remote modem. If no
connection is established during this time, the modem
disconnects from the line and returns a result code
indicating the cause of the disconnection. In TIA-602, this
is controlled by the value in the S7 register."
REFERENCE "V.58 callSetUpFailTimer"
DEFVAL { 30 }
::= { mdmCallControlEntry 3 }
mdmCCCallProgressDetect OBJECT-TYPE
SYNTAX INTEGER {
disabled(1),
dialToneDetectionEnabled(2),
Expires July 14, 1994 [Page 17]
draft Modem MIB January 14, 1994
busyToneDetectionEnabled(3),
bothEnabled(4)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"In TIA-602, call progress messages are controlled by the
ATX command. The setting of this parameter determines
whether or not the modem transmits particular result codes
to the DTE. It also controls whether or not the modem
verifies the presence of dial tone when it first goes off-
hook to begin dialing, and whether or not engaged tone (busy
signal) detection is enabled. However, this setting has no
effect on the operation of the 'W' dial modifier, which
always checks for dial tone regardless of this setting, nor
on the busy signal detection capability of the 'W' and '@'
dial modifiers. In V.58, the object
'displayCallProgressMessages' enables or disables the
display of call progress messages, and the objects
'dialToneDetection' and'busyDetection' independently control
the detection, but not reporting, of the dial tone and
engaged tone call progress signals respectively."
DEFVAL { bothEnabled }
::= { mdmCallControlEntry 4 }
mdmCCResultCodeEnable OBJECT-TYPE
SYNTAX INTEGER {
enable(1),
disable(2)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"When disabled, the DCE shall issue no 'result codes' of any
kind to the DTE either in response to unsolicited events
(eg. ring signal), or commands. In TIA-602, this is
controlled by the ATQ command. In V.58, the result code
enable and result code format are both controlled by the
single object 'responseModeSelect'."
REFERENCE "V.58 responseModeSelect"
DEFVAL { enable }
::= { mdmCallControlEntry 5 }
mdmCCEscapeAction OBJECT-TYPE
SYNTAX INTEGER {
Expires July 14, 1994 [Page 18]
draft Modem MIB January 14, 1994
ignoreEscape(1),
hangUp(2),
enterCommandMode(3)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The modem's action upon successfully recognizing the
'escape to command mode' character sequence."
DEFVAL { ignoreEscape }
::= { mdmCallControlEntry 6 }
-- Call status portion of the call control table
mdmCCCallDuration OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Present or last completed connection time in seconds. If
there have been no previous connections this value should be
-1."
::= { mdmCallControlEntry 7 }
mdmCCConnectFailReason OBJECT-TYPE
SYNTAX INTEGER {
other(1),
unknown(2), -- Use this if no previous call since reset
managementCommand(3),
inactivityTimerExpired(4),
dtrDrop(5), -- Ref: V.58 cct108TurnedOff
callSetupFailTimerExpired(6),
noAnswer(7),
noCarrier(8),
-- how are noAnswer and noCarrier differentiated
-- from callSetupFailTimerExpired?
loopCurrentInterrupted(9),
-- same as loopLoss(12) in last draft?
noDialTone(10),
voiceDetected(11),
lineBusy(12), -- Ref: V.58 engagedTone
Expires July 14, 1994 [Page 19]
draft Modem MIB January 14, 1994
noAnswerTone(13),
carrierLost(14),
trainingFailed(15),
noModulationInCommon(16),
invalidSpeed(17),
retrainFailed(18),
gstnCleardownReceived(19),
-- same as v32Cleardown in last draft?
faxDetected(20),
anyKeyAbort(21),
dteHangupCommand(22),
escapeSequence(23),
dteResetCommand(24),
linkDisconnectMsgReceived(25),
retransmitLimit(26), -- Ref: V.58 n400Exceeded
negotiationFailed(27),
v42SabmeTimeout(28),
v42BreakTimeout(29),
v42DisconnectCmd(30),
v42IdExchangeFail(31),
v42BadSetup(32),
v42InvalidCodeWord(33),
v42StringToLong(34),
v42InvalidCommand(35),
v42BisLossOfSynchronization(36),
mnpIncompatible(37)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the reason that the last connection or connection
attempt failed. The following explains the meaning of each
reason code.
other:
This code is selected when no other code is applicable.
unknown:
This code is selected when the failure reason is unknown.
managementCommand:
The network management system has issued a command to the
modem, for example, to initiate a dial call, a redial, or
a dial disconnect.
Expires July 14, 1994 [Page 20]
draft Modem MIB January 14, 1994
inactivityTimerExpired:
See the description under the 'mdmDTEInactivityTimeout'
object.
dtrDrop:
DTR has been turned off while the modem is strapped to
disconnect on DTR drop, for example, as specified
in TIA-602 (AT&D2).
callSetupFailTimerExpired:
The call establishment timer, for example, as specified
in TIA-602 (S7 register) has expired.
noAnswer: XXX
noCarrier: XXX
loopCurrentInterrupted:
For a GSTN connection, usually indicates that the line
interface cable has been disconnected from the modem or
the wall socket.
noDialTone:
If the modem is strapped to monitor for call progress tones,
for example, as specified in TIA-602 (ATX4), the modem has
failed to detect dial tone while attempting to dial a number.
voiceDetected: XXX
lineBusy:
Busy signal is detected while busy signal detection is enabled,
for example, as specified in TIA-602 (ATX4), or while
the 'W' or '@' dial modifier is used.
noAnswerTone: XXX
carrierLost:
Indicates that the modem has disconnected due to detection of
loss of carrier, providing the modem has been strapped
accordingly. In TIA-602, the S10 register determines the time
that loss of carrier must be detected before the modem
disconnects.
trainingFailed:
Indicates that the modems did not successfully train and reach
data mode on the previous connection.
noModulationInCommon:
Indicates that, during call establishment, the modems
determined that they had no common modulation.
invalidSpeed: XXX
retrainFailed:
Indicates that, although the modems did reach data mode on
the previous connection, they failed to reach data mode during
a subsequent retrain attempt.
gstnCleardownReceived:
Indicates that a GSTN cleardown code was received from the
Expires July 14, 1994 [Page 21]
draft Modem MIB January 14, 1994
remote modem (for example, a V.32 rate code with the rate bits
all cleared).
faxDetected: XXX
anyKeyAbort:
Indicates that the previous call was aborted before data mode
was reached, because the modem (either calling or answering)
received an extra character from the DTE.
dteHangupCommand:
Indicates that, while in command state, the modem received
a hangup command, for example, as specified in TIA-602 (ATH).
escapeSequence: XXX
dteResetCommand: XXX
linkDisconnectMsgReceived:
retransmitLimit:
Indicates that, while in V.42 error correcting mode, the
allowable number of retransmission attempts for any particular
frame was exceeded.
negotiationFailed:
Indicates that, while configured for error correcting only
mode,the modems failed to successfully negotiate an error
correcting link.
v42SabmeTimeout: XXX
v42BreakTimeout: XXX
v42DisconnectCmd: XXX
v42IdExchangeFail: XXX
v42BadSetup: XXX
v42InvalidCodeWord: XXX
v42StringToLong: XXX
v42InvalidCommand: XXX
v42BisLossOfSynchronization: XXX
mnpIncompatible: XXX
"
REFERENCE "V.58 callCleared"
::= { mdmCallControlEntry 8 }
mdmCCCurrentLineRate OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current link rate of a connection, or the last link
rate of the last connection in bits per second."
REFERENCE "V.58 transmissionSignallingRateActive"
::= { mdmCallControlEntry 9 }
Expires July 14, 1994 [Page 22]
draft Modem MIB January 14, 1994
mdmCCModulationSchemeUsed OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The modulation scheme of the current or previous call.
This shall be one of the values for modulation protocols
registered in the capabilities table for this modem."
REFERENCE "V.58 gstnModulationSchemeActive"
::= { mdmCallControlEntry 10 }
mdmCCErrorControlUsed OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the error control method used during the current
or previous call. This shall be one of the values for error
control protocols registered in the capabilities table for
this modem. If no error control protocol is in use, this
object shall have the value '{0 0}'."
REFERENCE "V.58 errorControlActive"
::= { mdmCallControlEntry 11 }
mdmCCCompressionTypeUsed OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the data compression method used during the
current or previous call. This shall be one of the values
for compression protocols registered in the capabilities
table for this modem. If no compression protocol is in use,
this object shall have the value '{0 0}'."
::= { mdmCallControlEntry 12 }
-- The Stored Dial String table
mdmStoredDialStringTable OBJECT-TYPE
SYNTAX SEQUENCE OF MdmStoredDialStringEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table of stored dial strings."
REFERENCE "V.58 telephoneNumbers"
Expires July 14, 1994 [Page 23]
draft Modem MIB January 14, 1994
::= { mdmMIBObjects 7 }
mdmStoredDialStringEntry OBJECT-TYPE
SYNTAX MdmStoredDialStringEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A stored dial string."
INDEX { mdmIndex, mdmStoredDialStringIndex }
::= { mdmStoredDialStringTable 1 }
MdmStoredDialStringEntry ::= SEQUENCE {
mdmStoredDialStringIndex Integer32,
mdmStoredDialString DisplayString
}
mdmStoredDialStringIndex OBJECT-TYPE
SYNTAX Integer32 (0..65535)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The unique index of a particular dial string."
::= { mdmStoredDialStringEntry 1 }
mdmStoredDialString OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A dial string stored in the modem."
::= { mdmStoredDialStringEntry 2 }
-- The Modem Statistics Table
mdmStatsTable OBJECT-TYPE
SYNTAX SEQUENCE OF MdmStatsEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The modem statistics Table augments the modem ID table."
::= { mdmMIBObjects 8 }
mdmStatsEntry OBJECT-TYPE
SYNTAX MdmStatsEntry
MAX-ACCESS not-accessible
Expires July 14, 1994 [Page 24]
draft Modem MIB January 14, 1994
STATUS current
DESCRIPTION
"Entries in this table are created only by the agent. One
entry exists for each modem managed by the agent."
AUGMENTS { mdmIDEntry }
::= { mdmStatsTable 1 }
MdmStatsEntry ::= SEQUENCE {
mdmStatsIncomingConnectionRequests Counter32,
mdmStatsIncomingConnectionFailures Counter32,
mdmStatsIncomingAbnormalTerminations Counter32,
mdmStatsOutgoingConnectionRequests Counter32,
mdmStatsOutgoingConnectionFailures Counter32,
mdmStatsOutgoingAbnormalTerminations Counter32,
mdmStatsConnectionTimeouts Counter32,
mdmStatsCarrierLossDisconnects Counter32,
mdmStatsRingNoAnswers Counter32,
mdmStatsDTERingNoAnswers Counter32,
mdmStatsSyncLostEvents Counter32,
mdmStatsRetrains Counter32,
mdmStats2400OrLessConnections Counter32,
mdmStats2400To14400Connections Counter32,
mdmStatsGreaterThan14400Connections Counter32,
mdmStatsErrorControlledConnections Counter32,
mdmStatsCompressedConnections Counter32,
mdmStatsSentOctets Counter32,
mdmStatsReceivedOctets Counter32,
mdmStatsSentDataFrames Counter32,
mdmStatsReceivedDataFrames Counter32,
mdmStatsResentFrames Counter32,
mdmStatsErrorFrames Counter32
}
mdmStatsIncomingConnectionRequests OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of incoming connection requests."
::= { mdmStatsEntry 1 }
mdmStatsIncomingConnectionFailures OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Expires July 14, 1994 [Page 25]
draft Modem MIB January 14, 1994
"The number of incoming connection requests that failed to
establish a connection."
::= { mdmStatsEntry 2 }
mdmStatsIncomingAbnormalTerminations OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of abnormal terminations of established incoming
connections."
::= { mdmStatsEntry 3 }
mdmStatsOutgoingConnectionRequests OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of outgoing connection requests."
::= { mdmStatsEntry 4 }
mdmStatsOutgoingConnectionFailures OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of outgoing connection requests that failed to
establish a connection."
::= { mdmStatsEntry 5 }
mdmStatsOutgoingAbnormalTerminations OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of abnormal terminations of established outgoing
connections."
::= { mdmStatsEntry 6 }
mdmStatsConnectionTimeouts OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of connection attempts (incoming and outgoing)
Expires July 14, 1994 [Page 26]
draft Modem MIB January 14, 1994
that failed to sync up and were timed out."
::= { mdmStatsEntry 7 }
mdmStatsCarrierLossDisconnects OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of connections (incoming and outgoing) that were
disconnected due to carrier loss."
::= { mdmStatsEntry 8 }
mdmStatsRingNoAnswers OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of events in which the modem has detected
ringing, but not enough rings were received to answer the
call."
::= { mdmStatsEntry 9 }
mdmStatsDTERingNoAnswers OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of events in which the modem has detected
ringing, and enough rings were received to answer the call,
but the DTE did not provide DTR in time to answer the call."
::= { mdmStatsEntry 10 }
mdmStatsSyncLostEvents OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times carrier sync was lost."
::= { mdmStatsEntry 11 }
mdmStatsRetrains OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
Expires July 14, 1994 [Page 27]
draft Modem MIB January 14, 1994
DESCRIPTION
"The number of retrains experienced on connections on this
line."
::= { mdmStatsEntry 12 }
-- Utilization counters
mdmStats2400OrLessConnections OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of connections initially established at a
modulation speed of 2400 bits per second or less."
::= { mdmStatsEntry 13 }
mdmStats2400To14400Connections OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of connections initially established at a
modulation speed of greater than 2400 bits per second and
less than 14400 bits per second."
::= { mdmStatsEntry 14 }
mdmStatsGreaterThan14400Connections OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of connections initially established at a
modulation speed of greater than 14400 bits per second."
::= { mdmStatsEntry 15 }
mdmStatsErrorControlledConnections OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of established connections using an error
control protocol."
::= { mdmStatsEntry 16 }
Expires July 14, 1994 [Page 28]
draft Modem MIB January 14, 1994
mdmStatsCompressedConnections OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of established connections using a compression
protocol."
::= { mdmStatsEntry 17 }
mdmStatsSentOctets OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of octets presented to the modem by the DTE."
::= { mdmStatsEntry 18 }
mdmStatsReceivedOctets OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of octets presented to the DTE by the modem."
::= { mdmStatsEntry 19 }
mdmStatsSentDataFrames OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of data frames sent (DTE or line?)."
::= { mdmStatsEntry 20 }
mdmStatsReceivedDataFrames OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of data frames received (DTE or line?)."
::= { mdmStatsEntry 21 }
mdmStatsResentFrames OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
Expires July 14, 1994 [Page 29]
draft Modem MIB January 14, 1994
DESCRIPTION
"The number of times this modem retransmits frames."
::= { mdmStatsEntry 22 }
mdmStatsErrorFrames OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of block errors received on the link."
::= { mdmStatsEntry 23 }
END
Expires July 14, 1994 [Page 30]
draft Modem MIB January 14, 1994
4. Acknowledgements
This document was produced by the Modem Management Working group.
In addition, the authors gratefully acknowledge the comments of Tom
Holodnik and Mark Lewis.
Expires July 14, 1994 [Page 31]
draft Modem MIB January 14, 1994
Table of Contents
1 Introduction .................................................... 2
2 The SNMPv2 Network Management Framework ......................... 3
2.1 Object Definitions ............................................ 3
3 Definitions ..................................................... 4
4 Acknowledgements ................................................ 31
Expires July 14, 1994 [Page 32]
- new modem mib document Jim Barnes