Job Control Profile 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 26 Document Number: DCIM1034 Document Type: Specification Document Status: Published Document Language: E Date: 2012-12-30 27 Version: 1.3.
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 THIS PROFILE IS FOR INFORMATIONAL PURPOSES ONLY, AND MAY CONTAIN TYPOGRAPHICAL ERRORS AND TECHNICAL INACCURACIES. THE CONTENT IS PROVIDED AS IS, WITHOUT EXPRESS OR IMPLIED WARRANTIES OF ANY KIND.
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 CONTENTS 1 2 3 4 5 6 7 8 9 10 11 Scope .................................................................................................................................................... 5 Normative References ........................................................................................................................... 5 Terms and Definitions ..........................................................
96 Figures 97 98 99 100 101 102 Figure 1 – Job Control Profile: Class Diagram.............................................................................................. 9 Figure 2 – Job Workflow for RAID Attributes .............................................................................................. 11 Figure 3 – Job Workflow for IDRAC Card Attributes ................................................................................... 12 Figure 4 – Configuration Job Timing Diagram ............
Job Control Profile 131 132 1 Scope 133 134 The Dell Job Control Profile extends the management capabilities of referencing profiles by adding the capability to create, schedule, track, and manage jobs that represent platform management operations. 135 2 136 Refer to the following documents for more information. 137 138 NOTE: For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.
161 162 163 3.1 164 165 166 3.2 167 168 3.3 169 170 3.4 171 172 3.5 173 174 3.6 175 176 3.7 177 178 179 3.8 180 181 182 3.9 Conditional – Indicates requirements to be followed strictly in order to conform to the document when the specified conditions are met. Mandatory – Indicates requirements to be followed strictly in order to conform to the document and from which no deviation is permitted. May – Indicates a course of action permissible within the limits of the document.
183 184 185 3.10 186 187 188 3.11 189 190 3.12 191 192 3.13 193 194 195 3.14 196 197 198 3.15 199 200 201 3.16 202 3.17 203 204 GET – Refers to WS-MAN GET operation as defined in Section 7.3 of DSP00226_V1.1 and Section 7.1 of DSP0227_V1.0 205 4 206 207 4.1 208 209 210 4.2 211 212 4.3 213 214 215 4.4 216 5 217 Profile Name: Job Control 218 Version: 1.2.
220 CIM Schema Version: 2.26 Experimental 221 Central Class: DCIM_JobService 222 Scoping Class: CIM_ComputerSystem 223 224 225 226 227 228 The Job Control Profile extends the management capability of the referencing profiles by adding the capability to create, schedule, track, and otherwise manage system management tasks, hereafter referred to as “jobs”. In this profile, a job is represented by an instance of a Dell subclass of CIM_ConcreteJob, DCIM_LifecycleJob.
DCIM_LCRegisteredProfile “interop” namespace “root/dcim” Implementation namespace RegisteredProfile = “Job Control” OwningEntity = “DCIM” DCIM_LCElementConformsToProfile DCIM_ JobService DCIM_LifeCycleJob 238 Figure 1 – Job Control Profile: Class Diagram 239 240 6.1 Job Types 241 242 243 Different kinds of system management tasks, such as firmware updates, reboots, configurations, and so on often take a while to complete.
260 261 the Lifecycle Controller is to perform the system reboot needed to execute update jobs, a reboot job is included in the job queue definition. 262 6.4 263 264 265 Jobs, such as firmware updates, that are created as a result of extrinsic method invocations are initially unscheduled. One or more job can be scheduled to start immediately or at a specified start time by setting up a job queue. Job queues are setup by calling the SetupJobQueue() method on the job service. 266 6.
DCIM_RAIDService. SetAttribute() SetAttributes() No Job DCIM_RAIDService. CreateTargetedConfigJob () returns 4096 (Job Created) JobStatus = Ready for Execution DCIM_JobService. CreateRebootJob () returns 0 (Successful) DCIM_JobService.
DCIM_IDRACCardService. SetAttribute() SetAttributes() No Job DCIM_IDRACCardService. CreateTargetedConfigJob () returns 4096 (Job Created) DCIM_JobService. SetupJobQueue() returns 0 (Successful) JobStatus = Ready for Execution Job Execution JobStatus = Completed Job Execution JobStatus = Completed with Errors JobStatus = Failed 303 Figure 3 – Job Workflow for IDRAC Card Attributes 304 305 306 307 Figure 4 shows the timing diagram for configuration job executions.
326 327 328 NOTE: In 11G, management applications have to invoke DCIM_LCService.GetRSStatus() or GetRemoteServicesAPIStatus() method (as described in the LC Management Profile) to determine that the completed job changes have been successfully reflected in the LC instrumentation API interface. 329 READY FOR EXECUTION SCHEDULED Job Status RUNNING COMPLETED RELOADING DM Status / RS Status READY READY SYNC TIME Time 330 Figure 4 – Configuration Job Timing Diagram 331 332 6.8.
No Job DCIM_SoftwareInstallatioService. InstallFromURI () returns 4096 (Job Created) JobStatus = “New” Download Started JobStatus = “Downloading” Download Finished JobStatus = “Downloaded” DCIM_JobService. CreateRebootJob () returns 0 (Successful) DCIM_JobService.
349 350 represents the auto-delete policy activation threshold and has a default value of 128 jobs representing the half of the maximum number of jobs possible in the job queue. 351 352 7 Implementation Requirements 353 This section describes the requirements and guidelines for implementing Dell Job Control Profile Table 2 – CIM Elements: Job Control Profile 354 Element Name Requirement Description DCIM_JobService Mandatory The class shall be implemented in the Implementation Namespace.
Table 3 – DCIM_JobService – Operations 369 Operation Name Get Enumerate Invoke Requirements Mandatory Mandatory Mandatory Required Input Instance URI Class URI Instance URI 370 371 7.1.
Get Enumerate Version 1.2.
384 7.2.3 Class Properties 385 386 387 388 The following table lists the implemented properties for DCIM_LifecycleJob instance representing a system in a system. The “Requirements” column shall denote whether the property is implemented (for requirement definitions, see section 3). The “Additional Requirements” column shall denote either possible values for the property, or requirements on the value formulation.
390 391 392 393 394 395 396 The management tasks requested by the management application shall be represented by instances of a subclass of the DCIM_LifecycleJob class which is a subclass of the CIM_ConcreteJob class. The DCIM_LifecycleJob class is further subclassed as the DCIM_SoftUpdateConcreteJob for BIOS, firmware, and embedded software update jobs. Software update related methods (see the Dell Software Update Profile) return references to the DCIM_SoftUpdateConcreteJob class.
Table 7 – Job Types 404 20 JobType Description Value Update The flashing of FW into the target device , Update:DCIM:InstanceID of SoftwareIdentity Rollback The flashing of Available FW into the device.
JobType Description Value System Configuration Applying the pending system configuration. SYSConfig: For example, SYSConfig: System.Embedded.1 405 7.2.3.2 JobStatus 406 407 The value of DCIM_LifeCycleJob.JobStatus represents the current state of the specific job.
Status Value Description Completed Job has been completed. Failed Job failed. Job Type: NIC Configuration New New Job has been created. Ready For Execution Job is ready for execution. Scheduled Job has been scheduled. Running Job is being executed. Completed Job has been completed. Completed with Errors Job has been completed with one or more errors. Failed Job failed. Job Type: BIOS Configuration New New Job has been created. Ready For Execution Job is ready for execution.
418 7.3.2 Operations 419 The following table lists the operations implemented on DCIM_SystemView. Table 9 – DCIM_LCRegisteredProfile - Operations 420 Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 421 7.3.3 Class Properties 422 423 424 425 The following table lists the implemented properties for DCIM_LCRegisteredProfile instance representing Job Control Profile implementation.
431 7.4.1 General Filter Query 432 433 434 The general indication filter query for this class shall be "SELECT * FROM DCIM_LifecycleJobCreateAlertIndication.” The client subscribed using the general filter query shall receive instances of DCIM_LifecycleJobCreateAlertIndication, when jobs are created. 435 7.4.2 436 The following table lists the operations implemented on DCIM_SystemView.
Properties Type Requirement Additional Requirements Mandatory This property shall have the DCIM_LifecycleJob.MessageID value of the newly created job, for which this indication has been created. Mandatory This property shall have the value “Job Execution Alert” Mandatory This property shall have the value 2 (Informational). MessageID string OtherAlertType string PerceivedSeverity uint16 ProbableCause uint16 Mandatory This property shall have the value 1 (Other).
Properties JobName JobStatus JobType Message MessageArguments Type string Requirement Additional Requirements Mandatory This property shall have the DCIM_LifecycleJob.JobName value for the job with the update, for which this indication has been created. Mandatory This property shall have the DCIM_LifecycleJob.JobStatus value for the job with the update, for which this indication has been created. Mandatory This property shall have the DCIM_LifecycleJob.
Table 15 – DCIM_JobService.SetupJobQueue() Method: Return Code Values 469 Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 16 – DCIM_JobService.SetupJobQueue() Method: Parameters 470 Qualifiers Name Type Description/Values IN JobArray string[] Array containing the value of the InstanceID property of the instances of DCIM_LifeCycleJob that represent the set of jobs to add to the job queue.
472 8.2 DCIM_JobService.DeleteJobQueue() 473 The DeleteJobQueue() method is used for deleting one or all jobs from the JobQueue (or job store). 474 475 476 Clearing all the jobs may be accomplished using the keyword JID_CLEARALL for the JobID. Note that the successful execution of this method with the JID_CLEARALL parameter value shall clear all the pending attribute values as well.
Table 20 – DCIM_JobService.DeleteJobQueue() Method: Standard Messages 485 MessageID (OUT parameter) Message MessageArguments[] JCP012 Resource allocation failure JCP013 Required parameter not found JCP015 The job cannot be deleted as it is currently in process SUP011 Invalid Job ID SUP020 The specified job was deleted 486 487 8.3 DCIM_JobService.SetDeleteOnCompletionTimeout () 488 489 490 491 This method will set the job store auto-delete policy.
Table 23 – DCIM_JobService.CreateRebootJob() Method: Standard Messages 495 MessageID (OUT parameter) Message MessageArguments[] JCP010 The command was successful JCP011 Invalid parameter value JCP012 Resoure allocation failure JCP013 Required parameter not found SUP022 JobQueue Exceeds the size limit. Delete unwanted JobID(s) 496 497 8.4 DCIM_JobService.CreateRebootJob () 498 The CreateRebootJob() method is used for creating a reboot job. Table 24 – DCIM_JobService.
Table 26 – DCIM_JobService.CreateRebootJob() Method: Standard Messages 502 MessageID (OUT parameter) Message JCP010 The command was successful JCP011 Invalid parameter value JCP012 Resource allocation failure JCP013 Required parameter not found SUP022 JobQueue Exceeds the size limit. Delete unwanted JobID(s) MessageArguments[] 503 8.5 DCIM_JobService.CreateJob 504 505 506 To create a host shutdown job specify a Jobtype of Shutdown.
Table 27 – DCIM_JobService.CreateJob() Method: Return Code Values 507 Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred 3 Error Job of this type already exists. Only one job of this type can have a status of new or scheduled. Table 24 – DCIM_JobService.CreateJob() Method: Parameters 508 Qualifiers Name Type Description/Values IN JobType Int16 Input parameter identifies the type of job to be created..
511 512 9 Use Cases 513 See Lifecycle Controller (LC) Integration Best Practices Guide 514 10 CIM Elements 515 No additional details specified. 516 11 Privilege and License Requirement 517 518 519 The following table describes the privilege and license requirements for the listed operations . For the detailed explanation of the privileges and licenses, refer to the Dell WSMAN Licenses and Privileges specification.