INTERNET DRAFT DOCSIS Telephony-Return MIB July 30,
1998
Telephony-Return Interface (TRI) Management Information Base
for DOCSIS-compliant Telephony-Return Cable Modems and
Cable Modem Termination Systems
<draft-ietf-ipcdn-tri-mib-00.txt>
S. Adiraju
J. Fijolek
Jack_Fijolek@3Com.com
3Com Corp
July 30, 1998
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 draft documents valid for a maximum of six
months. Internet Drafts may be updated, replaced, or obsoleted by
other documents at any time. It is not appropriate to use Internet
Drafts as reference material or to cite them other than as a "working
draft" or "work in progress."
Please check the I-D abstract listing contained in each Internet
Draft directory to learn the current status of this or any Internet
Draft. Distribution of this document is unlimited.
Abstract
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 defines a basic set of
managed objects for SNMP-based management of MCNS compliant Cable
Modems and Cable Modem Termination Systems. This memo specifies a
MIB module in a manner that is compliant to the SNMPv2 SMI. The set
of objects is consistent with the SNMP framework and existing SNMP
standards. This memo does not specify a standard for the Internet
community. This memo is a product of the IPCDN working group within
the Internet Engineering Task Force. Comments are solicited and
should be addressed to the working group's mailing list at
ipcdn@terayon.com and/or the author.
Expires January 1999 [Page 1]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
1. Introduction
1.1 The Network Management Framework
The Internet-standard Network Management Framework consists of three
components. They are:
RFC 1155 which defines the SMI, the mechanisms used for describing
and naming objects for the purpose of management. RFC 1212 defines a
more concise description mechanism, which is wholly consistent with
the SMI.
RFC 1156 which defines MIB-I, the core set of managed objects for the
Internet suite of protocols. RFC 1213, defines MIB-II, an evolution
of MIB-I based on implementation experience and new operational
requirements.
RFC 1157 which defines the SNMP, the protocol used for network access
to managed objects.
The Framework permits new objects to be defined for the purpose of
experimentation and evaluation.
The SNMPv2 Network Management Framework consists of four major
components. They are:
0 RFC 1442 which defines the SMI, the mechanisms used
for describing and naming objects for the purpose of
management.
0 STD 17, RFC 1213 defines MIB-II, the core set of
managed objects for the Internet suite of protocols.
0 RFC 1445 which defines the administrative and other
architectural aspects of the framework.
0 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.0 Objects
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) [1,
and 2] defined in the SMI. In particular, each object has a name, a
syntax, and an encoding. The name is an object identifier, an
administratively assigned name, which specifies an object type. The
Expires January 1999 [Page 2]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
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 OBJECT
DESCRIPTOR, to also refer to the object type.
The syntax of an object type defines the abstract data structure
corresponding to that object type. The ASN.1 language is used for
this purpose. However, the SMI [RFC1155] purposely restricts the
ASN.1 constructs which may be used. These restrictions are
explicitly made for simplicity.
The encoding of an object type is simply how that object type is
represented using the object type's syntax. Implicitly tied to the
notion of an object type's syntax and encoding is how the object type
is represented when being transmitted on the network.
The SMI specifies the use of the basic encoding rules of ASN.1 [BER]
subject to the additional requirements imposed by the SNMP.
2.2 Format of Definitions
Section 5 contains contains the specification of all object types
contained in this MIB module. The object types are defined using the
conventions defined in the SMI, as amended by the extensions
specified in [RFC1212]
3.0 Discussion
The data-over-cable-system telephony return interface specification
is documented in [5]. The management requirements of this interface
are detailed in that specification. Specific inferences to other
controls are itemized in the following list: The Telephony Return CM
and telephony Return CMTS MUST support the objects in the IPCDN RFI
MIB [3] and Cable Device MIB [4] that are applicable to downstream
only. In a Telephony Return CM, the management of the telephony modem
MAY use the Modem Management Information Base (MIB) using SMIv2
[RFC1696]. These objects generally require proprietary handling to
address the telephony modems serial AT command interface. It is not
reasonable to require MIB support for all third party dial modems.
However, if a dial modem is integrated within a cable modem product,
using a subset of the RFC1696 Modem MIB objects to control the dial
modem is practical and reasonable. Guidelines for dial modem
physical capabilities are provided in [5]. Guidelines for specific
applicability of [3], [4], and [RFC1696] for telephony return systems
are provided in [6].
Expires January 1999 [Page 3]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
4.0 Management Requirements
4.1 Handling Of Service Provider Descriptor (SPD) Updates
The Cable Modem service provider option process is documented in [5].
An operator creates service provider descriptors (SPDs) that the CMTS
will send to all CMs in its domain. The operator must signify one
entry as factory default for initial dial-in service for a
subscriber. An external telco-return modem may have objects within
the selected SPD modified by changing corresponding scalar objects on
a CM using the network management station.
One reason for the SNMP-initiated SPD update is to allow loading of
permanent Telephone Numbers, Login Usernames and Login Passwords
without requiring individualized configuration files on a per CM
basis. For example the operator MAY:
o set docsTrTsSPDphoneNum1 to dial a temporary access Telephone
Number. A factory default CM user may then be given some limited
access by using default values for all other SPD objects.
o Temporary system access may be upgraded after an undefined
operator specified authentication. The operator may then set
docsTrTsSPDphoneNum1, docsTrTsSPDuserName, docsTrTsSPDuserPassword
(phone/login/password) or any other CM SPD objects to individualized
settings.
o These settings remain in effect unless changed by Telephone
Settings Options in the CMs TFTP configuration file.
o The operator may want to change individual Telephone Settings
Options for CMs sharing a global TFTP configuration file. For
example, the DHCP Server (ip address) can be changed for all CMs
sharing a configuration file without affecting any other active SPD
settings by having just DHCP server parameter set in the file. All
other MIB modified SPD parameters would remain active (excepting
docsTrTsSPDdhcpAddress MIB object) if docsTrCmSPDpersistEnable is
TRUE.
5.0 Definitions
TelcoReturnCABLE-DEVICE-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE,
Integer32, IpAddress, Unsigned32
FROM SNMPv2-SMI
DisplayString, DateAndTime, TruthValue, RowStatus
Expires January 1999 [Page 4]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
FROM SNMPv2-TC
OBJECT-GROUP, MODULE-COMPLIANCE
FROM SNMPv2-CONF
InterfaceIndexOrZero
FROM DOCS-IF-MIB
transmission
FROM RFC1213-MIB
;
docsTrCmMIB MODULE-IDENTITY
LAST-UPDATED "9807280920Z"
ORGANIZATION "3Com - Cable Access"
CONTACT-INFO " Jack Fijolek/Srinivyasa Murthy Adiraju
Postal: 3Com
3800 Golf Road
Rolling Meadows, IL 60008
Tel: +1 847 2622201 +1 847 2622205
Fax: +1 847 2620258
E-mail: Srinivyasa_Adiraju@3Com.com"
DESCRIPTION
"TELCO Return MIB for Data Over Cable Access modems and
termination systems"
::= { transmission 128 }
docsTrCmMIBObjects OBJECT IDENTIFIER ::= {docsTrCmMIB 1}
docsTrCmBase OBJECT IDENTIFIER ::= { docsTrCmMIBObjects 1}
docsTrCmCapability OBJECT-TYPE
SYNTAX INTEGER {
other(1),
telcoReturn(2),
twoWay(3),
threeWay(4)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object represents the CM Capability. A CM may be
'TelcoReturn(2)', or 'TwoWay(3)', or as a Three Way Capable
'ThreeWay(4).'
or Other e.g., undefined"
::= { docsTrCmBase 1 }
docsTrCmMode OBJECT-TYPE
SYNTAX INTEGER {
other(1),
telcoReturn(2),
Expires January 1999 [Page 5]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
twoWay(3)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object represents the CM Operating Mode. A CM may be
operating
as
'TelcoReturn(2)', or 'TwoWay(3)', or Other e.g, undefined"
::= { docsTrCmBase 2 }
docsTrMsgBase OBJECT IDENTIFIER ::= { docsTrCmMIBObjects 2}
docsTrMsgBaseTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsTrMsgBaseEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Telco Return Message Base Table"
::= { docsTrMsgBase 1 }
docsTrMsgBaseEntry OBJECT-TYPE
SYNTAX DocsTrMsgBaseEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table contains the information about
TCD/TSI
and
USRbackOff for
Each interface"
INDEX { docsTrMsgIfIndex }
::= { docsTrMsgBaseTable 1 }
DocsTrMsgBaseEntry ::= SEQUENCE {
docsTrMsgIfIndex InterfaceIndexOrZero,
docsTrMsgTCDInterval INTEGER,
docsTrMsgTSIInterval INTEGER,
docsTrMsgUSRBackOff Unsigned32,
docsTrMsgRowValue RowStatus
}
docsTrMsgIfIndex OBJECT-TYPE
Expires January 1999 [Page 6]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
SYNTAX InterfaceIndexOrZero
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The value corresponds to ifIndex for either a
CATV
MAC
or other network interface. In Cable Modems, the
default
value is the customer side interface. In Cable
Modem
Termination Systems, this object has to be
specified
to create a row in this table."
::= { docsTrMsgBaseEntry 1 }
docsTrMsgTCDInterval OBJECT-TYPE
SYNTAX INTEGER (500..2000)
UNITS "Milliseconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The interval between CMTS transmission of successive
Telephony
Channel Descriptor (TCD) messages at this interface. This is
also the
time interval a CM minimally scans on a specific channel for
TCD
message. "
REFERENCE
"Data Over Cable Telephony Return Interface Specification,
[1], TCD Interval."
DEFVAL { 2000 }
::= { docsTrMsgBaseEntry 2 }
docsTrMsgTSIInterval OBJECT-TYPE
SYNTAX INTEGER (1000..4000)
UNITS "Milliseconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The interval between CMTS transmission of successive
Termination
System Interface (TSI) messages for a downstream channel at
this
interface.
This is also the time interval a CM should scan on a specific
Expires January 1999 [Page 7]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
channel
for a TSI message and sets the frequency the CM monitors the
CMTS
epoch counter. "
REFERENCE
"Data Over Cable Telephony Return Interface Specification,
[6], TSI Interval."
DEFVAL { 4000 }
::= { docsTrMsgBaseEntry 3 }
docsTrMsgUSRBackOff OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object represents the number of times CMTS will
resend
User
Station Reset
messages if unacknowledged by CM; Number of duplicate reset
requests
CM may receive"
DEFVAL{4}
--REFERENCE
--"Data Over Cable Telephony Return Interface Specification,
--[6], USR Backoff ."
::= { docsTrMsgBaseEntry 4 }
docsTrMsgRowValue OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" Controls and reflects the status of rows in this table "
::= { docsTrMsgBaseEntry 5 }
docsTrTsSPD OBJECT IDENTIFIER ::= { docsTrCmMIBObjects 3}
docsTrTsSPDTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsTrTsSPDEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
" A table of all the SPD messages that get sent out"
::= { docsTrTsSPD 1 }
docsTrTsSPDEntry OBJECT-TYPE
Expires January 1999 [Page 8]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
SYNTAX DocsTrTsSPDEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This an entry in the SPD table which is one of the SPD that
get sent out to the cable modems"
INDEX {docsTrTsSPDindex}
::= {docsTrTsSPDTable 1}
DocsTrTsSPDEntry ::= SEQUENCE {
docsTrTsSPDindex INTEGER,
docsTrTsSPDname DisplayString,
docsTrTsSPDphoneNum1 DisplayString,
docsTrTsSPDphoneNum2 DisplayString,
docsTrTsSPDphoneNum3 DisplayString,
docsTrTsSPDConnThreshold Integer32,
docsTrTsSPDuserName DisplayString,
docsTrTsSPDuserPassword OCTET STRING,
docsTrTsSPDpppAuth INTEGER,
docsTrTsSPDdhcpAuth INTEGER,
docsTrTsSPDradiusRealm DisplayString,
docsTrTsDemandDialTimer Unsigned32,
docsTrTsSPDdhcpAddress IpAddress,
docsTrTsSPDfactoryDef INTEGER,
docsTrTsSPDstatus INTEGER
}
docsTrTsSPDindex OBJECT-TYPE
SYNTAX INTEGER(1..16383)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The unique number which identifies the Service Provider
Descriptor in the SPD Table"
::= { docsTrTsSPDEntry 1}
docsTrTsSPDname OBJECT-TYPE
SYNTAX DisplayString (SIZE(1..128))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The name of the Service Provider. A value of null string
means no name"
DEFVAL { "" }
Expires January 1999 [Page 9]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
::= { docsTrTsSPDEntry 2 }
docsTrTsSPDphoneNum1 OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..128))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The first phone number to try when trying to reach the
service
provider. A value of null string means no phone number"
DEFVAL { "" }
::= { docsTrTsSPDEntry 3 }
docsTrTsSPDphoneNum2 OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..128))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The second phone number to try to reach the service provider
when the first number fails. A value of null string means no phone
number"
DEFVAL { "" }
::= { docsTrTsSPDEntry 4 }
docsTrTsSPDphoneNum3 OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..128))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The third phone number to try in case the 1st and 2nd
numbers
fail. A value of null string means no phone number"
DEFVAL { "" }
::= { docsTrTsSPDEntry 5 }
docsTrTsSPDConnThreshold OBJECT-TYPE
SYNTAX Integer32 (1..10)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The number of sequential connection try failures before
indicating connection failure. "
DEFVAL { 1 }
::= { docsTrTsSPDEntry 6 }
docsTrTsSPDuserName OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..32))
MAX-ACCESS read-create
Expires January 1999 [Page 10]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
STATUS current
DESCRIPTION
"The username the CM will use during PAP or CHAP
authentication
over telco link during the initialization procedure."
DEFVAL { "guest" }
::= { docsTrTsSPDEntry 7 }
docsTrTsSPDuserPassword OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (1..15))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The password that the CM will use during the PAP or CHAP
authentication over the telco link during the initialization
procedure."
DEFVAL { "" }
::= { docsTrTsSPDEntry 8 }
docsTrTsSPDpppAuth OBJECT-TYPE
SYNTAX INTEGER { other(1),
uNegotiate(1),
uPAP(2),
uCHAP(3)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This instructs the telco return modem of the authentication
procedure to perform over the telco link."
DEFVAL { uNegotiate }
::= { docsTrTsSPDEntry 9 }
docsTrTsSPDdhcpAuth OBJECT-TYPE
SYNTAX INTEGER { other(1),
disable(2),
enable(3)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Boolean value reserved to indicate CM MUST authenticate DHCP
messages when enable."
DEFVAL { disable }
::= { docsTrTsSPDEntry 10 }
docsTrTsSPDradiusRealm OBJECT-TYPE
SYNTAX DisplayString (SIZE(0..128))
Expires January 1999 [Page 11]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The realm name contains the ASCII string which defines a
RADIUS
server domain. TRAC RADIUS MUST proxy requests to a server
realm.
RADIUS syntax is to address login name as Username-
String@Realm-String
- RADIUS Realm-String MUST be correlated by the TRAC RADIUS
to
the
IP address of a RADIUS server to be proxied to for the
designated
RADIUS user profile. If the TRAC RADIUS is the server for
designated
user profile,the default value is the null string."
DEFVAL { "" }
::= { docsTrTsSPDEntry 11 }
docsTrTsDemandDialTimer OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object represents the number of seconds of networking
inactivity allowed before hang-up, the default zero indicates
demand
dial is not enabled. Demand dial is desirable to allow the
traffic
engineering of dial-in ports. Networking activity monitoring
is
a
vendor specific implementation"
DEFVAL{ 0 }
::= { docsTrTsSPDEntry 12 }
docsTrTsSPDdhcpAddress OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-create
STATUS current
DESCRIPTION
" The ip address of the DHCP server."
::= { docsTrTsSPDEntry 13 }
docsTrTsSPDfactoryDef OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-create
Expires January 1999 [Page 12]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
STATUS current
DESCRIPTION
"boolean value, if true, indicates the SPD which SHOULD be
used
by the CM during factory default procedure."
::= { docsTrTsSPDEntry 14 }
docsTrTsSPDstatus OBJECT-TYPE
SYNTAX INTEGER {
disabled(1),
enabled(2),
deleted(3)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"When the status is set to disabled, that
corresponding SPD entry will be disabled from the CMTS.
When
the status is set to enabled, that corresponding SPD entry
will be enabled in the CMTS. When the status is set to
deleted, that corresponding SPD entry will be deleted from
the CMTS. At least one SPD entry must be present and
enabled
in a CMTS"
::= { docsTrTsSPDEntry 15 }
docsTrCmSPDBase OBJECT IDENTIFIER ::= { docsTrCmMIBObjects 4}
docsTrCmSPDpersistEnable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"truth value contains interpretation of the SPD MIB objects
for the CM local ISP selection method. If
docsTrCmSPDpersistEnable
is false (2), no SPD MIB objects persist in an active SPD if
ANY
SPD parameters are set in a TFTP configuration
file. In such a case the CM MUST use only configuration file
SPD
settings and defaults to construct the active SPD.
When docsTrCmSPDpersistEnable is true(1), SPD MIB objects
persist in an active SPD except where specific SPD
parameters in a
Expires January 1999 [Page 13]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
TFTP configuration file override their corresponding
specific SPD MIB
objects. In such a case the CM MUST first use the
configuration file
SPD settings, then use ANY SPD MIB object previously set
where TFTP
configuration file parameters are not present, lastly,
appropriate
defaults defined in [6] to construct the active SPD. The
initial
setting is false(2)."
::= { docsTrCmSPDBase 1 }
docsTrCmSPDname OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object contains the service provider Name"
::= { docsTrCmSPDBase 2 }
docsTrCmISPphoneNum1 OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object contains the Primary ISP Phone number 1"
::= { docsTrCmSPDBase 3 }
docsTrCmISPphoneNum2 OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object contains the Backup Phone number 2 "
::= { docsTrCmSPDBase 4 }
docsTrCmISPphoneNum3 OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object contains the Backup Phone number 3"
::= { docsTrCmSPDBase 5 }
docsTrCmconnThreshold OBJECT-TYPE
SYNTAX Integer32 (1..10)
MAX-ACCESS read-write
Expires January 1999 [Page 14]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
STATUS current
DESCRIPTION
"The number of sequential connection try failures before
indicating connection failure."
::= { docsTrCmSPDBase 6 }
docsTrCmPPPloginName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object contains the PPP Login Name"
::= { docsTrCmSPDBase 7 }
docsTrCmPPPpassword OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object contains the PPP Password"
::= { docsTrCmSPDBase 8 }
docsTrCmPPPauth OBJECT-TYPE
SYNTAX INTEGER{
none(1),
pap(2),
chap(3)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object contains the secure login verification method"
::= { docsTrCmSPDBase 9 }
docsTrCmDHCPauth OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object contains the DHCP Server IP Address"
::= { docsTrCmSPDBase 10 }
docsTrCmradiusRealm OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object contains the RADIUS Cable Access Realm Name"
Expires January 1999 [Page 15]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
::= { docsTrCmSPDBase 11 }
docsTrCmdemandDialTimer OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
" This object represents the number of seconds of networking
inactivity allowed before hang-up, the default zero indicates
demand
dial is not enabled. Demand dial is desirable to allow the
traffic
engineering of dial-in ports. Networking activity monitoring
is
a
vendor specific implementation"
::= { docsTrCmSPDBase 12 }
docsTrCmDHCPserver OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object contains the DHCP Server IP Address"
::= { docsTrCmSPDBase 13 }
docsTrCmSessionBase OBJECT IDENTIFIER ::= { docsTrCmMIBObjects 5}
docsTrCmPingAuth OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object has a value of 'true(1)' if CPE is allowed to
generate
ping (ICMP request) across the network, 'false(2)' if
otherwise.
A CM
may be on a demand dial inactivity timer where restricting
CPE
ping
may not be allowed to hold the port connection"
::= { docsTrCmSessionBase 1 }
docsTrCmTerminateOnOffHook OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
Expires January 1999 [Page 16]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
DESCRIPTION
"This object has a value of 'true(1)' if CM must terminate
data
session on off hook/voice call events, 'false(2)' if
otherwise.
"
::= { docsTrCmSessionBase 2 }
docsTrCmCMType OBJECT-TYPE
SYNTAX INTEGER {
extGeneric(1),
extRouted(2),
internalISA(3),
internalPCI(4),
internalMAC(5),
internalSBUS(6),
internalUSB(7),
internalOther(8)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object represents the CM configured type. A CM may be
configured as an MCNS bridge 'ExtGeneric(1)',
as an IP forwarder 'ExtRouted(2)',
or as a single host 'InternalXXX(3-8). "
::= { docsTrCmSessionBase 3 }
docsTrCmRingNoAns OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object defines the number of rings before answer a CM
should
allow (ring threshold) before failing the connection as NO
ANSWER"
::= { docsTrCmSessionBase 4 }
docsTrCmWaitInterval OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object defines the number of seconds of time CM should
wait
for a call to ring after dialing"
Expires January 1999 [Page 17]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
::= { docsTrCmSessionBase 5 }
-- The telephony return modem Command group addresses scripting
for dial-modem
-- where a command and result are processed to allow a
management station to
-- communicate without apriori mapping of a given AT command
set. This process
-- is provided to allow some degree of control over non-
integrated dial modems
-- by external telephony return cable modems. Internal (to host)
cable modems
-- have OS specific vehicles available to handle dial-up.
Integrated telephone
-- and cable solutions should have specific source to deal with
dial initialization
-- and modem commands of bundled hardware.
docsTrCmCommand OBJECT IDENTIFIER ::= { docsTrCmMIBObjects 6
}
docsTrCmCdCode OBJECT-TYPE
SYNTAX INTEGER{
noError(1),
unable(2),
unrecognizedCommand(3),
noResponse(4),
notConnected(5),
connected(6),
onLine(7),
unsupportedCommand(8),
deviceDisabled(9),
deviceInTestMode(10),
testFailed(11),
deviceInSecurityMode(12),
noRTS(13),
noDTR(14),
wrongLoopbackSpeed(15),
noLoopbackInARQ(16),
pendingSoftwareDownload(17),
invalidFrequency(18),
noLoopCurrent(19),
noDialTone(20),
noLineDetected(21)
}
MAX-ACCESS read-only
Expires January 1999 [Page 18]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
STATUS current
DESCRIPTION
"The value of this object indicates a further description
of what went wrong when a command fails."
::= { docsTrCmCommand 1 }
docsTrCmCdMgtStationId OBJECT-TYPE
SYNTAX OCTET STRING (SIZE(0..8))
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is a generic read-write variable that a
Management Station (MS) can use to guarantee that the
results from a given command are the results of a command
issued by that specific MS. Each MS must SET a unique
value to this object when doing commands and GET the value
of this object together with docsTrCmCdResult and
docsTrCmCdReqId to detect interference from other MSs."
::= { docsTrCmCommand 2 }
docsTrCmCdReqId OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object contains the request ID field of the SNMP PDU
which
invoked the most recent command on the telephony return
modem,
if the request-id is unknown or undefined, the object
contains
the
value zero "
::= { docsTrCmCommand 3}
docsTrCmCdResult OBJECT-TYPE
SYNTAX OCTET STRING (SIZE(0..64000))
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object can contain parameters that are raw results to
the
particular command being issued. "
::= { docsTrCmCommand 4 }
docsTrCmCdForce OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
Expires January 1999 [Page 19]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
STATUS current
DESCRIPTION
"In certain cases the telephony return modem may be in
a state where certain commands could adversely affect
connections.
In such cases, a command request with this object not present
or
set to 'false(2)' will result in a warning. If the operator
elects to ignore such warnings, this object can be set to
force 'true(1)' in a subsequent request to cause the command
to
be
carried out regardless of the potentially hazardous effect."
::= { docsTrCmCommand 5 }
docsTrCmCdScript OBJECT-TYPE
SYNTAX OCTET STRING (SIZE(0..64000))
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object can contain parameters that specifically define
a
particular command or series of commands being issued
directly to the dial modem. Script execution depends
upon the inclusion in this string of a suitable escape
sequence
(usually +++) to enter a dial modem into a command mode."
::= { docsTrCmCommand 6 }
docsTrCmCdStatus OBJECT-TYPE
SYNTAX INTEGER{
none(1),
success(2),
inProgress(3),
notSupported(4),
unAbleToRun(5),
aborted(6),
failed(7)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object contains the result of the most recently
requested command or test, or the value none(1) if no
commands have been requested since last reset."
::= { docsTrCmCommand 7 }
--
Expires January 1999 [Page 20]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
-- Conformance Statements
--
docsTrCmConformance OBJECT IDENTIFIER ::= { docsTrCmMIB 2 }
docsTrCmGroups OBJECT IDENTIFIER ::= {
docsTrCmConformance 1
}
docsTrCmCompliances OBJECT IDENTIFIER ::= {
docsTrCmConformance
2 }
docsCmBasicCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for MCNS Telephony Return Cable
Modems and Cable Modem Termination Systems"
MODULE -- This module
MANDATORY-GROUPS { docsTrCmBaseGroup }
-- conditionally mandatory groups
GROUP docsTrCmBaseGroup
DESCRIPTION
"Must be implemented on CMs, not implemented
on
CMTSs."
GROUP docsTrMsgBaseGroup
DESCRIPTION
"Must be implemented on CMTSs and Optional on
CMs."
GROUP docsTrTsSPDBaseGroup
DESCRIPTION
"Must be implemented on CMTSs, not
implemented
on Cable Modems."
GROUP docsTrCmSessionSPDBaseGroup
DESCRIPTION
"Must be implemented on Cable Modems, not
implemented on CMTSs."
GROUP docsTrCmSessionBaseGroup
Expires January 1999 [Page 21]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
DESCRIPTION
"Must be implemented on Cable Modems, not
implemented on CMTSs."
GROUP docsTrCmCommandGroup
DESCRIPTION
"Optional on Cable Modems, not implemented on
CMTSs."
::= { docsTrCmCompliances 1 }
docsTrCmBaseGroup OBJECT-GROUP
OBJECTS {
docsTrCmCapability ,
docsTrCmMode
}
STATUS current
DESCRIPTION
"A collection of objects providing CM base parameters"
::= { docsTrCmGroups 1}
docsTrMsgBaseGroup OBJECT-GROUP
OBJECTS {
docsTrMsgTCDInterval ,
docsTrMsgTSIInterval ,
docsTrMsgUSRBackOff ,
docsTrMsgRowValue
}
STATUS current
DESCRIPTION
"A collection of objects providing CM and CMTS message
configured parameters"
::= { docsTrCmGroups 2}
docsTrTsSPDGroup OBJECT-GROUP
OBJECTS {
docsTrTsSPDname ,
docsTrTsSPDphoneNum1 ,
docsTrTsSPDphoneNum2 ,
docsTrTsSPDphoneNum3 ,
docsTrTsSPDConnThreshold ,
docsTrTsSPDuserName ,
docsTrTsSPDuserPassword ,
docsTrTsSPDpppAuth ,
docsTrTsSPDdhcpAuth ,
docsTrTsSPDradiusRealm ,
docsTrTsDemandDialTimer,
docsTrTsSPDdhcpAddress ,
docsTrTsSPDstatus ,
Expires January 1999 [Page 22]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
docsTrTsSPDfactoryDef
}
STATUS current
DESCRIPTION
"A collection of objects global SPD configured parameters
for CMTS"
::= { docsTrCmGroups 3}
docsTrCmSPDBaseGroup OBJECT-GROUP
OBJECTS {
docsTrCmSPDname ,
docsTrCmISPphoneNum1 ,
docsTrCmISPphoneNum2 ,
docsTrCmISPphoneNum3 ,
docsTrCmconnThreshold ,
docsTrCmPPPloginName ,
docsTrCmPPPpassword ,
docsTrCmPPPauth ,
docsTrCmDHCPauth ,
docsTrCmradiusRealm ,
docsTrCmdemandDialTimer,
docsTrCmDHCPserver
}
STATUS current
DESCRIPTION
"A collection of objects providing local SPD parameters
for
a CM"
::= { docsTrCmGroups 4}
docsTrCmSessionBaseGroup OBJECT-GROUP
OBJECTS {
docsTrCmPingAuth ,
docsTrCmTerminateOnOffHook,
docsTrCmCMType,
docsTrCmRingNoAns,
docsTrCmWaitInterval
}
STATUS current
DESCRIPTION
"A collection of objects providing session based
parameters
for
dial modem"
::= { docsTrCmGroups 5}
docsTrCmCommandGroup OBJECT-GROUP
OBJECTS {
Expires January 1999 [Page 23]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
docsTrCmCdCode,
docsTrCmCdMgtStationId,
docsTrCmCdReqId,
docsTrCmCdForce,
docsTrCmCdResult ,
docsTrCmCdScript,
docsTrCmCdStatus
}
STATUS current
DESCRIPTION
"A collection of objects providing a command script
interface
to the serial dial modem device"
::= { docsTrCmGroups 6 }
END
Expires January 1999 [Page 24]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
7.0 Security
Security is not specifically addressed in this memo.
8.0 References
[1] Information processing systems - Open Systems Interconnection
Specification of Abstract Syntax Notation One (ASN.1),
International Organization for Standardization, International
Standard 8824, December 1987.
[2] Information processing systems - Open Systems Interconnection
Specification of Basic Encoding Rules for Abstract Notation
One (ASN.1), International Organization for Standardization,
International Standard 8825, December 1987.
[3] G. Roeck,draft-ietf-ipcdn-rf-interface-mib-04.txt,
Radio Frequency (RF) Interface Management Information Base for
MCNS compliant RF interfaces", May 1998.
[4] G. Roeck, draft-ietf-ipcdn-cable-device-mib-04.txt,
Cable Device Management Information Base for MCNS compliant
Cable Modems and Cable Modem Termination Systems", May 1998.
[5] MCNS Data Over Cable Services Cable Modem Telephony Return
Interface Specification SP-CMTRI-I01-970804, MCNS, August 1997.
[6] MCNS Data Over Cable Services Interface Specification Operations
Support System Interface Specification Telephony Return MIB,
SP-OSSI-TRD03-980209, MCNS, February 1998.
[RFC1155] Rose M., and K. McCloghrie, "Structure and Identification
of Management Information for TCP/IP-based internets", RFC 1155,
Performance Systems International, Hughes LAN Systems, May
1990.
[RFC1212] Rose, M., and K. McCloghrie, Editors, "Concise MIB
Definitions", RFC 1212, Performance Systems International,
Hughes LAN Systems, March 1991.
[RFC1213] Rose M., Editor, "Management Information Base for Network
Management of TCP/IP-based internets: MIB-II", RFC 1213,
Expires January 1999 [Page 25]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
- 26 -
Performance Systems International, March 1991.
[RFC1573] K. McCloghrie, F. Kastenholz, "Evolution of the
Interfaces Group of MIB-II", RFC1573, 01/20/1994.
[RFC1696] J. Barnes et al., Modem Management Information Base (MIB)
using SMIv2, IETF RFC-1696, August 1994.
Author's Address
Jack Fijolek
3Com Corporation
Cable Access Division
3800 Golf Road
Rolling Meadows, IL 60008
Phone: (847) 262-2201
EMail: Jack_Fijolek@3COM.COM
Expires January 1999 [Page 26]
INTERNET DRAFT DOCSIS Telephony Return MIB July 30, 1998
Expires January 1999 [Page 27]
