values. The canceledByUser, canceledByOperator, or
canceledAtDevice values remain while the job is in the
canceled state.
aborted(8),
The job has been aborted by the system, usually while the
job was in the processing or processingStopped state and
the server or device has completed aborting the job AND
all MIB objects and attributes have reached their final
values for the job. While the server or device is
aborting the job, the job's jmJobStateReasons1 object MAY
contain the processingToStopPoint and abortedBySystem
values. If implemented, the abortedBySystem value SHALL
remain while the job is in the aborted state.
completed(9)
The job has completed successfully or with warnings or
errors after processing and all of the media have been
successfully stacked in the appropriate output bin(s) AND
all MIB objects and attributes have reached their final
values for the job. The job's jmJobStateReasons1 object
SHOULD contain one of: completedSuccessfully,
completedWithWarnings, or completedWithErrors values.
This is a type 2 enumeration. See Section 3.7.1.2."
SYNTAX INTEGER {
unknown(2),
pending(3),
pendingHeld(4),
processing(5),
processingStopped(6),
canceled(7),
aborted(8),
completed(9)
}
JmAttributeTypeTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The type of the attribute which identifies the attribute.
NOTE - The enum assignments are grouped logically with values
assigned in groups of 20, so that additional values may be
registered in the future and assigned a value that is part of
their logical grouping.
Values in the range 2**30 to 2**31-1 are reserved for private
or experimental usage. This range corresponds to the same
range reserved in IPP. Implementers are warned that use of
such values may conflict with other implementations.
Implementers are encouraged to request registration of enum
values following the procedures in Section 3.7.1.
See Section 3.2 entitled 'The Attribute Mechanism' for a
description of this textual-convention and its use in the
jmAttributeTable. See Section 3.3.8 for the specification of
each attribute. The comment(s) after each enum assignment
specifies the data type(s) of the attribute.
This is a type 2 enumeration. See Section 3.7.1.2."
SYNTAX INTEGER {
other(1), -- Integer32 (-2..2147483647)
-- AND/OR
-- OCTET STRING(SIZE(0..63))
-- Job State attributes:
jobStateReasons2(3), -- JmJobStateReasons2TC
jobStateReasons3(4), -- JmJobStateReasons3TC
jobStateReasons4(5), -- JmJobStateReasons4TC
processingMessage(6), -- JmUTF8StringTC (SIZE(0..63))
processingMessageNaturalLangTag(7),
-- OCTET STRING(SIZE(0..63))
jobCodedCharSet(8), -- CodedCharSet
jobNaturalLanguageTag(9), -- OCTET STRING(SIZE(0..63))
-- Job Identification attributes:
jobURI(20), -- OCTET STRING(SIZE(0..63))
jobAccountName(21), -- OCTET STRING(SIZE(0..63))
serverAssignedJobName(22), -- JmJobStringTC (SIZE(0..63))
jobName(23), -- JmJobStringTC (SIZE(0..63))
jobServiceTypes(24), -- JmJobServiceTypesTC
jobSourceChannelIndex(25), -- Integer32 (0..2147483647)
jobSourcePlatformType(26), -- JmJobSourcePlatformTypeTC
submittingServerName(27), -- JmJobStringTC (SIZE(0..63))
submittingApplicationName(28), -- JmJobStringTC (SIZE(0..63))
jobOriginatingHost(29), -- JmJobStringTC (SIZE(0..63))
deviceNameRequested(30), -- JmJobStringTC (SIZE(0..63))
queueNameRequested(31), -- JmJobStringTC (SIZE(0..63))
physicalDevice(32), -- hrDeviceIndex
-- AND/OR
-- JmUTF8StringTC (SIZE(0..63))
numberOfDocuments(33), -- Integer32 (-2..2147483647)
fileName(34), -- JmJobStringTC (SIZE(0..63))
documentName(35), -- JmJobStringTC (SIZE(0..63))
jobComment(36), -- JmJobStringTC (SIZE(0..63))
documentFormatIndex(37), -- Integer32 (0..2147483647)
documentFormat(38), -- PrtInterpreterLangFamilyTC
-- AND/OR
-- OCTET STRING(SIZE(0..63))
-- Job Parameter attributes:
jobPriority(50), -- Integer32 (-2..100)
jobProcessAfterDateAndTime(51), -- DateAndTime (SNMPv2-TC)
jobHold(52), -- JmBooleanTC
jobHoldUntil(53), -- JmJobStringTC (SIZE(0..63))
outputBin(54), -- Integer32 (0..2147483647)
-- AND/OR
-- JmJobStringTC (SIZE(0..63))
sides(55), -- Integer32 (-2..2)
finishing(56), -- JmFinishingTC
-- Image Quality attributes:
printQualityRequested(70), -- JmPrintQualityTC
printQualityUsed(71), -- JmPrintQualityTC
printerResolutionRequested(72), -- JmPrinterResolutionTC
printerResolutionUsed(73), -- JmPrinterResolutionTC
tonerEcomonyRequested(74), -- JmTonerEconomyTC
tonerEcomonyUsed(75), -- JmTonerEconomyTC
tonerDensityRequested(76), -- Integer32 (-2..100)
tonerDensityUsed(77), -- Integer32 (-2..100)
-- Job Progress attributes:
jobCopiesRequested(90), -- Integer32 (-2..2147483647)
jobCopiesCompleted(91), -- Integer32 (-2..2147483647)
documentCopiesRequested(92), -- Integer32 (-2..2147483647)
documentCopiesCompleted(93), -- Integer32 (-2..2147483647)
jobKOctetsTransferred(94), -- Integer32 (-2..2147483647)
sheetCompletedCopyNumber(95), -- Integer32 (-2..2147483647)
sheetCompletedDocumentNumber(96),
-- Integer32 (-2..2147483647)
jobCollationType(97), -- JmJobCollationTypeTC
-- Impression attributes:
impressionsSpooled(110), -- Integer32 (-2..2147483647)
impressionsSentToDevice(111), -- Integer32 (-2..2147483647)
impressionsInterpreted(112), -- Integer32 (-2..2147483647)
impressionsCompletedCurrentCopy(113),
-- Integer32 (-2..2147483647)
fullColorImpressionsCompleted(114),
-- Integer32 (-2..2147483647)
highlightColorImpressionsCompleted(115),
-- Integer32 (-2..2147483647)
-- Page attributes:
pagesRequested(130), -- Integer32 (-2..2147483647)
pagesCompleted(131), -- Integer32 (-2..2147483647)
pagesCompletedCurrentCopy(132), -- Integer32 (-2..2147483647)
-- Sheet attributes:
sheetsRequested(150), -- Integer32 (-2..2147483647)
sheetsCompleted(151), -- Integer32 (-2..2147483647)
sheetsCompletedCurrentCopy(152),-- Integer32 (-2..2147483647)
-- Resource attributes:
mediumRequested(170), -- JmMediumTypeTC
-- AND/OR
-- JmJobStringTC (SIZE(0..63))
mediumConsumed(171), -- Integer32 (-2..2147483647)
-- AND
-- JmJobStringTC (SIZE(0..63))
colorantRequested(172), -- Integer32 (-2..2147483647)
-- AND/OR
-- JmJobStringTC (SIZE(0..63))
colorantConsumed(173), -- Integer32 (-2..2147483647)
-- AND/OR
-- JmJobStringTC (SIZE(0..63))
mediumTypeConsumed(174), -- Integer32 (-2..2147483647)
-- AND
-- JmJobStringTC (SIZE(0..63))
mediumSizeConsumed(175), -- Integer32 (-2..2147483647)
-- AND
-- JmJobStringTC (SIZE(0..63))
-- Time attributes:
jobSubmissionToServerTime(190), -- JmTimeStampTC
-- AND/OR
-- DateAndTime
jobSubmissionTime(191), -- JmTimeStampTC
-- AND/OR
-- DateAndTime
jobStartedBeingHeldTime(192), -- JmTimeStampTC
-- AND/OR
-- DateAndTime
jobStartedProcessingTime(193), -- JmTimeStampTC
-- AND/OR
-- DateAndTime
jobCompletionTime(194), -- JmTimeStampTC
-- AND/OR
-- DateAndTime
jobProcessingCPUTime(195) -- Integer32 (-2..2147483647)
}
JmJobServiceTypesTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Specifies the type(s) of service to which the job has been
submitted (print, fax, scan, etc.). The service type is
represented as an enum that is bit encoded with each job
service type so that more general and arbitrary services can be
created, such as services with more than one destination type,
or ones with only a source or only a destination. For example,
a job service might scan, faxOut, and print a single job. In
this case, three bits would be set in the jobServiceTypes
attribute, corresponding to the hexadecimal values: 0x8 + 0x20
+ 0x4, respectively, yielding: 0x2C.
Whether this attribute is set from a job attribute supplied by
the job submission client or is set by the recipient job
submission server or device depends on the job submission
protocol. With either implementation, the agent SHALL return a
non-zero value for this attribute indicating the type of the
job.
One of the purposes of this attribute is to permit a requester
to filter out jobs that are not of interest. For example, a
printer operator MAY only be interested in jobs that include
printing. That is why the attribute is in the job
identification category.
The following service component types are defined (in
hexadecimal) and are assigned a separate bit value for use with
the jobServiceTypes attribute:
other 0x1
The job contains some instructions that are not one of the
identified types.
unknown 0x2
The job contains some instructions whose type is unknown to
the agent.
print 0x4
The job contains some instructions that specify printing
scan 0x8
The job contains some instructions that specify scanning
faxIn 0x10
The job contains some instructions that specify receive fax
faxOut 0x20
The job contains some instructions that specify sending fax
getFile 0x40
The job contains some instructions that specify accessing
files or documents
putFile 0x80
The job contains some instructions that specify storing
files or documents
mailList 0x100
The job contains some instructions that specify
distribution of documents using an electronic mail system.
These bit definitions are the equivalent of a type 2 enum
except that combinations of them MAY be used together. See
section 3.7.1.2."
SYNTAX INTEGER (0..2147483647) -- 31 bits, all but sign bit
JmJobStateReasons1TC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The JmJobStateReasonsNTC (N=1..4) textual-conventions are used
with the jmJobStateReasons1 object and jobStateReasonsN
(N=2..4), respectively, to provide additional information
regarding the current jmJobState object value. These values
MAY be used with any job state or states for which the reason
makes sense. See section 3.3.9.1 for the specification of each
bit value defined for use with the JmJobStateReasons1TC.
These bit definitions are the equivalent of a type 2 enum
except that combinations of bits may be used together. See
section 3.7.1.2."
SYNTAX INTEGER (0..2147483647) -- 31 bits, all but sign bit
JmJobStateReasons2TC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual-convention is used with the jobStateReasons2
attribute to provides additional information regarding the
jmJobState object. See section 3.3.9.2 for the specification
of JmJobStateReasons2TC. See section 3.3.9.1 for the
description under JmJobStateReasons1TC for additional
information that applies to all reasons.
These bit definitions are the equivalent of a type 2 enum
except that combinations of them may be used together. See
section 3.7.1.2."
SYNTAX INTEGER (0..2147483647) -- 31 bits, all but sign bit
JmJobStateReasons3TC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual-convention is used with the jobStateReasons3
attribute to provides additional information regarding the
jmJobState object. See section 3.3.9.3 for the specification
of JmJobStateReasons3TC. See section 3.3.9.1 for the
description under JmJobStateReasons1TC for additional
information that applies to all reasons.
These bit definitions are the equivalent of a type 2 enum
except that combinations of them may be used together. See
section 3.7.1.2. "
SYNTAX INTEGER (0..2147483647) -- 31 bits, all but sign bit
JmJobStateReasons4TC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual-convention is used in the jobStateReasons4
attribute to provides additional information regarding the
jmJobState object. See section 3.3.9.4 for the specification
of JmJobStateReasons4TC. See section 3.3.9.1 for the
description under JmJobStateReasons1TC for additional
information that applies to all reasons.
These bit definitions are the equivalent of a type 2 enum
except that combinations of them may be used together. See
section 3.7.1.2."
SYNTAX INTEGER (0..2147483647) -- 31 bits, all but sign bit
jobmonMIBObjects OBJECT IDENTIFIER ::= { jobmonMIB 1 }
-- The General Group (MANDATORY)
-- The jmGeneralGroup consists entirely of the jmGeneralTable.
jmGeneral OBJECT IDENTIFIER ::= { jobmonMIBObjects 1 }
jmGeneralTable OBJECT-TYPE
SYNTAX SEQUENCE OF JmGeneralEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The jmGeneralTable consists of information of a general nature
that are per-job-set, but are not per-job. See Section 2
entitled 'Terminology and Job Model' for the definition of a
job set.
The MANDATORY-GROUP macro specifies that this group is
MANDATORY."
::= { jmGeneral 1 }
jmGeneralEntry OBJECT-TYPE
SYNTAX JmGeneralEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Information about a job set (queue).
An entry SHALL exist in this table for each job set."
INDEX { jmGeneralJobSetIndex }
::= { jmGeneralTable 1 }
JmGeneralEntry ::= SEQUENCE {
jmGeneralJobSetIndex Integer32 (1..32767),
jmGeneralNumberOfActiveJobs Integer32 (0..2147483647),
jmGeneralOldestActiveJobIndex Integer32 (0..2147483647),
jmGeneralNewestActiveJobIndex Integer32 (0..2147483647),
jmGeneralJobPersistence Integer32 (15..2147483647),
jmGeneralAttributePersistence Integer32 (15..2147483647),
jmGeneralJobSetName JmUTF8StringTC (SIZE(0..63))
}
jmGeneralJobSetIndex OBJECT-TYPE
SYNTAX Integer32 (1..32767)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique value for each job set in this MIB. The jmJobTable
and jmAttributeTable tables have this same index as their
primary index.
The value(s) of the jmGeneralJobSetIndex SHALL be persistent
across power cycles, so that clients that have retained
jmGeneralJobSetIndex values will access the same job sets upon
subsequent power-up.
An implementation that has only one job set, such as a printer
with a single queue, SHALL hard code this object with the value
1.
See Section 2 entitled 'Terminology and Job Model' for the
definition of a job set.
Corresponds to the first index in jmJobTable and
jmAttributeTable."
::= { jmGeneralEntry 1 }
jmGeneralNumberOfActiveJobs OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current number of 'active' jobs in the jmJobIDTable,
jmJobTable, and jmAttributeTable, i.e., the total number of
jobs that are in the pending, processing, or processingStopped
states. See the JmJobStateTC textual-convention for the exact
specification of the semantics of the job states."
DEFVAL { 0 } -- no jobs
::= { jmGeneralEntry 2 }
jmGeneralOldestActiveJobIndex OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The jmJobIndex of the oldest job that is still in one of the
'active' states (pending, processing, or processingStopped).
In other words, the index of the 'active' job that has been in
the job tables the longest.
If there are no active jobs, the agent SHALL set the value of
this object to 0.
See Section 3.2 entitled 'The Job Tables and the Oldest Active
and Newest Active Indexes' for a description of the usage of
this object."
DEFVAL { 0 } -- no active jobs
::= { jmGeneralEntry 3 }
jmGeneralNewestActiveJobIndex OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The jmJobIndex of the newest job that is in one of the
'active' states (pending, processing, or processingStopped).
In other words, the index of the 'active' job that has been
most recently added to the job tables.
When all jobs become 'inactive', i.e., enter the pendingHeld,
completed, canceled, or aborted states, the agent SHALL set the
value of this object to 0.
See Section 3.2 entitled 'The Job Tables and the Oldest Active
and Newest Active Indexes' for a description of the usage of
this object."
DEFVAL { 0 } -- no active jobs
::= { jmGeneralEntry 4 }
jmGeneralJobPersistence OBJECT-TYPE
SYNTAX Integer32 (15..2147483647)
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The minimum time in seconds for this instance of the Job Set
that an entry SHALL remain in the jmJobIDTable and jmJobTable
after processing has completed, i.e., the minimum time in
seconds starting when the job enters the completed, canceled,
or aborted state.
Configuring this object is implementation-dependent.
This value SHALL be equal to or greater than the value of
jmGeneralAttributePersistence. This value SHOULD be at least
60 which gives a monitoring or accounting application one
minute in which to poll for job data."
DEFVAL { 60 } -- one minute
::= { jmGeneralEntry 5 }
jmGeneralAttributePersistence OBJECT-TYPE
SYNTAX Integer32 (15..2147483647)
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The minimum time in seconds for this instance of the Job Set
that an entry SHALL remain in the jmAttributeTable after
processing has completed , i.e., the time in seconds starting
when the job enters the completed, canceled, or aborted state.
Configuring this object is implementation-dependent.
This value SHOULD be at least 60 which gives a monitoring or
accounting application one minute in which to poll for job
data."
DEFVAL { 60 } -- one minute
::= { jmGeneralEntry 6 }
jmGeneralJobSetName OBJECT-TYPE
SYNTAX JmUTF8StringTC (SIZE(0..63))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The human readable name of this job set assigned by the system
administrator (by means outside of this MIB). Typically, this
name SHOULD be the name of the job queue. If a server or
device has only a single job set, this object can be the
administratively assigned name of the server or device itself.
This name does not need to be unique, though each job set in a
single Job Monitoring MIB SHOULD have distinct names.
NOTE - If the job set corresponds to a single printer and the
Printer MIB is implemented, this value SHOULD be the same as
the prtGeneralPrinterName object in the draft Printer MIB
[print-mib-draft]. If the job set corresponds to an IPP
Printer, this value SHOULD be the same as the IPP 'printer-
name' Printer attribute.
NOTE - The purpose of this object is to help the user of the
job monitoring application distinguish between several job sets
in implementations that support more than one job set.
See the OBJECT compliance macro for the minimum maximum length
required for conformance."
DEFVAL { ''H } -- empty string
::= { jmGeneralEntry 7 }
-- The Job ID Group (MANDATORY)
-- The jmJobIDGroup consists entirely of the jmJobIDTable.
jmJobID OBJECT IDENTIFIER ::= { jobmonMIBObjects 2 }
jmJobIDTable OBJECT-TYPE
SYNTAX SEQUENCE OF JmJobIDEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The jmJobIDTable provides a correspondence map (1) between the
job submission ID that a client uses to refer to a job and (2)
the jmGeneralJobSetIndex and jmJobIndex that the Job Monitoring
MIB agent assigned to the job and that are used to access the
job in all of the other tables in the MIB. If a monitoring
application already knows the jmGeneralJobSetIndex and the
jmJobIndex of the job it is querying, that application NEED NOT
use the jmJobIDTable.
The MANDATORY-GROUP macro specifies that this group is
MANDATORY."
::= { jmJobID 1 }
jmJobIDEntry OBJECT-TYPE
SYNTAX JmJobIDEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The map from (1) the jmJobSubmissionID to (2) the
jmGeneralJobSetIndex and jmJobIndex.
An entry SHALL exist in this table for each job currently known
to the agent for all job sets and job states. There MAY be
more than one jmJobIDEntry that maps to a single job. This
many to one mapping can occur when more than one network entity
along the job submission path supplies a job submission ID.
See Section 3.5. However, each job SHALL appear once and in
one and only one job set."
INDEX { jmJobSubmissionID }
::= { jmJobIDTable 1 }
JmJobIDEntry ::= SEQUENCE {
jmJobSubmissionID OCTET STRING(SIZE(48)),
jmJobIDJobSetIndex Integer32 (0..32767),
jmJobIDJobIndex Integer32 (0..2147483647)
}
jmJobSubmissionID OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(48))
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A quasi-unique 48-octet fixed-length string ID which
identifies the job within a particular client-server
environment. There are multiple formats for the
jmJobSubmissionID. Each format SHALL be uniquely identified.
See the JmJobSubmissionIDTypeTC textual convention. Each
format SHALL be registered using the procedures of a type 2
enum. See section 3.7.3 entitled: 'PWG Registration of Job
Submission Id Formats'.
If the requester (client or server) does not supply a job
submission ID in the job submission protocol, then the
recipient (server or device) SHALL assign a job submission ID
using any of the standard formats that have been reserved for
agents and adding the final 8 octets to distinguish the ID from
others submitted from the same requester.
The monitoring application, whether in the client or running
separately, MAY use the job submission ID to help identify
which jmJobIndex was assigned by the agent, i.e., in which row
the job information is in the other tables.
NOTE - fixed-length is used so that a management application
can use a shortened GetNext varbind (in SNMPv1 and SNMPv2) in
order to get the next submission ID, disregarding the remainder
of the ID in order to access jobs independent of the trailing
identifier part, e.g., to get all jobs submitted by a
particular jmJobOwner or submitted from a particular MAC
address.
See the JmJobSubmissionIDTypeTC textual convention.
See APPENDIX B - Support of Job Submission Protocols."
::= { jmJobIDEntry 1 }
jmJobIDJobSetIndex OBJECT-TYPE
SYNTAX Integer32 (0..32767)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object contains the value of the jmGeneralJobSetIndex for
the job with the jmJobSubmissionID value, i.e., the job set
index of the job set in which the job was placed when that
server or device accepted the job. This 16-bit value in
combination with the jmJobIDJobIndex value permits the
management application to access the other tables to obtain the
job-specific objects for this job.
See jmGeneralJobSetIndex in the jmGeneralTable."
DEFVAL { 0 } -- 0 indicates no job set index
::= { jmJobIDEntry 2 }
jmJobIDJobIndex OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object contains the value of the jmJobIndex for the job
with the jmJobSubmissionID value, i.e., the job index for the
job when the server or device accepted the job. This value, in
combination with the jmJobIDJobSetIndex value, permits the
management application to access the other tables to obtain the
job-specific objects for this job.
See jmJobIndex in the jmJobTable."
DEFVAL { 0 } -- 0 indicates no jmJobIndex value.
::= { jmJobIDEntry 3 }
-- The Job Group (MANDATORY)
-- The jmJobGroup consists entirely of the jmJobTable.
jmJob OBJECT IDENTIFIER ::= { jobmonMIBObjects 3 }
jmJobTable OBJECT-TYPE
SYNTAX SEQUENCE OF JmJobEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The jmJobTable consists of basic job state and status
information for each job in a job set that (1) monitoring
applications need to be able to access in a single SNMP Get
operation, (2) that have a single value per job, and (3) that
SHALL always be implemented.
The MANDATORY-GROUP macro specifies that this group is
MANDATORY."
::= { jmJob 1 }
jmJobEntry OBJECT-TYPE
SYNTAX JmJobEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Basic per-job state and status information.
An entry SHALL exist in this table for each job, no matter what
the state of the job is. Each job SHALL appear in one and only
one job set.
See Section 3.2 entitled 'The Job Tables'."
INDEX { jmGeneralJobSetIndex, jmJobIndex }
::= { jmJobTable 1 }
JmJobEntry ::= SEQUENCE {
jmJobIndex Integer32 (1..2147483647),
jmJobState JmJobStateTC,
jmJobStateReasons1 JmJobStateReasons1TC,
jmNumberOfInterveningJobs Integer32 (-2..2147483647),
jmJobKOctetsPerCopyRequested Integer32 (-2..2147483647),
jmJobKOctetsProcessed Integer32 (-2..2147483647),
jmJobImpressionsPerCopyRequested Integer32 (-2..2147483647),
jmJobImpressionsCompleted Integer32 (-2..2147483647),
jmJobOwner JmJobStringTC (SIZE(0..63))
}
jmJobIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The sequential, monatonically increasing identifier index for
the job generated by the server or device when that server or
device accepted the job. This index value permits the
management application to access the other tables to obtain the
job-specific row entries.
See Section 3.2 entitled 'The Job Tables and the Oldest Active
and Newest Active Indexes'.
See Section 3.5 entitled 'Job Identification'.
See also jmGeneralNewestActiveJobIndex for the largest value of
jmJobIndex.
See JmJobSubmissionIDTypeTC for a limit on the size of this
index if the agent represents it as an 8-digit decimal number."
::= { jmJobEntry 1 }
jmJobState OBJECT-TYPE
SYNTAX JmJobStateTC
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current state of the job (pending, processing, completed,
etc.). Agents SHALL implement only those states which are
appropriate for the particular implementation. However,
management applications SHALL be prepared to receive all the
standard job states.
The final value for this object SHALL be one of: completed,
canceled, or aborted. The minimum length of time that the
agent SHALL maintain MIB data for a job in the completed,
canceled, or aborted state before removing the job data from
the jmJobIDTable and jmJobTable is specified by the value of
the jmGeneralJobPersistence object."
DEFVAL { unknown } -- default is unknown
::= { jmJobEntry 2 }
jmJobStateReasons1 OBJECT-TYPE
SYNTAX JmJobStateReasons1TC
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Additional information about the job's current state, i.e.,
information that augments the value of the job's jmJobState
object.
Implementation of any reason values is OPTIONAL, but an agent
SHOULD return any reason information available. These values
MAY be used with any job state or states for which the reason
makes sense. Since the Job State Reasons will be more dynamic
than the Job State, it is recommended that a job monitoring
application read this object every time jmJobState is read.
When the agent cannot provide a reason for the current state of
the job, the value of the jmJobStateReasons1 object and
jobStateReasonsN attributes SHALL be 0.
The jobStateReasonsN (N=2..4) attributes provide further
additional information about the job's current state."
DEFVAL { 0 } -- no reasons
::= { jmJobEntry 3 }
jmNumberOfInterveningJobs OBJECT-TYPE
SYNTAX Integer32 (-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of jobs that are expected to complete processing
before this job has completed processing according to the
implementation's queuing algorithm, if no other jobs were to be
submitted. In other words, this value is the job's queue
position. The agent SHALL return a value of 0 for this
attribute when the job is the next job to complete processing
(or has completed processing)."
DEFVAL { 0 } -- default is no intervening jobs.
::= { jmJobEntry 4 }
jmJobKOctetsPerCopyRequested OBJECT-TYPE
SYNTAX Integer32 (-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total size in K (1024) octets of the document(s) being
requested to be processed in the job. The agent SHALL round
the actual number of octets up to the next highest K. Thus 0
octets is represented as '0', 1-1024 octets is represented as
'1', 1025-2048 is represented as '2', etc.
In computing this value, the server/device SHALL NOT include
the multiplicative factors contributed by (1) the number of
document copies, and (2) the number of job copies, independent
of whether the device can process multiple copies of the job or
document without making multiple passes over the job or
document data and independent of whether the output is collated
or not. Thus the server/device computation is independent of
the implementation and indicates the size of the document(s)
measured in K octets independent of the number of copies."
DEFVAL { -2 } -- the default is unknown(-2)
::= { jmJobEntry 5 }
jmJobKOctetsProcessed OBJECT-TYPE
SYNTAX Integer32 (-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of octets processed by the server or device
measured in units of K (1024) octets so far. The agent SHALL
round the actual number of octets processed up to the next
higher K. Thus 0 octets is represented as '0', 1-1024 octets
is represented as '1', 1025-2048 octets is '2', etc. For
printing devices, this value is the number interpreted by the
page description language interpreter rather than what has been
marked on media.
For implementations where multiple copies are produced by the
interpreter with only a single pass over the data, the final
value SHALL be equal to the value of the
jmJobKOctetsPerCopyRequested object. For implementations where
multiple copies are produced by the interpreter by processing
the data for each copy, the final value SHALL be a multiple of
the value of the jmJobKOctetsPerCopyRequested object.
NOTE - See the impressionsCompletedCurrentCopy and
pagesCompletedCurrentCopy attributes for attributes that are
reset on each document copy.
NOTE - The jmJobKOctetsProcessed object can be used with the
jmJobKOctetsPerCopyRequested object to provide an indication of
the relative progress of the job, provided that the
multiplicative factor is taken into account for some
implementations of multiple copies."
DEFVAL { 0 } -- default is no octets processed.
::= { jmJobEntry 6 }
jmJobImpressionsPerCopyRequested OBJECT-TYPE
SYNTAX Integer32 (-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total size in number of impressions of the document(s)
submitted.
In computing this value, the server/device SHALL NOT include
the multiplicative factors contributed by (1) the number of
document copies, and (2) the number of job copies, independent
of whether the device can process multiple copies of the job or
document without making multiple passes over the job or
document data and independent of whether the output is collated
or not. Thus the server/device computation is independent of
the implementation and reflects the size of the document(s)
measured in impressions independent of the number of copies.
See the definition of the term 'impression' in Section 2."
DEFVAL { -2 } -- default is unknown(-2)
::= { jmJobEntry 7 }
jmJobImpressionsCompleted OBJECT-TYPE
SYNTAX Integer32 (-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of impressions completed for this job so far.
For printing devices, the impressions completed includes
interpreting, marking, and stacking the output. For other
types of job services, the number of impressions completed
includes the number of impressions processed.
NOTE - See the impressionsCompletedCurrentCopy and
pagesCompletedCurrentCopy attributes for attributes that are
reset on each document copy.
NOTE - The jmJobImpressionsCompleted object can be used with
the jmJobImpressionsPerCopyRequested object to provide an
indication of the relative progress of the job, provided that
the multiplicative factor is taken into account for some
implementations of multiple copies.
See the definition of the term 'impression' in Section 2 and
the counting example in Section 3.4 entitled 'Monitoring Job
Progress'."
DEFVAL { 0 } -- default is no octets
::= { jmJobEntry 8 }
jmJobOwner OBJECT-TYPE
SYNTAX JmJobStringTC (SIZE(0..63))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The coded character set name of the user that submitted the
job. The method of assigning this user name will be system
and/or site specific but the method MUST ensure that the name
is unique to the network that is visible to the client and
target device.
This value SHOULD be the most authenticated name of the user
submitting the job.
See the OBJECT compliance macro for the minimum maximum length
required for conformance."
DEFVAL { ''H } -- default is empty string
::= { jmJobEntry 9 }
-- The Attribute Group (MANDATORY)
-- The jmAttributeGroup consists entirely of the jmAttributeTable.
--
-- Implementation of the objects in this group is MANDATORY.
-- See Section 3.1 entitled 'Conformance Considerations'.
-- An agent SHALL implement any attribute if (1) the server or device
-- supports the functionality represented by the attribute and (2) the
-- information is available to the agent.
jmAttribute OBJECT IDENTIFIER ::= { jobmonMIBObjects 4 }
jmAttributeTable OBJECT-TYPE
SYNTAX SEQUENCE OF JmAttributeEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The jmAttributeTable SHALL contain attributes of the job and
document(s) for each job in a job set. Instead of allocating
distinct objects for each attribute, each attribute is
represented as a separate row in the jmAttributeTable.
The MANDATORY-GROUP macro specifies that this group is
MANDATORY. An agent SHALL implement any attribute if (1) the
server or device supports the functionality represented by the
attribute and (2) the information is available to the agent. "
::= { jmAttribute 1 }
jmAttributeEntry OBJECT-TYPE
SYNTAX JmAttributeEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Attributes representing information about the job and
document(s) or resources required and/or consumed.
Each entry in the jmAttributeTable is a per-job entry with an
extra index for each type of attribute (jmAttributeTypeIndex)
that a job can have and an additional index
(jmAttributeInstanceIndex) for those attributes that can have
multiple instances per job. The jmAttributeTypeIndex object
SHALL contain an enum type that indicates the type of attribute
(see the JmAttributeTypeTC textual-convention). The value of
the attribute SHALL be represented in either the
jmAttributeValueAsInteger or jmAttributeValueAsOctets objects,
and/or both, as specified in the JmAttributeTypeTC textual-
convention.
The agent SHALL create rows in the jmAttributeTable as the
server or device is able to discover the attributes either from
the job submission protocol itself or from the document PDL.
As the documents are interpreted, the interpreter MAY discover
additional attributes and so the agent adds additional rows to
this table. As the attributes that represent resources are
actually consumed, the usage counter contained in the
jmAttributeValueAsInteger object is incremented according to
the units indicated in the description of the JmAttributeTypeTC
enum.
The agent SHALL maintain each row in the jmAttributeTable for
at least the minimum time after a job completes as specified by
the jmGeneralAttributePersistence object.
Zero or more entries SHALL exist in this table for each job in
a job set.
See Section 3.3 entitled 'The Attribute Mechanism' for a
description of the jmAttributeTable."
INDEX { jmGeneralJobSetIndex, jmJobIndex, jmAttributeTypeIndex,
jmAttributeInstanceIndex }
::= { jmAttributeTable 1 }
JmAttributeEntry ::= SEQUENCE {
jmAttributeTypeIndex JmAttributeTypeTC,
jmAttributeInstanceIndex Integer32 (1..32767),
jmAttributeValueAsInteger Integer32 (-2..2147483647),
jmAttributeValueAsOctets OCTET STRING(SIZE(0..63))
}
jmAttributeTypeIndex OBJECT-TYPE
SYNTAX JmAttributeTypeTC
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The type of attribute that this row entry represents.
The type MAY identify information about the job or document(s)
or MAY identify a resource required to process the job before
the job start processing and/or consumed by the job as the job
is processed.
Examples of job attributes (i.e., apply to the job as a whole)
that have only one instance per job include:
jobCopiesRequested(90), documentCopiesRequested(92),
jobCopiesCompleted(91), documentCopiesCompleted(93), while
examples of job attributes that may have more than one instance
per job include: documentFormatIndex(37), and
documentFormat(38).
Examples of document attributes (one instance per document)
include: fileName(34), and documentName(35).
Examples of required and consumed resource attributes include:
pagesRequested(130), mediumRequested(170), pagesCompleted(131),
and mediumConsumed(171), respectively."
::= { jmAttributeEntry 1 }
jmAttributeInstanceIndex OBJECT-TYPE
SYNTAX Integer32 (1..32767)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A running 16-bit index of the attributes of the same type for
each job. For those attributes with only a single instance per
job, this index value SHALL be 1. For those attributes that
are a single value per document, the index value SHALL be the
document number, starting with 1 for the first document in the
job. Jobs with only a single document SHALL use the index
value of 1. For those attributes that can have multiple values
per job or per document, such as documentFormatIndex(37) or
documentFormat(38), the index SHALL be a running index for the
job as a whole, starting at 1."
::= { jmAttributeEntry 2 }
jmAttributeValueAsInteger OBJECT-TYPE
SYNTAX Integer32 (-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The integer value of the attribute. The value of the
attribute SHALL be represented as an integer if the enum
description in the JmAttributeTypeTC textual-convention
definition has the tag: 'INTEGER:'.
Depending on the enum definition, this object value MAY be an
integer, a counter, an index, or an enum, depending on the
jmAttributeTypeIndex value. The units of this value are
specified in the enum description.
For those attributes that are accumulating job consumption as
the job is processed as specified in the JmAttributeTypeTC
textual-convention, SHALL contain the final value after the job
completes processing, i.e., this value SHALL indicate the total
usage of this resource made by the job.
A monitoring application is able to copy this value to a
suitable longer term storage for later processing as part of an
accounting system.
Since the agent MAY add attributes representing resources to
this table while the job is waiting to be processed or being
processed, which can be a long time before any of the resources
are actually used, the agent SHALL set the value of the
jmAttributeValueAsInteger object to 0 for resources that the
job has not yet consumed.
Attributes for which the concept of an integer value is
meaningless, such as fileName(34), jobName, and
processingMessage, do not have the 'INTEGER:' tag in the
JmAttributeTypeTC definition and so an agent SHALL always
return a value of '-1' to indicate 'other' for the value of the
jmAttributeValueAsInteger object for these attributes.
For attributes which do have the 'INTEGER:' tag in the
JmAttributeTypeTC definition, if the integer value is not (yet)
known, the agent either (1) SHALL not materialize the row in
the jmAttributeTable until the value is known or (2) SHALL
return a '-2' to represent an 'unknown' counting integer value,
a '0' to represent an 'unknown' index value, and a '2' to
represent an 'unknown(2)' enum value."
DEFVAL { -2 } -- default value is unknown(-2)
::= { jmAttributeEntry 3 }
jmAttributeValueAsOctets OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(0..63))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The octet string value of the attribute. The value of the
attribute SHALL be represented as an OCTET STRING if the enum
description in the JmAttributeTypeTC textual-convention
definition has the tag: 'OCTETS:'.
Depending on the enum definition, this object value MAY be a
coded character set string (text), such as 'JmUTF8StringTC', or
a binary octet string, such as 'DateAndTime'.
Attributes for which the concept of an octet string value is
meaningless, such as pagesCompleted, do not have the tag
'OCTETS:' in the JmAttributeTypeTC definition and so the agent
SHALL always return a zero length string for the value of the
jmAttributeValueAsOctets object.
For attributes which do have the 'OCTETS:' tag in the
JmAttributeTypeTC definition, if the OCTET STRING value is not
(yet) known, the agent either SHALL NOT materialize the row in
the jmAttributeTable until the value is known or SHALL return a
zero-length string."
DEFVAL { ''H } -- empty string
::= { jmAttributeEntry 4 }
-- Notifications and Trapping
-- Reserved for the future
jobmonMIBNotifications OBJECT IDENTIFIER ::= { jobmonMIB 2 }
-- Conformance Information
jmMIBConformance OBJECT IDENTIFIER ::= { jobmonMIB 3 }
-- compliance statements
jmMIBCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for agents that implement the
job monitoring MIB."
MODULE -- this module
MANDATORY-GROUPS {
jmGeneralGroup, jmJobIDGroup, jmJobGroup, jmAttributeGroup }
OBJECT jmGeneralJobSetName
SYNTAX JmUTF8StringTC (SIZE(0..8))
DESCRIPTION
"Only 8 octets maximum string length NEED be supported by the
agent."
OBJECT jmJobOwner
SYNTAX JmJobStringTC (SIZE(0..16))
DESCRIPTION
"Only 16 octets maximum string length NEED be supported by the
agent."
-- There are no CONDITIONALLY MANDATORY or OPTIONAL groups.
::= { jmMIBConformance 1 }
jmMIBGroups OBJECT IDENTIFIER ::= { jmMIBConformance 2 }
jmGeneralGroup OBJECT-GROUP
OBJECTS {
jmGeneralNumberOfActiveJobs, jmGeneralOldestActiveJobIndex,
jmGeneralNewestActiveJobIndex, jmGeneralJobPersistence,
jmGeneralAttributePersistence, jmGeneralJobSetName}
STATUS current
DESCRIPTION
"The general group."
::= { jmMIBGroups 1 }
jmJobIDGroup OBJECT-GROUP
OBJECTS {
jmJobIDJobSetIndex, jmJobIDJobIndex }
STATUS current
DESCRIPTION
"The job ID group."
::= { jmMIBGroups 2 }
jmJobGroup OBJECT-GROUP
OBJECTS {
jmJobState, jmJobStateReasons1, jmNumberOfInterveningJobs,
jmJobKOctetsPerCopyRequested, jmJobKOctetsProcessed,
jmJobImpressionsPerCopyRequested, jmJobImpressionsCompleted,
jmJobOwner }
STATUS current
DESCRIPTION
"The job group."
::= { jmMIBGroups 3 }
jmAttributeGroup OBJECT-GROUP
OBJECTS {
jmAttributeValueAsInteger, jmAttributeValueAsOctets }
STATUS current
DESCRIPTION
"The attribute group."
::= { jmMIBGroups 4 }
END
5 Appendix A - Implementing the Job Life Cycle
The job object has well-defined states and client operations that
affect the transition between the job states. Internal server and
device actions also affect the transitions of the job between the job
states. These states and transitions are referred to as the job's
life cycle.
Not all implementations of job submission protocols have all of the
states of the job model specified here. The job model specified here
is intended to be a superset of most implementations. It is the
purpose of the agent to map the particular implementation's job life
cycle onto the one specified here. The agent MAY omit any states not
implemented. Only the processing and completed states are required
to be implemented by an agent. However, a conforming management
application SHALL be prepared to accept any of the states in the job
life cycle specified here, so that the management application can
interoperate with any conforming agent.
The job states are intended to be user visible. The agent SHALL make
these states visible in the MIB, but only for the subset of job
states that the implementation has. Some implementations MAY need to
have sub-states of these user-visible states. The jmJobStateReasons1
object and the jobStateReasonsN (N=2..4) attributes can be used to
represent the sub-states of the jobs.
Job states are intended to last a user-visible length of time in most
implementations. However, some jobs may pass through some states in
zero time in some situations and/or in some implementations.
The job model does not specify how accounting and auditing is
implemented, except to assume that accounting and auditing logs are
separate from the job life cycle and last longer than job entries in
the MIB. Jobs in the completed, aborted, or canceled states are not
logs, since jobs in these states are accessible via SNMP protocol
operations and SHALL be removed from the Job Monitoring MIB tables
after a site-settable or implementation-defined period of time. An
accounting application MAY copy accounting information incrementally
to an accounting log as a job processes, or MAY be copied while the
job is in the canceled, aborted, or completed states, depending on
implementation. The same is true for auditing logs.
The jmJobState object specifies the standard job states. The normal
job state transitions are shown in the state transition diagram
presented in Figure 4.
6 APPENDIX B - Support of Job Submission Protocols
A companion PWG document, entitled "Job Submission Protocol Mapping
Recommendations for the Job Monitoring MIB" [protomap] contains the
recommended usage of each of the objects and attributes in this MIB
with a number of job submission protocols. In particular, which job
submission ID format should be used is indicated for each job
submission protocol.
Some job submission protocols have support for the client to specify
a job submission ID. A second approach is to enhance the document
format to embed the job submission ID in the document data. This
second approach is independent of the job submission protocol. This
appendix lists some examples of these approaches.
Some PJL implementations wrap a banner page as a PJL job around a job
submitted by a client. If this results in multiple job submission
IDs, the agent SHALL create multiple jmJobIDEntry rows in the
jmJobIDTable that each point to the same job entry in the job tables.
See the specification of the jmJobIDEntry.
7 References
[BCP-11] Bradner S. and R. Hovey, "The Organizations
Involved in the IETF Standards Process", BCP 11,
RFC2028, October 1996.
[GB2312] GB 2312-1980, "Chinese People's Republic of China
(PRC) mixed one byte and two byte coded character
set"
[hr-mib] Grillo, P. and S. Waldbusser, "Host Resources
MIB", RFC1514, September 1993.
[iana] Reynolds, J. and J. Postel, "Assigned Numbers",
STD 2, RFC1700, October 1994.
[IANA-charsets] Coded Character Sets registered by IANA and
assigned an enum value for use in the CodedCharSet
textual convention imported from the Printer MIB.
See ftp://ftp.isi.edu/in-
notes/iana/assignments/character-sets
[iana-media-types] IANA Registration of MIME media types (MIME
content types/subtypes). See
ftp://ftp.isi.edu/in-notes/iana/assignments/
[ipp-model] deBry, R., Hastings, T., Herriot, R., Issaacson,
S. and P. Powell, "The Internet Printing
Protocol/1.0: Model and Semantics",