Welcome: Guest
NOTE: This site is no longer maintained. Upgrade to the latest version of ipMonitor ยป

SNMP Legend
Partial Branch
String
Counter
Integer
Enumerated Value
IP Address
Gauge
Time-Ticks
Object Identifier
Table
Row
Row Extension
Row-Key
Object Group
Trap
SNMP Center > Mibs > Oid-Tree View
DOCS-BPI-MIB: Cisco DOCSIS Baseline Privacy Interface

MIB Module for the DOCSIS Baseline Privacy Interface (BPI) at cable modems (CMs) and cable modem termination systems (CMTSs). CableLabs requires the implementation of this MIB in DOCSIS 1.0 cable modems that implement the Baseline Privacy Interface, as...

 iso (1)
 org (3)
 dod (6)
 internet (1)
 mgmt (2)
 mib-2 (1)
 transmission (10)
 docsIfMib (127)
 
 docsBpiMIB (5)
 docsBpiMIBObjects (1)
 docsBpiCmObjects (1)
 docsBpiCmBaseTable (1)
 docsBpiCmBaseEntry (1)
 docsBpiCmPrivacyEnable (1)
 docsBpiCmPublicKey (2)
 docsBpiCmAuthState (3)
 docsBpiCmAuthKeySequenceNumber (4)
 docsBpiCmAuthExpires (5)
 docsBpiCmAuthReset (6)
 docsBpiCmAuthGraceTime (7)
 docsBpiCmTEKGraceTime (8)
 docsBpiCmAuthWaitTimeout (9)
 docsBpiCmReauthWaitTimeout (10)
 docsBpiCmOpWaitTimeout (11)
 docsBpiCmRekeyWaitTimeout (12)
 docsBpiCmAuthRejectWaitTimeout (13)
 docsBpiCmAuthRequests (14)
 docsBpiCmAuthReplies (15)
 docsBpiCmAuthRejects (16)
 docsBpiCmAuthInvalids (17)
 docsBpiCmAuthRejectErrorCode (18)
 docsBpiCmAuthRejectErrorString (19)
 docsBpiCmAuthInvalidErrorCode (20)
 docsBpiCmAuthInvalidErrorString (21)
 docsBpiCmTEKTable (2)
 docsBpiCmTEKEntry (1)
 docsBpiCmTEKPrivacyEnable (1)
 docsBpiCmTEKState (2)
 docsBpiCmTEKExpiresOld (3)
 docsBpiCmTEKExpiresNew (4)
 docsBpiCmTEKKeyRequests (5)
 docsBpiCmTEKKeyReplies (6)
 docsBpiCmTEKKeyRejects (7)
 docsBpiCmTEKInvalids (8)
 docsBpiCmTEKAuthPends (9)
 docsBpiCmTEKKeyRejectErrorCode (10)
 docsBpiCmTEKKeyRejectErrorString (11)
 docsBpiCmTEKInvalidErrorCode (12)
 docsBpiCmTEKInvalidErrorString (13)
 docsBpiCmtsObjects (2)
 docsBpiCmtsBaseTable (1)
 docsBpiCmtsBaseEntry (1)
 docsBpiCmtsDefaultAuthLifetime (1)
 docsBpiCmtsDefaultTEKLifetime (2)
 docsBpiCmtsDefaultAuthGraceTime (3)
 docsBpiCmtsDefaultTEKGraceTime (4)
 docsBpiCmtsAuthRequests (5)
 docsBpiCmtsAuthReplies (6)
 docsBpiCmtsAuthRejects (7)
 docsBpiCmtsAuthInvalids (8)
 docsBpiCmtsAuthTable (2)
 docsBpiCmtsAuthEntry (1)
 docsBpiCmtsAuthCmMacAddress (1)
 docsBpiCmtsAuthCmPublicKey (2)
 docsBpiCmtsAuthCmKeySequenceNumber (3)
 docsBpiCmtsAuthCmExpires (4)
 docsBpiCmtsAuthCmLifetime (5)
 docsBpiCmtsAuthCmGraceTime (6)
 docsBpiCmtsAuthCmReset (7)
 docsBpiCmtsAuthCmRequests (8)
 docsBpiCmtsAuthCmReplies (9)
 docsBpiCmtsAuthCmRejects (10)
 docsBpiCmtsAuthCmInvalids (11)
 docsBpiCmtsAuthRejectErrorCode (12)
 docsBpiCmtsAuthRejectErrorString (13)
 docsBpiCmtsAuthInvalidErrorCode (14)
 docsBpiCmtsAuthInvalidErrorString (15)
 docsBpiCmtsTEKTable (3)
 docsBpiCmtsTEKEntry (1)
 docsBpiCmtsTEKLifetime (1)
 docsBpiCmtsTEKGraceTime (2)
 docsBpiCmtsTEKExpiresOld (3)
 docsBpiCmtsTEKExpiresNew (4)
 docsBpiCmtsTEKReset (5)
 docsBpiCmtsKeyRequests (6)
 docsBpiCmtsKeyReplies (7)
 docsBpiCmtsKeyRejects (8)
 docsBpiCmtsTEKInvalids (9)
 docsBpiCmtsKeyRejectErrorCode (10)
 docsBpiCmtsKeyRejectErrorString (11)
 docsBpiCmtsTEKInvalidErrorCode (12)
 docsBpiCmtsTEKInvalidErrorString (13)
 docsBpiMulticastControl (4)
 docsBpiIpMulticastMapTable (1)
 docsBpiIpMulticastMapEntry (1)
 docsBpiIpMulticastAddress (1)
 docsBpiIpMulticastPrefixLength (2)
 docsBpiIpMulticastServiceId (3)
 docsBpiIpMulticastMapControl (4)
 docsBpiMulticastAuthTable (2)
 docsBpiMulticastAuthEntry (1)
 docsBpiMulticastServiceId (1)
 docsBpiMulticastCmMacAddress (2)
 docsBpiMulticastAuthControl (3)
 docsBpiNotification (2)
 docsBpiConformance (3)
 docsBpiCompliances (1)
 docsBpiBasicCompliance (1)
 docsBpiGroups (2)
 docsBpiCmGroup (1)
 docsBpiCmtsGroup (2)
 docsBpiObsoleteObjectsGroup (3)
docsBpiCmBaseTable

This table describes the basic and authorization-related Baseline
Privacy attributes of each CM MAC interface.
docsBpiCmBaseEntry

Each entry contains objects describing attributes of one CM MAC
interface. An entry in this table exists for each ifEntry with an
ifType of docsCableMaclayer(127).
docsBpiCmPrivacyEnable

This object identifies whether this CM is provisioned to run
Baseline Privacy. This is analogous to the presence (or absence)
of the Baseline Privacy Configuration Setting option. The status
of each individual SID with respect to Baseline Privacy is
captured in the docsBpiCmTEKPrivacyEnable object.
docsBpiCmPublicKey

The value of this object is a DER-encoded RSAPublicKey ASN.1 type
string, as defined in the RSA Encryption Standard (PKCS #1) [22],
corresponding to the public key of the CM. The 74, 106, 140, and
270 byte key encoding lengths correspond to 512 bit, 768 bit, 1024
bit, and 2048 public moduli respectively.
docsBpiCmAuthState

The value of this object is the state of the CM authorization
FSM.  The start state indicates that FSM is in its initial state.
docsBpiCmAuthKeySequenceNumber

The value of this object is the authorization key sequence number
for this FSM.
docsBpiCmAuthExpires

The value of this object is the actual clock time when the current
authorization for this FSM expires. If the CM does not have an active
authorization, then the value is of the expiration date and time of
the last active authorization.
docsBpiCmAuthReset

Setting this object to TRUE generates a Reauthorize event in the
authorization FSM. Reading this object always returns FALSE.
docsBpiCmAuthGraceTime

The value of this object is the grace time for an authorization key.
A CM is expected to start trying to get a new authorization key
beginning AuthGraceTime seconds before the authorization key actually
expires.
docsBpiCmTEKGraceTime

The value of this object is the grace time for a TEK.  A CM is
expected to start trying to get a new TEK beginning TEKGraceTime
seconds before the TEK actually expires.
docsBpiCmAuthWaitTimeout

The value of this object is the Authorize Wait Timeout.
docsBpiCmReauthWaitTimeout

The value of this object is the Reauthorize Wait Timeout in seconds.
docsBpiCmOpWaitTimeout

The value of this object is the Operational Wait Timeout in seconds.
docsBpiCmRekeyWaitTimeout

The value of this object is the Rekey Wait Timeout in seconds.
docsBpiCmAuthRejectWaitTimeout

The value of this object is the Authorization Reject Wait Timeout in
seconds.
docsBpiCmAuthRequests

The value of this object is the count of times the CM has
transmitted an Authorization Request message.
docsBpiCmAuthReplies

The value of this object is the count of times the CM has
received an Authorization Reply message.
docsBpiCmAuthRejects

The value of this object is the count of times the CM has
received an Authorization Reject message.
docsBpiCmAuthInvalids

The value of this object is the count of times the CM has
received an Authorization Invalid message.
docsBpiCmAuthRejectErrorCode

The value of this object is the enumerated description of the
Error-Code in most recent Authorization Reject message received by
the CM.  This has value unknown(2) if the last Error-Code value was
0, and none(1) if no Authorization Reject message has been received
since reboot.
docsBpiCmAuthRejectErrorString

The value of this object is the Display-String in most recent
Authorization Reject message received by the CM.  This is a zero
length string if no Authorization Reject message has been received
since reboot.
docsBpiCmAuthInvalidErrorCode

The value of this object is the enumerated description of the
Error-Code in most recent Authorization Invalid message received by
the CM.  This has value unknown(2) if the last Error-Code value was
0, and none(1) if no Authorization Invalid message has been received
since reboot.
docsBpiCmAuthInvalidErrorString

The value of this object is the Display-String in most recent
Authorization Invalid message received by the CM.  This is a zero
length string if no Authorization Invalid message has been received
since reboot.
docsBpiCmTEKTable

This table describes the attributes of each CM Traffic Encryption Key
(TEK) association. The CM maintains (no more than) one TEK association
per SID per CM MAC interface.
docsBpiCmTEKEntry

Each entry contains objects describing the TEK association attributes
of one SID. The CM MUST create one entry per unicast SID, regardless
of whether the SID was obtained from a Registration Response message,
or from an Authorization Reply message.
docsBpiCmTEKPrivacyEnable

This object identifies whether this SID is provisioned to run
Baseline Privacy. This is analogous to enabling Baseline Privacy on
a provisioned SID using the Class-of-Service Privacy Enable option.
Baseline Privacy is not effectively enabled for any SID unless
Baseline Privacy is enabled for the CM, which is managed via the
docsBpiCmPrivacyEnable object.
docsBpiCmTEKState

The value of this object is the state of the indicated TEK FSM.
The start(1) state indicates that FSM is in its initial state.
docsBpiCmTEKExpiresOld

The value of this object is the actual clock time for expiration
of the immediate predecessor of the most recent TEK for this FSM.
If this FSM has only one TEK, then the value is the time of activation
of this FSM.
docsBpiCmTEKExpiresNew

The value of this object is the actual clock time for expiration
of the most recent TEK for this FSM.
docsBpiCmTEKKeyRequests

The value of this object is the count of times the CM has transmitted
a Key Request message.
docsBpiCmTEKKeyReplies

The value of this object is the count of times the CM has received
a Key Reply message, including a message whose authentication failed.
docsBpiCmTEKKeyRejects

The value of this object is the count of times the CM has received
a Key Reject message, including a message whose authentication failed.
docsBpiCmTEKInvalids

The value of this object is the count of times the CM has received
a TEK Invalid message, including a message whose authentication failed.
docsBpiCmTEKAuthPends

The value of this object is the count of times an Authorization
Pending (Auth Pend) event occurred in this FSM.
docsBpiCmTEKKeyRejectErrorCode

The value of this object is the enumerated description of the
Error-Code in most recent Key Reject message received by the CM. This
has value unknown(2) if the last Error-Code value was 0, and none(1)
if no Key Reject message has been received since reboot.
docsBpiCmTEKKeyRejectErrorString

The value of this object is the Display-String in most recent Key
Reject message received by the CM. This is a zero length string if no
Key Reject message has been received since reboot.
docsBpiCmTEKInvalidErrorCode

The value of this object is the enumerated description of the
Error-Code in most recent TEK Invalid message received by the CM.
This has value unknown(2) if the last Error-Code value was 0, and
none(1) if no TEK Invalid message has been received since reboot.
docsBpiCmTEKInvalidErrorString

The value of this object is the Display-String in most recent TEK
Invalid message received by the CM. This is a zero length string if
no TEK Invalid message has been received since reboot.
docsBpiCmtsBaseTable

This table describes the basic Baseline Privacy attributes of each
CMTS MAC interface.
docsBpiCmtsBaseEntry

Each entry contains objects describing attributes of one CMTS MAC
interface. An entry in this table exists for each ifEntry with an
ifType of docsCableMaclayer(127).
docsBpiCmtsDefaultAuthLifetime

The value of this object is the default lifetime, in seconds, the
CMTS assigns to a new authorization key.
docsBpiCmtsDefaultTEKLifetime

The value of this object is the default lifetime, in seconds, the
CMTS assigns to a new Traffic Encryption Key (TEK).
docsBpiCmtsDefaultAuthGraceTime

This object was obsoleted because the provisioning system, not the CMTS,
manages the authorization key grace time for DOCSIS CMs.
docsBpiCmtsDefaultTEKGraceTime

This object was obsoleted because the provisioning system, not the CMTS,
manages the Traffic Encryption Key (TEK) grace time for DOCSIS CMs.
docsBpiCmtsAuthRequests

The value of this object is the count of times the CMTS has
received an Authorization Request message from any CM.
docsBpiCmtsAuthReplies

The value of this object is the count of times the CMTS has
transmitted an Authorization Reply message to any CM.
docsBpiCmtsAuthRejects

The value of this object is the count of times the CMTS has
transmitted an Authorization Reject message to any CM.
docsBpiCmtsAuthInvalids

The value of this object is the count of times the CMTS has
transmitted an Authorization Invalid message to any CM.
docsBpiCmtsAuthTable

This table describes the attributes of each CM authorization
association. The CMTS maintains one authorization association with
each Baseline Privacy-enabled CM on each CMTS MAC interface.
docsBpiCmtsAuthEntry

Each entry contains objects describing attributes of one
authorization association. The CMTS MUST create one entry per CM per
MAC interface, based on the receipt of an Authorization Request
message, and MUST not delete the entry before the CM authorization
permanently expires.
docsBpiCmtsAuthCmMacAddress

The value of this object is the physical address of the CM to
which the authorization association applies.
docsBpiCmtsAuthCmPublicKey

The value of this object is a DER-encoded RSAPublicKey ASN.1 type
string, as defined in the RSA Encryption Standard (PKCS #1) [22],
corresponding to the public key of the CM. The 74, 106, 140, and
270 byte key encoding lengths correspond to 512 bit, 768 bit, 1024
bit, and 2048 public moduli respectively. This is a zero-length
string if the CMTS does not retain the public key.
docsBpiCmtsAuthCmKeySequenceNumber

The value of this object is the authorization key sequence number
for this CM.
docsBpiCmtsAuthCmExpires

The value of this object is the actual clock time when the current
authorization for this CM expires. If this CM does not have an
active authorization, then the value is of the expiration date and
time of the last active authorization.
docsBpiCmtsAuthCmLifetime

The value of this object is the lifetime, in seconds, the CMTS
assigns to an authorization key for this CM.
docsBpiCmtsAuthCmGraceTime

The value of this object is the grace time for the authorization key
in seconds.  The CM is expected to start trying to get a new
authorization key beginning AuthGraceTime seconds before the
authorization key actually expires.
docsBpiCmtsAuthCmReset

Setting this object to invalidateAuth(2) causes the CMTS to
invalidate the current CM authorization key, but not to transmit an
Authorization Invalid message nor to invalidate unicast TEKs.  Setting
this object to sendAuthInvalid(3) causes the CMTS to invalidate the
current CM authorization key, and to transmit an Authorization Invalid
message to the CM, but not to invalidate unicast TEKs.  Setting this
object to invalidateTeks(4) causes the CMTS to invalidate the current
CM authorization key, to transmit an Authorization Invalid message to
the CM, and to invalidate all unicast TEKs associated with this CM
authorization. Reading this object returns the most-recently-set value
of this object, or returns noResetRequested(1) if the object has not
been set since the last CMTS reboot.
docsBpiCmtsAuthCmRequests

The value of this object is the count of times the CMTS has
received an Authorization Request message from this CM.
docsBpiCmtsAuthCmReplies

The value of this object is the count of times the CMTS has
transmitted an Authorization Reply message to this CM.
docsBpiCmtsAuthCmRejects

The value of this object is the count of times the CMTS has
transmitted an Authorization Reject message to this CM.
docsBpiCmtsAuthCmInvalids

The value of this object is the count of times the CMTS has
transmitted an Authorization Invalid message to this CM.
docsBpiCmtsAuthRejectErrorCode

The value of this object is the enumerated description of the
Error-Code in most recent Authorization Reject message transmitted to
the CM.  This has value unknown(2) if the last Error-Code value was
0, and none(1) if no Authorization Reject message has been transmitted
to the CM.
docsBpiCmtsAuthRejectErrorString

The value of this object is the Display-String in most recent
Authorization Reject message transmitted to the CM.  This is a
zero length string if no Authorization Reject message has been
transmitted to the CM.
docsBpiCmtsAuthInvalidErrorCode

The value of this object is the enumerated description of the
Error-Code in most recent Authorization Invalid message transmitted
to the CM.  This has value unknown(2) if the last Error-Code value was
0, and none(1) if no Authorization Invalid message has been
transmitted to the CM.
docsBpiCmtsAuthInvalidErrorString

The value of this object is the Display-String in most recent
Authorization Invalid message transmitted to the CM.  This is a
zero length string if no Authorization Invalid message has been
transmitted to the CM.
docsBpiCmtsTEKTable

This table describes the attributes of each CM Traffic Encryption
Key (TEK) association. The CMTS maintains one TEK association per BPI
SID on each CMTS MAC interface.
docsBpiCmtsTEKEntry

Each entry contains objects describing attributes of one TEK
association on a particular CMTS MAC interface. The CMTS MUST create
one entry per SID per MAC interface, based on the receipt of an
Key Request message, and MUST not delete the entry before the CM
authorization for the SID permanently expires.
docsBpiCmtsTEKLifetime

The value of this object is the lifetime, in seconds, the CMTS assigns
to keys for this TEK association.
docsBpiCmtsTEKGraceTime

The value of this object is the grace time for the TEK in seconds.
The CM is expected to start trying to get a new TEK beginning
TEKGraceTime seconds before the TEK actually expires.
docsBpiCmtsTEKExpiresOld

The value of this object is the actual clock time for expiration
of the immediate predecessor of the most recent TEK for this FSM.
If this FSM has only one TEK, then the value is the time of activation
of this FSM.
docsBpiCmtsTEKExpiresNew

The value of this object is the actual clock time for expiration
of the most recent TEK for this FSM.
docsBpiCmtsTEKReset

Setting this object to TRUE causes the CMTS to invalidate the current
active TEK(s) (plural due to key transition periods), and to generate
a new TEK for the associated SID; the CMTS MAY also generate an
unsolicited TEK Invalid message, to optimize the TEK synchronization
between the CMTS and the CM. Reading this object always returns
FALSE.
docsBpiCmtsKeyRequests

The value of this object is the count of times the CMTS has
received a Key Request message.
docsBpiCmtsKeyReplies

The value of this object is the count of times the CMTS has
transmitted a Key Reply message.
docsBpiCmtsKeyRejects

The value of this object is the count of times the CMTS has
transmitted a Key Reject message.
docsBpiCmtsTEKInvalids

The value of this object is the count of times the CMTS has
transmitted a TEK Invalid message.
docsBpiCmtsKeyRejectErrorCode

The value of this object is the enumerated description of the
Error-Code in the most recent Key Reject message sent in response to
a Key Request for this BPI SID. This has value unknown(2) if the last
Error-Code value was 0, and none(1) if no Key Reject message has been
received since reboot.
docsBpiCmtsKeyRejectErrorString

The value of this object is the Display-String in the most recent
Key Reject message sent in response to a Key Request for this BPI
SID.  This is a zero length string if no Key Reject message has been
received since reboot.
docsBpiCmtsTEKInvalidErrorCode

The value of this object is the enumerated description of the
Error-Code in the most recent TEK Invalid message sent in association
with this BPI SID.  This has value unknown(2) if the last Error-Code
value was 0, and none(1) if no TEK Invalid message has been received
since reboot.
docsBpiCmtsTEKInvalidErrorString

The value of this object is the Display-String in the most recent TEK
Invalid message sent in association with this BPI SID.  This is a zero
length string if no TEK Invalid message has been received since reboot.
docsBpiIpMulticastMapTable

This table describes the mapping of IP multicast address prefixes to
multicast SIDs on each CMTS MAC interface.
docsBpiIpMulticastMapEntry

Each entry contains objects describing the mapping of one IP
multicast address prefix to one multicast SID on one CMTS MAC
interface. The CMTS uses the mapping when forwarding downstream IP
multicast traffic.
docsBpiIpMulticastAddress

This object represents the IP multicast address (prefix) to be
mapped by this row, in conjunction with
docsBpiIpMulticastPrefixLength.
docsBpiIpMulticastPrefixLength

This object represents the IP multicast address prefix length
for this row. The value of this object represents the length in
bits of docsBpiIpMulticastAddress for multicast address
comparisons, using big-endian ordering. An IP multicast address
matches this row if the (docsBpiIpMulticastPrefixLength) most
significant bits of the IP multicast address and of the
(docsBpiIpMulticastAddress) are identical.
This object is similar in usage to an IP address mask. The value
0 corresponds to IP address mask 0.0.0.0, the value 1 corresponds
to IP address mask 128.0.0.0, the value 8 corresponds to IP
address mask 255.0.0.0, and the value 32 corresponds to IP
address mask 255.255.255.255.
docsBpiIpMulticastServiceId

This object represents the multicast SID to be used in this
IP multicast address prefix mapping entry.
docsBpiIpMulticastMapControl

This object controls and reflects the IP multicast address prefix
mapping entry. There is no restriction on the ability to change values
in this row while the row is active.
docsBpiMulticastAuthTable

This table describes the multicast SID authorization for each
CM on each CMTS MAC interface.
docsBpiMulticastAuthEntry

Each entry contains objects describing the key authorization of one
cable modem for one multicast SID for one CMTS MAC interface.
docsBpiMulticastServiceId

This object represents the multicast SID for authorization.
docsBpiMulticastCmMacAddress

This object represents the MAC address of the CM to which the
multicast SID authorization applies.
docsBpiMulticastAuthControl

This object controls and reflects the CM authorization for each
multicast SID. There is no restriction on the ability to change
values in this row while the row is active.
docsBpiBasicCompliance

This is the compliance statement for devices which implement the
DOCSIS Baseline Privacy Interface.
docsBpiCmGroup

This collection of objects provides CM BPI status and control.
docsBpiCmtsGroup

This collection of objects provides CMTS BPI status and control.
docsBpiObsoleteObjectsGroup

This is a collection of obsolete BPI objects.

< Back (DOCS-BPI-MIB)

What did you think of this topic?

Privacy Statement | Terms of Use | EULA | Contact | Site Map

Prices displayed do not reflect international pricing unless otherwise stated. Please see our international price list for current pricing specific to your location. All prices are subject to change without notice.

© 2003-2008 SolarWinds.net, Inc. All Rights Reserved. SolarWinds®, the SolarWinds logo, ipMonitor®, LANsurveyor®, and Orion® are among the trademarks or registered trademarks of the company in the United States and/or other countries. All other trademarks are property of their respective owners.