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-03-08 27 Version: 1.2.
30 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 CONTENTS 1 2 3 4 5 6 7 8 9 10 11 Scope .................................................................................................................................................... 5 Normative References........................................................................................................................... 5 Terms and Definitions ..............................................................
95 Figures 96 97 98 99 100 101 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 127 128 1 Scope 129 130 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. 131 2 132 Refer to the following documents for more information. 133 134 NOTE: For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.
157 158 159 3.1 160 161 162 3.2 163 164 3.3 165 166 3.4 167 168 3.5 169 170 3.6 171 172 3.7 173 174 175 3.8 176 177 178 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.
179 180 181 3.10 182 183 184 3.11 185 186 3.12 187 188 3.13 189 190 191 3.14 192 193 194 3.15 195 196 197 3.16 198 3.17 199 200 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 201 4 202 203 4.1 204 205 206 4.2 207 208 4.3 209 210 211 4.4 212 5 213 Profile Name: Job Control 214 Version: 1.2.
216 CIM Schema Version: 2.26 Experimental 217 Central Class: DCIM_JobService 218 Scoping Class: CIM_ComputerSystem 219 220 221 222 223 224 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 234 235 Figure 1 – Job Control Profile: Class Diagram 236 6.1 Job Types 237 238 239 Different kinds of system management tasks, such as firmware updates, reboots, configurations, and so on often take a while to complete.
253 6.3 254 255 256 257 One or more jobs are be grouped together in job queues to define job order, start time, and to prepare the job grouping for execution in another environment such as Unified Extensible Firmware Interface(UEFI). If the Lifecycle Controller is to perform the system reboot needed to execute update jobs, a reboot job is included in the job queue definition. 258 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 299 300 Figure 3 – Job Workflow for IDRAC Card Attributes 301 302 303 Figure 4 shows the timing diagram for configuration job executions.
320 321 system’s status (as reflected in the ServerStatus output parameter) and overall API status (as reflected in the Status output parameter). 322 323 324 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.
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.
344 345 346 SetDeleteOnCompletionTimeout() method. The DCIM_JobService.StartAutoDeleteAtThreshold 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.
365 Table 3 – DCIM_JobService – Operations Operation Name Get Enumerate Invoke Requirements Mandatory Mandatory Mandatory Required Input Instance URI Class URI Instance URI 366 367 7.1.
Get Enumerate Version 1.2.
380 7.2.3 Class Properties 381 382 383 384 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.
386 387 388 389 390 391 392 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.
400 Table 7 – Job Types 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 401 7.2.3.2 JobStatus 402 403 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.
414 7.3.2 Operations 415 The following table lists the operations implemented on DCIM_SystemView. 416 Table 9 – DCIM_LCRegisteredProfile - Operations Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 417 7.3.3 Class Properties 418 419 420 421 The following table lists the implemented properties for DCIM_LCRegisteredProfile instance representing Job Control Profile implementation.
426 8.1 427 428 The SetupJobQueue() method is used for creating a job queue that shall contain one or more DCIM_LyfecycleJobs with a specified order of execution within the queue. 24 DCIM_JobService.SetupJobQueue() Version 1.2.
429 Table 11 – DCIM_JobService.SetupJobQueue() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred 430 Table 12 – DCIM_JobService.SetupJobQueue() Method: Parameters 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.
432 8.2 DCIM_JobService.DeleteJobQueue() 433 The DeleteJobQueue() method is used for deleting one or all jobs from the JobQueue (or job store). 434 435 436 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.
445 Table 16 – DCIM_JobService.DeleteJobQueue() Method: Standard Messages 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 446 447 8.3 DCIM_JobService.SetDeleteOnCompletionTimeout () 448 449 450 451 This method will set the job store auto-delete policy.
455 Table 19 – DCIM_JobService.CreateRebootJob() Method: Standard Messages 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) 456 457 8.4 DCIM_JobService.CreateRebootJob () 458 The CreateRebootJob() method is used for creating a reboot job. 459 Table 20 – DCIM_JobService.
462 Table 22 – DCIM_JobService.CreateRebootJob() Method: Standard Messages 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) 463 464 9 Use Cases 465 See Lifecycle Controller (LC) Integration Best Practices Guide 466 10 CIM Elements 467 No additional details specified.