Job Control Profile
Total Page:16
File Type:pdf, Size:1020Kb
1 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 Document Number: DCIM1034 24 Document Type: Specification Document Status: Published 25 Document Language: E 26 Date: 2012-03-08 27 Version: 1.2.0 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 THIS PROFILE IS FOR INFORMATIONAL PURPOSES ONLY, AND MAY CONTAIN TYPOGRAPHICAL 52 ERRORS AND TECHNICAL INACCURACIES. THE CONTENT IS PROVIDED AS IS, WITHOUT 53 EXPRESS OR IMPLIED WARRANTIES OF ANY KIND. ABSENT A SEPARATE AGREEMENT 54 BETWEEN YOU AND DELL™ WITH REGARD TO FEEDBACK TO DELL ON THIS PROFILE 55 SPECIFICATION, YOU AGREE ANY FEEDBACK YOU PROVIDE TO DELL REGARDING THIS 56 PROFILE SPECIFICATION WILL BE OWNED AND CAN BE FREELY USED BY DELL. 57 58 © 2010 - 2012 Dell Inc. All rights reserved. Reproduction in any manner whatsoever without the express 59 written permission of Dell, Inc. is strictly forbidden. For more information, contact Dell. 60 61 Dell and the DELL logo are trademarks of Dell Inc. Microsoft and WinRM are either trademarks or 62 registered trademarks of Microsoft Corporation in the United States and/or other countries. Other 63 trademarks and trade names may be used in this document to refer to either the entities claiming the 64 marks and names or their products. Dell disclaims proprietary interest in the marks and names of others. 65 2 Version 1.2.0 66 CONTENTS 67 1 Scope .................................................................................................................................................... 5 68 2 Normative References ........................................................................................................................... 5 69 3 Terms and Definitions ........................................................................................................................... 5 70 4 Symbols and Abbreviated Terms .......................................................................................................... 7 71 5 Synopsis ................................................................................................................................................ 7 72 6 Description ............................................................................................................................................ 8 73 6.1 Job Types ................................................................................................................................... 9 74 6.2 Creating Jobs .............................................................................................................................. 9 75 6.3 Grouping Jobs ........................................................................................................................... 10 76 6.4 Scheduling Jobs ........................................................................................................................ 10 77 6.5 Canceling Jobs ......................................................................................................................... 10 78 6.6 Auto-Deleting Completed Jobs ................................................................................................. 10 79 6.7 Maintenance Windows .............................................................................................................. 10 80 6.8 Job Status Lifecycle .................................................................................................................. 10 81 6.9 Completed Jobs Auto-deletion .................................................................................................. 14 82 7 Implementation Requirements ............................................................................................................ 15 83 7.1 DCIM_JobService ..................................................................................................................... 15 84 7.2 DCIM_LifecycleJob ................................................................................................................... 16 85 7.3 DCIM_LCRegisteredProfile ...................................................................................................... 22 86 8 Methods ............................................................................................................................................... 23 87 8.1 DCIM_JobService.SetupJobQueue() ....................................................................................... 24 88 8.2 DCIM_JobService.DeleteJobQueue() ...................................................................................... 26 89 8.3 DCIM_JobService.SetDeleteOnCompletionTimeout () ............................................................ 27 90 8.4 DCIM_JobService.CreateRebootJob () .................................................................................... 28 91 9 Use Cases ........................................................................................................................................... 29 92 10 CIM Elements ...................................................................................................................................... 29 93 11 Privilege and License Requirement .................................................................................................... 29 94 Version 1.2.0 3 95 Figures 96 Figure 1 – Job Control Profile: Class Diagram.............................................................................................. 9 97 Figure 2 – Job Workflow for RAID Attributes .............................................................................................. 11 98 Figure 3 – Job Workflow for IDRAC Card Attributes ................................................................................... 12 99 Figure 4 – Configuration Job Timing Diagram ............................................................................................ 13 100 Figure 5 – Update Job Workflow ................................................................................................................. 14 101 102 Tables 103 Table 1 – Related Profiles ............................................................................................................................. 8 104 Table 2 – CIM Elements: Job Control Profile .............................................................................................. 15 105 Table 3 – DCIM_JobService – Operations ................................................................................................. 16 106 Table 4 – Class: DCIM_JobService ............................................................................................................ 16 107 Table 5 – DCIM_LifecycleJob - Operations ................................................................................................ 16 108 Table 6 – Class: DCIM_LifecycleJob .......................................................................................................... 18 109 Table 7 – Job Types .................................................................................................................................... 20 110 Table 8 – JobStatus Property Values ......................................................................................................... 21 111 Table 9 – DCIM_LCRegisteredProfile - Operations .................................................................................... 23 112 Table 10 – Class: DCIM_LCRegisteredProfile ............................................................................................ 23 113 Table 11 – DCIM_JobService.SetupJobQueue() Method: Return Code Values ........................................ 25 114 Table 12 – DCIM_JobService.SetupJobQueue() Method: Parameters ...................................................... 25 115 Table 13 – DCIM_JobService.SetupJobQueue() Method: Standard Messages ........................................ 25 116 Table 14 – DCIM_JobService.DeleteJobQueue() Method: Return Code Values ....................................... 26 117 Table 15 – DCIM_JobService.DeleteJobQueue() Method: Parameters ..................................................... 26 118 Table 16 – DCIM_JobService.DeleteJobQueue() Method: Standard Messages ....................................... 27 119 Table 17 – DCIM_JobService.CreateRebootJob() Method: Return Code Values ...................................... 27 120 Table 18 – DCIM_JobService.CreateRebootJob() Method: Parameters ................................................... 27 121 Table 19 – DCIM_JobService.CreateRebootJob() Method: Standard Messages ...................................... 28 122 Table 20 – DCIM_JobService.CreateRebootJob() Method: Return Code Values ...................................... 28 123 Table 21 – DCIM_JobService.CreateRebootJob() Method: Parameters ................................................... 28 124 Table 22 – DCIM_JobService.CreateRebootJob() Method: Standard Messages ...................................... 29 125 Table 23 – Privilege and License Requirements ........................................................................................ 29 126 4 Version 1.2.0 127 Job Control Profile 128 1 Scope 129 The Dell Job Control Profile extends the management capabilities of referencing profiles by adding the 130 capability to create, schedule, track, and manage jobs that represent platform management operations. 131 2 Normative References 132 Refer to the following documents for more information. 133 NOTE: For dated references, only the edition cited applies. For undated references,