Class CIM_ConcreteJob
CIM_ManagedElement
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_Job
CIM_ConcreteJob
class CIM_ConcreteJob
- extends CIM_Job
General Information:
A concrete version of Job. This class
represents a generic and instantiable unit of work, such as a batch or a print
job.
Qualifiers:
-------------
Deprecated={CIM_ConcreteJob.GetErrors}
Version=2.31.1
UMLPackagePath=CIM::Core::CoreElements
Supported Fields
Summary |
string
|
OtherRecoveryAction
A string describing the recovery action when the RecoveryAction
property of the instance is 1 ("Other").
|
uint16
|
RecoveryAction
Describes the recovery action to be taken for an unsuccessfully
run Job . . .
|
string
|
ErrorDescription
A free-form string that contains the vendor error description .
. .
|
uint16
|
ErrorCode A
vendor-specific error code . . .
|
boolean
|
DeleteOnCompletion
Indicates whether or not the job should be automatically
deleted upon completion . . .
|
uint16
|
PercentComplete
The percentage of the job that has completed at the time that
this value is requested . . .
|
uint32
|
Priority Indicates the
urgency or importance of execution of the Job . . .
|
string
|
Owner The User that
submitted the Job, or the Service or method name that caused the job to be
created.
|
string
|
Notify The User who is
to be notified upon the Job completion or failure.
|
datetime
|
UntilTime The time
after which the Job is invalid or should be stopped . . .
|
uint16
|
LocalOrUtcTime
This property indicates whether the times represented in the
RunStartInterval and UntilTime properties represent local times or UTC
times . . .
|
datetime
|
RunStartInterval
The time interval after midnight when the Job should be
processed . . .
|
sint8
|
RunDayOfWeek A
positive or negative integer used in conjunction with RunDay to indicate
the day of the week on which the Job is processed . . .
|
sint8
|
RunDay The day in the
month on which the Job should be processed . . .
|
uint8
|
RunMonth The month
during which the Job should be processed . . .
|
uint32
|
JobRunTimes The
number of times that the Job should be run . . .
|
datetime
|
ElapsedTime The
time interval that the Job has been executing or the total execution time
if the Job is complete . . .
|
datetime
|
StartTime The time
that the Job was actually started . . .
|
datetime
|
ScheduledStartTime
The time that the current Job is scheduled to start . .
.
|
datetime
|
TimeSubmitted The
time that the Job was submitted to execute . . .
|
string
|
JobStatus A free-form
string that represents the status of the job . . .
|
uint16
|
PrimaryStatus
PrimaryStatus provides a high level status value, intended to
align with Red-Yellow-Green type representation of status . . .
|
uint16
|
OperatingStatus
OperatingStatus provides a current status value for the
operational condition of the element and can be used for providing more
detail with respect to the value of EnabledState . . .
|
uint16
|
DetailedStatus
DetailedStatus compliments PrimaryStatus with additional status
detail . . .
|
uint16
|
CommunicationStatus
CommunicationStatus indicates the ability of the
instrumentation to communicate with the underlying ManagedElement . .
.
|
uint16
|
HealthState
Indicates the current health of the element . . .
|
string
|
Status A string
indicating the current status of the object . . .
|
string[]
|
StatusDescriptions
Strings describing the various OperationalStatus array values .
. .
|
uint16[]
|
OperationalStatus
Indicates the current statuses of the element . . .
|
datetime
|
InstallDate A
datetime value that indicates when the object was installed . . .
|
string
|
Caption The Caption
property is a short textual description (one- line string) of the
object.
|
string
|
Description The
Description property provides a textual description of the object.
|
string
|
ElementName A
user-friendly name for the object . . .
|
string
|
InstanceID Within the scope of the instantiating Namespace,
InstanceID opaquely and uniquely identifies an instance of this class . .
.
|
string
|
Name The user-friendly
name for this instance of a Job . . .
|
uint16
|
JobState JobState is
an integer enumeration that indicates the operational state of a Job . .
.
|
datetime
|
TimeOfLastStateChange The
date or time when the state of the Job last changed . . .
|
datetime
|
TimeBeforeRemoval
The amount of time that the Job is retained after it has
finished executing, either succeeding or failing in that execution . .
.
|
Methods Summary |
|
Get(Instance) Gets the
representation of the instance
|
|
Pull(EnumerationContext,
MaxElements) Pulls instances of this class, following an
Enumerate operation
|
|
Enumerate()
Enumerates the instances of this class
|
|
Release(EnumerationContext)
Releases an enumeration context
|
OtherRecoveryAction
public string OtherRecoveryAction
- General Information:
A string describing the recovery action
when the RecoveryAction property of the instance is 1
("Other").
Qualifiers:
-------------
ModelCorrespondence={CIM_Job.RecoveryAction}
MaxLen=256
RecoveryAction
public uint16 RecoveryAction
- General Information:
Describes the recovery action to be taken
for an unsuccessfully run Job. The possible values are:
0 = "Unknown",
meaning it is unknown as to what recovery action to take
1 = "Other",
indicating that the recovery action will be specified in the
OtherRecoveryAction property
2 = "Do Not Continue", meaning stop the
execution of the job and appropriately update its status
3 = "Continue
With Next Job", meaning continue with the next job in the queue
4 =
"Re-run Job", indicating that the job should be re-run
5 = "Run Recovery
Job", meaning run the Job associated using the RecoveryJob relationship. Note
that the recovery Job must already be in the queue from which it will
run.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4,
5}
Values={Unknown, Other, Do Not Continue, Continue With Next Job, Re-run
Job, Run Recovery
Job}
ModelCorrespondence={CIM_Job.OtherRecoveryAction}
ErrorDescription
public string ErrorDescription
- General Information:
A free-form string that contains the vendor
error description. Note that this property is also present in the
JobProcessingStatistics class. This class is necessary to capture the
processing information for recurring Jobs, because only the 'last' run error
can be stored in this single-valued
property.
Qualifiers:
-------------
ModelCorrespondence={CIM_Job.ErrorCode}
MaxLen=256
ErrorCode
public uint16 ErrorCode
- General Information:
A vendor-specific error code. The value
must be set to zero if the Job completed without error. Note that this
property is also present in the JobProcessingStatistics class. This class is
necessary to capture the processing information for recurring Jobs, because
only the 'last' run error can be stored in this single-valued
property.
Qualifiers:
-------------
ModelCorrespondence={CIM_Job.ErrorDescription}
DeleteOnCompletion
public boolean DeleteOnCompletion
- General Information:
Indicates whether or not the job should be
automatically deleted upon completion. Note that the 'completion' of a
recurring job is defined by its JobRunTimes or UntilTime properties, or when
the Job is terminated by manual intervention. If this property is set to false
and the job completes, then the extrinsic method DeleteInstance must be used
to delete the job instead of updating this
property.
Qualifiers:
-------------
Write
PercentComplete
public uint16 PercentComplete
- General Information:
The percentage of the job that has
completed at the time that this value is requested. Note that this property is
also present in the JobProcessingStatistics class. This class is necessary to
capture the processing information for recurring Jobs, because only the 'last'
run data can be stored in this single-valued property.
Note that the value
101 is undefined and will be not be allowed in the next major revision of the
specification.
Qualifiers:
-------------
Units=Percent
MinValue=0
MaxValue=101
PUnit=percent
Priority
public uint32 Priority
- General Information:
Indicates the urgency or importance of
execution of the Job. The lower the number, the higher the priority. Note that
this property is also present in the JobProcessingStatistics class. This class
is necessary to capture the setting information that would influence the
results of a job.
Qualifiers:
-------------
Write
Owner
public string Owner
- General Information:
The User that submitted the Job, or the
Service or method name that caused the job to be
created.
Qualifiers:
-------------
ModelCorrespondence={CIM_OwningJobElement}
MaxLen=256
Notify
public string Notify
- General Information:
The User who is to be notified upon the Job
completion or
failure.
Qualifiers:
-------------
Write
MaxLen=256
UntilTime
public datetime UntilTime
- General Information:
The time after which the Job is invalid or
should be stopped. This time can be represented by an actual date and time, or
by an interval relative to the time that this property is requested. A value
of all nines indicates that the Job can run
indefinitely.
Qualifiers:
-------------
Write
ModelCorrespondence={CIM_Job.LocalOrUtcTime}
LocalOrUtcTime
public uint16 LocalOrUtcTime
- General Information:
This property indicates whether the times
represented in the RunStartInterval and UntilTime properties represent local
times or UTC times. Time values are synchronized worldwide by using the
enumeration value 2, "UTC
Time".
Qualifiers:
-------------
Write
ValueMap={1,
2}
Values={Local Time, UTC Time}
RunStartInterval
public datetime RunStartInterval
- General Information:
The time interval after midnight when the
Job should be processed. For example,
00000000020000.000000:000
indicates that the Job should be run on or after two o'clock, local time
or UTC time (distinguished using the LocalOrUtcTime
property.
Qualifiers:
-------------
Write
ModelCorrespondence={CIM_Job.RunMonth,
CIM_Job.RunDay, CIM_Job.RunDayOfWeek, CIM_Job.RunStartInterval}
RunDayOfWeek
public sint8 RunDayOfWeek
- General Information:
A positive or negative integer used in
conjunction with RunDay to indicate the day of the week on which the Job is
processed. RunDayOfWeek is set to 0 to indicate an exact day of the month,
such as March 1. A positive integer (representing Sunday, Monday, ...,
Saturday) means that the day of week is found on or after the specified
RunDay. A negative integer (representing -Sunday, -Monday, ..., -Saturday)
means that the day of week is found on or BEFORE the
RunDay.
Qualifiers:
-------------
Write
ValueMap={-7,
-6, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7}
Values={-Saturday, -Friday,
-Thursday, -Wednesday, -Tuesday, -Monday, -Sunday, ExactDayOfMonth, Sunday,
Monday, Tuesday, Wednesday, Thursday, Friday,
Saturday}
ModelCorrespondence={CIM_Job.RunMonth, CIM_Job.RunDay,
CIM_Job.RunStartInterval}
RunDay
public sint8 RunDay
- General Information:
The day in the month on which the Job
should be processed. There are two different interpretations for this
property, depending on the value of DayOfWeek. In one case, RunDay defines the
day-in-month on which the Job is processed. This interpretation is used when
the DayOfWeek is 0. A positive or negative integer indicates whether the
RunDay should be calculated from the beginning or end of the month. For
example, 5 indicates the fifth day in the RunMonth and -1 indicates the last
day in the RunMonth.
When RunDayOfWeek is not 0, RunDay is the
day-in-month on which the Job is processed, defined in conjunction with
RunDayOfWeek. For example, if RunDay is 15 and RunDayOfWeek is Saturday, then
the Job is processed on the first Saturday on or after the 15th day in the
RunMonth (for example, the third Saturday in the month). If RunDay is 20 and
RunDayOfWeek is -Saturday, then this indicates the first Saturday on or before
the 20th day in the RunMonth. If RunDay is -1 and RunDayOfWeek is -Sunday,
then this indicates the last Sunday in the
RunMonth.
Qualifiers:
-------------
Write
MinValue=-31
MaxValue=31
ModelCorrespondence={CIM_Job.RunMonth,
CIM_Job.RunDayOfWeek, CIM_Job.RunStartInterval}
RunMonth
public uint8 RunMonth
- General Information:
The month during which the Job should be
processed. Specify 0 for January, 1 for February, and so
on.
Qualifiers:
-------------
Write
ValueMap={0, 1, 2,
3, 4, 5, 6, 7, 8, 9, 10, 11}
Values={January, February, March, April, May,
June, July, August, September, October, November,
December}
ModelCorrespondence={CIM_Job.RunDay, CIM_Job.RunDayOfWeek,
CIM_Job.RunStartInterval}
JobRunTimes
public uint32 JobRunTimes
- General Information:
The number of times that the Job should be
run. A value of 1 indicates that the Job is not recurring, while any non-zero
value indicates a limit to the number of times that the Job will recur. Zero
indicates that there is no limit to the number of times that the Job can be
processed, but that it is terminated either after the UntilTime or by manual
intervention. By default, a Job is processed
once.
Qualifiers:
-------------
Write
ElapsedTime
public datetime ElapsedTime
- General Information:
The time interval that the Job has been
executing or the total execution time if the Job is complete. Note that this
property is also present in the JobProcessingStatistics class. This class is
necessary to capture the processing information for recurring Jobs, because
only the 'last' run time can be stored in this single-valued property.
StartTime
public datetime StartTime
- General Information:
The time that the Job was actually started.
This time can be represented by an actual date and time, or by an interval
relative to the time that this property is requested. Note that this property
is also present in the JobProcessingStatistics class. This class is necessary
to capture the processing information for recurring Jobs, because only the
'last' run time can be stored in this single-valued property.
ScheduledStartTime
public datetime ScheduledStartTime
- General Information:
The time that the current Job is scheduled
to start. This time can be represented by the actual date and time, or an
interval relative to the time that this property is requested. A value of all
zeroes indicates that the Job is already executing. The property is deprecated
in lieu of the more expressive scheduling properties, RunMonth, RunDay,
RunDayOfWeek, and
RunStartInterval.
Qualifiers:
-------------
Deprecated={CIM_Job.RunMonth,
CIM_Job.RunDay, CIM_Job.RunDayOfWeek,
CIM_Job.RunStartInterval}
Write
TimeSubmitted
public datetime TimeSubmitted
- General Information:
The time that the Job was submitted to
execute. A value of all zeroes indicates that the owning element is not
capable of reporting a date and time. Therefore, the ScheduledStartTime and
StartTime are reported as intervals relative to the time their values are
requested.
JobStatus
public string JobStatus
- General Information:
A free-form string that represents the
status of the job. The primary status is reflected in the inherited
OperationalStatus property. JobStatus provides additional,
implementation-specific
details.
Qualifiers:
-------------
ModelCorrespondence={CIM_ManagedSystemElement.OperationalStatus}
MaxLen=256
PrimaryStatus
public uint16 PrimaryStatus
- General Information:
PrimaryStatus provides a high level status
value, intended to align with Red-Yellow-Green type representation of status.
It should be used in conjunction with DetailedStatus to provide high level and
detailed health status of the ManagedElement and its subcomponents.
PrimaryStatus consists of one of the following values: Unknown, OK,
Degraded or Error. "Unknown" indicates the implementation is in general
capable of returning this property, but is unable to do so at this time.
"OK" indicates the ManagedElement is functioning normally.
"Degraded"
indicates the ManagedElement is functioning below normal.
"Error"
indicates the ManagedElement is in an Error
condition.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
.., 0x8000..}
Values={Unknown, OK, Degraded, Error, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_ManagedSystemElement.DetailedStatus,
CIM_ManagedSystemElement.HealthState}
OperatingStatus
public uint16 OperatingStatus
- General Information:
OperatingStatus provides a current status
value for the operational condition of the element and can be used for
providing more detail with respect to the value of EnabledState. It can also
provide the transitional states when an element is transitioning from one
state to another, such as when an element is transitioning between
EnabledState and RequestedState, as well as other transitional
conditions.
OperatingStatus consists of one of the following values:
Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted,
Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting.
Shutting Down, In Test
A Null return indicates the implementation
(provider) does not implement this property.
"Unknown" indicates the
implementation is in general capable of returning this property, but is unable
to do so at this time.
"None" indicates that the implementation (provider)
is capable of returning a value for this property, but not ever for this
particular piece of hardware/software or the property is intentionally not
used because it adds no meaningful information (as in the case of a property
that is intended to add additional info to another property).
"Servicing"
describes an element being configured, maintained, cleaned, or otherwise
administered.
"Starting" describes an element being initialized.
"Stopping" describes an element being brought to an orderly stop.
"Stopped" and "Aborted" are similar, although the former implies a clean
and orderly stop, while the latter implies an abrupt stop where the state and
configuration of the element might need to be updated.
"Dormant" indicates
that the element is inactive or quiesced.
"Completed" indicates that the
element has completed its operation. This value should be combined with either
OK, Error, or Degraded in the PrimaryStatus so that a client can tell if the
complete operation Completed with OK (passed), Completed with Error (failed),
or Completed with Degraded (the operation finished, but it did not complete OK
or did not report an error).
"Migrating" element is being moved between
host elements.
"Immigrating" element is being moved to new host element.
"Emigrating" element is being moved away from host element.
"Shutting
Down" describes an element being brought to an abrupt stop.
"In Test"
element is performing test functions.
"Transitioning" describes an element
that is between states, that is, it is not fully available in either its
previous state or its next state. This value should be used if other values
indicating a transition to a specific state are not applicable.
"In
Service" describes an element that is in service and
operational.
Qualifiers:
-------------
ValueMap={0, 1, 2,
3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, ..,
0x8000..}
Values={Unknown, Not Available, Servicing, Starting, Stopping,
Stopped, Aborted, Dormant, Completed, Migrating, Emigrating, Immigrating,
Snapshotting, Shutting Down, In Test, Transitioning, In Service, DMTF
Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}
DetailedStatus
public uint16 DetailedStatus
- General Information:
DetailedStatus compliments PrimaryStatus
with additional status detail. It consists of one of the following values: Not
Available, No Additional Information, Stressed, Predictive Failure, Error,
Non-Recoverable Error, SupportingEntityInError. Detailed status is used to
expand upon the PrimaryStatus of the element.
A Null return indicates the
implementation (provider) does not implement this property.
"Not
Available" indicates that the implementation (provider) is capable of
returning a value for this property, but not ever for this particular piece of
hardware/software or the property is intentionally not used because it adds no
meaningful information (as in the case of a property that is intended to add
additional info to another property).
"No Additional Information"
indicates that the element is functioning normally as indicated by
PrimaryStatus = "OK".
"Stressed" indicates that the element is
functioning, but needs attention. Examples of "Stressed" states are overload,
overheated, and so on.
"Predictive Failure" indicates that an element is
functioning normally but a failure is predicted in the near future.
"Non-Recoverable Error " indicates that this element is in an error
condition that requires human intervention.
"Supporting Entity in Error"
indicates that this element might be "OK" but that another element, on which
it is dependent, is in error. An example is a network service or endpoint that
cannot function due to lower-layer networking
problems.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
4, 5, .., 0x8000..}
Values={Not Available, No Additional Information,
Stressed, Predictive Failure, Non-Recoverable Error, Supporting Entity in
Error, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.PrimaryStatus,
CIM_ManagedSystemElement.HealthState}
CommunicationStatus
public uint16 CommunicationStatus
- General Information:
CommunicationStatus indicates the ability
of the instrumentation to communicate with the underlying ManagedElement.
CommunicationStatus consists of one of the following values: Unknown, None,
Communication OK, Lost Communication, or No Contact.
A Null return
indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning
this property, but is unable to do so at this time.
"Not Available"
indicates that the implementation (provider) is capable of returning a value
for this property, but not ever for this particular piece of hardware/software
or the property is intentionally not used because it adds no meaningful
information (as in the case of a property that is intended to add additional
info to another property).
"Communication OK " indicates communication is
established with the element, but does not convey any quality of service.
"No Contact" indicates that the monitoring system has knowledge of this
element, but has never been able to establish communications with it.
"Lost Communication" indicates that the Managed Element is known to exist
and has been contacted successfully in the past, but is currently
unreachable.
Qualifiers:
-------------
ValueMap={0, 1, 2,
3, 4, .., 0x8000..}
Values={Unknown, Not Available, Communication OK, Lost
Communication, No Contact, DMTF Reserved, Vendor Reserved}
HealthState
public uint16 HealthState
- General Information:
Indicates the current health of the
element. This attribute expresses the health of this element but not
necessarily that of its subcomponents. The possible values are 0 to 30, where
5 means the element is entirely healthy and 30 means the element is completely
non-functional. The following continuum is defined:
"Non-recoverable
Error" (30) - The element has completely failed, and recovery is not possible.
All functionality provided by this element has been lost.
"Critical
Failure" (25) - The element is non-functional and recovery might not be
possible.
"Major Failure" (20) - The element is failing. It is possible
that some or all of the functionality of this component is degraded or not
working.
"Minor Failure" (15) - All functionality is available but some
might be degraded.
"Degraded/Warning" (10) - The element is in working
order and all functionality is provided. However, the element is not working
to the best of its abilities. For example, the element might not be operating
at optimal performance or it might be reporting recoverable errors.
"OK"
(5) - The element is fully functional and is operating within normal
operational parameters and without error.
"Unknown" (0) - The
implementation cannot report on HealthState at this time.
DMTF has
reserved the unused portion of the continuum for additional HealthStates in
the future.
Qualifiers:
-------------
ValueMap={0, 5, 10,
15, 20, 25, 30, .., 32768..65535}
Values={Unknown, OK, Degraded/Warning,
Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF
Reserved, Vendor Specific}
Status
public string Status
- General Information:
A string indicating the current status of
the object. Various operational and non-operational statuses are defined. This
property is deprecated in lieu of OperationalStatus, which includes the same
semantics in its enumeration. This change is made for 3 reasons:
1) Status
is more correctly defined as an array. This definition overcomes the
limitation of describing status using a single value, when it is really a
multi-valued property (for example, an element might be OK AND Stopped.
2)
A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
3) The change to a uint16 data type was discussed when CIM V2.0 was
defined. However, existing V1.0 implementations used the string property and
did not want to modify their code. Therefore, Status was grandfathered into
the Schema. Use of the deprecated qualifier allows the maintenance of the
existing property, but also permits an improved definition using
OperationalStatus.
Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}
ValueMap={OK,
Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed,
NonRecover, No Contact, Lost Comm, Stopped}
MaxLen=10
StatusDescriptions
public string[] StatusDescriptions
- General Information:
Strings describing the various
OperationalStatus array values. For example, if "Stopping" is the value
assigned to OperationalStatus, then this property may contain an explanation
as to why an object is being stopped. Note that entries in this array are
correlated with those at the same array index in
OperationalStatus.
Qualifiers:
-------------
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.OperationalStatus}
MaxLen=256
OperationalStatus
public uint16[] OperationalStatus
- General Information:
Indicates the current statuses of the
element. Various operational statuses are defined. Many of the enumeration's
values are self-explanatory. However, a few are not and are described here in
more detail.
"Stressed" indicates that the element is functioning, but
needs attention. Examples of "Stressed" states are overload, overheated, and
so on.
"Predictive Failure" indicates that an element is functioning
nominally but predicting a failure in the near future.
"In Service"
describes an element being configured, maintained, cleaned, or otherwise
administered.
"No Contact" indicates that the monitoring system has
knowledge of this element, but has never been able to establish communications
with it.
"Lost Communication" indicates that the ManagedSystem Element is
known to exist and has been contacted successfully in the past, but is
currently unreachable.
"Stopped" and "Aborted" are similar, although the
former implies a clean and orderly stop, while the latter implies an abrupt
stop where the state and configuration of the element might need to be
updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" indicates that this element might be "OK" but
that another element, on which it is dependent, is in error. An example is a
network service or endpoint that cannot function due to lower-layer networking
problems.
"Completed" indicates that the element has completed its
operation. This value should be combined with either OK, Error, or Degraded so
that a client can tell if the complete operation Completed with OK (passed),
Completed with Error (failed), or Completed with Degraded (the operation
finished, but it did not complete OK or did not report an error).
"Power
Mode" indicates that the element has additional power model information
contained in the Associated PowerManagementService association.
"Relocating" indicates the element is being
relocated.
OperationalStatus replaces the Status property on
ManagedSystemElement to provide a consistent approach to enumerations, to
address implementation needs for an array property, and to provide a migration
path from today's environment to the future. This change was not made earlier
because it required the deprecated qualifier. Due to the widespread use of the
existing Status property in management applications, it is strongly
recommended that providers or instrumentation provide both the Status and
OperationalStatus properties. Further, the first value of OperationalStatus
should contain the primary status for the element. When instrumented, Status
(because it is single-valued) should also provide the primary status of the
element.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ..,
0x8000..}
Values={Unknown, Other, OK, Degraded, Stressed, Predictive
Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In
Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity
in Error, Completed, Power Mode, Relocating, DMTF Reserved, Vendor
Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}
InstallDate
public datetime InstallDate
- General Information:
A datetime value that indicates when the
object was installed. Lack of a value does not indicate that the object is not
installed.
Qualifiers:
-------------
MappingStrings={MIF.DMTF|ComponentID|001.5}
Caption
public string Caption
- General Information:
The Caption property is a short textual
description (one- line string) of the
object.
Qualifiers:
-------------
MaxLen=64
Description
public string Description
- General Information:
The Description property provides a textual
description of the
object.
Qualifiers:
-------------
MaxLen=256
ElementName
public string ElementName
- General Information:
A user-friendly name for the object. This
property allows each instance to define a user-friendly name in addition to
its key properties, identity data, and description information.
Note that
the Name property of ManagedSystemElement is also defined as a user-friendly
name. But, it is often subclassed to be a Key. It is not reasonable that the
same property can convey both identity and a user-friendly name, without
inconsistencies. Where Name exists and is not a Key (such as for instances of
LogicalDevice), the same information can be present in both the Name and
ElementName properties. Note that if there is an associated instance of
CIM_EnabledLogicalElementCapabilities, restrictions on this properties may
exist as defined in ElementNameMask and MaxElementNameLen properties defined
in that
class.
Qualifiers:
-------------
MaxLen=256
InstanceID
public string InstanceID
- General Information:
Within the scope of the instantiating
Namespace, InstanceID opaquely and uniquely identifies an instance of this
class. In order to ensure uniqueness within the NameSpace, the value of
InstanceID SHOULD be constructed using the following 'preferred' algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID>
are separated by a colon ':', and where <OrgID> must include a
copyrighted, trademarked or otherwise unique name that is owned by the
business entity that is creating or defining the InstanceID, or that is a
registered ID that is assigned to the business entity by a recognized global
authority. (This requirement is similar to the <Schema Name>_<Class
Name> structure of Schema class names.) In addition, to ensure uniqueness
<OrgID> must not contain a colon (':'). When using this algorithm, the
first colon to appear in InstanceID must appear between <OrgID> and
<LocalID>.
<LocalID> is chosen by the business entity and
should not be re-used to identify different underlying (real-world) elements.
If the above 'preferred' algorithm is not used, the defining entity must
assure that the resulting InstanceID is not re-used across any InstanceIDs
produced by this or other providers for the NameSpace of this instance.
For DMTF defined instances, the 'preferred' algorithm must be used with
the <OrgID> set to
'CIM'.
Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=256
Name
public string Name
- General Information:
The user-friendly name for this instance of
a Job. In addition, the user-friendly name can be used as a property for a
search or query. (Note: Name does not have to be unique within a
namespace.)
Qualifiers:
-------------
Required
Override=Name
MaxLen=256
JobState
public uint16 JobState
- General Information:
JobState is an integer enumeration that
indicates the operational state of a Job. It can also indicate transitions
between these states, for example, 'Shutting Down' and 'Starting'. Following
is a brief description of the states:
New (2) indicates that the job has
never been started.
Starting (3) indicates that the job is moving from the
'New', 'Suspended', or 'Service' states into the 'Running' state.
Running
(4) indicates that the Job is running.
Suspended (5) indicates that the
Job is stopped, but can be restarted in a seamless manner.
Shutting Down
(6) indicates that the job is moving to a 'Completed', 'Terminated', or
'Killed' state.
Completed (7) indicates that the job has completed
normally.
Terminated (8) indicates that the job has been stopped by a
'Terminate' state change request. The job and all its underlying processes are
ended and can be restarted (this is job-specific) only as a new job.
Killed (9) indicates that the job has been stopped by a 'Kill' state
change request. Underlying processes might have been left running, and cleanup
might be required to free up resources.
Exception (10) indicates that the
Job is in an abnormal state that might be indicative of an error condition.
Actual status might be displayed though job-specific objects.
Service (11)
indicates that the Job is in a vendor-specific state that supports problem
discovery, or resolution, or both.
Query pending (12) waiting for a client
to resolve a query
Qualifiers:
-------------
ValueMap={2,
3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13..32767, 32768..65535}
Values={New,
Starting, Running, Suspended, Shutting Down, Completed, Terminated, Killed,
Exception, Service, Query Pending, DMTF Reserved, Vendor Reserved}
TimeOfLastStateChange
public datetime TimeOfLastStateChange
- General Information:
The date or time when the state of the Job
last changed. If the state of the Job has not changed and this property is
populated, then it must be set to a 0 interval value. If a state change was
requested, but rejected or not yet processed, the property must not be
updated.
TimeBeforeRemoval
public datetime TimeBeforeRemoval
- General Information:
The amount of time that the Job is retained
after it has finished executing, either succeeding or failing in that
execution. The job must remain in existence for some period of time regardless
of the value of the DeleteOnCompletion property.
The default is five
minutes.
Qualifiers:
-------------
Required
Write
Get
public Get([OUT]CIM_ConcreteJob Instance)
- Permission Information:
No permissions defined
General
Information:
Gets the representation of the instance
Pull
public Pull([IN]String EnumerationContext, [IN]String MaxElements)
- Permission Information:
All users permitted to use method, only
instances to whom the user has permissions will be returned
General
Information:
Pulls instances of this class, following an Enumerate
operation
Enumerate
public Enumerate()
- Permission Information:
All users permitted to use
method
General Information:
Enumerates the instances of this
class
Release
public Release([IN]String EnumerationContext)
- Permission Information:
All users permitted to use
method
General Information:
Releases an enumeration
context