csubJobEntry
CISCO-SUBSCRIBER-SESSION-MIB ·
.1.3.6.1.4.1.9.9.786.1.3.7.1
Object
row
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'.
Context
- MIB
- CISCO-SUBSCRIBER-SESSION-MIB
- OID
.1.3.6.1.4.1.9.9.786.1.3.7.1- Type
- row
- Status
- current
- Parent
- csubJobTable
- Table
- csubJobTable
- Children
- 9
Syntax
No syntax metadata recorded.
Values & Constraints
No enumerated values or constraints recorded.
Related Objects
Child Objects
| Object | Type | Syntax | OID |
|---|---|---|---|
| csubJobId This object indicates an arbitrary, positive integer-value
uniquely identifying the subscriber session job. | column | SubscriberJobIdentifier | .1.3.6.1.4.1.9.9.786.1.3.7.1.1 |
| csubJobStatus This object specifies the status of the subscriber session
job. The following columns must be valid before activating a
subscriber session job:
- csubJobStorag… | column | SNMPv2-TCRowStatus | .1.3.6.1.4.1.9.9.786.1.3.7.1.2 |
| csubJobStorage This object specifies what happens to the subscriber session
job upon restart. | column | SNMPv2-TCStorageType | .1.3.6.1.4.1.9.9.786.1.3.7.1.3 |
| csubJobType This object specifies the type of subscriber session job:
'noop'
This type of job does nothing and simply serves as a
convenient default value for newly cre… | column | Enumeration | .1.3.6.1.4.1.9.9.786.1.3.7.1.4 |
| csubJobControl This object specifies an action relating to the subscriber
session job:
'noop'
This action does nothing.
'start'
If the corre… | column | Enumeration | .1.3.6.1.4.1.9.9.786.1.3.7.1.5 |
| csubJobState This object indicates the current state of the subscriber
session job:
'idle'
This state indicates that the system has not executed
the subscrib… | column | Enumeration | .1.3.6.1.4.1.9.9.786.1.3.7.1.6 |
| csubJobStartedTime This object indicates the value of sysUpTime when the system
started executing the subscriber session job. This value will
be '0' when the corresponding instance of csubJobState … | column | SNMPv2-TCTimeStamp | .1.3.6.1.4.1.9.9.786.1.3.7.1.7 |
| csubJobFinishedTime This object indicates the value of sysUpTime when the system
finished executing the subscriber session job, for whatever
reason. This value will be '0' when the corresponding ins… | column | SNMPv2-TCTimeStamp | .1.3.6.1.4.1.9.9.786.1.3.7.1.8 |
| csubJobFinishedReason This object indicates the reason why the system finished
executing the subscriber session job:
'invalid'
Indicates that the corresponding instance of
… | column | Enumeration | .1.3.6.1.4.1.9.9.786.1.3.7.1.9 |
Indexes
| Object | Type | Syntax | OID |
|---|---|---|---|
| csubJobId This object indicates an arbitrary, positive integer-value
uniquely identifying the subscriber session job. | column | SubscriberJobIdentifier | .1.3.6.1.4.1.9.9.786.1.3.7.1.1 |