| CsubSessionEntry |
|
| SEQUENCE |
|
|
|
| |
csubSessionType |
SubSessionType |
|
| |
csubSessionIpAddrAssignment |
INTEGER |
|
| |
csubSessionState |
SubSessionState |
|
| |
csubSessionAuthenticated |
TruthValue |
|
| |
csubSessionRedundancyMode |
SubSessionRedundancyMode |
|
| |
csubSessionCreationTime |
DateAndTime |
|
| |
csubSessionDerivedCfg |
DynamicTemplateName |
|
| |
csubSessionAvailableIdentities |
SubSessionIdentities |
|
| |
csubSessionSubscriberLabel |
SubscriberLabel |
|
| |
csubSessionMacAddress |
MacAddress |
|
| |
csubSessionNativeVrf |
SubscriberVRF |
|
| |
csubSessionNativeIpAddrType |
InetAddressType |
|
| |
csubSessionNativeIpAddr |
InetAddress |
|
| |
csubSessionNativeIpMask |
InetAddress |
|
| |
csubSessionDomainVrf |
SubscriberVRF |
|
| |
csubSessionDomainIpAddrType |
InetAddressType |
|
| |
csubSessionDomainIpAddr |
InetAddress |
|
| |
csubSessionDomainIpMask |
InetAddress |
|
| |
csubSessionPbhk |
SubscriberPbhk |
|
| |
csubSessionRemoteId |
SubscriberRemoteId |
|
| |
csubSessionCircuitId |
SubscriberCircuitId |
|
| |
csubSessionNasPort |
SubscriberNasPort |
|
| |
csubSessionDomain |
SubscriberDomain |
|
| |
csubSessionUsername |
SubscriberUsername |
|
| |
csubSessionAcctSessionId |
SubscriberAcctSessionId |
|
| |
csubSessionDnis |
SubscriberDnis |
|
| |
csubSessionMedia |
SubscriberMediaType |
|
| |
csubSessionMlpNegotiated |
TruthValue |
|
| |
csubSessionProtocol |
SubscriberProtocolType |
|
| |
csubSessionDhcpClass |
SubscriberDhcpClass |
|
| |
csubSessionTunnelName |
SubscriberTunnelName |
|
| |
csubSessionLocationIdentifier |
SubscriberLocationName |
|
| |
csubSessionServiceIdentifier |
SubscriberServiceName |
|
| |
csubSessionLastChanged |
DateAndTime |
|
| |
csubSessionNativeIpAddrType2 |
InetAddressType |
|
| |
csubSessionNativeIpAddr2 |
InetAddress |
|
| |
csubSessionNativeIpMask2 |
InetAddress |
|
| CsubAggStatsEntry |
|
| SEQUENCE |
|
|
|
| |
csubAggStatsPointType |
INTEGER |
|
| |
csubAggStatsPoint |
Unsigned32 |
|
| |
csubAggStatsSessionType |
SubSessionType |
|
| |
csubAggStatsPendingSessions |
Gauge32 |
|
| |
csubAggStatsUpSessions |
Gauge32 |
|
| |
csubAggStatsAuthSessions |
Gauge32 |
|
| |
csubAggStatsUnAuthSessions |
Gauge32 |
|
| |
csubAggStatsLightWeightSessions |
Gauge32 |
|
| |
csubAggStatsRedSessions |
Gauge32 |
|
| |
csubAggStatsHighUpSessions |
Gauge32 |
|
| |
csubAggStatsAvgSessionUptime |
Gauge32 |
|
| |
csubAggStatsAvgSessionRPM |
Gauge32 |
|
| |
csubAggStatsAvgSessionRPH |
Gauge32 |
|
| |
csubAggStatsThrottleEngagements |
Counter64 |
|
| |
csubAggStatsTotalCreatedSessions |
Counter64 |
|
| |
csubAggStatsTotalFailedSessions |
Counter64 |
|
| |
csubAggStatsTotalUpSessions |
Counter64 |
|
| |
csubAggStatsTotalAuthSessions |
Counter64 |
|
| |
csubAggStatsTotalDiscSessions |
Counter64 |
|
| |
csubAggStatsTotalLightWeightSessions |
Counter64 |
|
| |
csubAggStatsTotalFlowsUp |
Counter64 |
|
| |
csubAggStatsDayCreatedSessions |
PerfTotalCount |
|
| |
csubAggStatsDayFailedSessions |
PerfTotalCount |
|
| |
csubAggStatsDayUpSessions |
PerfTotalCount |
|
| |
csubAggStatsDayAuthSessions |
PerfTotalCount |
|
| |
csubAggStatsDayDiscSessions |
PerfTotalCount |
|
| |
csubAggStatsCurrTimeElapsed |
Gauge32 |
|
| |
csubAggStatsCurrValidIntervals |
Gauge32 |
|
| |
csubAggStatsCurrInvalidIntervals |
Gauge32 |
|
| |
csubAggStatsCurrFlowsUp |
Gauge32 |
|
| |
csubAggStatsCurrCreatedSessions |
PerfCurrentCount |
|
| |
csubAggStatsCurrFailedSessions |
PerfCurrentCount |
|
| |
csubAggStatsCurrUpSessions |
PerfCurrentCount |
|
| |
csubAggStatsCurrAuthSessions |
PerfCurrentCount |
|
| |
csubAggStatsCurrDiscSessions |
PerfCurrentCount |
|
| |
csubAggStatsDiscontinuityTime |
DateAndTime |
|
| CsubAggStatsIntEntry |
|
| SEQUENCE |
|
|
|
| |
csubAggStatsIntNumber |
Unsigned32 |
|
| |
csubAggStatsIntValid |
TruthValue |
|
| |
csubAggStatsIntCreatedSessions |
PerfIntervalCount |
|
| |
csubAggStatsIntFailedSessions |
PerfIntervalCount |
|
| |
csubAggStatsIntUpSessions |
PerfIntervalCount |
|
| |
csubAggStatsIntAuthSessions |
PerfIntervalCount |
|
| |
csubAggStatsIntDiscSessions |
PerfIntervalCount |
|
| CsubAggStatsThreshEntry |
|
| SEQUENCE |
|
|
|
| |
csubSessionRisingThresh |
Unsigned32 |
|
| |
csubSessionFallingThresh |
Unsigned32 |
|
| |
csubSessionDeltaPercentFallingThresh |
Unsigned32 |
|
| |
csubSessionThreshEvalInterval |
Unsigned32 |
|
| CsubJobMatchParamsEntry |
|
| SEQUENCE |
|
|
|
| |
csubJobMatchIdentities |
SubSessionIdentities |
|
| |
csubJobMatchOtherParams |
BITS |
|
| |
csubJobMatchSubscriberLabel |
SubscriberLabel |
|
| |
csubJobMatchMacAddress |
MacAddress |
|
| |
csubJobMatchNativeVrf |
SubscriberVRF |
|
| |
csubJobMatchNativeIpAddrType |
InetAddressType |
|
| |
csubJobMatchNativeIpAddr |
InetAddress |
|
| |
csubJobMatchNativeIpMask |
InetAddress |
|
| |
csubJobMatchDomainVrf |
SubscriberVRF |
|
| |
csubJobMatchDomainIpAddrType |
InetAddressType |
|
| |
csubJobMatchDomainIpAddr |
InetAddress |
|
| |
csubJobMatchDomainIpMask |
InetAddress |
|
| |
csubJobMatchPbhk |
SubscriberPbhk |
|
| |
csubJobMatchRemoteId |
SubscriberRemoteId |
|
| |
csubJobMatchCircuitId |
SubscriberCircuitId |
|
| |
csubJobMatchNasPort |
SubscriberNasPort |
|
| |
csubJobMatchDomain |
SubscriberDomain |
|
| |
csubJobMatchUsername |
SubscriberUsername |
|
| |
csubJobMatchAcctSessionId |
SubscriberAcctSessionId |
|
| |
csubJobMatchDnis |
SubscriberDnis |
|
| |
csubJobMatchMedia |
SubscriberMediaType |
|
| |
csubJobMatchMlpNegotiated |
TruthValue |
|
| |
csubJobMatchProtocol |
SubscriberProtocolType |
|
| |
csubJobMatchServiceName |
CbpElementName |
|
| |
csubJobMatchDhcpClass |
SubscriberDhcpClass |
|
| |
csubJobMatchTunnelName |
SubscriberTunnelName |
|
| |
csubJobMatchDanglingDuration |
Unsigned32 |
|
| |
csubJobMatchState |
SubSessionState |
|
| |
csubJobMatchAuthenticated |
TruthValue |
|
| |
csubJobMatchRedundancyMode |
SubSessionRedundancyMode |
|
| CsubJobQueryParamsEntry |
|
| SEQUENCE |
|
|
|
| |
csubJobQuerySortKey1 |
SubSessionIdentity |
|
| |
csubJobQuerySortKey2 |
SubSessionIdentity |
|
| |
csubJobQuerySortKey3 |
SubSessionIdentity |
|
| |
csubJobQueryResultingReportSize |
Gauge32 |
|
| ciscoSubscriberSessionMIB |
1.3.6.1.4.1.9.9.786 |
| 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. |
| MODULE-IDENTITY |
|
|
|
| csubSessionEntry |
1.3.6.1.4.1.9.9.786.1.1.1.1 |
| This entry contains data describing a subscriber sessions,
including its state, configuration, and collected identities.
An entry exists for a corresponding entry in the ifTable
describing a subscriber session. Currently, subscriber
sessions must have one of the following ifType values:
'ppp'
'ipSubscriberSession'
'l2SubscriberSession'
The system creates an entry when it establishes a subscriber
session. Likewise, the system destroys an entry when it
terminates the corresponding subscriber session. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubSessionEntry |
|
|
| csubSessionIpAddrAssignment |
1.3.6.1.4.1.9.9.786.1.1.1.1.2 |
| This object indicates how the system assigns IP addresses to
the subscriber:
'none'
The system does not an involvement in (or is it aware
of) the assignment an subscriber IP addresses. For
example, a system does not have an involvement in the
assignment of subscriber IP addresses for IP interface
subscriber sessions.
'other'
The system assigns subscriber IP addresses using a
method not recognized by this MIB module.
'static'
Subscriber IP addresses have been configured correctly
for the service domain. The system does not have an
involvement in the assignment of the IP address.
'localPool'
The system assigns subscriber IP addresses from a
locally configured pool of IP addresses.
'dhcpv4'
The system assigns subscriber IP addresses are using the
DHCPv4.
'dhcpv6'
The system assigns subscriber IP addresses using the
DHCPv6.
'userProfileIpAddr'
The system assigns subscriber IP addresses from a user
profile.
'userProfileIpSubnet'
The system assigns the subscriber an IP subnet from a
user profile.
'userProfileNamedPool'
The system assigns subscriber IP addresses from a
locally configured named pool specified by a user
profile. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
none(1), other(2), static(3), localPool(4), dhcpv4(5), dhcpv6(6), userProfileIpAddr(7), userProfileIpSubnet(8), userProfileNamedPool(9) |
|
| csubSessionDomainVrf |
1.3.6.1.4.1.9.9.786.1.1.1.1.15 |
| This object indicates the VRF to which the system transfers
the subscriber session's traffic.
This column is valid only if the 'domainVrf' bit of the
corresponding instance of csubSessionAvailableIdentities is
'1'. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
SubscriberVRF |
|
|
| csubSessionDomainIpAddrType |
1.3.6.1.4.1.9.9.786.1.1.1.1.16 |
| This object indicates the type of IP address assigned to the
subscriber on the service-facing side of the system.
This column is valid only if the 'domainIpAddress' bit of the
corresponding instance of csubSessionAvailableIdentities is
'1'. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
InetAddressType |
|
|
| csubSessionDomainIpAddr |
1.3.6.1.4.1.9.9.786.1.1.1.1.17 |
| This object indicates the IP address assigned to the
subscriber on the service-facing side of the system.
This column is valid only if the 'domainIpAddress' bit of the
corresponding instance of csubSessionAvailableIdentities is
'1'. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
InetAddress |
|
|
| csubSessionDomainIpMask |
1.3.6.1.4.1.9.9.786.1.1.1.1.18 |
| This object indicates the corresponding mask for the IP
address assigned to the subscriber on the service-facing side of
the system.
This column is valid only if the 'domainIpAddress' bit of the
corresponding instance of csubSessionAvailableIdentities is
'1'. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
InetAddress |
|
|
| csubSessionDomain |
1.3.6.1.4.1.9.9.786.1.1.1.1.23 |
| This object indicates the domain associated with the
subscriber.
This column is valid only if the 'domain' bit of the
corresponding instance of csubSessionAvailableIdentities is
'1'. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
SubscriberDomain |
|
|
| csubSessionByTypeEntry |
1.3.6.1.4.1.9.9.786.1.1.2.1 |
| This entry identifies a subscriber session.
An entry exists for a corresponding entry in the ifTable
describing a subscriber session. Currently, subscriber
sessions must have one of the following ifType values:
'ppp'
'ipSubscriberSession'
'l2SubscriberSession'
The system creates an entry when it establishes a subscriber
session. Likewise, the system destroys an entry when it
terminates the corresponding subscriber session. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubSessionByTypeEntry |
|
|
| csubAggStatsEntry |
1.3.6.1.4.1.9.9.786.1.2.1.1 |
| An entry contains a set of aggregated statistics relating to
those subscriber sessions that fall into a 'scope of
aggregation'.
A 'scope of aggregation' is the set of subscriber sessions
that meet specified criteria. For example, a 'scope of
aggregation' may be the set of all PPPoE subscriber sessions
maintained by the system. The following criteria define the
'scope of aggregation':
1) Aggregation Point type
Aggregation point type identifies the format of the
csubAggStatsPoint for this entry.
2) Aggregation Point
'Physical' Aggregation Point type case:
In a distributed system, a 'node' represents a physical
entity capable of maintaining the context representing
a subscriber session.
If the 'scope of aggregation' specifies a physical
entity having an entPhysicalClass of 'chassis', then
the set of subscriber sessions in the 'scope of
aggregation' may contain the subscriber sessions maintained by all
the nodes contained in the system.
If the 'scope of aggregation' specifies a physical
entity having an entPhysicalClass of 'module' (e.g., a
line card), then the set of subscriber sessions in the
'scope of aggregation' may contain the subscriber
sessions maintained by the nodes contained by the
module.
If the 'scope of aggregation' specifies a physical
entity having an entPhysicalClass of 'cpu', then the
set of subscriber sessions in the 'scope of aggregation'
may contain the subscriber sessions maintained by the node
running on that processor.
Observe that a centralized system (i.e., a system
that essentially contains a single node) can only
support a 'scope of aggregation' that specifies a
physical entity classified as a 'chassis'.
If the scope of aggregation specifies 'interface',
then the scope is the set of subscriber sessions carried
by the interface identified the ifIndex value
represented in the csubAggStatsPoint value.
2) Subscriber Session Type
If the 'scope of aggregation' specifies the value 'all'
for the subscriber session type, then the set of
subscriber sessions in the 'scope of aggregation' may
contain all subscriber sessions, regardless of type.
If the 'scope of aggregation' specifies a value other
than 'all' for the subscriber session type, then the
set of subscriber sessions in the 'scope of aggregation may
contain only those subscriber sessions of the specified
type.
Implementation Guidance
=======================
A system MUST maintain a set of statistics with a 'scope of
aggregation' that contains all subscriber sessions maintained
by the system. The system creates this entry during the
initialization of the SNMP entity.
A system SHOULD maintain a set of statistics for each 'scope of
aggregation' containing subscriber sessions of each subscriber
session type the system is capable of providing access. If the
system supports these sets of statistics, then it creates these
entries during the initialization of the SNMP entity.
A system MAY maintain sets of node-specific statistics. if the
system supports sets of node-specific statistics, then it
creates the appropriate entries upon detection of a physical
entity (resulting from system restart or insertion) containing
those nodes. Likewise, the system destroys these entries
upon removal of the physical entity. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubAggStatsEntry |
|
|
| csubAggStatsIntEntry |
1.3.6.1.4.1.9.9.786.1.2.2.1 |
| An entry contains the aggregated subscriber session performance
data collected over a single 15-minute measurement interval
within a 'scope of aggregation'. For further details regarding
'scope of aggregation', see the descriptive text associated with
the csubAggStatsEntry. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubAggStatsIntEntry |
|
|
| csubAggStatsThreshEntry |
1.3.6.1.4.1.9.9.786.1.2.3.1 |
| A row in this table exists for each row in the
csubAggStatsTable.
Each row defines the set of thresholds and evaluation attributes
for an aggregation point. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubAggStatsThreshEntry |
|
|
| csubJobEntry |
1.3.6.1.4.1.9.9.786.1.3.7.1 |
| An entry describing a subscriber session job. At this time,
subscriber session jobs can perform one of two tasks:
- Subscriber Session Query
This type of job invokes the report generator, which builds
a list of subscriber sessions matching criteria specified by
the corresponding row in the csubJobMatchParamsTable. The
list built by the report generator must conform to
parameters specified by the corresponding row in
csubJobQueryParamsTable, which at this time only affects
sorting order.
- Subscriber Session Clear
This type of job causes the system to terminate those
subscriber sessions matching criteria specified by the
corresponding row in the csubJobMatchParamsTable.
The following procedure summarizes how the EMS/NMS can start and
monitor a subscriber session job:
1) The EMS/NMS must start by reading csubJobIdNext. If it is
zero, continue polling csubJobIdNext until it is non-zero.
2) The EMS/NMS creates a row in the csubJobTable using the
instance identifier retrieved in the last step. Since every
object contained by the entry with a MAX-ACCESS of
'read-create' specifies a default value, it makes little
difference whether the EMS/NMS employs create-and-wait or
create-and-go semantics.
3) The EMS/NMS sets the type of subscriber session job by
setting the corresponding instance of csubJobType.
4a) If the job is a 'query', then the EMS/NMS must configure
the query before starting it by setting columns contained
by the corresponding rows in the csubJobMatchParamsTable and
csubJobQueryParamsTable.
4b) If job is a 'clear', then the EMS/NMS must configure
the job before starting it by setting columns contained by
the corresponding row in the csubJobMatchParamsTable.
5) The EMS/NMS can now start the job by setting the
corresponding instance of csubJobControl to 'start'.
6) The EMS/NMS can monitor the progress of the job by polling
the corresponding instance of csubJobState. It can also
wait for a csubJobFinishedNotify notification. When the
state of the job transitions to 'finished', then the system
has finished executing the job.
7) The EMS/NMS can determine the final status of the job by
reading the corresponding instance of csubJobFinishedReason.
If job is a 'query' and the corresponding instance of
csubJobFinishedReason is 'normal', then the EMS/NMS can
safely read the report by retrieving the corresponding
rows from the csubJobReportTable.
8a) After a job has finished, the EMS/NMS has the option of
destroying it. It can do this by simply setting the
corresponding instance of csubJobStatus to 'destroy'.
Alternatively, the EMS/NMS may retain the job and execute it
again in the future (by returning to step 5). Additionally,
nothing would prevent the EMS/NMS from changing the job's
type, which causes the automatic destruction of the
corresponding report.
8b) If the job is a 'query' and the EMS/NMS opts to retain the
job, then it may consider releasing the corresponding report
after reading it. It can do this by setting the
corresponding instance of csubJobControl to 'release'. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubJobEntry |
|
|
| csubJobMatchParamsEntry |
1.3.6.1.4.1.9.9.786.1.3.8.1 |
| An entry describes a set of subscriber session match criteria.
The set contains those subscriber session identities specified
by csubJobMatchIdentities.
If the corresponding row in the csubJobTable has a csubJobType
of 'query', then the system builds a report containing those
subscriber sessions matching these criteria.
If the corresponding row in the csubJobTable has a csubJobType
of 'clear', then the system terminates those subscriber
sessions matching these criteria.
The system automatically creates an entry when the EMS/NMS sets
the corresponding instance of csubJobType to 'query' or 'clear'.
Likewise, the system automatically destroys an entry under the
following circumstances:
1) The EMS/NMS destroys the corresponding row in the
csubJobTable.
2) The EMS/NMS sets the corresponding instance of csubJobType
to 'noop'. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubJobMatchParamsEntry |
|
|
| csubJobMatchDomainVrf |
1.3.6.1.4.1.9.9.786.1.3.8.1.9 |
| This object specifies the domain VRF the system matches
against subscriber sessions in the process of executing a
subscriber session job.
This value is valid only if the 'domainVrf' bit of the
corresponding instance of csubJobMatchIdentities is '1'. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
SubscriberVRF |
|
|
| csubJobMatchDomainIpAddrType |
1.3.6.1.4.1.9.9.786.1.3.8.1.10 |
| This object specifies the type of Internet address specified
by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask.
This value is valid only if the 'domainIpAddress' bit of the
corresponding instance of csubJobMatchIdentities is '1'. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
InetAddressType |
|
|
| csubJobMatchDomainIpAddr |
1.3.6.1.4.1.9.9.786.1.3.8.1.11 |
| This object specifies the domain IP address that the system
matches against subscriber sessions in the process of executing
a subscriber session job.
This value is valid only if the 'domainIpAddress' bit of the
corresponding instance of csubJobMatchIdentities is '1'. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
InetAddress |
|
|
| csubJobMatchDomainIpMask |
1.3.6.1.4.1.9.9.786.1.3.8.1.12 |
| This object specifies the mask used when matching the domain IP
address against subscriber sessions in the process of executing
a subscriber session job.
This value is valid only if the 'domainIpAddress' bit of the
corresponding instance of csubJobMatchIdentities is '1'. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
InetAddress |
|
|
| csubJobMatchDomain |
1.3.6.1.4.1.9.9.786.1.3.8.1.17 |
| This object specifies the domain the system matches against
subscriber sessions in the process of executing a subscriber
session job.
This value is valid only if the 'domain' bit of the
corresponding instance of csubJobMatchIdentities is '1'. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
SubscriberDomain |
|
|
| csubJobQueryParamsEntry |
1.3.6.1.4.1.9.9.786.1.3.9.1 |
| An entry describes a set of subscriber session query
parameters.
The system automatically creates an entry when the EMS/NMS sets
the corresponding instance of csubJobType to 'query'. Likewise,
the system automatically destroys an entry under the following
circumstances:
1) The EMS/NMS destroys the corresponding row in the csubJobTable.
2) The EMS/NMS sets the corresponding instance of csubJobType to
'noop' or 'clear'. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubJobQueryParamsEntry |
|
|
| csubJobQueueEntry |
1.3.6.1.4.1.9.9.786.1.3.10.1 |
| An entry describing an subscriber session job in the
subscriber session job queue.
The system creates an entry in this table when it places a
subscriber session job on the subscriber session job queue. It
does this when the EMS/NMS sets an instance of csubJobControl to
'start' and the system is already executing a subscriber session
job. Likewise, the system destroys an entry when it removes it
from the queue. This occurs under the following circumstances:
1) The system has finished executing a job, for whatever
reason, and is ready to start executing the job at the head
of the queue.
2) The EMS/NMS has set an instance of csubJobControl to 'abort'
for a job that was on the queue. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubJobQueueEntry |
|
|
| csubJobReportEntry |
1.3.6.1.4.1.9.9.786.1.3.11.1 |
| An entry describes a subscriber session that satisfied the
match criteria specified by the corresponding job.
The system creates an entry for each subscriber session that
satisfied the specified match criteria of a subscriber session
job having a csubJobType of 'query'. However, it does not
create these entries until after the system has successfully
executed the subscriber session job.
The system destroys an entry under the following circumstances:
1) The corresponding subscriber session job has been destroyed
by the EMS/NMS.
2) The value of csubJobMaxLife is non-zero and the age of the
report has reached the specified maximum life.
3) The EMS/NMS has set the corresponding instance of
csubJobControl to 'release'.
4) The EMS/NMS has restarted the corresponding subscriber
session job (i.e., has set the corresponding instance of
csubJobControl to 'start'). |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CsubJobReportEntry |
|
|
