home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Internet Info 1997 December
/
Internet_Info_CD-ROM_Walnut_Creek_December_1997.iso
/
drafts
/
draft_ietf_j_p
/
draft-ietf-printmib-job-monitor-05.txt
< prev
next >
Wrap
Text File
|
1997-08-26
|
213KB
|
6,002 lines
Job Monitoring MIB, V0.85 Aug 8, 1997
INTERNET-DRAFT Ron Bergman
Dataproducts Corp.
Tom Hastings
Xerox Corporation
Scott Isaacson
Novell, Inc.
Harry Lewis
IBM Corp.
August 8, 1997
Job Monitoring MIB - V0.85
<draft-ietf-printmib-job-monitor-05.txt>
Expires Feb 8, 1997
Status of this Memo
This document is an Internet-Draft. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its areas,
and its working groups. Note that other groups may also distribute
working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six
months and may be updated, replaced, or obsoleted by other
documents at any time. It is inappropriate to use Internet-Drafts
as reference material or to cite them other than as "work in
progress."
To learn the current status of any Internet-Draft, please check the
"1id-abstracts.txt" listing contained in the Internet-Drafts Shadow
Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe),
munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or
ftp.isi.edu (US West Coast).
Abstract
This Internet-Draft specifies a small set of read-only SNMP MIB
objects for (1) monitoring the status and progress of print jobs
(2) obtaining resource requirements before a job is processed, (3)
monitoring resource consumption while a job is being processed and
(4) collecting resource accounting data after the completion of a
job. This MIB is intended to be implemented (1) in a printer or
(2) in a server that supports one or more printers. Use of the
object set is not limited to printing. However, support for
services other than printing is outside the scope of this Job
Bergman, Hastings, Isaacson, Lewis [Page 1]
Job Monitoring MIB, V0.85 Aug 8, 1997
Monitoring MIB. Future extensions to this MIB may include, but are
not limited to, fax machines and scanners.
Bergman, Hastings, Isaacson, Lewis [Page 2]
Job Monitoring MIB, V0.85 Aug 8, 1997
TABLE OF CONTENTS
1. INTRODUCTION 8
1.1 Types of Information in the MIB 8
1.2 Types of Job Monitoring Applications 10
2. TERMINOLOGY AND JOB MODEL 11
2.1 System Configurations for the Job Monitoring MIB 13
2.1.1 Configuration 1 - client-printer 14
2.1.2 Configuration 2 - client-server-printer - agent in the server14
2.1.3 Configuration 3 - client-server-printer - client monitors
printer agent and server 16
3. MANAGED OBJECT USAGE 17
3.1 Conformance Considerations 17
3.1.1 Conformance Terminology 18
3.1.2 Agent Conformance Requirements 18
3.1.2.1 MIB II System Group objects 18
3.1.2.2 MIB II Interface Group objects 19
3.1.2.3 Printer MIB objects 19
3.1.3 Job Monitoring Application Conformance Requirements 19
3.2 The Job Tables and the Oldest Active and Newest Active Indexes 19
3.3 The Attribute Mechanism 21
3.3.1 Conformance of Attribute Implementation 22
3.3.2 Useful, 'Unknown', and 'Other' Values for Objects and
Attributes 23
3.3.3 Data Sub-types and Attribute Naming Conventions 23
3.3.4 Single-Value (Row) Versus Multi-Value (MULTI-ROW) Attributes 24
3.3.5 Requested Attributes 24
3.3.6 Consumption Attributes 26
3.3.7 Index Value Attributes 26
3.4 Job Identification .............................................26
3.5 Internationalization Considerations 26
3.5.1 'JmUTF8StringTC' for text generated by the server or device 25
3.5.2 'JmJobStringTC' for text generated by the job submitter 25
Bergman, Hastings, Isaacson, Lewis [Page 3]
Job Monitoring MIB, V0.85 Aug 8, 1997
3.5.3 'DateAndTime' for representing the date and time 25
3.6 IANA Considerations 27
3.6.1 IANA Registration of enums 28
3.6.1.1 Type 1 enumerations 28
3.6.1.2 Type 2 enumerations 28
3.6.1.3 Type 3 enumeration 29
3.6.2 IANA Registration of type 2 bit values 29
3.6.3 IANA Registration of Job Submission Id Formats 29
3.6.4 IANA Registration of MIME types/sub-types for document-formats29
3.7 Security Considerations 30
3.7.1 Read-Write objects 30
3.7.2 Read-Only Objects In Other User's Jobs 30
3.8 Values for Objects 23
3.9 Notifications 30
4. MIB SPECIFICATION 30
Textual conventions for this MIB module 32
JmUTF8StringTC 33
JmJobStringTC 33
JmTimeStampTC 33
JmJobSourcePlatformTypeTC 33
JmFinishingTC 34
JmPrintQualityTC 36
JmPrinterResolutionTC 36
JmTonerEconomyTC 37
JmBooleanTC 37
JmMediumTypeTC 38
JmJobSubmissionIDTypeTC 39
JmJobStateTC 41
JmAttributeTypeTC 44
other (Int32(-2..) and/or Octets63) 45
Job State attributes 45
jobStateReasons2 (JmJobStateReasons2TC) 45
jobStateReasons3 (JmJobStateReasons3TC) 45
jobStateReasons4 (JmJobStateReasons4TC) 45
processingMessage (UTF8String63) 45
jobCodedCharSet (CodedCharSet) 45
Job Identification attributes 46
jobAccountName (JobString63) 46
serverAssignedJobName (JobString63) 47
jobName (JobString63) 47
jobServiceTypes (JmJobServiceTypesTC) 48
Bergman, Hastings, Isaacson, Lewis [Page 4]
Job Monitoring MIB, V0.85 Aug 8, 1997
jobSourceChannelIndex (Int32(0..)) 48
jobSourcePlatformType (JmJobSourcePlatformTypeTC) 48
submittingServerName (JobString63) 48
submittingApplicationName (JobString63) 49
jobOriginatingHost (JobString63) 49
deviceNameRequested (JobString63) 49
queueNameRequested (JobString63) 49
physicalDevice (hrDeviceIndex and/or UTF8String63) 49
numberOfDocuments (Int32(-2..)) 49
fileName (JobString63) 50
documentName (JobString63) 50
jobComment (JobString63) 50
documentFormatIndex (Int32(0..)) 50
documentFormat (PrtInterpreterLangFamilyTC and/or Octets63) 50
Job Parameter attributes 51
jobPriority (Int32(1..100)) 51
jobProcessAfterDateAndTime (DateAndTime) 51
jobHold (JmBooleanTC) 51
jobHoldUntil (JobString63) 52
outputBin (Int32(0..) and/or JobString63) 52
sides (Int32(-2..2)) 52
finishing (JmFinishingTC) 52
Image Quality attributes (requested and used) 52
printQualityRequested (JmPrintQualityTC) 52
printQualityUsed (JmPrintQualityTC) 53
printerResolutionRequested (JmPrinterResolutionTC) 53
printerResolutionUsed (JmPrinterResolutionTC) 53
tonerEcomonyRequested (JmTonerEconomyTC) 53
tonerEcomonyUsed (JmTonerEconomyTC) 53
tonerDensityRequested (Int32(-2..100)) 53
tonerDensityUsed (Int32(-2..100)) 53
Job Progress attributes (requested and consumed) 53
jobCopiesRequested (Int32(-2..)) 54
jobCopiesCompleted (Int32(-2..)) 54
documentCopiesRequested (Int32(-2..)) 54
documentCopiesCompleted (Int32(-2..)) 54
jobKOctetsTransferred (Int32(-2..)) 54
Impression attributes (requested and consumed) 55
impressionsSpooled (Int32(-2..)) 55
impressionsSentToDevice (Int32(-2..)) 55
impressionsInterpreted (Int32(-2..)) 55
impressionsCompletedCurrentCopy (Int32(-2..)) 55
fullColorImpressionsCompleted (Int32(-2..)) 55
highlightColorImpressionsCompleted (Int32(-2..)) 55
Page attributes (requested and consumed) 56
pagesRequested (Int32(-2..)) 56
pagesCompleted (Int32(-2..)) 56
pagesCompletedCurrentCopy (Int32(-2..)) 56
Bergman, Hastings, Isaacson, Lewis [Page 5]
Job Monitoring MIB, V0.85 Aug 8, 1997
Sheet attributes (requested and consumed) 57
sheetsRequested (Int32(-2..)) 57
sheetsCompleted (Int32(-2..)) 57
sheetsCompletedCurrentCopy (Int32(-2..)) 57
Resource attributes (requested and consumed) 57
mediumRequested (JmMediumTypeTC and/or JobString63) 57
mediumConsumed (JobString63) 57
colorantRequested (Int32(-2..) and/or JobString63) 58
colorantConsumed (Int32(-2..) and/or JobString63) 58
Time attributes (set by server or device) 58
jobSubmissionToServerTime (JmTimeStampTC and/or DateAndTime) 59
jobSubmissionTime (JmTimeStampTC and/or DateAndTime) 59
jobStartedBeingHeldTime (JmTimeStampTC and/or DateAndTime) 59
jobStartedProcessingTime (JmTimeStampTC and/or DateAndTime) 59
jobCompletedTime (JmTimeStampTC and/or DateAndTime) 59
jobProcessingCPUTime (Int32(-2..)) 59
JmJobServiceTypesTC 61
JmJobStateReasons1TC 63
JmJobStateReasons2TC 67
JmJobStateReasons3TC 71
JmJobStateReasons4TC 72
The General Group (MANDATORY) 73
jmGeneralJobSetIndex (Int32(1..32767)) 73
jmGeneralNumberOfActiveJobs (Int32(0..)) 74
jmGeneralOldestActiveJobIndex (Int32(0..)) 74
jmGeneralNewestActiveJobIndex (Int32(0..)) 75
jmGeneralJobPersistence (Int32(15..)) 75
jmGeneralAttributePersistence (Int32(15..)) 75
jmGeneralJobSetName (UTF8String63) 76
The Job ID Group (MANDATORY) 76
jmJobSubmissionID (OCTET STRING(SIZE(48))) 77
jmJobIDJobSetIndex (Int32(1..32767)) 78
jmJobIDJobIndex (Int32(1..)) 78
The Job Group (MANDATORY) 79
jmJobIndex (Int32(1..)) 80
jmJobState (JmJobStateTC) 80
jmJobStateReasons1 (JmJobStateReasons1TC) 81
jmNumberOfInterveningJobs (Int32(-2..)) 81
jmJobKOctetsRequested (Int32(-2..)) 81
jmJobKOctetsProcessed (Int32(-2..)) 82
jmJobImpressionsRequested (Int32(-2..)) 83
jmJobImpressionsCompleted (Int32(-2..)) 83
jmJobOwner (JobString63) 83
The Attribute Group (MANDATORY) 84
Bergman, Hastings, Isaacson, Lewis [Page 6]
Job Monitoring MIB, V0.85 Aug 8, 1997
jmAttributeTypeIndex (JmAttributeTypeTC) 86
jmAttributeInstanceIndex (Int32(1..32767)) 86
jmAttributeValueAsInteger (Int32(-2..)) 87
jmAttributeValueAsOctets (Octets63) 88
5. APPENDIX A - IMPLEMENTING THE JOB LIFE CYCLE 91
6. APPENDIX B - SUPPORT OF THE JOB SUBMISSION ID IN JOB SUBMISSION
PROTOCOLS 92
6.1 Hewlett-Packard's Printer Job Language (PJL) 92
6.2 ISO DPA 92
7. REFERENCES 93
8. AUTHOR'S ADDRESSES 94
9. INDEX 97
Bergman, Hastings, Isaacson, Lewis [Page 7]
Job Monitoring MIB, V0.85 Aug 8, 1997
Job Monitoring MIB
1. Introduction
The Job Monitoring MIB is intended to be implemented by an agent within
a printer or the first server closest to the printer, where the printer
is either directly connected to the server only or the printer does not
contain the job monitoring MIB agent. It is recommended that
implementations place the SNMP agent as close as possible to the
processing of the print job. This MIB applies to printers with and
without spooling capabilities. This MIB is designed to be compatible
with most current commonly-used job submission protocols. In most
environments that support high function job submission/job control
protocols, like ISO DPA[iso-dpa], those protocols would be used to
monitor and manage print jobs rather than using the Job Monitoring MIB.
The Job Monitoring MIB consists of a General Group, a Job Submission ID
Group, a Job Group, and an Attribute Group. Each group is a table. All
accessible objects are read-only. The General Group contains general
information that applies to all jobs in a job set. The Job Submission
ID table maps the job submission ID that the client uses to identify a
job to the jmJobIndex that the Job Monitoring Agent uses to identify
jobs in the Job and Attribute tables. The Job table contains the
MANDATORY integer job state and status objects. The Attribute table
consists of multiple entries per job that specify (1) job and document
identification and parameters, (2) requested resources, and (3)
consumed resources during and after job processing/printing. A larger
number of job attributes are defined as textual conventions that an
agent SHALL return if the server or device implements the functionality
so represented and the agent has access to the information.
1.1 Types of Information in the MIB
The job MIB is intended to provide the following information for the
indicated Role Models in the Printer MIB[print-mib] (Appendix D - Roles
of Users).
User:
Provide the ability to identify the least busy printer. The user
will be able to determine the number and size of jobs waiting for
each printer. No attempt is made to actually predict the length
of time that jobs will take.
Provide the ability to identify the current status of the user's
job (user queries).
Bergman, Hastings, Isaacson, Lewis [Page 8]
Job Monitoring MIB, V0.85 Aug 8, 1997
Provide a timely indication that the job has completed and where
it can be found.
Provide error and diagnostic information for jobs that did not
successfully complete.
Operator:
Provide a presentation of the state of all the jobs in the print
system.
Provide the ability to identify the user that submitted the print
job.
Provide the ability to identify the resources required by each
job.
Provide the ability to define which physical printers are
candidates for the print job.
Provide some idea of how long each job will take. However, exact
estimates of time to process a job is not being attempted.
Instead, objects are included that allow the operator to be able
to make gross estimates.
Capacity Planner:
Provide the ability to determine printer utilization as a function
of time.
Provide the ability to determine how long jobs wait before
starting to print.
Accountant:
Provide information to allow the creation of a record of resources
consumed and printer usage data for charging users or groups for
resources consumed.
Provide information to allow the prediction of consumable usage
and resource need.
The MIB supports printers that can contain more than one job at a time,
but still be usable for low end printers that only contain a single job
at a time. In particular, the MIB supports the needs of Windows and
other PC environments for managing low-end direct-connect (serial or
parallel) and networked devices without unnecessary overhead or
complexity, while also providing for higher end systems and devices.
Bergman, Hastings, Isaacson, Lewis [Page 9]
Job Monitoring MIB, V0.85 Aug 8, 1997
1.2 Types of Job Monitoring Applications
The Job Monitoring MIB is designed for the following types of monitoring
applications:
1. Monitor a single job starting when the job is submitted and ending
a defined period after the job completes. The Job Submission ID
table provides the map to find the specific job to be monitored.
2. Monitor all 'active' jobs in a queue, which this specification
generalizes to a "job set". End users may use such a program when
selecting a least busy printer, so the MIB is designed for such a
program to start up quickly and find the information needed
quickly without having to read all (completed) jobs in order to
find the active jobs. System operators may also use such a
program, in which case it would be running for a long period of
time and may also be interested in the jobs that have completed.
Finally such a program may be used to provide an enhanced console
and logging capability.
3. Collect resource usage for accounting or system utilization
purposes that copy the completed job statistics to an accounting
system. It is recognized that depending on accounting programs to
copy MIB data during the job-retention period is somewhat
unreliable, since the accounting program may not be running (or
may have crashed). Such a program is also expected to keep a
shadow copy of the entire Job Attribute table including completed,
canceled, and aborted jobs which the program updates on each
polling cycle. Such a program polls at the rate of the
persistence of the Attribute table. The design is not optimized
to help such an application determine which jobs are completed,
canceled, or aborted. Instead, the application SHALL query each
job that the application's shadow copy shows was not complete,
canceled, or aborted at the previous poll cycle to see if it is
now complete or canceled, plus any new jobs that have been
submitted.
The MIB provides a set of objects that represent a compatible subset of
job and document attributes of the ISO DPA standard[iso-dpa] and the
Internet Printing Protocol (IPP)[ipp-model], so that coherence is
maintained between these two protocols and the information presented to
end users and system operators by monitoring applications. However, the
job monitoring MIB is intended to be used with printers that implement
other job submitting and management protocols, such as IEEE 1284.1
(TIPSI)[tipsi], as well as with ones that do implement ISO DPA. Thus
the job monitoring MIB does not require implementation of either the ISO
DPA or IPP protocols.
Bergman, Hastings, Isaacson, Lewis [Page 10]
Job Monitoring MIB, V0.85 Aug 8, 1997
The MIB is designed so that an additional MIB(s) can be specified in the
future for monitoring multi-function (scan, FAX, copy) jobs as an
augmentation to this MIB.
2. Terminology and Job Model
This section defines the terms that are used in this specification and
the general model for jobs.
NOTE - Existing systems use conflicting terms, so these terms are
drawn from the ISO 10175 Document Printing Application (DPA)
standard[iso-dpa]. For example, PostScript systems use the term
session for what is called a job in this specification and the term
job to mean what is called a document in this specification. PJL
systems use the term job to mean what is called a job in this
specification. PJL also supports multiple documents per job, but does
not support specifying per-document attributes independently for each
document.
Job: a unit of work whose results are expected together without
interjection of unrelated results. A job contains one or more
documents.
Job Set: a group of jobs that are queued and scheduled together
according to a specified scheduling algorithm for a specified device or
set of devices. For implementations that embed the SNMP agent in the
device, the MIB job set normally represents all the jobs known to the
device, so that the implementation only implements a single job set. If
the SNMP agent is implemented in a server that controls one or more
devices, each MIB job set represents a job queue for (1) a specific
device or (2) set of devices, if the server uses a single queue to load
balance between several devices. Each job set is disjoint; no job SHALL
be represented in more than one MIB job set.
Document: a sub-section within a job that contains print data and
document instructions that apply to just the document.
Client: the network entity that end users use to submit jobs to
spoolers, servers, or printers and other devices, depending on the
configuration, using any job submission protocol over a serial or
parallel port to a directly-connected device or over the network to a
networked-connected device.
Server: a network entity that accepts jobs from clients and in turn
submits the jobs to printers and other devices that may be directly
connected to the server via a serial or parallel port or may be on the
network. A server MAY be a printer supervisor control program, or a
print spooler.
Bergman, Hastings, Isaacson, Lewis [Page 11]
Job Monitoring MIB, V0.85 Aug 8, 1997
Device: a hardware entity that (1) interfaces to humans in human
perceptible means, such as produces marks on paper, scans marks on paper
to produce an electronic representations, or writes CD-ROMs or (2)
interfaces electronically to another device, such as sends FAX data to
another FAX device.
Printer: a device that puts marks on media.
Supervisor: a server that contains a control program that controls a
printer or other device. A supervisor is a client to the printer or
other device.
Spooler: a server that accepts jobs, spools the data, and decides when
and on which printer to print the job. A spooler is a client to a
printer or a printer supervisor, depending on implementation.
Spooling: the act of a device or server of (1) accepting jobs and (2)
writing the job's attributes and document data on to secondary storage.
Queuing: the act of a device or server of ordering (queuing) the jobs
for the purposes of scheduling the jobs to be processed.
Monitor or Job Monitoring Application: the SNMP management application
that End Users, and System Operators use to monitor jobs using SNMP. A
monitor MAY be either a separate application or MAY be part of the
client that also submits jobs.
Accounting Application: the SNMP management application that copies job
information to some more permanent medium so that another application
can perform accounting on the data for Accountants, Asset Managers, and
Capacity Planners use.
Agent: the network entity that accepts SNMP requests from a monitor or
accounting application and provides access to the instrumentation for
managing jobs modeled by the management objects defined in the Job
Monitoring MIB module for a server or a device.
Proxy: an agent that acts as a concentrator for one or more other
agents by accepting SNMP operations on the behalf of one or more other
agents, forwarding them on to those other agents, gathering responses
from those other agents and returning them to the original requesting
monitor.
User: a person that uses a client or a monitor.
End User: a user that uses a client to submit a print job.
Bergman, Hastings, Isaacson, Lewis [Page 12]
Job Monitoring MIB, V0.85 Aug 8, 1997
System Operator: a user that uses a monitor to monitor the system and
carries out tasks to keep the system running.
System Administrator: a user that specifies policy for the system.
Job Instruction: an instruction specifying how, when, or where the job
is to be processed. Job instructions MAY be passed in the job
submission protocol or MAY be embedded in the document data or a
combination depending on the job submission protocol and implementation.
Document Instruction: an instruction specifying how to process the
document. Document instructions MAY be passed in the job submission
protocol separate from the actual document data, or MAY be embedded in
the document data or a combination, depending on the job submission
protocol and implementation.
SNMP Information Object: a name, value-pair that specifies an action, a
status, or a condition in an SNMP MIB. Objects are identified in SNMP
by an OBJECT IDENTIFIER.
Attribute: a name, value-pair that specifies a job or document
instruction, a status, or a condition of a job or a document that has
been submitted to a server or device. A particular attribute NEED NOT
be present in each job instance. In other words, attributes are present
in a job instance only when there is a need to express the value, either
because (1) the client supplied a value in the job submission protocol,
(2) the document data contained an embedded attribute, or (3) the server
or device supplied a default value. An agent SHALL represent an
attribute as an entry (row) in the Attribute table in this MIB in which
entries are present only when necessary. Attributes are identified in
this MIB by an enum.
Job Monitoring (using SNMP): the activity of a management application
of accessing the MIB and (1) identifying jobs in the job tables being
processed by the server, printer or other devices, and (2) displaying
information to the user about the processing of the job.
Job Accounting: the activity of a management application of accessing
the MIB and recording what happens to the job during and after the
processing of the job.
2.1 System Configurations for the Job Monitoring MIB
This section enumerates the three configurations in which the Job
Monitoring MIB is intended to be used. To simplify the pictures, the
devices are shown as printers. See section 1.1 entitled "Types of
Information in the MIB".
Bergman, Hastings, Isaacson, Lewis [Page 13]
Job Monitoring MIB, V0.85 Aug 8, 1997
The diagram in the Printer MIB[print-mib] entitled: "One Printer's View
of the Network" is assumed for this MIB as well. Please refer to that
diagram to aid in understanding the following system configurations.
2.1.1 Configuration 1 - client-printer
In the client-printer configuration 1, the client(s) submit jobs
directly to the printer, either by some direct connect, or by network
connection.
The job submitting client and/or monitoring application monitor jobs by
communicating directly with an agent that is part of the printer. The
agent in the printer SHALL keep the job in the Job Monitoring MIB as
long as the job is in the printer, plus a defined time period after the
job enters the completed state in which accounting programs can copy out
the accounting data from the Job Monitoring MIB.
all end-user ######## SNMP query
+-------+ +--------+ ---- job submission
|monitor| | client |
+---#---+ +--#--+--+
# # |
# ############ |
# # |
+==+===#=#=+==+ |
| | agent | | |
| +-------+ | |
| PRINTER <--------+
| | Print Job Delivery Channel
| |
+=============+
Figure 2-1 - Configuration 1 - client-printer - agent in the printer
The Job Monitoring MIB is designed to support the following
relationships (not shown in Figure 2-1):
1. Multiple clients MAY submit jobs to a printer.
2. Multiple clients MAY monitor a printer.
3. Multiple monitors MAY monitor a printer.
4. A client MAY submit jobs to multiple printers.
5. A monitor MAY monitor multiple printers.
2.1.2 Configuration 2 - client-server-printer - agent in the server
In the client-server-printer configuration 2, the client(s) submit jobs
to an intermediate server by some network connection, not directly to
Bergman, Hastings, Isaacson, Lewis [Page 14]
Job Monitoring MIB, V0.85 Aug 8, 1997
the printer. While configuration 2 is included, the design center for
this MIB is configurations 1 and 3.
The job submitting client and/or monitoring application monitor jobs by
communicating directly with:
A Job Monitoring MIB agent that is part of the server (or a front
for the server)
There is no SNMP Job Monitoring MIB agent in the printer in
configuration 2, at least that the client or monitor are aware. In this
configuration, the agent SHALL return the current values of the objects
in the Job Monitoring MIB both for jobs the server keeps and jobs that
the server has submitted to the printer. The Job Monitoring MIB agent
SHALL obtain the required information from the printer by a method that
is beyond the scope of this document. The agent in the server SHALL
keep the job in the Job Monitoring MIB in the server as long as the job
is in the printer, plus a defined time period after the job enters the
completed state in which accounting programs can copy out the accounting
data from the Job Monitoring MIB.
all end-user
+-------+ +----------+
|monitor| | client | ######## SNMP query
+---+---# +---#----+-+ **** non-SNMP cntrl
# # | ---- job submission
# # |
# # |
#=====#=+==v==+
| agent | |
+-------+ |
| server |
+----+-----+--+
control * |
********** |
* |
+========v====+ |
| | |
| | |
| PRINTER <---------+
| | Print Job Delivery Channel
| |
+=============+
Figure 2-2 - Configuration 2 - client-server-printer - agent in the
server
Bergman, Hastings, Isaacson, Lewis [Page 15]
Job Monitoring MIB, V0.85 Aug 8, 1997
The Job Monitoring MIB is designed to support the following
relationships (not shown in Figure 2-2):
1. Multiple clients MAY submit jobs to a server.
2. Multiple clients MAY monitor a server.
3. Multiple monitors MAY monitor a server.
4. A client MAY submit jobs to multiple servers.
5. A monitor MAY monitor multiple servers.
6. Multiple servers MAY submit jobs to a printer.
7. Multiple servers MAY control a printer.
2.1.3 Configuration 3 - client-server-printer - client monitors printer
agent and server
In the client-server-printer configuration 3, the client(s) submit jobs
to an intermediate server by some network connection, not directly to
the printer. That server does not contain a Job Monitoring MIB agent.
The job submitting client and/or monitoring application monitor jobs by
communicating directly with:
1. The server using some undefined protocol to monitor jobs in the
server (that does not contain the Job Monitoring MIB) AND
2. A Job Monitoring MIB agent that is part of the printer to monitor
jobs after the server passes the jobs to the printer. In such
configurations, the server deletes its copy of the job from the
server after submitting the job to the printer usually almost
immediately (before the job does much processing, if any).
In configuration 3, the agent (in the printer) SHALL keep the values of
the objects in the Job Monitoring MIB that the agent implements updated
for a job that the server has submitted to the printer. The agent SHALL
obtain information about the jobs submitted to the printer from the
server (either in the job submission protocol, in the document data, or
by direct query of the server), in order to populate some of the objects
the Job Monitoring MIB in the printer. The agent in the printer SHALL
keep the job in the Job Monitoring MIB as long as the job is in the
Printer, and longer in order to implement the completed state in which
monitoring programs can copy out the accounting data from the Job
Monitoring MIB.
Bergman, Hastings, Isaacson, Lewis [Page 16]
Job Monitoring MIB, V0.85 Aug 8, 1997
all end-user
+-------+ +----------+
|monitor| | client | ######## SNMP query
+---+---* +---*----+-+ **** non-SNMP query
# * * | ---- job submission
# * * |
# * * |
# *=====v====v==+
# | |
# | server |
# | |
# +----#-----+--+
# optional# |
# ########## |
# # |
+==+=v===v=+==+ |
| | agent | | |
| +-------+ | |
| PRINTER <---------+
| | Print Job Delivery Channel
| |
+=============+
Figure 2-3 - Configuration 3 - client-server-printer - client monitors
printer agent and server
The Job Monitoring MIB is designed to support the following
relationships (not shown in Figure 2-3):
1. Multiple clients MAY submit jobs to a server.
2. Multiple clients MAY monitor a server.
3. Multiple monitors MAY monitor a server.
4. A client MAY submit jobs to multiple servers.
5. A monitor MAY monitor multiple servers.
6. Multiple servers MAY submit jobs to a printer.
7. Multiple servers MAY control a printer.
3. Managed Object Usage
This section describes the usage of the objects in the MIB.
3.1 Conformance Considerations
In order to achieve interoperability between job monitoring applications
and job monitoring agents, this specification includes the conformance
requirements for both monitoring applications and agents.
Bergman, Hastings, Isaacson, Lewis [Page 17]
Job Monitoring MIB, V0.85 Aug 8, 1997
3.1.1 Conformance Terminology
This specification uses the verbs: "SHALL", "SHOULD", "MAY", and "NEED
NOT" to specify conformance requirements according to RFC 2119 [req-
words] as follows:
. "SHALL": indicates an action that the subject of the sentence must
implement in order to claim conformance to this specification
. "MAY": indicates an action that the subject of the sentence does
not have to implement in order to claim conformance to this
specification, in other words that action is an implementation
option
. "NEED NOT": indicates an action that the subject of the sentence
does not have to implement in order to claim conformance to this
specification. The verb "NEED NOT" is used instead of "may not",
since "may not" sounds like a prohibition.
. "SHOULD": indicates an action that is recommended for the subject
of the sentence to implement, but is not required, in order to
claim conformance to this specification.
3.1.2 Agent Conformance Requirements
A conforming agent:
1. SHALL implement all MANDATORY groups in this specification.
2. SHALL implement any attributes if (1) the server or device
supports the functionality represented by the attribute and (2)
the information is available to the agent.
3. SHOULD implement both forms of an attribute if it implements an
attribute that permits a choice of INTEGER and OCTET STRING forms,
since implementing both forms may help management applications by
giving them a choice of representations, since the representation
are equivalent. See the JmAttributeTypeTC textual-convention.
4. NOTE - This MIB, like the Printer MIB, is written following the
subset of SMIv2 that can be supported by SMIv1 and SNMPv1
implementations.
3.1.2.1 MIB II System Group objects
The Job Monitoring MIB agent SHALL implement all objects in the System
Group of MIB-II[mib-II], whether the Printer MIB[print-mib] is
implemented or not.
Bergman, Hastings, Isaacson, Lewis [Page 18]
Job Monitoring MIB, V0.85 Aug 8, 1997
3.1.2.2 MIB II Interface Group objects
The Job Monitoring MIB agent SHALL implement all objects in the
Interfaces Group of MIB-II[mib-II], whether the Printer MIB[print-mib]
is implemented or not.
3.1.2.3 Printer MIB objects
If the agent is providing access to a device that is a printer, the
agent SHALL implement all of the MANDATORY objects in the Printer
MIB[print-mib] and all the objects in other MIBs that conformance to the
Printer MIB requires, such as the Host Resources MIB[hr-mib]. If the
agent is providing access to a server that controls one or more direct-
connect or networked printers, the agent NEED NOT implement the Printer
MIB and NEED NOT implement the Host Resources MIB.
3.1.3 Job Monitoring Application Conformance Requirements
A conforming job monitoring application:
1. SHALL accept the full syntactic range for all objects in all
MANDATORY groups and all MANDATORY attributes that are required to
be implemented by an agent according to Section 3.1.2 and SHALL
either present them to the user or ignore them.
2. SHALL accept the full syntactic range for all attributes,
including enum and bit values specified in this specification and
additional ones that may be registered with IANA and SHALL either
present them to the user or ignore them. In particular, a
conforming job monitoring application SHALL not malfunction when
receiving any standard or registered enum or bit values. See
Section 3.6 entitled "IANA Considerations".
3. SHALL NOT fail when operating with agents that materialize
attributes after the job has been submitted, as opposed to when
the job is submitted.
4. SHALL, if it supports a time attribute, accept either form of the
time attribute, since agents are free to implement either time
form.
3.2 The Job Tables and the Oldest Active and Newest Active Indexes
The jmJobTable and jmAttributeTable contain objects and attributes,
respectively, for each job in a job set. These first two indexes are:
1. jmGeneralJobSetIndex - which job set
2. jmJobIndex - which job in the job set
Bergman, Hastings, Isaacson, Lewis [Page 19]
Job Monitoring MIB, V0.85 Aug 8, 1997
In order for a monitoring application to quickly find that active jobs
(jobs in the pending, processing, or processingStopped states), the MIB
contains two indexes:
1. jmGeneralOldestActiveJobIndex - the index of the active job that
has been in the tables the longest.
2. jmGeneralNewestActiveJobIndex - the index of the active job that
has been most recently added to the tables.
The agent SHALL assign the next incremental value of jmJobIndex to the
job, when a new job is accepted by the server or device to which the
agent is providing access. If the incremented value of jmJobIndex would
exceed the implementation-defined maximum value for jmJobIndex, the
agent SHALL 'wrap' back to 1. An agent uses the resulting value of
jmJobIndex for storing information in the jmJobTable and the
jmAttributeTable about the job.
It is recommended that the largest value for jmJobIndex be much larger
than the maximum number of jobs that the implementation can contain at a
single time, so as to minimize the premature re-use of a jmJobIndex
value for a newer job while clients retain the same 'stale' value for an
older job.
It is recommended that agents that are providing access to
servers/devices that already allocate job-identifiers for jobs as
integers use the same integer value for the jmJobIndex. Then the jobs
will have the same job identifier value as the jmJobIndex value, so that
users viewing jobs by management applications using this MIB and
applications using other protocols will see the same job identifiers for
the same jobs. Agents providing access to systems that contain jobs
with a job identifier of 0 SHALL map the job identifier value 0 to a
jmJobIndex value that is one higher than the highest job identifier
value that any job can have on that system. Then only job 0 will have a
different job-identifier value than the job's jmJobIndex value.
NOTE - If a server or device accepts jobs using multiple job submission
protocols, it may be difficult for the agent to meet the recommendation
to use the job-identifier values that the server or device assigns as
the jmJobIndex value, unless the server/device assigns job-identifiers
for each of its job submission protocols from the same job-identifier
number space.
Each time a new job is accepted by the server or device that the agent
is providing access to AND that job is to be 'active' (pending,
processing, or processingStopped, but not pendingHeld), the agent SHALL
copy the value of the job's jmJobIndex to the
jmGeneralNewestActiveJobIndex object. If the new job is to be
Bergman, Hastings, Isaacson, Lewis [Page 20]
Job Monitoring MIB, V0.85 Aug 8, 1997
'inactive' (pendingHeld state), the agent SHALL not change the value of
jmGeneralNewestActiveJobIndex object (though the agent SHALL assign the
next incremental jmJobIndex value to the job).
When a job transitions from one of the 'active' job states (pending,
processing, processingStopped) to one of the 'inactive' job states
(pendingHeld, completed, canceled, or aborted), with a jmJobIndex value
that matches the jmGeneralOldestActiveJobIndex object, the agent SHALL
advance (or wrap) the value to the next oldest 'active' job, if any.
See the JmJobStateTC textual-convention for a definition of the job
states.
Whenever a job transitions from one of the 'inactive' job states to one
of the 'active' job states (from pendingHeld to pending or processing),
the agent SHALL update the value of either the
jmGeneralOldestActiveJobIndex or the jmGeneralNewestActiveJobIndex
objects, or both, if the job's jmJobIndex value is outside the range
between jmGeneralOldestActiveJobIndex and jmGeneralNewestActiveJobIndex.
When all jobs become 'inactive', i.e., enter the pendingHeld, completed,
canceled, or aborted states, the agent SHALL set the value of both the
jmGeneralOldestActiveJobIndex and jmGeneralNewestActiveJobIndex objects
to 0.
NOTE - Applications that wish to efficiently access all of the active
jobs MAY use jmGeneralOldestActiveJobIndex value to start with the
oldest active job and continue until they reach the index value equal to
jmGeneralNewestActiveJobIndex, skipping over any pendingHeld, completed,
canceled, or aborted jobs that might intervene.
If an application detects that the jmGeneralNewestActiveJobIndex is
smaller than jmGeneralOldestActiveJobIndex, the job index has wrapped.
In this case, the application SHALL reset the index to 1 when the end of
the table is reached and continue the GetNext operations to find the
rest of the active jobs.
NOTE - Application detect the end of the jmAttributeTable table when the
OID returned by the GetNext operation is an OID in a different MIB.
There is no object in this MIB that specifies the maximum value for the
jmJobIndex supported by the implementation.
When the server or device is power-cycled, the agent SHALL remember the
next jmJobIndex value to be assigned, so that new jobs are not assigned
the same jmJobIndex as recent jobs before the power cycle.
Bergman, Hastings, Isaacson, Lewis [Page 21]
Job Monitoring MIB, V0.85 Aug 8, 1997
3.3 The Attribute Mechanism
Attributes are similar to information objects, except that attributes
are identified by an enum, instead of an OID, so that attributes may be
registered without requiring a new MIB. Also an implementation that
does not have the functionality represented by the attribute can omit
the attribute entirely, rather than having to return a distinguished
value. The agent is free to materialize an attribute in the
jmAttributeTable as soon as the agent is aware of the value of the
attribute.
The agent materializes job attributes in a four-indexed
jmAttributeTable:
1. jmGeneralJobSetIndex - which job set
2. jmJobIndex - which job in the job set
3. jmAttributeTypeIndex - which attribute
4. jmAttributeInstanceIndex - which attribute instance for those
attributes that can have multiple values per job.
Some attributes represent information about a job, such as a file-name,
a document-name, a submission-time or a completion time. Other
attributes represent resources required, e.g., a medium or a colorant,
etc. to process the job before the job starts processing OR to indicate
the amount of the resource consumed during and after processing, e.g.,
pages completed or impressions completed. If both a required and a
consumed value of a resource is needed, this specification assigns two
separate attribute enums in the textual convention.
NOTE - The table of contents lists all the attributes in order. This
order is the order of enum assignments which is the order that the SNMP
GetNext operation returns attributes. Most attributes apply to all
three configurations covered by this MIB specification (see section 2.1
entitled "System Configurations for the Job Monitoring MIB"). Those
attributes that apply to a particular configuration are indicated as
'Configuration n:' and SHALL NOT be used with other configurations.
3.3.1 Conformance of Attribute Implementation
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. The agent MAY create the
attribute row in the jmAttributeTable when the information is available
or MAY create the row earlier with the designated 'unknown' value
appropriate for that attribute. See next section.
Bergman, Hastings, Isaacson, Lewis [Page 22]
Job Monitoring MIB, V0.85 Aug 8, 1997
If the server or device does not implement or does not provide access to
the information about an attribute, the agent SHOULD NOT create the
corresponding row in the jmAttributeTable.
3.3.2 Useful, 'Unknown', and 'Other' Values for Objects and Attributes
Some attributes have a 'useful' Integer32 value, some have a 'useful'
OCTET STRING value, some MAY have either or both depending on
implementation, and some MUST have both. See the JmAttributeTypeTC
textual convention for the specification of each attribute.
SNMP requires that if an object cannot be implemented because its values
cannot be accessed, then a compliant agent SHALL return an SNMP error in
SNMPv1 or an exception value in SNMPv2. However, this MIB has been
designed so that 'all' objects can and SHALL be implemented by an agent,
so that neither the SNMPv1 error nor the SNMPv2 exception value SHALL be
generated by the agent. This MIB has also been designed so that when an
agent materializes an attribute, the agent SHALL materialize a row
consisting of both the jmAttributeValueAsInteger and
jmAttributeValueAsOctets objects.
In general, values for objects and attributes have been chosen so that a
management application will be able to determine whether a 'useful',
'unknown', or 'other' value is available. When a useful value is not
available for an object that agent SHALL return a zero-length string for
octet strings, the value 'unknown(2)' for enums, a '0' value for an
object that represents an index in another table, and a value '-2' for
counting integers.
Since each attribute is represented by a row consisting of both the
jmAttributeValueAsInteger and jmAttributeValueAsOctets MANDATORY
objects, SNMP requires that the agent SHALL always create an attribute
row with both objects specified. However, for most attributes the agent
SHALL return a "useful" value for one of the objects and SHALL return
the 'other' value for the other object. For integer only attributes,
the agent SHALL always return a zero-length string value for the
jmAttributeValueAsOctets object. For octet string only attributes, the
agent SHALL always return a '-1' value for the jmAttributeValueAsInteger
object.
3.3.3 Data Sub-types and Attribute Naming Conventions
Many attributes are sub-typed to give a more specific data type than
Integer32 or OCTET STRING. The data sub-type of each attribute is
indicated on the first line(s) of the description. Some attributes have
several different data sub-type representations. When an attribute has
both an Integer32 data sub-type and an OCTET STRING data sub-type, the
attribute can be represented in a single row in the jmAttributeTable.
Bergman, Hastings, Isaacson, Lewis [Page 23]
Job Monitoring MIB, V0.85 Aug 8, 1997
In this case, the data sub-type name is not included as the last part of
the name of the attribute, e.g., documentFormat(38) which is both an
enum and/or a name. When the data sub-types cannot be represented by a
single row in the jmAttributeTable, each such representation is
considered a separate attribute and is assigned a separate name and enum
value. For these attributes, the name of the data sub-type is the last
part of the name of the attribute: Name, Index, DateAndTime, TimeStamp,
etc. For example, documentFormatIndex(37) is an index.
NOTE: The Table of Contents also lists the data sub-type and/or data
sub-types of each attribute, using the textual-convention name when such
is defined. The following abbreviations are used in the Table of
Contents as shown:
'Int32(-2..)' Integer32(-2..2147483647)
'Int32(0..)' Integer32(0..2147483647)
'Int32(1..)' Integer32(1..2147483647)
'Int32(m..n)' For all other Integer ranges, the lower
and upper bound of the range is
indicated.
'UTF8String63' JmUTF8StringTC(SIZE(0..63))
'JobString63' JmJobStringTC(SIZE(0..63))
'Octets63' OCTET STRING(SIZE(0..63))
'Octets(m..n)' For all other OCTET STRING ranges, the
exact range is indicated.
3.3.4 Single-Value (Row) Versus Multi-Value (MULTI-ROW) Attributes
Most attributes SHALL have only one row per job. However, a few
attributes can have multiple values per job or even per document, where
each value is a separate row in the jmAttributeTable. Unless indicated
with 'MULTI-ROW:' in the JmAttributeTypeTC description, an agent SHALL
ensure that each attribute occurs only once in the jmAttributeTable for
a job. Most of the 'MULTI-ROW' attributes do not allow duplicate
values, i.e., the agent SHALL ensure that each value occurs only once
for a job. Only if the specification of the 'MULTI-ROW' attribute also
says "the values NEED NOT be unique" can the agent allow duplicate
values to occur for the job.
NOTE - Duplicates are allowed for 'extensive' 'MULTI-ROW' attributes,
such as fileName(34) or documentName(35) which are specified to be 'per-
document' attributes, but are not allowed for 'intensive' 'MULTI-ROW'
attributes, such as mediumConsumed(171) and documentFormat(38) which are
specified to be 'per-job' attributes.
3.3.5 Requested Attributes
A number of attributes record requirements for the job. Such attribute
names end with the word 'Requested'. In the interests of brevity, the
Bergman, Hastings, Isaacson, Lewis [Page 24]
Job Monitoring MIB, V0.85 Aug 8, 1997
phrase 'requested' SHALL mean: (1) requested by the client (or
intervening server) in the job submission protocol and MAY also mean (2)
embedded in the submitted document data, and/or (3) defaulted by the
recipient device or server with the same semantics as if the requester
had supplied, depending on implementation.
3.3.6 Consumption Attributes
A number of attributes record consumption. Such attribute names end
with the word 'Completed' or 'Consumed'. If the job has not yet
consumed what that resource is metering, the agent either: (1) SHALL
return the value 0 or (2) SHALL not add this attribute to the
jmAttributeTable until the consumption begins. In the interests of
brevity, the semantics for 0 is specified once here and is not repeated
for each consumptive attribute specification.
3.3.7 Index Value Attributes
A number of attributes are indexes in other tables. Such attribute
names end with the word 'Index'. If the agent has not (yet) assigned an
index value for a particular index attribute for a job, the agent SHALL
either: (1) return the value 0 or (2) not add this attribute to the
jmAttributeTable until the index value is assigned. In the interests of
brevity, the semantics for 0 is specified once here and is not repeated
for each index attribute specification.
3.4 Job Identification
There are a number of attributes that permit a user, operator or system
administrator to identify jobs of interest, such as jobName,
jobOriginatingHost, etc. In addition, there is a jmJobSubmissionID
object that is a text string table index. Being a table index allows a
monitoring application to quickly locate and identify a particular job
of interest that was submitted from a particular client by the user
invoking the monitoring application. The Job Monitoring MIB needs to
provide for identification of the job at both sides of the job
submission process. The primary identification point is the client
side. The jmJobSubmissionID allows the monitoring application to
identify the job of interest from all the jobs currently "known" by the
server or device. The value of jmJobSubmissionID can be assigned by
either the client's local system or a downstream server or device. The
point of assignment depends on the job submission protocol in use.
The server/device-side identifier, called the jmJobIndex object, SHALL
be assigned by the SNMP Job Monitoring MIB agent when the server or
device accepts the jobs from submitting clients. The jmJobIndex object
allows the interested party to obtain all objects desired that relate to
a particular job. See Section 3.2, entitled 'The Job Tables and the
Bergman, Hastings, Isaacson, Lewis [Page 25]
Job Monitoring MIB, V0.85 Aug 8, 1997
Oldest Active and Newest Active Indexes' for the specification of how
the agent shall assign the jmJobIndex values.
NOTE - For a number of job submission protocols the server/device
assigns an integer job identifier when accepting a job so that the
submitting client can reference the job in subsequent protocol
operations (For example, see IPP [ipp]). For such implementations, it
is recommended that the value of the job identifier and the value of
jmJobIndex be the same, so that
The MIB provides a mapping table that maps each jmJobSubmissionID value
to the corresponding jmJobIndex value generated by the agent, so that an
application can determine the correct value for the jmJobIndex value for
the job of interest in a single Get operation, given the Job Submission
ID. See the jmJobIDGroup.
The jobName attribute provides a name that the user supplies as a job
attribute with the job. The jobName attribute is not necessarily
unique, even for one user, let alone across users.
3.5 Internationalization Considerations
This section describes the internationalization considerations included
in this MIB.
3.5.1 'JmUTF8StringTC' for text generated by the server or device
There are a few objects and attributes that are represented using the
Universal Multiple-Octet Coded Character Set (UCS) [ISO-10646] encoded
as an octet string using the UTF-8 [UTF-8] character encoding scheme.
The 'JmUTF8StringTC' textual convention is used to indicate UTF-8 text
strings. These objects and attributes are always supplied (if
implemented) by the agent, not by the job submitting client:
1. jmGeneralJobSetName object
2. processingMessage(6) attribute
3. physicalDevice(32) (name value) attribute
The coded character set for representing these objects and attributes
SHALL be UTF-8 as recommended by RFC 2130 [RFC 2130] and the "IETF
Policy on Character Sets and Language" [char-set policy].
NOTE - For strings in 7-bit US-ASCII, there is no impact since the UTF-8
representation is identical to the US-ASCII [US-ASCII] encoding.
3.5.2 'JmJobStringTC' for text generated by the job submitter
All of the objects and attributes represented by the 'JmJobStringTC'
textual-convention are either (1) supplied in the job submission
Bergman, Hastings, Isaacson, Lewis [Page 26]
Job Monitoring MIB, V0.85 Aug 8, 1997
protocol by the client that submits the job to the server or device or
(2) are defaulted by the server or device if the job submitting client
does not supply values. The agent SHALL represent these objects and
attributes in the MIB either (1) in the coded character set as they were
submitted or (2) MAY convert the coded character set to another coded
character set or encoding scheme. In any case, the resulting coded
character set representation SHOULD be UTF-8 [UTF-8], but SHALL be one
in which the code positions from 0 to 31 SHALL not be used, 32 to 127
SHALL be US-ASCII [US-ASCII], 127 SHALL be unused, and the remaining
code positions 128 to 255 SHALL represent single-byte or multi-byte
graphic characters structured according to ISO 2022 [ISO 2022] or SHALL
be unused.
The coded character set SHALL be one of the ones registered with IANA
[IANA] and SHALL be identified by the jobCodedCharSet attribute in the
jmJobAttributeTable for the job. If the agent does not know what coded
character set was used by the job submitting client, the agent SHALL
return the 'unknown(2)' value for the jobCodedCharSet attribute for the
job.
Examples of coded character sets which meet this criteria for use as the
value of the jobCodedCharSet job attribute are: US-ASCII [US-ASCII], ISO
8859-1 (Latin-1) [ISO 8859-1], any ISO 8859-n, HP Roman8, IBM Code Page
850, Windows Default 8-bit set, UTF-8 [UTF-8], US-ASCII plus JIS X0208-
1990 Japanese [JIS X0208], US-ASCII plus GB2312-1980 PRC Chinese
[GB2312]. See the IANA registry of coded character sets [IANA
charsets].
Examples of coded character sets which do not meet this criteria are:
national 7-bit sets conforming to ISO 646 (except US-ASCII), EBCDIC, and
ISO 10646 (Unicode) [ISO-10646]. In order to represent Unicode
characters, the UTF-8 [UTF-8] encoding scheme SHALL be used which has
been assigned the MIBenum value of '106' by IANA.
The jobCodedCharSet attribute uses the imported 'CodedCharSet' textual-
convention from the Printer MIB [printmib].
3.5.3 'DateAndTime' for representing the date and time
This MIB also contains objects that are represented using the
DateAndTime textual convention from SMIv2 [SMIv2-TC]. The job
management application SHALL display such objects in the locale of the
user running the monitoring application.
3.6 IANA Considerations
During the development of this standard, the Printer Working Group (PWG)
working with IANA [iana] will register additional enums while the
Bergman, Hastings, Isaacson, Lewis [Page 27]
Job Monitoring MIB, V0.85 Aug 8, 1997
standard is in the proposed and draft states according to the procedures
described in this section. IANA will handle registration of additional
enums after this standard is approved in cooperation with an IANA-
appointed registration editor from the PWG according to the procedures
described in this section:
3.6.1 IANA Registration of enums
This specification uses textual conventions to define enumerated values
(enums) and bit values. Enumerations (enums) and bit values are sets of
symbolic values defined for use with one or more objects or attributes.
All enumeration sets and bit value sets are assigned a symbolic data
type name (textual convention). As a convention the symbolic name ends
in "TC" for textual convention. These enumerations are defined at the
beginning of the MIB module specification.
This working group has defined several type of enumerations for use in
the Job Monitoring MIB and the Printer MIB[print-mib]. These types
differ in the method employed to control the addition of new
enumerations. Throughout this document, references to "type n enum",
where n can be 1, 2 or 3 can be found in the various tables. The
definitions of these types of enumerations are:
3.6.1.1 Type 1 enumerations
Type 1 enumeration: All the values are defined in the Job Monitoring
MIB specification (RFC for the Job Monitoring MIB). Additional
enumerated values require a new RFC.
There are no type 1 enums in the current draft.
3.6.1.2 Type 2 enumerations
Type 2 enumeration: An initial set of values are defined in the Job
Monitoring MIB specification. Additional enumerated values are
registered after review by this working group or an editor appointed by
IANA after this working group is no longer active.
The following type 2 enums are contained in the current draft :
1. JmUTF8StringTC
2. JmJobStringTC
3. JmTimeStampTC
4. JmFinishingTC [same enum values as IPP "finishing" attribute]
5. JmPrintQualityTC [same enum values as IPP "print-quality"
attribute]
6. JmTonerEconomyTC
7. JmMediumTypeTC
8. JmJobSubmissionTypeTC
Bergman, Hastings, Isaacson, Lewis [Page 28]
Job Monitoring MIB, V0.85 Aug 8, 1997
9. JmJobStateTC [same enum values as IPP "job-state" attribute]
10.JmAttributeTypeTC
For those textual conventions that have the same enum values as the
indicated IPP Job attribute SHALL be simultaneously registered by IANA
for use with IPP [ipp-model] and the Job Monitoring MIB.
3.6.1.3 Type 3 enumeration
Type 3 enumeration: An initial set of values are defined in the Job
Monitoring MIB specification. Additional enumerated values are
registered through IANA without working group review.
There are no type 3 enums in the current draft.
3.6.2 IANA Registration of type 2 bit values
This draft contains the following type 2 bit value textual-conventions:
1. JmJobServiceTypesTC
2. JmJobStateReasons1TC
3. JmJobStateReasons2TC
4. JmJobStateReasons3TC
5. JmJobStateReasons4TC
These textual-conventions are defined as bits in an Integer so that they
can be used with SNMPv1 SMI. The jobStateReasonsN (N=1..4) attributes
are defined as bit values using the corresponding JmJobStateReasonsNTC
textual-conventions.
The registration of JmJobServiceTypesTC and JmJobStateReasonsNTC bit
values SHALL follow the procedures for a type 2 enum as specified in
Section 3.6.1.2.
3.6.3 IANA Registration of Job Submission Id Formats
In addition to enums and bit values, this specification assigns a single
ASCII digit or letter to various job submission ID formats. See the
JmJobSubmissionIDTypeTC textual-convention and the object. The
registration of jmJobSubmissionID format numbers SHALL follow the
procedures for a type 2 enum as specified in Section 3.6.1.2.
3.6.4 IANA Registration of MIME types/sub-types for document-formats
The documentFormat(38) attribute has MIME type/sub-type values for
indicating document formats which IANA registers as "media type" names.
The values of the documentFormat(38) attribute are the same as the
corresponding Internet Printing Protocol (IPP) "document-format" Job
attribute values [ipp-model].
Bergman, Hastings, Isaacson, Lewis [Page 29]
Job Monitoring MIB, V0.85 Aug 8, 1997
3.7 Security Considerations
3.7.1 Read-Write objects
All objects are read-only, greatly simplifying the security
considerations. If another MIB augments this MIB, that MIB might accept
SNMP Write operations to objects in that MIB whose effect is to modify
the values of read-only objects in this MIB. However, that MIB SHALL
have to support the required access control in order to achieve
security, not this MIB.
3.7.2 Read-Only Objects In Other User's Jobs
The security policy of some sites MAY be that unprivileged users can
only get the objects from jobs that they submitted, plus a few minimal
objects from other jobs, such as the jmJobKOctetsRequested and
jmJobKOctetsProcessed objects, so that a user can tell how busy a
printer is. Other sites MAY allow all unprivileged users to see all
objects of all jobs. This MIB does not require, nor does it specify
how, such restrictions would be implemented. A monitoring application
SHOULD enforce the site security policy with respect to returning
information to an unprivileged end user that is using the monitoring
application to monitor jobs that do not belong to that user, i.e., the
jmJobOwner object in the jmJobTable does not match the user's user name.
An operator is a privileged user that would be able to see all objects
of all jobs, independent of the policy for unprivileged users.
3.8 Notifications
This MIB does not specify any notifications. For simplicity, management
applications are expected to poll for status. The
jmGeneralJobPersistence and jmGeneralAttributePersistence objects assist
an application to determine the polling rate. The resulting network
traffic is not expected to be significant.
4. MIB specification
The following pages constitute the actual Job Monitoring MIB.
Bergman, Hastings, Isaacson, Lewis [Page 30]
Job Monitoring MIB, V0.85 Aug 8, 1997
Job-Monitoring-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, experimental,
Integer32 FROM SNMPv2-SMI
TEXTUAL-CONVENTION FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF;
-- The following textual-conventions are needed
-- to implement certain attributes, but are not
-- needed to compile this MIB. They are
-- provided here for convenience:
-- hrDeviceIndex FROM HOST-RESOURCES-MIB
-- DateAndTime FROM SNMPv2-TC
-- PrtInterpreterLangFamilyTC,
-- CodedCharSet FROM Printer-MIB
-- Use the experimental (54) OID assigned to the Printer MIB[print-mib]
-- before it was published as RFC 1759.
-- Upon publication of the Job Monitoring MIB as an RFC, delete this
-- comment and the line following this comment and change the
-- reference of { temp 105 } (below) to { mib-2 X }.
-- This will result in changing:
-- 1 3 6 1 3 54 jobmonMIB(105) to:
-- 1 3 6 1 2 1 jobmonMIB(X)
-- This will make it easier to translate prototypes to
-- the standard namespace because the lengths of the OIDs won't
-- change.
temp OBJECT IDENTIFIER ::= { experimental 54 }
jobmonMIB MODULE-IDENTITY
LAST-UPDATED "9708080000Z"
ORGANIZATION "IETF Printer MIB Working Group"
CONTACT-INFO
"Tom Hastings
Postal: Xerox Corp.
Mail stop ESAE-231
701 S. Aviation Blvd.
El Segundo, CA 90245
Tel: (301)333-6413
Fax: (301)333-5514
E-mail: hastings@cp10.es.xerox.com
Send comments to the printmib WG using the Job Monitoring
Project (JMP) Mailing List: jmp@pwg.org
To learn how to subscribe to the JMP mailing list,
send email to: jmp-request@pwg.org
Bergman, Hastings, Isaacson, Lewis [Page 31]
Job Monitoring MIB, V0.85 Aug 8, 1997
For further information, access the PWG web page under 'JMP':
http://www.pwg.org/"
DESCRIPTION
"The MIB module for monitoring job in servers, printers, and
other devices.
File: draft-ietf-printmib-job-monitor-05.txt
Version: 0.85"
::= { temp 105 }
-- Textual conventions for this MIB module
JmUTF8StringTC ::= TEXTUAL-CONVENTION
DISPLAY-HINT "255a"
STATUS current
DESCRIPTION
"To facilitate internationalization, this TC represents
information taken from the ISO/IEC IS 10646-1 character set,
encoded as an octet string using the UTF-8 character encoding
scheme.
NOTE - The values of objects and attributes using this textual
convention are generated by the server or the device, not by the
job submitter."
REFERENCE
"See section 3.5.1, ''JmUTF8StringTC' for text generated by the
server or device'."
SYNTAX OCTET STRING (SIZE (0..63))
JmJobStringTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"To facilitate internationalization, this TC represents
information using any coded character set registered by IANA
that has the following properties: (1) code positions from 0 to
31 SHALL not be used, (2) 32 to 127 SHALL be US-ASCII [US-
ASCII], (3) 127 SHALL be unused, and (4) the remaining code
Bergman, Hastings, Isaacson, Lewis [Page 32]
Job Monitoring MIB, V0.85 Aug 8, 1997
positions 128 to 255 SHALL represent single-byte or multi-byte
graphic characters structured according to ISO 2022 [ISO 2022]
or SHALL be unused. While it is recommended that the coded
character set be UTF-8 [UTF-8], the actual coded character set
SHALL be indicated by the value of the jobCodedCharSet(7)
attribute for the job.
NOTE - The values of objects and attributes using this textual
convention are either generated by the job submitter or
defaulted by the server or device when the job submitter does
not supply values."
REFERENCE
"See section 3.5.2, ''JmJobStringTC' for text generated by the
job submitter'."
SYNTAX OCTET STRING (SIZE (0..63))
JmTimeStampTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The simple time at which an event took place. The units SHALL
be in seconds since the system was booted.
NOTE - JmTimeStampTC is defined in units of seconds, rather than
100ths of seconds, so as to be simpler for agents to implement
(even if they have to implement the 100ths of a second to comply
with implementing sysUpTime in MIB-II[mib-II].)
NOTE - JmTimeStampTC is defined as an Integer32 so that it can
be used as a value of an attribute, i.e., as a value of the
jmAttributeValueAsInteger object. The TimeStamp textual-
convention defined in SMNPv2-TC is defined as an APPLICATION 3
IMPLICIT INTEGER tag, not an Integer32, so cannot be used in
this MIB as one of the values of jmAttributeValueAsInteger."
SYNTAX INTEGER(0..2147483647)
JmJobSourcePlatformTypeTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The source platform type that can submit jobs to servers or
devices in any of the 3 configurations."
Bergman, Hastings, Isaacson, Lewis [Page 33]
Job Monitoring MIB, V0.85 Aug 8, 1997
REFERENCE
"This is a type 2 enumeration. See Section 3.6.1.2."
SYNTAX INTEGER {
other(1),
unknown(2),
sptUNIX(3), -- UNIX(tm)
sptOS2(4), -- OS/2
sptPCDOS(5), -- DOS
sptNT(6), -- NT
sptMVS(7), -- MVS
sptVM(8), -- VM
sptOS400(9), -- OS/400
sptVMS(10), -- VMS
sptWindows95(11), -- Windows95
sptNetWare(33) -- NetWare
}
JmFinishingTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The type of finishing operation.
These values are the same as the enum values of the IPP
'finishings' attribute. See Section 3.6.1.2.
other(1),
Some other finishing operation besides one of the specified
or registered values.
unknown(2),
The finishing is unknown.
none(3),
Perform no finishing.
staple(4),
Bind the document(s) with one or more staples. The exact
number and placement of the staples is site-defined.
stapleTopLeft(5),
Place one or more staples on the top left corner of the
document(s).
Bergman, Hastings, Isaacson, Lewis [Page 34]
Job Monitoring MIB, V0.85 Aug 8, 1997
stapleBottomLeft(6),
Place one or more staples on the bottom left corner of the
document(s).
stapleTopRight(7),
Place one or more staples on the top right corner of the
document(s).
stapleBottomRight(8),
Place one or more staples on the bottom right corner of the
document(s).
saddleStitch(9),
Bind the document(s) with one or more staples (wire
stitches) along the middle fold. The exact number and
placement of the stitches is site-defined.
edgeStitch(10),
Bind the document(s) with one or more staples (wire
stitches) along one edge. The exact number and placement of
the staples is site-defined.
punch(11),
This value indicates that holes are required in the finished
document. The exact number and placement of the holes is
site-defined The punch specification MAY be satisfied (in a
site- and implementation-specific manner) either by
drilling/punching, or by substituting pre-drilled media.
cover(12),
This value is specified when it is desired to select a non-
printed (or pre-printed) cover for the document. This does
not supplant the specification of a printed cover (on cover
stock medium) by the document itself.
bind(13)
This value indicates that a binding is to be applied to the
document; the type and placement of the binding is product-
specific."
REFERENCE
"This is a type 2 enumeration. See Section 3.6.1.2."
SYNTAX INTEGER {
other(1),
unknown(2),
none(3),
staple(4),
stapleTopLeft(5),
stapleBottomLeft(6),
Bergman, Hastings, Isaacson, Lewis [Page 35]
Job Monitoring MIB, V0.85 Aug 8, 1997
stapleTopRight(7),
stapleBottomRight(8),
saddleStitch(9),
edgeStitch(10),
punch(11),
cover(12),
bind(13)
}
JmPrintQualityTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Print quality settings.
These values are the same as the enum values of the IPP 'print-
quality' attribute. See Section 3.6.1.2."
REFERENCE
"This is a type 2 enumeration. See Section 3.6.1.2."
SYNTAX INTEGER {
other(1), -- Not one of the specified or registered
-- values.
unknown(2), -- The actual value is unknown.
draft(3), -- Lowest quality available on the printer.
normal(4), -- Normal or intermediate quality on the
-- printer.
high(5) -- Highest quality available on the printer.
}
JmPrinterResolutionTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Printer resolutions.
Nine octets consisting of two 4-octet SIGNED-INTEGERs followed
by a SIGNED-BYTE. The values are the same as those specified in
the Printer MIB [printmib]. The first SIGNED-INTEGER contains
the value of prtMarkerAddressabilityXFeedDir. The second
SIGNED-INTEGER contains the value of
Bergman, Hastings, Isaacson, Lewis [Page 36]
Job Monitoring MIB, V0.85 Aug 8, 1997
prtMarkerAddressabilityFeedDir. The SIGNED-BYTE contains the
value of prtMarkerAddressabilityUnit.
Note: the latter value is either 3 (tenThousandsOfInches) or 4
(micrometers) and the addressability is in 10,000 units of
measure. Thus the SIGNED-INTEGERs represent integral values in
either dots-per-inch or dots-per-centimeter.
The syntax is the same as the IPP 'printer-resolution'
attribute. See Section 3.6.1.2."
SYNTAX OCTET STRING (SIZE(9))
JmTonerEconomyTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Toner economy settings."
REFERENCE
"This is a type 2 enumeration. See Section 3.6.1.2."
SYNTAX INTEGER {
unknown(2), -- unknown.
off(3), -- Off. Normal. Use full toner.
on(4) -- On. Use less toner than normal.
}
JmBooleanTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Boolean true or false value."
REFERENCE
"This is a type 2 enumeration. See Section 3.6.1.2."
SYNTAX INTEGER {
unknown(2), -- unknown.
false(3), -- FALSE.
true(4) -- TRUE.
}
Bergman, Hastings, Isaacson, Lewis [Page 37]
Job Monitoring MIB, V0.85 Aug 8, 1997
JmMediumTypeTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Identifies the type of medium.
other(1),
The type is neither one of the values listed in this
specification nor a registered value.
unknown(2),
The type is not known.
stationery(3),
Separately cut sheets of an opaque material.
transparency(4),
Separately cut sheets of a transparent material.
envelope(5),
Envelopes that can be used for conventional mailing
purposes.
envelopePlain(6),
Envelopes that are not preprinted and have no windows.
envelopeWindow(7),
Envelopes that have windows for addressing purposes.
continuousLong(8),
Continuously connected sheets of an opaque material
connected along the long edge.
continuousShort(9),
Continuously connected sheets of an opaque material
connected along the short edge.
tabStock(10),
Media with tabs.
multiPartForm(11),
Form medium composed of multiple layers not pre-attached to
one another; each sheet MAY be drawn separately from an
input source.
Bergman, Hastings, Isaacson, Lewis [Page 38]
Job Monitoring MIB, V0.85 Aug 8, 1997
labels(12),
Label-stock.
multiLayer(13)
Form medium composed of multiple layers which are pre-
attached to one another, e.g. for use with impact printers."
REFERENCE
"This is a type 2 enumeration. See Section 3.6.1.2."
SYNTAX INTEGER {
other(1),
unknown(2),
stationery(3),
transparency(4),
envelope(5),
envelopePlain(6),
envelopeWindow(7),
continuousLong(8),
continuousShort(9),
tabStock(10),
multiPartForm(11),
labels(12),
multiLayer(13)
}
JmJobSubmissionTypeTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Identifies the format type of a job submission ID.
The ASCII characters '0-9', 'A-Z', and 'a-z' are assigned in
order giving 62 possible formats.
Each job submission ID is a fixed-length, 48-octet printable
ASCII coded character string, consisting of the following
fields:
octet 1 The format letter.
octets 2-40 A 39-character, ASCII trailing SPACE filled
field specified by the format letter, if the
data is less than 39 ASCII characters.
octets 41-48 A sequential or random number to make the ID
quasi-unique.
Bergman, Hastings, Isaacson, Lewis [Page 39]
Job Monitoring MIB, V0.85 Aug 8, 1997
If the client does not supply a job submission ID in the job
submission protocol, then the server SHALL assign a job
submission ID using any of the standard formats that are
reserved to the agent. Clients SHALL not use formats that are
reserved to agents.
The format values defined at the time of completion of the
specification are:
Format
Letter Description
------ ------------
'0' octets 2-40: last 39 bytes of the jmJobOwner
object.
octets 41-48: 8-decimal-digit sequential number
This format is reserved to agents for use when
the client does not supply a job submission ID.
Clients wishing to use a job submission ID that
incorporates the job owner, SHALL use format '8',
not format '0', in order to reduce the chances of
one client assigning the same ID as the agent when
receiving a job from another client that does not
supply a job submission id.
NOTE - other formats may be registered that are
reserved to the agent for use when the client does
not supply a job submission ID.
'1' octets 2-40: last 39 bytes of the jobName attribute.
octets 41-48: 8-decimal-digit random number
'2' octets 2-40: Client MAC address: in hexadecimal
with each nibble of the 6 octet address being
'0'-'9' or 'A' - 'F' (uppercase only).
Most significant octet first.
octets 41-48: 8-decimal-digit sequential number
'3' octets 2-40: last 39 bytes of the client URL
[URI-spec].
octets 41-48: 8-decimal-digit sequential number
'4' octets 2-40: last 39 bytes of the URI [URI-spec]
assigned by the server or device to the job when
the job was submitted for processing.
octets 41-48: 8-decimal-digit sequential number
'5' octets 2-40: last 39 bytes of a user number, such
as POSIX user number.
Bergman, Hastings, Isaacson, Lewis [Page 40]
Job Monitoring MIB, V0.85 Aug 8, 1997
octets 41-48: 8-decimal-digit sequential number
'6' octets 2-40: last 39 bytes of the user account
number.
octets 41-48: 8-decimal-digit sequential number
'7' octets 2-40: last 39 bytes of the DTMF incoming
FAX routing number.
octets 41-48: 8-decimal-digit sequential number
'8' octets 2-40: last 39 bytes of the job owner name
(that the agent returns in the jmJobOwner object).
octets 41-48: 8-decimal-digit sequential number
NOTE - the job submission id is only intended to be unique
between a limited set of clients for a limited duration of time,
namely, for the life time of the job in the context of the
server or device that is processing the job. Some of the
formats include something that is unique per client and a random
number so that the same job submitted by the same client will
have a different job submission id. For other formats, where
part of the id is guaranteed to be unique for each client, such
as the MAC address or URL, a sequential number SHOULD suffice
for each client (and may be easier for each client to manage).
Therefore, the length of the job submission id has been selected
to reduce the probability of collision to an extremely low
number, but is not intended to be an absolute guarantee of
uniqueness. None-the-less, collisions are remotely possible,
but without bad consequences, since this MIB is intended to be
used only for monitoring jobs, not for controlling and managing
them."
REFERENCE
"This is like a type 2 enumeration. See section 3.6.3."
SYNTAX OCTET STRING(SIZE(1)) -- ASCII '0'-'9', 'A'-'Z', 'a'-'z'
JmJobStateTC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The current state of the job (pending, processing, completed,
etc.).
The following figure shows the normal job state transitions:
Bergman, Hastings, Isaacson, Lewis [Page 41]
Job Monitoring MIB, V0.85 Aug 8, 1997
+----> canceled(7)
/
+---> pending(3) --------> processing(5) ------+------> completed(9)
| ^ ^ \
--->+ | | +----> aborted(8)
| v v /
+---> pendingHeld(4) processingStopped(6) ---+
Figure 4 - Normal Job State Transitions
Normally a job progresses from left to right. Other state
transitions are unlikely, but are not forbidden. Not shown are
the transitions to the canceled state from the pending,
pendingHeld, processing, and processingStopped states.
Jobs in the pending, processing, and processingStopped states
are called 'active', while jobs in the pendingHeld, canceled,
aborted, and completed are called 'inactive'.
These values are the same as the enum values of the IPP 'job-
state' job attribute. See Section 3.6.1.2.
unknown(2),
The job state is not known, or its state is indeterminate.
pending(3),
The job is a candidate to start processing, but is not yet
processing.
pendingHeld(4),
The job is not a candidate for processing for any number of
reasons but will return to the pending state as soon as the
reasons are no longer present. The job's jmJobStateReasons1
object and/or jobStateReasonsN (N=2..4) attributes SHALL
indicate why the job is no longer a candidate for
processing. The reasons are represented as bits in the
jmJobStateReasons1 object and/or jobStateReasonsN (N=2..4)
attributes. See the JmJobStateReasonsNTC (N=1..4) textual
convention for the specification of each reason.
processing(5),
Either:
1. The job is using, or is attempting to use, one or more
document transforms which include (1) purely software
Bergman, Hastings, Isaacson, Lewis [Page 42]
Job Monitoring MIB, V0.85 Aug 8, 1997
processes that are interpreting a PDL, and (2) hardware
devices that are interpreting a PDL, making marks on a
medium, and/or performing finishing, such as stapling, etc.
OR
2. (configuration 2) the server has made the job ready for
printing, but the output device is not yet printing it,
either because the job hasn't reached the output device or
because the job is queued in the output device or some other
spooler, awaiting the output device to print it.
When the job is in the processing state, the entire job
state includes the detailed status represented in the device
MIB indicated by the hrDeviceIndex value of the job's
physicalDevice attribute, if the agent implements such a
device MIB.
Implementations MAY, though they NEED NOT, include
additional values in the job's jmJobStateReasons1 object to
indicate the progress of the job, such as adding the
jobPrinting value to indicate when the device is actually
making marks on a medium.
processingStopped(6),
The job has stopped while processing for any number of
reasons and will return to the processing state as soon as
the reasons are no longer present.
The job's jmJobStateReasons1 object and/or the job's
jobStateReasonsN (N=2..4) attributes MAY indicate why the
job has stopped processing. For example, if the output
device is stopped, the deviceStopped value MAY be included
in the job's jmJobStateReasons1 object.
NOTE - When an output device is stopped, the device usually
indicates its condition in human readable form at the
device. The management application can obtain more complete
device status remotely by querying the appropriate device
MIB using the job's deviceIndex attribute(s), if the agent
implements such a device MIB
canceled(7),
A client has canceled the job and the job is either: (1) in
the process of being terminated by the server or device or
(2) has completed terminating. The job's jmJobStateReasons1
object SHOULD contain either the canceledByUser or
canceledByOperator value.
Bergman, Hastings, Isaacson, Lewis [Page 43]
Job Monitoring MIB, V0.85 Aug 8, 1997
aborted(8),
The job has been aborted by the system, usually while the
job was in the processing or processingStopped 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). The
job's jmJobStateReasons1 object SHOULD contain one of:
completedSuccessfully, completedWithWarnings, or
completedWithErrors values."
REFERENCE
"This is a type 2 enumeration. See Section 3.6.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.
In the following definitions of the enums, each description
indicates whether the useful value of the attribute SHALL be
represented using the jmAttributeValueAsInteger or the
jmAttributeValueAsOctets objects by the initial tag: 'INTEGER:'
or 'OCTETS:', respectively.
Some attributes allow the agent implementer a choice of useful
values of either an integer, an octets representation, or both,
depending on implementation. These attributes are indicated
with 'INTEGER:' AND/OR 'OCTETS:' tags.
A very few attributes require both objects at the same time to
represent a pair of useful values (see mediumConsumed(171)).
These attributes are indicated with 'INTEGER:' AND 'OCTETS:'
tags. See the jmAttributeGroup for the descriptions of these
two MANDATORY objects.
Bergman, Hastings, Isaacson, Lewis [Page 44]
Job Monitoring MIB, V0.85 Aug 8, 1997
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.
NOTE: No attribute name exceeds 31 characters.
The standard attribute types defined at the time of completion
of the specification are:
jmAttributeTypeIndex Datatype
-------------------- --------
other(1), Integer32(-2..2147483647)
AND/OR
OCTET STRING(SIZE(0..63))
INTEGER: and/or OCTETS: An attribute that is not in the
list and/or that has not been approved and registered with
IANA.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Job State attributes
+
+ The following attributes specify the state of a job.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
jobStateReasons2(3), JmJobStateReasons2TC
INTEGER: Additional information about the job's current
state that augments the jmJobState object. See the
description under the JmJobStateReasons1TC textual-
convention.
jobStateReasons3(4), JmJobStateReasons3TC
INTEGER: Additional information about the job's current
state that augments the jmJobState object. See the
description under JmJobStateReasons1TC textual-convention.
jobStateReasons4(5), JmJobStateReasons4TC
INTEGER: Additional information about the job's current
state that augments the jmJobState object. See the
description under JmJobStateReasons1TC textual-convention.
processingMessage(6), JmUTF8StringTC(SIZE(0..63))
OCTETS: MULTI-ROW: A coded character set message that is
generated by the server or device during the processing of
Bergman, Hastings, Isaacson, Lewis [Page 45]
Job Monitoring MIB, V0.85 Aug 8, 1997
the job as a simple form of processing log to show progress
and any problems.
There is no restriction for the same message occurring in
multiple rows.
jobCodedCharSet(7), CodedCharSet
INTEGER: The MIBenum identifier of the coded character set
that the agent is using to represent coded character set
objects and attributes of type 'JmJobStringTC'. These coded
character set objects and attributes are either: (1)
supplied by the job submitting client or (2) defaulted by
the server or device when omitted by the job submitting
client. The agent SHALL represent these objects and
attributes in the MIB either (1) in the coded character set
as they were submitted or (2) MAY convert the coded
character set to another coded character set or encoding
scheme as identified by the jobCodedCharSet attribute.
These MIBenum values are assigned by IANA [IANA-charsets]
when the coded character sets are registered. The coded
character set SHALL be one of the ones registered with IANA
[IANA] and the enum value uses the CodedCharSet textual-
convention from the Printer MIB. See the JmJobStringTC
textual-convention.
If the agent does not know what coded character set was used
by the job submitting client, the agent SHALL return the
'unknown(2)' value for the jobCodedCharSet attribute for the
job. See Section 3.5.2, entitled ''JmJobStringTC' for text
generated by the job submitter'.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Job Identification attributes
+
+ The following attributes help an end user, a system
+ operator, or an accounting program identify a job.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
jobAccountName(21), JmJobStringTC(SIZE(0..63))
OCTETS: Arbitrary binary information which MAY be coded
character set data or encrypted data supplied by the
submitting user for use by accounting services to allocate
Bergman, Hastings, Isaacson, Lewis [Page 46]
Job Monitoring MIB, V0.85 Aug 8, 1997
or categorize charges for services provided, such as a
customer account name or number.
NOTE: This attribute NEED NOT be printable characters.
serverAssignedJobName(22), JmJobStringTC(SIZE(0..63))
OCTETS: Configuration 3 only: The human readable string
name, number, or ID of the job as assigned by the server
that submitted the job to the device that the agent is
providing access to with this MIB.
NOTE - This attribute is intended for enabling a user to
find his/her job that a server submitted to a device when
either the client does not support the jmJobSubmissionID or
the server does not pass the jmJobSubmissionID through to
the device.
jobName(23), JmJobStringTC(SIZE(0..63))
OCTETS: The human readable string name of the job as
assigned by the submitting user to help the user distinguish
between his/her various jobs. This name does not need to be
unique.
This attribute is intended for enabling a user or the user's
application to convey a job name that MAY be printed on a
start sheet, returned in a query result, or used in
notification or logging messages.
In order to assist users to find their jobs for job
submission protocols that don't supply a jmJobSubmissionID,
the agent SHOULD maintain the jobName attribute for the time
specified by the jmGeneralJobPersistence object, rather than
the (shorter) jmGeneralAttributePersistence object.
If this attribute is not specified when the job is
submitted, no job name is assumed, but implementation
specific defaults are allowed, such as the value of the
documentName attribute of the first document in the job or
the fileName attribute of the first document in the job.
The jobName attribute is distinguished from the jobComment
attribute, in that the jobName attribute is intended to
permit the submitting user to distinguish between different
jobs that he/she has submitted. The jobComment attribute is
intended to be free form additional information that a user
might wish to use to communicate with himself/herself, such
as a reminder of what to do with the results or to indicate
Bergman, Hastings, Isaacson, Lewis [Page 47]
Job Monitoring MIB, V0.85 Aug 8, 1997
a different set of input parameters were tried in several
different job submissions.
jobServiceTypes(24), JmJobServiceTypesTC
INTEGER: Specifies the type(s) of service to which the job
has been submitted (print, fax, scan, etc.). The service
type 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. This attribute SHALL be implemented if the server
or device has other types in addition to or instead of
printing.
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.
jobSourceChannelIndex(25), Integer32(0..2147483647)
INTEGER: The index of the row in the associated Printer
MIB[print-mib] of the channel which is the source of the
print job.
jobSourcePlatformType(26), JmJobSourcePlatformTypeTC
INTEGER: The source platform type of the immediate upstream
submitter that submitted the job to the server
(configuration 2) or device (configuration 1 and 3) to which
the agent is providing access. For configuration 1, this is
the type of the client that submitted the job to the device;
for configuration 2, this is the type of the client that
submitted the job to the server; and for configuration 3,
this is the type of the server that submitted the job to the
device.
submittingServerName(27), JmJobStringTC(SIZE(0..63))
OCTETS: For configuration 3 only: The administrative name
of the server that submitted the job to the device.
Bergman, Hastings, Isaacson, Lewis [Page 48]
Job Monitoring MIB, V0.85 Aug 8, 1997
submittingApplicationName(28), JmJobStringTC(SIZE(0..63))
OCTETS: The name of the client application (not the server
in configuration 3) that submitted the job to the server or
device.
jobOriginatingHost(29), JmJobStringTC(SIZE(0..63))
OCTETS: The name of the client host (not the server host
name in configuration 3) that submitted the job to the
server or device.
deviceNameRequested(30), JmJobStringTC(SIZE(0..63))
OCTETS: The administratively defined coded character set
name of the target device requested by the submitting user.
For configuration 1, its value corresponds to the Printer
MIB[print-mib]: prtGeneralPrinterName object. For
configuration 2 and 3, its value is the name of the logical
or physical device that the user supplied to indicate to the
server on which device(s) they wanted the job to be
processed.
queueNameRequested(31), JmJobStringTC(SIZE(0..63))
OCTETS: The administratively defined coded character set
name of the target queue requested by the submitting user.
For configuration 1, its value corresponds to the queue in
the device for which the agent is providing access. For
configuration 2 and 3, its value is the name of the queue
that the user supplied to indicate to the server on which
device(s) they wanted the job to be processed.
NOTE - typically an implementation SHOULD support either the
deviceNameRequested or queueNameRequested attribute, but not
both.
physicalDevice(32), hrDeviceIndex
AND/OR
JmUTF8StringTC(SIZE(0..63))
INTEGER: MULTI-ROW: The index of the physical device MIB
instance requested/used, such as the Printer MIB[print-mib].
This value is an hrDeviceIndex value. See the Host
Resources MIB[hr-mib].
AND/OR
OCTETS: MULTI-ROW: The name of the physical device to
which the job is assigned.
numberOfDocuments(33), Integer32(-2..2147483647)
INTEGER: The number of documents in this job.
Bergman, Hastings, Isaacson, Lewis [Page 49]
Job Monitoring MIB, V0.85 Aug 8, 1997
fileName(34), JmJobStringTC(SIZE(0..63))
OCTETS: MULTI-ROW: The coded character set file name or
URI[URI-spec] of the document.
There is no restriction on the same file name occurring in
multiple rows.
documentName(35), JmJobStringTC(SIZE(0..63))
OCTETS: MULTI-ROW: The coded character set name of the
document.
There is no restriction on the same document name occurring
in multiple rows.
jobComment(36), JmJobStringTC(SIZE(0..63))
OCTETS: An arbitrary human-readable coded character text
string supplied by the submitting user or the job submitting
application program for any purpose. For example, a user
might indicate what he/she is going to do with the printed
output or the job submitting application program might
indicate how the document was produced.
The jobComment attribute is not intended to be a name; see
the jobName attribute.
documentFormatIndex(37), Integer32(0..2147483647)
INTEGER: MULTI-ROW: The index in the prtInterpreterTable
in the Printer MIB[print-mib] of the page description
language (PDL) or control language interpreter that this job
requires/uses. A document or a job MAY use more than one
PDL or control language.
NOTE - As with all intensive attributes where multiple rows
are allowed, there SHALL be only one distinct row for each
distinct interpreter; there SHALL be no duplicates.
NOTE - This attribute type is intended to be used with an
agent that implements the Printer MIB and SHALL not be used
if the agent does not implement the Printer MIB. Such an
agent SHALL use the documentFormat attribute instead.
documentFormat(38), PrtInterpreterLangFamilyTC
AND/OR
OCTET STRING(SIZE(0..63))
INTEGER: MULTI-ROW: The interpreter language family
corresponding to the Printer MIB[print-mib]
prtInterpreterLangFamily object, that this job
Bergman, Hastings, Isaacson, Lewis [Page 50]
Job Monitoring MIB, V0.85 Aug 8, 1997
requires/uses. A document or a job MAY use more than one
PDL or control language.
AND/OR
OCTETS: MULTI-ROW: The document format registered as a
media type[iana-media-types], i.e., the name of the MIME
content-type/subtype. Examples: 'application/postscript',
'application/vnd.hp-PCL', and 'application/pdf'
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Job Parameter attributes
+
+ The following attributes represent input parameters
+ supplied by the submitting client in the job submission
+ protocol.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
jobPriority(50), Integer32(1..100)
INTEGER: The priority for scheduling the job. It is used by
servers and devices that employ a priority-based scheduling
algorithm.
A higher value specifies a higher priority. The value 1 is
defined to indicate the lowest possible priority (a job
which a priority-based scheduling algorithm SHALL pass over
in favor of higher priority jobs). The value 100 is defined
to indicate the highest possible priority. Priority is
expected to be evenly or 'normally' distributed across this
range. The mapping of vendor-defined priority over this
range is implementation-specific.
jobProcessAfterDateAndTime(51), DateAndTime (SNMPv2-TC)
OCTETS: The calendar date and time of day after which the
job SHALL become a candidate to be scheduled for processing.
If the value of this attribute is in the future, the server
SHALL set the value of the job's jmJobState object to
pendingHeld and add the jobProcessAfterSpecified bit value
to the job's jmJobStateReasons1 object. When the specified
date and time arrives, the server SHALL remove the
jobProcessAfterSpecified bit value from the job's
jmJobStateReasons1 object and, if no other reasons remain,
SHALL change the job's jmJobState object to pending.
jobHold(52), JmBooleanTC
INTEGER: If the value is 'true(4)', a client has explicitly
specified that the job is to be held until explicitly
Bergman, Hastings, Isaacson, Lewis [Page 51]
Job Monitoring MIB, V0.85 Aug 8, 1997
released. Until the job is explicitly released by a client,
the job SHALL be in the pendingHeld state with the
jobHoldSpecified value in the jmJobStateReasons1 attribute.
jobHoldUntil(53), JmJobStringTC(SIZE(0..63))
OCTETS: The named time period during which the job SHALL
become a candidate for processing, such as 'evening',
'night', 'weekend', 'second-shift', 'third-shift', etc., as
defined by the system administrator. See IPP [ipp-model]
for the standard keyword values. Until that time period
arrives, the job SHALL be in the pendingHeld state with the
jobHoldUntilSpecified value in the jmJobStateReasons1
object. The value 'no-hold' SHALL indicate explicitly that
no time period has been specified; the absence of this
attribute SHALL indicate implicitly that no time period has
been specified.
outputBin(54), Integer32(0..2147483647)
AND/OR
JmJobStringTC(SIZE(0..63))
INTEGER: MULTI-ROW: The output subunit index in the
Printer MIB[print-mib]
AND/OR
OCTETS: the name or number (represented as ASCII digits) of
the output bin to which all or part of the job is placed in.
sides(55), Integer32(-2..2)
INTEGER: MULTI-ROW: The number of sides, '1' or '2', that
any document in this job requires/used.
finishing(56), JmFinishingTC
INTEGER: MULTI-ROW: Type of finishing that any document in
this job requires/used.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Image Quality attributes (requested and consumed)
+
+ For devices that can vary the image quality.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
printQualityRequested(70), JmPrintQualityTC
INTEGER: MULTI-ROW: The print quality selection requested
for a document in the job for printers that allow quality
differentiation.
Bergman, Hastings, Isaacson, Lewis [Page 52]
Job Monitoring MIB, V0.85 Aug 8, 1997
printQualityUsed(71), JmPrintQualityTC
INTEGER: MULTI-ROW: The print quality selection actually
used by a document in the job for printers that allow
quality differentiation.
printerResolutionRequested(72), JmPrinterResolutionTC
OCTETS: MULTI-ROW: The printer resolution requested for a
document in the job for printers that support resolution
selection.
printerResolutionUsed(73), JmPrinterResolutionTC
OCTETS: MULTI-ROW: The printer resolution actually used by
a document in the job for printers that support resolution
selection.
tonerEcomonyRequested(74), JmTonerEconomyTC
INTEGER: MULTI-ROW: The toner economy selection requested
for documents in the job for printers that allow toner
economy differentiation.
tonerEcomonyUsed(75), JmTonerEconomyTC
INTEGER: MULTI-ROW: The toner economy selection actually
used by documents in the job for printers that allow toner
economy differentiation.
tonerDensityRequested(76), Integer32(-2..100)
INTEGER: MULTI-ROW: The toner density requested for a
document in this job for devices that can vary toner density
levels. Level 1 is the lowest density and level 100 is the
highest density level. Devices with a smaller range, SHALL
map the 1-100 range evenly onto the implemented range.
tonerDensityUsed(77), Integer32(-2..100)
INTEGER: MULTI-ROW: The toner density used by documents in
this job for devices that can vary toner density levels.
Level 1 is the lowest density and level 100 is the highest
density level. Devices with a smaller range, SHALL map the
1-100 range evenly onto the implemented range.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Job Progress attributes (requested and consumed)
+
+ Pairs of these attributes can be used by monitoring
+ applications to show an indication of relative progress
+ to users.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Bergman, Hastings, Isaacson, Lewis [Page 53]
Job Monitoring MIB, V0.85 Aug 8, 1997
jobCopiesRequested(90), Integer32(-2..2147483647)
INTEGER: The number of copies of the entire job that are to
be produced.
jobCopiesCompleted(91), Integer32(-2..2147483647)
INTEGER: The number of copies of the entire job that have
been completed so far.
documentCopiesRequested(92), Integer32(-2..2147483647)
INTEGER: The total count of the number of document copies
requested for the job as a whole. If there are documents A,
B, and C, and document B is specified to produce 4 copies,
the number of document copies requested is 6 for the job.
This attribute SHALL be used only when a job has multiple
documents. The jobCopiesRequested attribute SHALL be used
when the job has only one document.
documentCopiesCompleted(93), Integer32(-2..2147483647)
INTEGER: The total count of the number of document copies
completed so far for the job as a whole. If there are
documents A, B, and C, and document B is specified to
produce 4 copies, the number of document copies starts a 0
and runs up to 6 for the job as the job processes.
This attribute SHALL be used only when a job has multiple
documents. The jobCopiesCompleted attribute SHALL be used
when the job has only one document.
jobKOctetsTransferred(94), Integer32(-2..2147483647)
INTEGER: The number of K (1024) octets transferred to the
server or device to which the agent is providing access.
This count is independent of the number of copies of the job
or documents that will be produced, but it is only a measure
of the number of bytes transferred to the server or device.
The agent SHALL round the actual number of octets
transferred up to the next higher K. Thus 0 octets SHALL be
represented as '0', 1-1024 octets SHALL BE represented as
'1', 1025-2048 SHALL be '2', etc. When the job completes,
the values of the jmJobKOctetsRequested object and the
jobKOctetsTransferred attribute SHALL be equal.
NOTE - The jobKOctetsTransferred can be used with the
jmJobKOctetsRequested object in order to produce a relative
indication of the progress of the job for agents that do not
implement the jmJobKOctetsProcessed object.
Bergman, Hastings, Isaacson, Lewis [Page 54]
Job Monitoring MIB, V0.85 Aug 8, 1997
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Impression attributes
+
+ For a print job, an impression is the marking of the
+ entire side of a sheet. Two-sided processing involves two
+ impressions per sheet. Two-up is the placement of two
+ logical pages on one side of a sheet and so is still a
+ single impression. See also jmJobImpressionsRequested and
+ jmJobImpressionsCompleted objects in the jmJobTable.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
impressionsSpooled(110), Integer32(-2..2147483647)
INTEGER: The number of impressions spooled to the server or
device for the job so far.
impressionsSentToDevice(111), Integer32(-2..2147483647)
INTEGER: The number of impressions sent to the device for
the job so far.
impressionsInterpreted(112), Integer32(-2..2147483647)
INTEGER: The number of impressions interpreted for the job
so far.
impressionsCompletedCurrentCopy(113), Integer32(-2..2147483647)
INTEGER: The number of impressions completed by the device
for the current copy of the current document so far. For
printing, 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.
This value SHALL be reset to 0 for each document in the job
and for each document copy.
fullColorImpressionsCompleted(114), Integer32(-2..2147483647)
INTEGER: The number of full color impressions completed by
the device for this job so far. For printing, 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. Full color impressions are typically
defined as those requiring 3 or more colorants, but this MAY
vary by implementation.
highlightColorImpressionsCompleted(115), Integer32(-2..
2147483647)
INTEGER: The number of highlight color impressions
Bergman, Hastings, Isaacson, Lewis [Page 55]
Job Monitoring MIB, V0.85 Aug 8, 1997
completed by the device for this job so far. For printing,
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. Highlight color impressions are
typically defined as those requiring black plus one other
colorant, but this MAY vary by implementation.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Page attributes
+
+ A page is a logical page. Number up can impose more than
+ one page on a single side of a sheet. Two-up is the
+ placement of two logical pages on one side of a sheet so
+ that each side counts as two pages.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
pagesRequested(130), Integer32(-2..2147483647)
INTEGER: The number of logical pages requested by the job
to be processed.
pagesCompleted(131), Integer32(-2..2147483647)
INTEGER: The number of logical pages completed for this job
so far.
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
pagesRequested 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 pagesRequested object.
NOTE - See the impressionsCompletedCurrentCopy and
pagesCompletedCurrentCopy attributes for attributes that are
reset on each document copy.
NOTE - The pagesCompleted object can be used with the
pagesRequested 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.
pagesCompletedCurrentCopy(132), Integer32(-2..2147483647)
INTEGER: The number of logical pages completed for the
current copy of the document so far. This value SHALL be
Bergman, Hastings, Isaacson, Lewis [Page 56]
Job Monitoring MIB, V0.85 Aug 8, 1997
reset to 0 for each document in the job and for each
document copy.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Sheet attributes
+
+ The sheet is a single piece of a medium, whether printing
+ on one or both sides.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
sheetsRequested(150), Integer32(-2..2147483647)
INTEGER: The number of medium sheets requested to be
processed for this job.
sheetsCompleted(151), Integer32(-2..2147483647)
INTEGER: The number of medium sheets that have completed
marking and stacking for the entire job so far whether those
sheets have been processed on one side or on both.
sheetsCompletedCurrentCopy(152), Integer32(-2..2147483647)
INTEGER: The number of medium sheets that have completed
marking and stacking for the current copy of a document in
the job so far whether those sheets have been processed on
one side or on both.
The value of this attribute SHALL be reset to 0 as each
document in the job starts being processed and for each
document copy as it starts being processed.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Resources attributes (requested and consumed)
+
+ Pairs of these attributes can be used by monitoring
+ applications to show an indication of relative usage to
+ users.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
mediumRequested(170), JmMediumTypeTC
AND/OR
JmJobStringTC(SIZE(0..63))
INTEGER: MULTI-ROW: The type
AND/OR
OCTETS: the name of the medium that is required by the job.
mediumConsumed(171), Integer32(-2..2147483647)
AND
Bergman, Hastings, Isaacson, Lewis [Page 57]
Job Monitoring MIB, V0.85 Aug 8, 1997
JmJobStringTC(SIZE(0..63))
INTEGER: The number of sheets
AND
OCTETS: MULTI-ROW: the name of the medium that has been
consumed so far whether those sheets have been processed on
one side or on both.
This attribute SHALL have both Integer32 and OCTET STRING
(represented as JmJobStringTC) values.
colorantRequested(172), Integer32(-2..2147483647)
AND/OR
JmJobStringTC(SIZE(0..63))
INTEGER: MULTI-ROW: The index (prtMarkerColorantIndex) in
the Printer MIB[print-mib]
AND/OR
OCTETS: the name of the colorant requested.
colorantConsumed(173), Integer32(-2..2147483647)
AND/OR
JmJobStringTC(SIZE(0..63))
INTEGER: MULTI-ROW: The index (prtMarkerColorantIndex) in
the Printer MIB[print-mib]
AND/OR
OCTETS: the name of the colorant consumed.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ Time attributes (set by server or device)
+
+ This section of attributes are ones that are set by the
+ server or device that accepts jobs. Two forms of time are
+ provided. Each form is represented in a separate attribute.
+ See section 3.1.2 and section 3.1.3 for the
+ conformance requirements for time attribute for agents and
+ monitoring applications, respectively. The two forms are:
+
+ 'DateAndTime' is an 8 or 11 octet binary encoded year,
+ month, day, hour, minute, second, deci-second with
+ optional offset from UTC. See SNMPv2-TC [SMIv2-TC].
+
+ NOTE: 'DateAndTime' is not printable characters; it is
+ binary.
+
+ 'JmTimeStampTC' is the time of day measured in the number of
+ seconds since the system was booted.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Bergman, Hastings, Isaacson, Lewis [Page 58]
Job Monitoring MIB, V0.85 Aug 8, 1997
jobSubmissionToServerTime(190), JmTimeStampTC
AND/OR
DateAndTime
INTEGER: Configuration 3 only: The time
AND/OR
OCTETS: the date and time that the job was submitted to the
server (as distinguished from the device which uses
jobSubmissionTime).
jobSubmissionTime(191), JmTimeStampTC
AND/OR
DateAndTime
INTEGER: Configurations 1, 2, and 3: The time
AND/OR
OCTETS: the date and time that the job was submitted to the
server or device to which the agent is providing access.
jobStartedBeingHeldTime(192), JmTimeStampTC
AND/OR
DateAndTime
INTEGER: The time
AND/OR
OCTETS: the date and time that the job last entered the
pendingHeld state. If the job has never entered the
pendingHeld state, then the value SHALL be '0' or the
attribute SHALL not be present in the table.
jobStartedProcessingTime(193), JmTimeStampTC
AND/OR
DateAndTime
INTEGER: The time
AND/OR
OCTETS: the date and time that the job started processing.
jobCompletedTime(194), JmTimeStampTC
AND/OR
DateAndTime
INTEGER: The time
AND/OR
OCTETS: the date and time that the job entered the
completed, canceled, or aborted state.
jobProcessingCPUTime(195) Integer32(-2..2147483647)
UNITS 'seconds'
INTEGER: The amount of CPU time in seconds that the job has
been in the processing state. If the job enters the
Bergman, Hastings, Isaacson, Lewis [Page 59]
Job Monitoring MIB, V0.85 Aug 8, 1997
processingStopped state, that elapsed time SHALL not be
included. In other words, the jobProcessingCPUTime value
SHOULD be relatively repeatable when the same job is
processed again on the same device."
REFERENCE
"See Section 3.2 entitled 'The Attribute Mechanism' for a
description of this textual-convention and its use in the
jmAttributeTable.
This is a type 2 enumeration. See Section 3.6.1.2."
SYNTAX INTEGER {
other(1),
unknown(2),
jobStateReasons2(3),
jobStateReasons3(4),
jobStateReasons4(5),
processingMessage(6),
jobCodedCharSet(7),
jobAccountName(21),
serverAssignedJobName(22),
jobName(23),
jobServiceTypes(24),
jobSourceChannelIndex(25),
jobSourcePlatformType(26),
submittingServerName(27),
submittingApplicationName(28),
jobOriginatingHost(29),
deviceNameRequested(30),
queueNameRequested(31),
physicalDevice(32),
numberOfDocuments(33),
fileName(34),
documentName(35),
jobComment(36),
documentFormatIndex(37),
documentFormat(38),
jobPriority(50),
jobProcessAfterDateAndTime(51),
jobHold(52),
jobHoldUntil(53),
outputBin(54),
sides(55),
finishing(56),
printQualityRequested(70),
Bergman, Hastings, Isaacson, Lewis [Page 60]
Job Monitoring MIB, V0.85 Aug 8, 1997
printQualityUsed(71),
printerResolutionRequested(72),
printerResolutionUsed(73),
tonerEcomonyRequested(74),
tonerEcomonyUsed(75),
tonerDensityRequested(76),
tonerDensityUsed(77),
jobCopiesRequested(90),
jobCopiesCompleted(91),
documentCopiesRequested(92),
documentCopiesCompleted(93),
jobKOctetsTransferred(94),
impressionsSpooled(110),
impressionsSentToDevice(111),
impressionsInterpreted(112),
impressionsCompletedCurrentCopy(113),
fullColorImpressionsCompleted(114),
highlightColorImpressionsCompleted(115),
pagesRequested(130),
pagesCompleted(131),
pagesCompletedCurrentCopy(132),
sheetsRequested(150),
sheetsCompleted(151),
sheetsCompletedCurrentCopy(152),
mediumRequested(170),
mediumConsumed(171),
colorantRequested(172),
colorantConsumed(173),
jobSubmissionToServerTime(190),
jobSubmissionTime(191),
jobStartedBeingHeldTime(192),
jobStartedProcessingTime(193),
jobCompletedTime(194),
jobProcessingCPUTime(195)
}
JmJobServiceTypesTC ::= TEXTUAL-CONVENTION
STATUS current
Bergman, Hastings, Isaacson, Lewis [Page 61]
Job Monitoring MIB, V0.85 Aug 8, 1997
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
Bergman, Hastings, Isaacson, Lewis [Page 62]
Job Monitoring MIB, V0.85 Aug 8, 1997
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."
REFERENCE
"These bit definitions are the equivalent of a type 2 enum
except that combinations of them MAY be used together. See
section 3.6.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.
NOTE - While values cannot be added to the jmJobState object
without impacting deployed clients that take actions upon
receiving jmJobState values, it is the intent that additional
JmJobStateReasonsNTC enums can be defined and registered without
impacting such deployed clients. In other words, the
jmJobStateReasons1 object and jobStateReasonsN attributes are
intended to be extensible.
NOTE - The Job Monitoring MIB contains a superset of the IPP
values[ipp-model] for the IPP 'job-state-reasons' attribute,
since the Job Monitoring MIB is intended to cover other job
submission protocols as well. Also some of the names of the
reasons have been changed from 'printer' to 'device', since the
Bergman, Hastings, Isaacson, Lewis [Page 63]
Job Monitoring MIB, V0.85 Aug 8, 1997
Job Monitoring MIB is intended to cover additional types of
devices, including input devices, such as scanners.
The following standard values are defined (in hexadecimal) as
powers of two, since multiple values MAY be used at the same
time. For ease of understanding, the JmJobStateReasons1TC
reasons are presented in the order in which the reasons are
likely to occur (if implemented), starting with the
'jobIncoming' value and ending with the 'jobCompletedWithErrors'
value.
other 0x1
The job state reason is not one of the standardized or
registered reasons.
unknown 0x2
The job state reason is not known to the agent or is
indeterminent.
jobIncoming 0x4
The job has been accepted by the server or device, but the
server or device is expecting (1) additional operations from
the client to finish creating the job and/or (2) is
accessing/accepting document data.
jobOutgoing 0x8
Configuration 2 only: The server is transmitting the job to
the device.
jobHoldSpecified 0x10
The value of the job's jobHold(52) attribute is TRUE. The
job SHALL NOT be a candidate for processing until this
reason is removed and there are no other reasons to hold the
job.
jobHoldUntilSpecified 0x20
The value of the job's jobHoldUntil(53) attribute specifies
a time period that is still in the future. The job SHALL
NOT be a candidate for processing until this reason is
removed and there are no other reasons to hold the job.
jobProcessAfterSpecified 0x40
The value of the job's jobProcessAfterDateAndTime(51)
attribute specifies a time that is still in the future. The
job SHALL NOT be a candidate for processing until this
reason is removed and there are no other reasons to hold the
job.
Bergman, Hastings, Isaacson, Lewis [Page 64]
Job Monitoring MIB, V0.85 Aug 8, 1997
resourcesAreNotReady 0x80
At least one of the resources needed by the job, such as
media, fonts, resource objects, etc., is not ready on any of
the physical devices for which the job is a candidate. This
condition MAY be detected when the job is accepted, or
subsequently while the job is pending or processing,
depending on implementation.
deviceStoppedPartly 0x100
One or more, but not all, of the devices to which the job is
assigned are stopped. If all of the devices are stopped (or
the only device is stopped), the deviceStopped reason SHALL
be used.
deviceStopped 0x200
The device(s) to which the job is assigned is (are all)
stopped.
jobPrinting 0x400
The output device is marking media. This attribute is useful
for servers and output devices which spend a great deal of
time processing when no marking is happening and then want
to show that marking is now happening or when the job is in
the canceled or aborted state, but the marking has not yet
stopped so that impression or sheet counts are still
increasing for the job.
jobCanceledByUser 0x800
The job was canceled by the user, i.e., by an unknown user
or by a user whose name is the same as the value of the
job's jmJobOwner object.
jobCanceledByOperator 0x1000
The job was canceled by the operator, i.e., by a user whose
name is different than the value of the job's jmJobOwner
object.
abortedBySystem 0x2000
The job was aborted by the system.
NOTE - When the system puts a job into the 'aborted' job
state, this reason is not needed. This reason is needed
only when the system aborts a job, but, instead of placing
the job in the aborted job state, places the job in the
pendingHeld state, so that a user or operator can manually
try the job again.
Bergman, Hastings, Isaacson, Lewis [Page 65]
Job Monitoring MIB, V0.85 Aug 8, 1997
processingToStopPoint 0x4000
The requester has issued an operation to cancel or interrupt
the job or the server/device has aborted the job but the
server/device is still performing some actions on the job
until a specified stop point occurs or job
termination/cleanup is completed.
This reason is recommended to be used in conjunction with
the canceled or aborted job state to indicate that the
server/device is still performing some actions on the job
after the job leaves the processing state, so that some of
the jobs resources consumed counters may still be
incrementing while the job is in the canceled or aborted job
states.
jobCompletedSuccessfully 0x8000
The job completed successfully.
jobCompletedWithWarnings 0x10000
The job completed with warnings.
jobCompletedWithErrors 0x20000
The job completed with errors (and possibly warnings too).
The following additional job state reasons have been added to
represent job states that are in ISO DPA[iso-dpa] and other job
submission protocols:
jobPaused 0x40000
The job has been indefinitely suspended by a client issuing
an operation to suspend the job so that other jobs may
proceed using the same devices. The client MAY issue an
operation to resume the paused job at any time, in which
case the agent SHALL remove the jobPaused values from the
job's jmJobStateReasons1 object and the job is eventually
resumed at or near the point where the job was paused.
jobInterrupted 0x80000
The job has been interrupted while processing by a client
issuing an operation that specifies another job to be run
instead of the current job. The server or device will
automatically resume the interrupted job when the
interrupting job completes.
jobRetained 0x100000
The job is being retained by the server or device with all
of the job's document data (and submitted resources, such as
Bergman, Hastings, Isaacson, Lewis [Page 66]
Job Monitoring MIB, V0.85 Aug 8, 1997
fonts, logos, and forms, if any). Thus a client could issue
an operation to the server or device to either (1) re-do the
job (or a copy of the job) on the same server or device or
(2) resubmit the job to another server or device. When a
client could no longer re-do/resubmit the job, such as after
the document data has been discarded, the agent SHALL remove
the jobRetained value from the jmJobStateReasons1 object."
REFERENCE
"These bit definitions are the equivalent of a type 2 enum
except that combinations of bits may be used together. See
section 3.6.1.2. The remaining bits are reserved for future
standardization and/or registration."
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 the description under
JmJobStateReasons1TC for additional information that applies to
all reasons.
The following standard values are defined (in hexadecimal) as
powers of two, since multiple values may be used at the same
time:
cascaded 0x1
An outbound gateway has transmitted all of the job's job and
document attributes and data to another spooling system.
deletedByAdministrator 0x2
The administrator has deleted the job.
discardTimeArrived 0x4
The job has been deleted due to the fact that the time
specified by the job's job-discard-time attribute has
arrived.
postProcessingFailed 0x8
The post-processing agent failed while trying to log
accounting attributes for the job; therefore the job has
been placed into the completed state with the jobRetained
Bergman, Hastings, Isaacson, Lewis [Page 67]
Job Monitoring MIB, V0.85 Aug 8, 1997
jmJobStateReasons1 object value for a system-defined period
of time, so the administrator can examine it, resubmit it,
etc.
submissionInterrupted 0x10
Indicates that the job was not completely submitted for some
unforeseen reason, such as: (1) the server has crashed
before the job was closed by the client, (2) the server or
the document transfer method has crashed in some non-
recoverable way before the document data was entirely
transferred to the server, (3) the client crashed or failed
to close the job before the time-out period.
maxJobFaultCountExceeded 0x20
The job has faulted several times and has exceeded the
administratively defined fault count limit.
devicesNeedAttentionTimeOut 0x40
One or more document transforms that the job is using needs
human intervention in order for the job to make progress,
but the human intervention did not occur within the site-
settable time-out value.
needsKeyOperatorTimeOut 0x80
One or more devices or document transforms that the job is
using need a specially trained operator (who may need a key
to unlock the device and gain access) in order for the job
to make progress, but the key operator intervention did not
occur within the site-settable time-out value.
jobStartWaitTimeOut 0x100
The server/device has stopped the job at the beginning of
processing to await human action, such as installing a
special cartridge or special non-standard media, but the job
was not resumed within the site-settable time-out value and
the server/device has transitioned the job to the
pendingHeld state.
jobEndWaitTimeOut 0x200
The server/device has stopped the job at the end of
processing to await human action, such as removing a special
cartridge or restoring standard media, but the job was not
resumed within the site-settable time-out value and the
server/device has transitioned the job to the completed
state.
jobPasswordWaitTimeOut 0x400
The server/device has stopped the job at the beginning of
Bergman, Hastings, Isaacson, Lewis [Page 68]
Job Monitoring MIB, V0.85 Aug 8, 1997
processing to await input of the job's password, but the
password was not received within the site-settable time-out
value.
deviceTimedOut 0x800
A device that the job was using has not responded in a
period specified by the device's site-settable attribute.
connectingToDeviceTimeOut 0x1000
The server is attempting to connect to one or more devices
which may be dial-up, polled, or queued, and so may be busy
with traffic from other systems, but server was unable to
connect to the device within the site-settable time-out
value.
transferring 0x2000
The job is being transferred to a down stream server or
device.
queuedInDevice 0x4000
The job has been queued in a down stream server or device.
jobCleanup 0x8000
The server/device is performing cleanup activity as part of
ending normal processing.
jobPasswordWait 0x20000
The server/device has selected the job to be next to
process, but instead of assigning resources and starting the
job processing, the server/device has transitioned the job
to the pendingHeld state to await entry of a password (and
dispatched another job, if there is one).
validating 0x40000
The server/device is validating the job after accepting the
job.
queueHeld 0x80000
The operator has held the entire job set or queue.
jobProofWait 0x100000
The job has produced a single proof copy and is in the
pendingHeld state waiting for the requester to issue an
operation to release the job to print normally, obeying any
job and document copy attributes that were originally
submitted.
Bergman, Hastings, Isaacson, Lewis [Page 69]
Job Monitoring MIB, V0.85 Aug 8, 1997
heldForDiagnostics 0x200000
The system is running intrusive diagnostics, so that all
jobs are being held.
serviceOffLine 0x400000
The service/document transform is off-line and accepting no
jobs. All pending jobs are put into the pendingHeld state.
This could be true if its input is impaired or broken.
noSpaceOnServer 0x800000
There is no room on the server to store all of the job.
pinRequired 0x1000000
The System Administrator settable device policy is (1) to
require PINs, and (2) to hold jobs that do not have a pin
supplied as an input parameter when the job was created.
exceededAccountLimit 0x2000000
The account for which this job is drawn has exceeded its
limit. This condition SHOULD be detected before the job is
scheduled so that the user does not wait until his/her job
is scheduled only to find that the account is overdrawn.
This condition MAY also occur while the job is processing
either as processing begins or part way through processing.
heldForRetry 0x4000000
The job encountered some errors that the server/device could
not recover from with its normal retry procedures, but the
error might not be encountered if the job is processed again
in the future. Example cases are phone number busy or
remote file system in-accessible. For such a situation, the
server/device SHALL transition the job from the processing
to the pendingHeld, rather than to the aborted state.
The following values are from the X/Open PSIS draft standard:
canceledByShutdown 0x8000000
The job was canceled because the server or device was
shutdown before completing the job.
deviceUnavailable 0x10000000
This job was aborted by the system because the device is
currently unable to accept jobs.
wrongDevice 0x20000000
This job was aborted by the system because the device is
unable to handle this particular job; the spooler SHOULD try
Bergman, Hastings, Isaacson, Lewis [Page 70]
Job Monitoring MIB, V0.85 Aug 8, 1997
another device or the user should submit the job to another
device.
badJob 0x40000000
This job was aborted by the system because this job has a
major problem, such as an ill-formed PDL; the spooler SHOULD
not even try another device. "
REFERENCE
"These bit definitions are the equivalent of a type 2 enum
except that combinations of them may be used together. See
section 3.6.1.2. See the description under JmJobStateReasons1TC
and the jobStateReasons2 attribute."
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 the description under
JmJobStateReasons1TC for additional information that applies to
all reasons.
The following standard values are defined (in hexadecimal) as
powers of two, since multiple values may be used at the same
time:
jobInterruptedByDeviceFailure 0x1
A device or the print system software that the job was using
has failed while the job was processing. The server or
device is keeping the job in the pendingHeld state until an
operator can determine what to do with the job."
REFERENCE
"These bit definitions are the equivalent of a type 2 enum
except that combinations of them may be used together. See
section 3.6.1.2. The remaining bits are reserved for future
standardization and/or registration. See the description under
JmJobStateReasons1TC and the jobStateReasons3 attribute."
SYNTAX INTEGER(0..2147483647) -- 31 bits, all but sign bit
Bergman, Hastings, Isaacson, Lewis [Page 71]
Job Monitoring MIB, V0.85 Aug 8, 1997
JmJobStateReasons4TC ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual-convention is used in the jobStateReasons4
attribute to provides additional information regarding the
jmJobState object. See the description under
JmJobStateReasons1TC for additional information that applies to
all reasons.
The following standard values are defined (in hexadecimal) as
powers of two, since multiple values may be used at the same
time:
none yet defined. These bits are reserved for future
standardization and/or registration."
REFERENCE
"These bit definitions are the equivalent of a type 2 enum
except that combinations of them may be used together. See
section 3.6.1.2. See the description under JmJobStateReasons1TC
and the jobStateReasons4 attribute."
SYNTAX INTEGER(0..2147483647) -- 31 bits, all but sign bit
Bergman, Hastings, Isaacson, Lewis [Page 72]
Job Monitoring MIB, V0.85 Aug 8, 1997
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."
REFERENCE
"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
Bergman, Hastings, Isaacson, Lewis [Page 73]
Job Monitoring MIB, V0.85 Aug 8, 1997
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."
REFERENCE
"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."
::= { 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."
REFERENCE
"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."
Bergman, Hastings, Isaacson, Lewis [Page 74]
Job Monitoring MIB, V0.85 Aug 8, 1997
::= { 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."
REFERENCE
"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."
::= { 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.
Depending on implementation, the value of this object MAY be
either: (1) set by the system administrator by means outside
this specification or (2) fixed by the implementation.
This value SHALL be equal to or greater than the value of
jmGeneralAttributePersistence. This value SHOULD be at least 60
which gives a monitoring 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
Bergman, Hastings, Isaacson, Lewis [Page 75]
Job Monitoring MIB, V0.85 Aug 8, 1997
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.
Depending on implementation, the value of this object MAY be
either (1) set by the system administrator by means outside this
specification or MAY be (2) fixed by the implementation.
This value SHOULD be at least 60 which gives a monitoring
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 - 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."
REFERENCE
"See the OBJECT compliance macro for the minimum maximum length
required for conformance."
::= { jmGeneralEntry 7 }
-- The Job ID Group (MANDATORY)
-- The jmJobIDGroup consists entirely of the jmJobIDTable.
jmJobID OBJECT IDENTIFIER ::= { jobmonMIBObjects 2 }
jmJobIDTable OBJECT-TYPE
Bergman, Hastings, Isaacson, Lewis [Page 76]
Job Monitoring MIB, V0.85 Aug 8, 1997
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."
REFERENCE
"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. Each job SHALL
appear in one and only one job set."
INDEX { jmJobSubmissionID }
::= { jmJobIDTable 1 }
JmJobIDEntry ::= SEQUENCE {
jmJobSubmissionID OCTET STRING(SIZE(48)),
jmJobIDJobSetIndex Integer32(1..32767),
jmJobIDJobIndex Integer32(1..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
Bergman, Hastings, Isaacson, Lewis [Page 77]
Job Monitoring MIB, V0.85 Aug 8, 1997
procedures of a type 2 enum. See section 3.6.3 entitled: 'IANA
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 to 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."
REFERENCE
"See the JmJobSubmissionIDTypeTC textual convention.
See APPENDIX B - Support of the Job Submission ID in Job
Submission Protocols."
::= { jmJobIDEntry 1 }
jmJobIDJobSetIndex OBJECT-TYPE
SYNTAX Integer32(1..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."
REFERENCE
"See jmGeneralJobSetIndex in the jmGeneralTable."
::= { jmJobIDEntry 2 }
jmJobIDJobIndex OBJECT-TYPE
SYNTAX Integer32(1..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Bergman, Hastings, Isaacson, Lewis [Page 78]
Job Monitoring MIB, V0.85 Aug 8, 1997
"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."
REFERENCE
"See jmJobIndex in the jmJobTable."
::= { 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."
REFERENCE
"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."
REFERENCE
"See Section 3.2 entitled 'The Job Tables'."
INDEX { jmGeneralJobSetIndex, jmJobIndex }
::= { jmJobTable 1 }
Bergman, Hastings, Isaacson, Lewis [Page 79]
Job Monitoring MIB, V0.85 Aug 8, 1997
JmJobEntry ::= SEQUENCE {
jmJobIndex Integer32(1..2147483647),
jmJobState JmJobStateTC,
jmJobStateReasons1 JmJobStateReasons1TC,
jmNumberOfInterveningJobs Integer32(-2..2147483647),
jmJobKOctetsRequested Integer32(-2..2147483647),
jmJobKOctetsProcessed Integer32(-2..2147483647),
jmJobImpressionsRequested 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."
REFERENCE
"See Section 3.2 entitled 'The Job Tables and the Oldest Active
and Newest Active Indexes'.
See Section 3.4 entitled 'Job Identification'.
See also jmGeneralNewestActiveJobIndex for the largest value of
jmJobIndex.
See JmJobSubmissionTypeTC 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
Bergman, Hastings, Isaacson, Lewis [Page 80]
Job Monitoring MIB, V0.85 Aug 8, 1997
and jmJobTable is specified by the value of the
jmGeneralJobPersistence object."
::= { 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. Furthermore, when implemented as with any MIB data, the
agent SHALL return these values when the reason applies and
SHALL NOT return them when the reason no longer applies whether
the value of the job's jmJobState object changed or not. When
the agent cannot provide a reason for the current state of the
job, the agent SHALL set the value of the jmJobStateReasons1
object and jobStateReasonsN attributes to 0."
REFERENCE
"The jobStateReasonsN (N=2..4) attributes provide further
additional information about the job's current state."
::= { 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 being
processed before this job has completed being processed
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)."
::= { jmJobEntry 4 }
jmJobKOctetsRequested OBJECT-TYPE
SYNTAX Integer32(-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Bergman, Hastings, Isaacson, Lewis [Page 81]
Job Monitoring MIB, V0.85 Aug 8, 1997
"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
SHALL be represented as '0', 1-1024 octets SHALL be represented
as '1', 1025-2048 SHALL be 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."
::= { jmJobEntry 5 }
jmJobKOctetsProcessed OBJECT-TYPE
SYNTAX Integer32(-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current number of octets processed by the server or device
measured in units of K (1024) octets. The agent SHALL round the
actual number of octets processed up to the next higher K. Thus
0 octets SHALL be represented as '0', 1-1024 octets SHALL be
represented as '1', 1025-2048 octets SHALL be '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 jmJobKOctetsRequested
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
jmJobKOctetsRequested 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
jmJobKOctetsRequested 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."
::= { jmJobEntry 6 }
Bergman, Hastings, Isaacson, Lewis [Page 82]
Job Monitoring MIB, V0.85 Aug 8, 1997
jmJobImpressionsRequested OBJECT-TYPE
SYNTAX Integer32(-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total size in number of impressions of the document(s)
being requested by this job to produce.
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."
::= { jmJobEntry 7 }
jmJobImpressionsCompleted OBJECT-TYPE
SYNTAX Integer32(-2..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current 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.
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
jmJobImpressionsRequested 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 jmJobImpressionsRequested object.
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
jmJobImpressionsRequested 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."
::= { jmJobEntry 8 }
jmJobOwner OBJECT-TYPE
Bergman, Hastings, Isaacson, Lewis [Page 83]
Job Monitoring MIB, V0.85 Aug 8, 1997
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 insure that the name is
unique to the network that is visible to the client and target
device.
This value SHOULD be the authenticated name of the user
submitting the job."
REFERENCE
"See the OBJECT compliance macro for the minimum maximum length
required for conformance."
::= { jmJobEntry 9 }
-- The Attribute Group (MANDATORY)
-- The jmAttributeGroup consists entirely of the jmAttributeTable.
--
-- Implementation of the two 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."
REFERENCE
"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 }
Bergman, Hastings, Isaacson, Lewis [Page 84]
Job Monitoring MIB, V0.85 Aug 8, 1997
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 jmJobTable 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."
REFERENCE
"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),
Bergman, Hastings, Isaacson, Lewis [Page 85]
Job Monitoring MIB, V0.85 Aug 8, 1997
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 }
Bergman, Hastings, Isaacson, Lewis [Page 86]
Job Monitoring MIB, V0.85 Aug 8, 1997
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."
::= { jmAttributeEntry 3 }
Bergman, Hastings, Isaacson, Lewis [Page 87]
Job Monitoring MIB, V0.85 Aug 8, 1997
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."
::= { jmAttributeEntry 4 }
Bergman, Hastings, Isaacson, Lewis [Page 88]
Job Monitoring MIB, V0.85 Aug 8, 1997
-- 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 }
Bergman, Hastings, Isaacson, Lewis [Page 89]
Job Monitoring MIB, V0.85 Aug 8, 1997
jmJobIDGroup OBJECT-GROUP
OBJECTS {
jmJobIDJobSetIndex, jmJobIDJobIndex }
STATUS current
DESCRIPTION
"The job ID group."
::= { jmMIBGroups 2 }
jmJobGroup OBJECT-GROUP
OBJECTS {
jmJobState, jmJobStateReasons1, jmNumberOfInterveningJobs,
jmJobKOctetsRequested, jmJobKOctetsProcessed,
jmJobImpressionsRequested, 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
Bergman, Hastings, Isaacson, Lewis [Page 90]
Job Monitoring MIB, V0.85 Aug 8, 1997
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
Table 1.
Bergman, Hastings, Isaacson, Lewis [Page 91]
Job Monitoring MIB, V0.85 Aug 8, 1997
6. APPENDIX B - Support of the Job Submission ID in Job Submission
Protocols
This appendix lists the job submission protocols that support the
concept of a job submission ID and indicates the attribute used in that
job submission protocol.
6.1 Hewlett-Packard's Printer Job Language (PJL)
Hewlett-Packard's Printer Job Language provides job-level printer
control and printer status information to applications. The PJL JOB
command is used at the beginning of a print job and can include options
applying only to that job. A PJL JOB command option has been defined to
facilitate passing the JobSubmissionID with the print job, as required
by the Job Monitoring MIB. The option is of the form:
SUBMISSIONID = "id string"
Where the "id string" is a string and SHALL be enclosed in double
quotes. The format is as described for the jmJobSubmissionID object.
The entire PJL JOB command with the optional parameter would be of the
form:
@PJL JOB SUBMISSIONID = "id string"
See "Printer Job Language Technical Reference Manual", part number 5021-
0328, from Hewlett-Packard for complete information on the PJL JOB
command and the Printer Job Language.
NOTE - Some PJL implementations wrap a banner page as a PJL job around a
job submitted by a client. In this case, there will be two job
submission ids. The outer one being the one with the banner page and
the inner one being the original user's job. The agent SHALL use the
last received job submission ID for the jmJobSubmissionID index, so that
the original user's job submission ID will be used, not the banner page
job ID.
6.2 ISO DPA
The ISO 10175 Document Printing Application (DPA) protocol specifies the
"job-client-id" attribute that allows the client to supply a text string
ID for each job.
Bergman, Hastings, Isaacson, Lewis [Page 92]
Job Monitoring MIB, V0.85 Aug 8, 1997
7. References
[char-set policy] Harald Avelstrand, "IETF Policy on Character Sets and
Language", June 1997. Latest draft: <draft-avelstrand-charset-policy-
00.txt>
[GB2312] GB 2312-1980, "Chinese People's Republic of China (PRC) mixed
one byte and two byte coded character set"
[hr-mib] P. Grillo, S. Waldbusser, "Host Resources MIB", RFC 1514,
September 1993
[iana] J. Reynolds, and J. Postel, "Assigned Numbers", STD 2, RFC 1700,
ISI, 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/
[ISO 646] ISO/IEC 646:1991, "Information technology -- ISO 7-bit coded
character set for information interchange", JTC1/SC2.
[ISO 8859] ISO/IEC 8859-1:1987, "Information technology -- 8-bit single
byte coded graphic character sets - Part 1: Latin alphabet No. 1,
JTC1/SC2."
[ISO 2022] ISO/IEC 2022:1994 - "Information technology -- Character code
structure and extension techniques", JTC1/SC2.
[ISO-10646] ISO/IEC 10646-1:1993, "Information technology -- Universal
Multiple-Octet Coded Character Set (UCS) - Part 1: Architecture and
Basic Multilingual Plane, JTC1/SC2.
[iso-dpa] ISO/IEC 10175 Document Printing Application (DPA). See
ftp://ftp.pwg.org/pub/pwg/dpa/
[ipp-model] Internet Printing Protocol (IPP), work in progress on the
IETF standards track. See draft-ietf-ipp-model-01.txt. See also
http://www.pwg.org/ipp/index.html
[JIS X0208] JIS X0208-1990, "Japanese two byte coded character set."
[mib-II] MIB-II, RFC 1213.
Bergman, Hastings, Isaacson, Lewis [Page 93]
Job Monitoring MIB, V0.85 Aug 8, 1997
[print-mib] The Printer MIB - RFC 1759, proposed IETF standard. Also an
Internet-Draft on the standards track as a draft standard: draft-ietf-
printmib-mib-info-02.txt
[req-words] S. Bradner, "Keywords for use in RFCs to Indicate
Requirement Levels", RFC 2119, March 1997.
[rfc 2130] C. Weider, C. Preston, K. Simonsen, H. Alvestrand, R.
Atkinson, M. Crispin, and P. Svanberg, "The Report of the IAB Character
Set Workshop held 29 Feb-1 March, 1997", April 1997, RFC 2130.
[SMIv2-TC] J. Case, et al. ``extual Conventions for Version 2 of the
Simple Network Management Protocol (SNMPv2)', RFC 1903, January 1996.
[tipsi] IEEE 1284.1, Transport-independent Printer System Interface
(TIPSI).
[URI-spec] Berners-Lee, T., Masinter, L., McCahill, M. , "Uniform
Resource Locators (URL)", RFC 1738, December, 1994.
[US-ASCII] Coded Character Set - 7-bit American Standard Code for
Information Interchange, ANSI X3.4-1986.
[UTF-8] F. Yergeau, "UTF-8, a transformation format of Unicode and ISO
10646", RFC 2044, October 1996.
8. Author's Addresses
Ron Bergman
Dataproducts Corp.
1757 Tapo Canyon Road
Simi Valley, CA 93063-3394
Phone: 805-578-4421
Fax: 805-578-4001
Email: rbergman@dpc.com
Tom Hastings
Xerox Corporation, ESAE-231
701 S. Aviation Blvd.
El Segundo, CA 90245
Phone: 310-333-6413
Fax: 310-333-5514
EMail: hastings@cp10.es.xerox.com
Scott A. Isaacson
Bergman, Hastings, Isaacson, Lewis [Page 94]
Job Monitoring MIB, V0.85 Aug 8, 1997
Novell, Inc.
122 E 1700 S
Provo, UT 84606
Phone: 801-861-7366
Fax: 801-861-4025
EMail: scott_isaacson@novell.com
Harry Lewis
IBM Corporation
6300 Diagonal Hwy
Boulder, CO 80301
Phone: (303) 924-5337
Fax:
Email: harryl@us.ibm.com
Send comments to the printmib WG using the Job Monitoring Project
(JMP) Mailing List: jmp@pwg.org
To learn how to subscribe, send email to: jmp-request@pwg.org
For further information, access the PWG web page under "JMP":
http://www.pwg.org/
Other Participants:
Chuck Adams - Tektronix
Jeff Barnett - IBM
Keith Carter, IBM Corporation
Jeff Copeland - QMS
Andy Davidson - Tektronix
Roger deBry - IBM
Mabry Dozier - QMS
Lee Ferrel - Canon
Steve Gebert - IBM
Robert Herriot - Sun Microsystems Inc.
Shige Kanemitsu - Kyocera
David Kellerman - Northlake Software
Rick Landau - Digital
Harry Lewis - IBM
Pete Loya - HP
Ray Lutz - Cognisys
Jay Martin - Underscore
Mike MacKay, Novell, Inc.
Bergman, Hastings, Isaacson, Lewis [Page 95]
Job Monitoring MIB, V0.85 Aug 8, 1997
Stan McConnell - Xerox
Carl-Uno Manros, Xerox, Corp.
Pat Nogay - IBM
Bob Pentecost - HP
Rob Rhoads - Intel
David Roach - Unisys
Hiroyuki Sato - Canon
Bob Setterbo - Adobe
Gail Songer, EFI
Mike Timperman - Lexmark
Randy Turner - Sharp
William Wagner - Digital Products
Jim Walker - Dazel
Chris Wellens - Interworking Labs
Rob Whittle - Novell
Don Wright - Lexmark
Lloyd Young - Lexmark
Atsushi Yuki - Kyocera
Peter Zehler, Xerox, Corp.
Bergman, Hastings, Isaacson, Lewis [Page 96]
Job Monitoring MIB, V0.85 Aug 8, 1997
9. INDEX
This index includes the textual conventions, the objects, and the
attributes. Textual conventions all start with the prefix: "JM" and
end with the suffix: "TC". Objects all starts with the prefix: "jm"
followed by the group name. Attributes are identified with enums, and
so start with any lower case letter and have no special prefix.
------
colorantConsumed, 53
colorantRequested, 53
--D---
deviceNameRequested, 44
documentCopiesCompleted, 49
documentCopiesRequested, 49
documentFormat, 46
documentFormatIndex, 46
documentName, 45
------
fileName, 45
finishing, 48
fullColorImpressionsCompleted, 51
--H---
highlightColorImpressionsCompleted, 51
------
impressionsCompletedCurrentCopy, 50
impressionsInterpreted, 50
impressionsSentToDevice, 50
impressionsSpooled, 50
--J---
jmAttributeInstanceIndex, 79
jmAttributeTypeIndex, 79
JmAttributeTypeTC, 40
jmAttributeValueAsInteger, 80
jmAttributeValueAsOctets, 81
JmBooleanTC, 34
Bergman, Hastings, Isaacson, Lewis [Page 97]
Job Monitoring MIB, V0.85 Aug 8, 1997
JmFinishingTC, 31
jmGeneralAttributePersistence, 69
jmGeneralJobPersistence, 69
jmGeneralJobSetIndex, 67
jmGeneralJobSetName, 70
jmGeneralNewestActiveJobIndex, 68
jmGeneralNumberOfActiveJobs, 68
jmGeneralOldestActiveJobIndex, 68
jmJobIDJobIndex, 72
jmJobIDJobSetIndex, 72
jmJobImpressionsCompleted, 76
jmJobImpressionsRequested, 76
jmJobIndex, 73
jmJobKOctetsProcessed, 75
jmJobKOctetsRequested, 75
jmJobOwner, 77
JmJobServiceTypesTC, 56
JmJobSourcePlatformTypeTC, 30
jmJobState, 74
jmJobStateReasons1, 74
JmJobStateReasons1TC, 58
JmJobStateReasons2TC, 62
JmJobStateReasons3TC, 65
JmJobStateReasons4TC, 66
JmJobStateTC, 38
JmJobStringTC, 29
jmJobSubmissionID, 71
JmJobSubmissionTypeTC, 36
JmMediumTypeTC, 34
jmNumberOfInterveningJobs, 75
JmPrinterResolutionTC, 33
JmPrintQualityTC, 32
JmTimeStampTC, 30
JmTonerEconomyTC, 33
JmUTF8StringTC, 29
jobAccountName, 42
jobCodedCharSet, 42
jobComment, 46
jobCompletedTime, 54
jobCopiesCompleted, 49
jobCopiesRequested, 49
jobHold, 47
jobHoldUntil, 47
jobKOctetsTransferred, 50
jobName, 43
jobOriginatingHost, 44
jobPriority, 47
jobProcessAfterDateAndTime, 47
Bergman, Hastings, Isaacson, Lewis [Page 98]
Job Monitoring MIB, V0.85 Aug 8, 1997
jobProcessingCPUTime, 55
jobServiceTypes, 43
jobSourceChannelIndex, 44
jobSourcePlatformType, 44
jobStartedBeingHeldTime, 54
jobStartedProcessingTime, 54
jobStateReasons2, 41
jobStateReasons3, 41
jobStateReasons4, 41
jobSubmissionTime, 54
jobSubmissionToServerTime, 54
--M---
mediumConsumed, 53
mediumRequested, 53
--N---
numberOfDocuments, 45
--O---
other, 41
outputBin, 47
------
pagesCompleted, 51
pagesCompletedCurrentCopy, 52
pagesRequested, 51
physicalDevice, 45
printerResolutionRequested, 48
printerResolutionUsed, 48
printQualityRequested, 48
printQualityUsed, 48
processingMessage, 41
------
queueNameRequested, 45
------
serverAssignedJobName, 43
sheetsCompleted, 52
sheetsCompletedCurrentCopy, 52
sheetsRequested, 52
Bergman, Hastings, Isaacson, Lewis [Page 99]
Job Monitoring MIB, V0.85 Aug 8, 1997
sides, 48
submittingApplicationName, 44
submittingServerName, 44
------
tonerDensityRequested, 49
tonerDensityUsed, 49
tonerEcomonyRequested, 48
tonerEcomonyUsed, 48
Bergman, Hastings, Isaacson, Lewis [Page 100]
