CISCO-SUBSCRIBER-SESSION-MIB

This MIB defines objects describing subscriber sessions, or
more specifically, subscriber sessions terminated by a RAS.  A
subscriber session consists of the traffic between a CPE and a
NAS, as illustrated in the diagram below.

                                   Service
                   Access          Provider
                   Network         Network
+--+  +---+  +--+   {   }   +---+   {   }
|PC+--+CPE+--+AN+--{     }--+NAS+--{     }
+--+  +---+  +--+   {   }   +---+   {   }
          |                 |
          |<--------------->|
               subscriber
                session

A subscriber session behaves according to the FSM illustrated
below.

      +-----------------+
 +--->|  DISCONNECTED   |<-------+
 |    +--------+--------+        |
 |             |                 |
 | failed      | initiated       | disconnect
 |             V                 |
 |    +-----------------+        |
 +----+     PENDING     +--------+
      +--------+--------+        |
               |                 |
               | established     |
               V                 |
+----------------------------+   |
|             UP             |   |
|                            +---+
|  +-----------------+       |
|  | UNAUTHENTICATED |       |
|  +--------+--------+       |
|           |                |
|           | authenticated  |
|           V                |
|  +-----------------+       |
|  |  AUTHENTICATED  |       |
|  +-----------------+       |
|                            |
+----------------------------+

A subscriber session in the DISCONNECTED state technically
doesn't exist; that is, the system does not maintain a context
to describe a disconnected subscriber session.

Once the system detects the initiation of a subscriber session,
then it creates a context and places the subscriber session in
the PENDING state.  The initiation of a subscriber session can
occur either through provisioning or the reception of a packet.
In the PENDING state, a system does not forward subscriber
traffic.

A pending subscriber session can become DISCONNECTED if
it fails to come up (e.g., a timeout) or if the system or the
subscriber explicitly terminates the subscriber session.

A pending subscriber session can become UP if the system
successfully configures and applies any relevant policies.
Once in the UP state, a system forwards subscriber traffic.

A operationally UP subscriber session can become DISCONNECTED if
either system or the subscriber terminates it.

A operationally UP subscriber session can either be
UNAUTHENTICATED or AUTHENTICATED.  When the system is in the
process of checking a the credentials associated with a
subscriber session, it is in the UNAUTHENTICATED state.  When
the system successfully completes this process, it transitions
the subscriber session to the AUTHENTICATED state.  If the
process fails, then the system terminates the subscriber
session.

Besides describing individual subscriber sessions, this MIB
module provides an EMS/NMS with the means to perform the
following functions:

1)  Enumerate subscriber sessions by ifIndex.

2)  Enumerate subscriber sessions by subscriber session type and
    ifIndex.

3)  Monitor aggregated statistics relating to subscriber
    sessions:

    a.  System-wide
    b.  System-wide by subscriber session type
    c.  Per node
    d.  Per node by subscriber session type

4)  Collect 15-minute aggregated performance data history
    relating to subscriber sessions:

    a.  System-wide
    b.  System-wide by subscriber session type
    c.  Per node
    d.  Per node by subscriber session type

5)  Submit a query for a report containing those subscriber
    sessions that match a specified identity match criteria.

6)  Terminate those subscriber session that match a
    specified identify match criteria.

GLOSSARY
========

Access Concentrator
    See NAS.

Access Network
    The network that provides connectivity between a AN and NAS.
    An access network may provide L2 or L3 connectivity. If the
    access network provide L2 connectivity, it may switch
    traffic or tunnel it through a MPLS or IP network.

AN (Access Node)
    A device (e.g., a DSLAM) that multiplexes or switches
    traffic between many CPEs and an access network.

BRAS (Broadband Remote Access Server)
    See NAS.

CPE (Customer Premise Equipment)
    A device (e.g., a DSL modem) that connects a customer's
    network to an AN.

DHCP (Dynamic Host Configuration Protocol)
    The protocol that provides a framework for transacting
    configuration information to devices on an IP network, as
    specified by RFC-2131.

NAS (Network Access Server)
    A device that switches or routes traffic between subscriber
    sessions and service provider networks.

Network Service
    Access to the Internet backbone, voice, video, or other
    content.

Node
    A physical entity capable of maintaining a subscriber
    session within a distributed system.  The notion of a node
    is not applicable to a centralized system.

PADI (PPPoE Active Discovery Initiation)
    A subscriber broadcasts a PADI packet to start the process
    of discovering access concentrators capable of serving it.

PADO (PPPoE Active Discovery Offer)
    The packet sent by an access concentrator to a subscriber
    indicating that it can serve the subscriber.

PADR (PPPoE Active Discovery Request)
    The packet sent by a subscriber to an access concentrator
    requesting a PPPoE connection.

PADS (PPPoE Active Discovery Session-confirmation)
    The packet sent by an access concentrator to a subscriber
    confirming the request for a PPPoE connection.  Once this
    packet has been sent, then the PPP can proceed as specified
    by RFC-1661.

PADT (PPPoE Active Discovery Terminate)
    The packet indicating that a PPPoE connection has been
    terminated.  Either the subscriber or the access
    concentrator can send this packet.

PPP (Point-to-Point Protocol)
    The standard method for transporting multi-protocol
    datagrams over point-to-point links, as defined by RFC-1661.
    The PPP specifies the encapsulation for these datagrams and
    the protocols necessary for establishing, configuring, and
    maintaining connectivity.

PPPoE (Point-to-Point Protocol over Ethernet)
    The protocol and encapsulation necessary to support a PPP
    connection over an Ethernet connection, as defined by IETF
    RFC-2516.

Service Provider Network
    The network that provides connectivity between a NAS and a
    network service.

Subscriber
    A customer of a network service.

Subscriber Session
    A context maintained by a NAS for the purpose of classifying
    a subscriber's traffic, maintaining a subscriber's identity,
    applying configuration and policies, and maintaining
    statistics.  For more information on the types of subscriber
    sessions, see the CISCO-SUBSCRIBER-SESSION-TC-MIB.

Imported Objects

CbpElementNameCISCO-CBP-TC-MIB
DynamicTemplateNameCISCO-DYNAMIC-TEMPLATE-TC-MIB
ciscoMgmtCISCO-SMI
SubscriberLocationName, SubSessionIdentity, SubSessionIdentities, SubscriberLabel, SubscriberPbhk, SubscriberVRF, SubscriberRemoteId, SubscriberCircuitId, SubscriberNasPort, SubscriberUsername, SubscriberAcctSessionId, SubscriberDomain, SubscriberDnis, SubscriberMediaType, SubscriberProtocolType, SubscriberDhcpClass, SubscriberTunnelName, SubscriberServiceNameCISCO-SUBSCRIBER-IDENTITY-TC-MIB
SubSessionRedundancyMode, SubSessionState, SubSessionTypeCISCO-SUBSCRIBER-SESSION-TC-MIB
PhysicalIndexENTITY-MIB
ifIndex, InterfaceIndexIF-MIB
InetAddress, InetAddressTypeINET-ADDRESS-MIB
PerfTotalCount, PerfIntervalCount, PerfCurrentCountPerfHist-TC-MIB
OBJECT-GROUP, MODULE-COMPLIANCE, NOTIFICATION-GROUPSNMPv2-CONF
Counter64, Gauge32, Unsigned32, Integer32, Counter32, OBJECT-TYPE, MODULE-IDENTITY, NOTIFICATION-TYPESNMPv2-SMI
DateAndTime, MacAddress, RowStatus, StorageType, TimeStamp, TruthValue, TEXTUAL-CONVENTIONSNMPv2-TC
ciscoSubscriberSessionMIB.1.3.6.1.4.1.9.9.786
ciscoSubscriberSessionMIBNotifs .1.3.6.1.4.1.9.9.786.0
csubJobFinishedNotify .1.3.6.1.4.1.9.9.786.0.1
csubSessionRisingNotif .1.3.6.1.4.1.9.9.786.0.2
csubSessionFallingNotif .1.3.6.1.4.1.9.9.786.0.3
csubSessionDeltaPercentFallingThreshNotif .1.3.6.1.4.1.9.9.786.0.4
ciscoSubscriberSessionMIBObjects .1.3.6.1.4.1.9.9.786.1
csubSession .1.3.6.1.4.1.9.9.786.1.1
csubSessionTable .1.3.6.1.4.1.9.9.786.1.1.1
csubSessionEntry .1.3.6.1.4.1.9.9.786.1.1.1.1
csubSessionType .1.3.6.1.4.1.9.9.786.1.1.1.1.1
csubSessionMacAddress .1.3.6.1.4.1.9.9.786.1.1.1.1.10
csubSessionNativeVrf .1.3.6.1.4.1.9.9.786.1.1.1.1.11
csubSessionNativeIpAddrType .1.3.6.1.4.1.9.9.786.1.1.1.1.12
csubSessionNativeIpAddr .1.3.6.1.4.1.9.9.786.1.1.1.1.13
csubSessionNativeIpMask .1.3.6.1.4.1.9.9.786.1.1.1.1.14
csubSessionDomainVrf .1.3.6.1.4.1.9.9.786.1.1.1.1.15
csubSessionDomainIpAddrType .1.3.6.1.4.1.9.9.786.1.1.1.1.16
csubSessionDomainIpAddr .1.3.6.1.4.1.9.9.786.1.1.1.1.17
csubSessionDomainIpMask .1.3.6.1.4.1.9.9.786.1.1.1.1.18
csubSessionPbhk .1.3.6.1.4.1.9.9.786.1.1.1.1.19
csubSessionIpAddrAssignment .1.3.6.1.4.1.9.9.786.1.1.1.1.2
csubSessionRemoteId .1.3.6.1.4.1.9.9.786.1.1.1.1.20
csubSessionCircuitId .1.3.6.1.4.1.9.9.786.1.1.1.1.21
csubSessionNasPort .1.3.6.1.4.1.9.9.786.1.1.1.1.22
csubSessionDomain .1.3.6.1.4.1.9.9.786.1.1.1.1.23
csubSessionUsername .1.3.6.1.4.1.9.9.786.1.1.1.1.24
csubSessionAcctSessionId .1.3.6.1.4.1.9.9.786.1.1.1.1.25
csubSessionDnis .1.3.6.1.4.1.9.9.786.1.1.1.1.26
csubSessionMedia .1.3.6.1.4.1.9.9.786.1.1.1.1.27
csubSessionMlpNegotiated .1.3.6.1.4.1.9.9.786.1.1.1.1.28
csubSessionProtocol .1.3.6.1.4.1.9.9.786.1.1.1.1.29
csubSessionState .1.3.6.1.4.1.9.9.786.1.1.1.1.3
csubSessionDhcpClass .1.3.6.1.4.1.9.9.786.1.1.1.1.30
csubSessionTunnelName .1.3.6.1.4.1.9.9.786.1.1.1.1.31
csubSessionLocationIdentifier .1.3.6.1.4.1.9.9.786.1.1.1.1.32
csubSessionServiceIdentifier .1.3.6.1.4.1.9.9.786.1.1.1.1.33
csubSessionLastChanged .1.3.6.1.4.1.9.9.786.1.1.1.1.34
csubSessionNativeIpAddrType2 .1.3.6.1.4.1.9.9.786.1.1.1.1.35
csubSessionNativeIpAddr2 .1.3.6.1.4.1.9.9.786.1.1.1.1.36
csubSessionNativeIpMask2 .1.3.6.1.4.1.9.9.786.1.1.1.1.37
csubSessionAuthenticated .1.3.6.1.4.1.9.9.786.1.1.1.1.4
csubSessionRedundancyMode .1.3.6.1.4.1.9.9.786.1.1.1.1.5
csubSessionCreationTime .1.3.6.1.4.1.9.9.786.1.1.1.1.6
csubSessionDerivedCfg .1.3.6.1.4.1.9.9.786.1.1.1.1.7
csubSessionAvailableIdentities .1.3.6.1.4.1.9.9.786.1.1.1.1.8
csubSessionSubscriberLabel .1.3.6.1.4.1.9.9.786.1.1.1.1.9
csubSessionByTypeTable .1.3.6.1.4.1.9.9.786.1.1.2
csubSessionByTypeEntry .1.3.6.1.4.1.9.9.786.1.1.2.1
csubSessionByType .1.3.6.1.4.1.9.9.786.1.1.2.1.1
csubSessionIfIndex .1.3.6.1.4.1.9.9.786.1.1.2.1.2
csubAggStats .1.3.6.1.4.1.9.9.786.1.2
csubAggStatsTable .1.3.6.1.4.1.9.9.786.1.2.1
csubAggStatsEntry .1.3.6.1.4.1.9.9.786.1.2.1.1
csubAggStatsPointType .1.3.6.1.4.1.9.9.786.1.2.1.1.1
csubAggStatsHighUpSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.10
csubAggStatsAvgSessionUptime .1.3.6.1.4.1.9.9.786.1.2.1.1.11
csubAggStatsAvgSessionRPM .1.3.6.1.4.1.9.9.786.1.2.1.1.12
csubAggStatsAvgSessionRPH .1.3.6.1.4.1.9.9.786.1.2.1.1.13
csubAggStatsThrottleEngagements .1.3.6.1.4.1.9.9.786.1.2.1.1.14
csubAggStatsTotalCreatedSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.15
csubAggStatsTotalFailedSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.16
csubAggStatsTotalUpSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.17
csubAggStatsTotalAuthSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.18
csubAggStatsTotalDiscSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.19
csubAggStatsPoint .1.3.6.1.4.1.9.9.786.1.2.1.1.2
csubAggStatsTotalLightWeightSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.20
csubAggStatsTotalFlowsUp .1.3.6.1.4.1.9.9.786.1.2.1.1.21
csubAggStatsDayCreatedSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.22
csubAggStatsDayFailedSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.23
csubAggStatsDayUpSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.24
csubAggStatsDayAuthSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.25
csubAggStatsDayDiscSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.26
csubAggStatsCurrTimeElapsed .1.3.6.1.4.1.9.9.786.1.2.1.1.27
csubAggStatsCurrValidIntervals .1.3.6.1.4.1.9.9.786.1.2.1.1.28
csubAggStatsCurrInvalidIntervals .1.3.6.1.4.1.9.9.786.1.2.1.1.29
csubAggStatsSessionType .1.3.6.1.4.1.9.9.786.1.2.1.1.3
csubAggStatsCurrFlowsUp .1.3.6.1.4.1.9.9.786.1.2.1.1.30
csubAggStatsCurrCreatedSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.31
csubAggStatsCurrFailedSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.32
csubAggStatsCurrUpSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.33
csubAggStatsCurrAuthSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.34
csubAggStatsCurrDiscSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.35
csubAggStatsDiscontinuityTime .1.3.6.1.4.1.9.9.786.1.2.1.1.36
csubAggStatsPendingSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.4
csubAggStatsUpSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.5
csubAggStatsAuthSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.6
csubAggStatsUnAuthSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.7
csubAggStatsLightWeightSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.8
csubAggStatsRedSessions .1.3.6.1.4.1.9.9.786.1.2.1.1.9
csubAggStatsIntTable .1.3.6.1.4.1.9.9.786.1.2.2
csubAggStatsIntEntry .1.3.6.1.4.1.9.9.786.1.2.2.1
csubAggStatsIntNumber .1.3.6.1.4.1.9.9.786.1.2.2.1.1
csubAggStatsIntValid .1.3.6.1.4.1.9.9.786.1.2.2.1.2
csubAggStatsIntCreatedSessions .1.3.6.1.4.1.9.9.786.1.2.2.1.3
csubAggStatsIntFailedSessions .1.3.6.1.4.1.9.9.786.1.2.2.1.4
csubAggStatsIntUpSessions .1.3.6.1.4.1.9.9.786.1.2.2.1.5
csubAggStatsIntAuthSessions .1.3.6.1.4.1.9.9.786.1.2.2.1.6
csubAggStatsIntDiscSessions .1.3.6.1.4.1.9.9.786.1.2.2.1.7
csubAggStatsThreshTable .1.3.6.1.4.1.9.9.786.1.2.3
csubAggStatsThreshEntry .1.3.6.1.4.1.9.9.786.1.2.3.1
csubSessionRisingThresh .1.3.6.1.4.1.9.9.786.1.2.3.1.1
csubSessionFallingThresh .1.3.6.1.4.1.9.9.786.1.2.3.1.2
csubSessionDeltaPercentFallingThresh .1.3.6.1.4.1.9.9.786.1.2.3.1.3
csubSessionThreshEvalInterval .1.3.6.1.4.1.9.9.786.1.2.3.1.4
csubJob .1.3.6.1.4.1.9.9.786.1.3
csubJobFinishedNotifyEnable .1.3.6.1.4.1.9.9.786.1.3.1
csubJobQueueTable .1.3.6.1.4.1.9.9.786.1.3.10
csubJobQueueEntry .1.3.6.1.4.1.9.9.786.1.3.10.1
csubJobQueueNumber .1.3.6.1.4.1.9.9.786.1.3.10.1.1
csubJobQueueJobId .1.3.6.1.4.1.9.9.786.1.3.10.1.2
csubJobReportTable .1.3.6.1.4.1.9.9.786.1.3.11
csubJobReportEntry .1.3.6.1.4.1.9.9.786.1.3.11.1
csubJobReportId .1.3.6.1.4.1.9.9.786.1.3.11.1.1
csubJobReportSession .1.3.6.1.4.1.9.9.786.1.3.11.1.2
csubJobIndexedAttributes .1.3.6.1.4.1.9.9.786.1.3.2
csubJobIdNext .1.3.6.1.4.1.9.9.786.1.3.3
csubJobMaxNumber .1.3.6.1.4.1.9.9.786.1.3.4
csubJobMaxLife .1.3.6.1.4.1.9.9.786.1.3.5
csubJobCount .1.3.6.1.4.1.9.9.786.1.3.6
csubJobTable .1.3.6.1.4.1.9.9.786.1.3.7
csubJobEntry .1.3.6.1.4.1.9.9.786.1.3.7.1
csubJobId .1.3.6.1.4.1.9.9.786.1.3.7.1.1
csubJobStatus .1.3.6.1.4.1.9.9.786.1.3.7.1.2
csubJobStorage .1.3.6.1.4.1.9.9.786.1.3.7.1.3
csubJobType .1.3.6.1.4.1.9.9.786.1.3.7.1.4
csubJobControl .1.3.6.1.4.1.9.9.786.1.3.7.1.5
csubJobState .1.3.6.1.4.1.9.9.786.1.3.7.1.6
csubJobStartedTime .1.3.6.1.4.1.9.9.786.1.3.7.1.7
csubJobFinishedTime .1.3.6.1.4.1.9.9.786.1.3.7.1.8
csubJobFinishedReason .1.3.6.1.4.1.9.9.786.1.3.7.1.9
csubJobMatchParamsTable .1.3.6.1.4.1.9.9.786.1.3.8
csubJobMatchParamsEntry .1.3.6.1.4.1.9.9.786.1.3.8.1
csubJobMatchIdentities .1.3.6.1.4.1.9.9.786.1.3.8.1.1
csubJobMatchDomainIpAddrType .1.3.6.1.4.1.9.9.786.1.3.8.1.10
csubJobMatchDomainIpAddr .1.3.6.1.4.1.9.9.786.1.3.8.1.11
csubJobMatchDomainIpMask .1.3.6.1.4.1.9.9.786.1.3.8.1.12
csubJobMatchPbhk .1.3.6.1.4.1.9.9.786.1.3.8.1.13
csubJobMatchRemoteId .1.3.6.1.4.1.9.9.786.1.3.8.1.14
csubJobMatchCircuitId .1.3.6.1.4.1.9.9.786.1.3.8.1.15
csubJobMatchNasPort .1.3.6.1.4.1.9.9.786.1.3.8.1.16
csubJobMatchDomain .1.3.6.1.4.1.9.9.786.1.3.8.1.17
csubJobMatchUsername .1.3.6.1.4.1.9.9.786.1.3.8.1.18
csubJobMatchOtherParams .1.3.6.1.4.1.9.9.786.1.3.8.1.2
csubJobMatchAcctSessionId .1.3.6.1.4.1.9.9.786.1.3.8.1.20
csubJobMatchDnis .1.3.6.1.4.1.9.9.786.1.3.8.1.21
csubJobMatchMedia .1.3.6.1.4.1.9.9.786.1.3.8.1.22
csubJobMatchMlpNegotiated .1.3.6.1.4.1.9.9.786.1.3.8.1.23
csubJobMatchProtocol .1.3.6.1.4.1.9.9.786.1.3.8.1.24
csubJobMatchServiceName .1.3.6.1.4.1.9.9.786.1.3.8.1.25
csubJobMatchDhcpClass .1.3.6.1.4.1.9.9.786.1.3.8.1.26
csubJobMatchTunnelName .1.3.6.1.4.1.9.9.786.1.3.8.1.27
csubJobMatchDanglingDuration .1.3.6.1.4.1.9.9.786.1.3.8.1.28
csubJobMatchState .1.3.6.1.4.1.9.9.786.1.3.8.1.29
csubJobMatchSubscriberLabel .1.3.6.1.4.1.9.9.786.1.3.8.1.3
csubJobMatchAuthenticated .1.3.6.1.4.1.9.9.786.1.3.8.1.30
csubJobMatchRedundancyMode .1.3.6.1.4.1.9.9.786.1.3.8.1.31
csubJobMatchMacAddress .1.3.6.1.4.1.9.9.786.1.3.8.1.4
csubJobMatchNativeVrf .1.3.6.1.4.1.9.9.786.1.3.8.1.5
csubJobMatchNativeIpAddrType .1.3.6.1.4.1.9.9.786.1.3.8.1.6
csubJobMatchNativeIpAddr .1.3.6.1.4.1.9.9.786.1.3.8.1.7
csubJobMatchNativeIpMask .1.3.6.1.4.1.9.9.786.1.3.8.1.8
csubJobMatchDomainVrf .1.3.6.1.4.1.9.9.786.1.3.8.1.9
csubJobQueryParamsTable .1.3.6.1.4.1.9.9.786.1.3.9
csubJobQueryParamsEntry .1.3.6.1.4.1.9.9.786.1.3.9.1
csubJobQuerySortKey1 .1.3.6.1.4.1.9.9.786.1.3.9.1.1
csubJobQuerySortKey2 .1.3.6.1.4.1.9.9.786.1.3.9.1.2
csubJobQuerySortKey3 .1.3.6.1.4.1.9.9.786.1.3.9.1.3
csubJobQueryResultingReportSize .1.3.6.1.4.1.9.9.786.1.3.9.1.4
csubAggThresh .1.3.6.1.4.1.9.9.786.1.4
csubAggStatsThreshNotifEnable .1.3.6.1.4.1.9.9.786.1.4.1
ciscoSubscriberSessionMIBConform .1.3.6.1.4.1.9.9.786.2
ciscoSubscriberSessionMIBCompliances .1.3.6.1.4.1.9.9.786.2.1
ciscoSubscriberSessionMIBGroups .1.3.6.1.4.1.9.9.786.2.2