(file) Return to CIM_Job.mof CVS log (file) (dir) Up to [Pegasus] / pegasus / Schemas / CIM231 / DMTF / Core

  1 marek 1.1 // Copyright (c) 2005 DMTF.  All rights reserved.
  2           // <change cr="SysDevCR00711.001" type ="change">Update of
  3           // descriptions based on Tech Edit review.</
  4           // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
  5           // qualifier values to CIM Schema.</change>
  6           // <change cr="ArchCR00089.003" type="add">Add PUnit qualifier values
  7           // to Units qualifier values.</change>
  8           // ==================================================================
  9           //  CIM_Job
 10           // ==================================================================
 11              [Abstract, Version ( "2.10.0" ), 
 12               UMLPackagePath ( "CIM::Core::CoreElements" ), 
 13               Description ( 
 14                  "A Job is a LogicalElement that represents an executing unit of "
 15                  "work, such as a script or a print job. A Job is distinct from "
 16                  "a Process in that a Job can be scheduled or queued, and its "
 17                  "execution is not limited to a single system." )]
 18           class CIM_Job : CIM_LogicalElement {
 19           
 20                 [Description ( 
 21                     "A free-form string that represents the status of the "
 22 marek 1.1           "job. The primary status is reflected in the inherited "
 23                     "OperationalStatus property. JobStatus provides "
 24                     "additional, implementation-specific details." ), 
 25                  ModelCorrespondence { 
 26                     "CIM_ManagedSystemElement.OperationalStatus" }]
 27              string JobStatus;
 28           
 29                 [Description ( 
 30                     "The time that the Job was submitted to execute. A value "
 31                     "of all zeroes indicates that the owning element is not "
 32                     "capable of reporting a date and time. Therefore, the "
 33                     "ScheduledStartTime and StartTime are reported as "
 34                     "intervals relative to the time their values are "
 35                     "requested." )]
 36              datetime TimeSubmitted;
 37           
 38                 [Deprecated { "CIM_Job.RunMonth", "CIM_Job.RunDay", 
 39                     "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval" }, 
 40                  Write, Description ( 
 41                     "The time that the current Job is scheduled to start. "
 42                     "This time can be represented by the actual date and "
 43 marek 1.1           "time, or an interval relative to the time that this "
 44                     "property is requested. A value of all zeroes indicates "
 45                     "that the Job is already executing. The property is "
 46                     "deprecated in lieu of the more expressive scheduling "
 47                     "properties, RunMonth, RunDay, RunDayOfWeek, and "
 48                     "RunStartInterval." )]
 49              datetime ScheduledStartTime;
 50           
 51                 [Description ( 
 52                     "The time that the Job was actually started. This time "
 53                     "can be represented by an actual date and time, or by an "
 54                     "interval relative to the time that this property is "
 55                     "requested. Note that this property is also present in "
 56                     "the JobProcessingStatistics class. This class is "
 57                     "necessary to capture the processing information for "
 58                     "recurring Jobs, because only the \'last\' run time can "
 59                     "be stored in this single-valued property." )]
 60              datetime StartTime;
 61           
 62                 [Description ( 
 63                     "The time interval that the Job has been executing or the "
 64 marek 1.1           "total execution time if the Job is complete. Note that "
 65                     "this property is also present in the "
 66                     "JobProcessingStatistics class. This class is necessary "
 67                     "to capture the processing information for recurring "
 68                     "Jobs, because only the \'last\' run time can be stored "
 69                     "in this single-valued property." )]
 70              datetime ElapsedTime;
 71           
 72                 [Write, Description ( 
 73                     "The number of times that the Job should be run. A value "
 74                     "of 1 indicates that the Job is not recurring, while any "
 75                     "non-zero value indicates a limit to the number of times "
 76                     "that the Job will recur. Zero indicates that there is no "
 77                     "limit to the number of times that the Job can be "
 78                     "processed, but that it is terminated either after the "
 79                     "UntilTime or by manual intervention. By default, a Job "
 80                     "is processed once." )]
 81              uint32 JobRunTimes = 1;
 82           
 83                 [Write, Description ( 
 84                     "The month during which the Job should be processed. "
 85 marek 1.1           "Specify 0 for January, 1 for February, and so on." ), 
 86                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", 
 87                     "10", "11" }, 
 88                  Values { "January", "February", "March", "April", "May", 
 89                     "June", "July", "August", "September", "October", 
 90                     "November", "December" }, 
 91                  ModelCorrespondence { "CIM_Job.RunDay", 
 92                     "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval" }]
 93              uint8 RunMonth;
 94           
 95                 [Write, Description ( 
 96                     "The day in the month on which the Job should be "
 97                     "processed. There are two different interpretations for "
 98                     "this property, depending on the value of DayOfWeek. In "
 99                     "one case, RunDay defines the day-in-month on which the "
100                     "Job is processed. This interpretation is used when the "
101                     "DayOfWeek is 0. A positive or negative integer indicates "
102                     "whether the RunDay should be calculated from the "
103                     "beginning or end of the month. For example, 5 indicates "
104                     "the fifth day in the RunMonth and -1 indicates the last "
105                     "day in the RunMonth. \n"
106 marek 1.1           "\n"
107                     "When RunDayOfWeek is not 0, RunDay is the day-in-month "
108                     "on which the Job is processed, defined in conjunction "
109                     "with RunDayOfWeek. For example, if RunDay is 15 and "
110                     "RunDayOfWeek is Saturday, then the Job is processed on "
111                     "the first Saturday on or after the 15th day in the "
112                     "RunMonth (for example, the third Saturday in the month). "
113                     "If RunDay is 20 and RunDayOfWeek is -Saturday, then this "
114                     "indicates the first Saturday on or before the 20th day "
115                     "in the RunMonth. If RunDay is -1 and RunDayOfWeek is "
116                     "-Sunday, then this indicates the last Sunday in the "
117                     "RunMonth." ), 
118                  MinValue ( -31 ), 
119                  MaxValue ( 31 ), 
120                  ModelCorrespondence { "CIM_Job.RunMonth", 
121                     "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval" }]
122              sint8 RunDay;
123           
124                 [Write, Description ( 
125                     "A positive or negative integer used in conjunction with "
126                     "RunDay to indicate the day of the week on which the Job "
127 marek 1.1           "is processed. RunDayOfWeek is set to 0 to indicate an "
128                     "exact day of the month, such as March 1. A positive "
129                     "integer (representing Sunday, Monday, ..., Saturday) "
130                     "means that the day of week is found on or after the "
131                     "specified RunDay. A negative integer (representing "
132                     "-Sunday, -Monday, ..., -Saturday) means that the day of "
133                     "week is found on or BEFORE the RunDay." ), 
134                  ValueMap { "-7", "-6", "-5", "-4", "-3", "-2", "-1", "0", 
135                     "1", "2", "3", "4", "5", "6", "7" }, 
136                  Values { "-Saturday", "-Friday", "-Thursday", "-Wednesday", 
137                     "-Tuesday", "-Monday", "-Sunday", "ExactDayOfMonth", 
138                     "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", 
139                     "Friday", "Saturday" }, 
140                  ModelCorrespondence { "CIM_Job.RunMonth", "CIM_Job.RunDay", 
141                     "CIM_Job.RunStartInterval" }]
142              sint8 RunDayOfWeek;
143           
144                 [Write, Description ( 
145                     "The time interval after midnight when the Job should be "
146                     "processed. For example, \n"
147                     "00000000020000.000000:000 \n"
148 marek 1.1           "indicates that the Job should be run on or after two "
149                     "o\'clock, local time or UTC time (distinguished using "
150                     "the LocalOrUtcTime property." ), 
151                  ModelCorrespondence { "CIM_Job.RunMonth", "CIM_Job.RunDay", 
152                     "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval" }]
153              datetime RunStartInterval;
154           
155                 [Write, Description ( 
156                     "This property indicates whether the times represented in "
157                     "the RunStartInterval and UntilTime properties represent "
158                     "local times or UTC times. Time values are synchronized "
159                     "worldwide by using the enumeration value 2, \"UTC Time\"." ), 
160                  ValueMap { "1", "2" }, 
161                  Values { "Local Time", "UTC Time" }]
162              uint16 LocalOrUtcTime;
163           
164                 [Write, Description ( 
165                     "The time after which the Job is invalid or should be "
166                     "stopped. This time can be represented by an actual date "
167                     "and time, or by an interval relative to the time that "
168                     "this property is requested. A value of all nines "
169 marek 1.1           "indicates that the Job can run indefinitely." ), 
170                  ModelCorrespondence { "CIM_Job.LocalOrUtcTime" }]
171              datetime UntilTime;
172           
173                 [Write, Description ( 
174                     "The User who is to be notified upon the Job completion or failure."
175                      )]
176              string Notify;
177           
178                 [Description ( 
179                     "The User that submitted the Job, or the Service or "
180                     "method name that caused the job to be created." ), 
181                  ModelCorrespondence { "CIM_OwningJobElement" }]
182              string Owner;
183           
184                 [Write, Description ( 
185                     "Indicates the urgency or importance of execution of the "
186                     "Job. The lower the number, the higher the priority. Note "
187                     "that this property is also present in the "
188                     "JobProcessingStatistics class. This class is necessary "
189                     "to capture the setting information that would influence "
190 marek 1.1           "the results of a job." )]
191              uint32 Priority;
192           
193                 [Description ( 
194                     "The percentage of the job that has completed at the time "
195                     "that this value is requested. Note that this property is "
196                     "also present in the JobProcessingStatistics class. This "
197                     "class is necessary to capture the processing information "
198                     "for recurring Jobs, because only the \'last\' run data "
199                     "can be stored in this single-valued property. \n"
200                     "Note that the value 101 is undefined and will be not be "
201                     "allowed in the next major revision of the specification." ), 
202                  Units ( "Percent" ), 
203                  MinValue ( 0 ), 
204                  MaxValue ( 101 ), 
205                  PUnit ( "percent" )]
206              uint16 PercentComplete;
207           
208                 [Write, Description ( 
209                     "Indicates whether or not the job should be automatically "
210                     "deleted upon completion. Note that the \'completion\' of "
211 marek 1.1           "a recurring job is defined by its JobRunTimes or "
212                     "UntilTime properties, or when the Job is terminated by "
213                     "manual intervention. If this property is set to false "
214                     "and the job completes, then the extrinsic method "
215                     "DeleteInstance must be used to delete the job instead of "
216                     "updating this property." )]
217              boolean DeleteOnCompletion;
218           
219                 [Description ( 
220                     "A vendor-specific error code. The value must be set to "
221                     "zero if the Job completed without error. Note that this "
222                     "property is also present in the JobProcessingStatistics "
223                     "class. This class is necessary to capture the processing "
224                     "information for recurring Jobs, because only the \'last\' "
225                     "run error can be stored in this single-valued property." ), 
226                  ModelCorrespondence { "CIM_Job.ErrorDescription" }]
227              uint16 ErrorCode;
228           
229                 [Description ( 
230                     "A free-form string that contains the vendor error "
231                     "description. Note that this property is also present in "
232 marek 1.1           "the JobProcessingStatistics class. This class is "
233                     "necessary to capture the processing information for "
234                     "recurring Jobs, because only the \'last\' run error can "
235                     "be stored in this single-valued property." ), 
236                  ModelCorrespondence { "CIM_Job.ErrorCode" }]
237              string ErrorDescription;
238           
239                 [Description ( 
240                     "Describes the recovery action to be taken for an "
241                     "unsuccessfully run Job. The possible values are: \n"
242                     "0 = \"Unknown\", meaning it is unknown as to what "
243                     "recovery action to take \n"
244                     "1 = \"Other\", indicating that the recovery action will "
245                     "be specified in the OtherRecoveryAction property \n"
246                     "2 = \"Do Not Continue\", meaning stop the execution of "
247                     "the job and appropriately update its status \n"
248                     "3 = \"Continue With Next Job\", meaning continue with "
249                     "the next job in the queue \n"
250                     "4 = \"Re-run Job\", indicating that the job should be "
251                     "re-run \n"
252                     "5 = \"Run Recovery Job\", meaning run the Job associated "
253 marek 1.1           "using the RecoveryJob relationship. Note that the "
254                     "recovery Job must already be in the queue from which it "
255                     "will run." ), 
256                  ValueMap { "0", "1", "2", "3", "4", "5" }, 
257                  Values { "Unknown", "Other", "Do Not Continue", 
258                     "Continue With Next Job", "Re-run Job", "Run Recovery Job" }, 
259                  ModelCorrespondence { "CIM_Job.OtherRecoveryAction" }]
260              uint16 RecoveryAction;
261           
262                 [Description ( 
263                     "A string describing the recovery action when the "
264                     "RecoveryAction property of the instance is 1 (\"Other\")." ), 
265                  ModelCorrespondence { "CIM_Job.RecoveryAction" }]
266              string OtherRecoveryAction;
267           
268           
269                 [Deprecated { "CIM_ConcreteJob.RequestStateChange()" }, 
270                  Description ( 
271                     "KillJob is being deprecated because there is no "
272                     "distinction made between an orderly shutdown and an "
273                     "immediate kill. CIM_ConcreteJob.RequestStateChange() "
274 marek 1.1           "provides \'Terminate\' and \'Kill\' options to allow "
275                     "this distinction. \n"
276                     "A method to kill this job and any underlying processes, "
277                     "and to remove any \'dangling\' associations." ), 
278                  ValueMap { "0", "1", "2", "3", "4", "6", "7", "..", 
279                     "32768..65535" }, 
280                  Values { "Success", "Not Supported", "Unknown", "Timeout", 
281                     "Failed", "Access Denied", "Not Found", "DMTF Reserved", 
282                     "Vendor Specific" }]
283              uint32 KillJob(
284                    [IN, Description ( 
285                        "Indicates whether or not the Job should be "
286                        "automatically deleted upon termination. This "
287                        "parameter takes precedence over the property, "
288                        "DeleteOnCompletion." )]
289                 boolean DeleteOnKill);
290           
291           };

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2