White Papers

ManualsBrandsDell ManualsConverged InfrastructureEnterprise Solution Resources

Version 1.5.0 1

Lifecycle Controller 1

(LC) Management Profile 2

Document Number: DCIM1039

Document Type: Specification

Document Status: Published

Document Language: E

Date: 2012-03-08

Version: 1.5.0

Summary of content (47 pages)

PAGE 1
2 Lifecycle Controller (LC) Management Profile 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 26 Document Number: DCIM1039 Document Type: Specification Document Status: Published Document Language: E Date: 2012-03-08 27 Version: 1.5.0 24 25 28 29 Version 1.5.
PAGE 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 57 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.
PAGE 3
64 65 66 trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Dell disclaims proprietary interest in the marks and names of others. Version 1.5.
PAGE 4
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 96 97 98 99 100 101 102 103 CONTENTS 1 2 3 4 5 6 7 8 9 10 11 4 Scope .................................................................................................................................................... 7 Normative References........................................................................................................................... 7 Terms and Definitions ................................
PAGE 5
104 Figures 105 106 Figure 1 – LC Management Profile: Class Diagram ................................................................................... 11 107 Tables 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 Table 1 – Related Profiles ...........................................................................................................................
PAGE 6
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 Table 39 – DCIM_LCService.SetPublicCertificate() Method: Standard Messages .................................... 31 Table 40 – DCIM_LCService.DeleteAutoDiscoveryServerPublicKey() Method: Return Code Values....... 32 Table 41 – DCIM_LCService.DeleteAutoDiscoveryServerPublicKey() Method: Parameters .................... 32 Table 42 – DCIM_LCService.
PAGE 7
Lifecycle Controller (LC) Management 181 182 1 183 184 185 186 The Lifecycle Controller (LC) Management Profile describes the management of the Dell Lifecycle Controller and its configuration attributes. The profile details certificate management and the LC configuration services that are necessary for the LC’s proper functionality. The LC configuration attributes are modeled as attribute collections for an individual LC; typically there is one LC per system platform.
PAGE 8
212 213 214 3.1 215 216 217 3.2 218 219 3.3 220 221 3.4 222 223 3.5 224 225 3.6 226 227 3.7 228 229 230 3.8 231 232 233 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.
PAGE 9
234 235 236 3.10 237 238 239 3.11 240 241 242 3.12 243 244 3.13 245 246 247 3.14 248 249 250 3.15 251 252 253 3.16 254 255 256 3.17 257 shall not – Indicates requirements to be followed strictly in order to conform to the document and from which no deviation is permitted. should – Indicates that among several possibilities, one is recommended as particularly suitable, without mentioning or excluding others, or that a certain course of action is preferred but not necessarily required.
PAGE 10
269 Central Class: DCIM_LCService 270 Scoping Class: CIM_ComputerSystem 271 272 273 The LC Management Profile extends the management capability of the referencing profiles by adding the capability to describe lifecycle controller (LC) through its attributes. Each DCIM_LCAttribute derived instance represents an LC configuration-related attribute. 274 275 276 The DCIM_LCService class shall be the Central Class. The DCIM_ComputerSystem class shall be the Scoping Class.
PAGE 11
DCIM_LCRegisteredProfile root/interop root/dcim DCIM_LCElementConformsToProfile DCIM_LCService DCIM_LCAttribute DCIM_LCEnumeration DCIM_LCString 289 290 Figure 1 – LC Management Profile: Class Diagram 291 7 292 This section describes the implementation of Dell LC Management.
PAGE 12
294 7.1 295 This section describes the implementation for the DCIM_LCService class. 296 This class is instantiated in the Implementation Namespace. 297 298 The DCIM_LCElementConformsToProfile association’s ManagedElement property shall references the DCIM_LCService instance(s). 299 7.1.1 Resource URIs for WinRM® 300 The class Resource URI is: 301 302 “http://schemas.dell.
PAGE 13
319 7.2 320 This section describes the implementation for the DCIM_LCEnumeration class. 321 This class shall be instantiated in the Implementation Namespace. 322 7.2.1 Resource URIs for WinRM® 323 324 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LCEnumeration?__cimnamespace=root/dcim” 325 The key property shall be the InstanceID. 326 327 328 The instance Resource URI for DCIM_LCEnumeration instance shall be: “http://schemas.dell.
PAGE 14
338 339 340 341 Table 3 – Class: DCIM_LCEnumeration Properties Type Requirement Additional Requirements InstanceID string Mandatory The property value shall have a unique value. AttributeName String Mandatory The property value shall be from the “AttributeName” column in Table 4. CurrentValue[] string Mandatory The property value shall be one of the values in the “PossibleValues” column at the corresponding row in Table 4.
PAGE 15
342 Table 4 – DCIM_LCEnumeration Attributes AttributeName Licensed IsReadOnly True Part Configuration Update PossibleValues • • Yes No • • • Disabled Apply always Apply only if firmware match False Description Whether the Component Configuration Recovery feature is licensed. Part cofiguration update method.
PAGE 16
345 This class shall be instantiated in the Implementation Namespace. 346 7.3.1 Resource URIs for WinRM® 347 348 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LCString?__cimnamespace=root/dcim” 349 The key property shall be the InstanceID. 350 351 352 The instance Resource URI for DCIM_LCString instance shall be: “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LCString?__cimnamespace=root/dcim+InstanceID=” 353 7.3.
PAGE 17
361 Table 6 – Class: DCIM_LCString Properties Type Requirement Additional Requirements InstanceID string Mandatory The property value shall have unique value. AttributeName string Mandatory The property value shall be from the “AttributeName” column in Table 7. CurrentValue[] string Mandatory The property shall represent the current value of the attribute. PendingValue[] string Mandatory The property value shall represent the pending value of the attribute.
PAGE 18
AttributeName SYSID IsRead Only MinLength MaxLength TRUE N/A N/A Description Dell System ID. Provisioning server address and port. Attribute value examples: • • • • • • • Provisioning Server VirtualAddressManagement Application* FALSE FALSE* 0 0 Hostname hostname.domain.com 1.1.1.1 Mypc:8080 Myps.dell.com(1.2.3.
PAGE 19
Get Enumerate Mandatory Mandatory Instance URI Class URI 385 386 7.4.3 Class Properties 387 388 389 390 391 The following table details the properties implemented for the DCIM_LCRegisteredProfile instance representing Lifecycle Controller (LC) Management implementation. The “Requirements” column shall denote whether the property is implemented (for requirement definitions, see section 3).
PAGE 20
397 8.1 398 The SetAttribute( ) method is used to set or change the value of an LC attribute. 399 400 401 402 403 404 Invoking the SetAttribute( ) method shall change the value of the DCIM_LCAttribute.CurrentValue or DCIM_LCAttribute.PendingValue property to the value specified by the AttributeValue parameter if the DCIM_LCAttribute.IsReadOnly property is FALSE. Invoking this method when the DCIM_LCAttribute.IsReadOnly property is TRUE shall result in no change to the value of the DCIM_LCAttribute.
PAGE 21
412 Table 12 – DCIM_LCService.
PAGE 22
425 Table 13 – DCIM_LCService.SetAttributes() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 426 Table 14 – DCIM_LCService.SetAttributes() Method: Parameters 22 Qualifiers Name Type Description/Values IN, REQ AttributeName[] string The array parameter shall contain the AttributeName property values for the attributes to be modified.
PAGE 23
Qualifiers Name Type Description/Values OUT MessageArguments[] string Substitution variables for dynamic error messages 427 Table 15 – DCIM_LCService.
PAGE 24
437 Table 16 – DCIM_LCService.CreateConfigJob() Method: Return Code Values Value Description 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob 438 Table 17 – DCIM_LCService.CreateConfigJob() Method: Parameters Qualifiers Name Type Description/Values OUT Job CIM_ConcreteJob REF Returned to keep track of config job status1 OUT MessageID string Error Message ID may be used to look-up in the Dell Message registry files.
PAGE 25
444 Table 19 – DCIM_LCService.ReInitiateDHS() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 445 Table 20 – DCIM_LCService.ReInitiateDHS() Method: Parameters Qualifiers Name Type IN ProvisioningServer string IN, REQ ResetToFactoryDefaults boolean IN, REQ PerformAutoDiscovery uint16 OUT MessageID string Error Message ID may be used to look-up in the Dell Message registry files. For more information, see Error Message Registry.
PAGE 26
448 8.5 449 The ClearProvisioningServer() method is used to clear the provisioning server values. DCIM_LCService.ClearProvisioningServer() 450 Table 22 – DCIM_LCService.ClearProvisioningServer() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 451 Table 23 – DCIM_LCService.
PAGE 27
Qualifiers Name Type Description/Values OUT Job CIM_ConcreteJob REF Returned to track the setting of the public key. OUT MessageID string Error Message ID can be used to index into Dell Message registry files. OUT Message string Error Message ID may be used to look-up in the Dell Message registry files. For more information, see Error Message Registry. OUT MessageArguments[] string Substitution variables for dynamic error messages. 460 461 Table 27 – DCIM_LCService.
PAGE 28
468 Table 28 – DCIM_LCService.DownloadClientCerts() Method: Return Code Values Value Description 2 Error occurred 4096 Job started 469 Table 29 – DCIM_LCService.DownloadClientCerts() Method: Parameters Qualifiers Name Type Description/Values IN, OctetString, REQ KeyContent string Base64 encoded private key content. IN, REQ Password string Private key password. IN, OctetString, REQ CAContent string Base64 encoded root certificate content.
PAGE 29
473 474 475 The DeleteAutoDiscoveryClientCerts() method is used to wipe all configurations from the Lifecycle controller before the system is retired. Table 31 – DCIM_LCService.DeleteAutoDiscoveryClientCerts() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 476 477 Table 32 – DCIM_LCService.
PAGE 30
479 8.9 480 481 482 483 The SetCertificateAndPrivateKey() method is used to set iDRAC owned server certificate and public and private key pairs using the contents of a PKCS#12 file. iDRAC will serve the certificate to identify itself during web server based connections such as for iDRAC’s web application and WSMan instrumentation connections. The certificate will also be served for connections with directory services. 484 DCIM_LCService.SetCertificateAndPrivateKey() Table 34 – DCIM_LCService.
PAGE 31
489 8.10 DCIM_LCService.SetPublicCertificate() 490 491 492 493 The SetPublicCertificate() method is used to set a public certificate in the chain of trust for directory services. The successful invocation of this method shall set the certificate inside the Certificate parameter to the iDRAC trusted Root CA list. The certificate will be used to authenticate the directory service access to iDRAC. 494 Table 37 – DCIM_LCService.
PAGE 32
500 Table 40 – DCIM_LCService.DeleteAutoDiscoveryServerPublicKey() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 501 502 Table 41 – DCIM_LCService.DeleteAutoDiscoveryServerPublicKey() Method: Parameters Qualifiers Name Type Description/Values OUT MessageID String Error Message ID may be used to look-up in the Dell Message registry files. For more information, see Error Message Registry.
PAGE 33
510 511 Table 45 – DCIM_LCService.InsertCommentInLCLog() Method: Standard Messages MessageID (OUT parameter) Message MessageArguments[] LC002 General failure LC008 Unsupported method parameter value LC014 Comment length must be between 1 and 255 characters 512 8.13 DCIM_LCService.ExportLCLog() 513 The ExportLCLog() method is used to export the log from the Lifecycle Controller to a remote share. 514 Table 46 – DCIM_LCService.
PAGE 34
518 Table 48 – DCIM_LCService.
PAGE 35
523 Table 49 – DCIM_LCService.ExportHWInventory() Method: Return Code Values Value Description 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob 524 Table 50 – DCIM_LCService.ExportHWInventory() Method: Parameters Qualifiers Name Type Description/Values IN, REQ IPAddress string The IP address of the target export server. IN. REQ ShareName string The directory path to the mount point. IN, REQ FileName string The target output file name.
PAGE 36
MessageID (OUT parameter) Message MessageArguments[] JCP018 Backup Job is running, cannot create new jobs until the existing Backup job is completed or is cancelled JCP018 JCP019 Restore Job is running, cannot create new jobs until the existing Restore job is completed or is cancelled NA 528 529 8.15 DCIM_LCService.ExportFactoryConfiguration() 530 531 The ExportFactoryConfiguration() method is used to export the factory configuration from the Lifecycle Controller to a remote share.
PAGE 37
MessageID (OUT parameter) Message LC025 Insufficient space on network share LC029 Filepath is invalid LC030 Filepath is a read-only file system LC033 Factory Configuration Export was successful LC034 Factory Configuration was not found on the system LC039 An instance of Factory Configuration is already running LC040 Resource Allocation Failure JCP017 Maximum job limit reached, cannot create new jobs JCP018 Backup Job is running, cannot create new jobs until the existing Backup job is comp
PAGE 38
540 Table 55 – DCIM_LCService.LCWipe() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 541 Table 56 – DCIM_LCService.LCWipe() Method: Parameters Qualifiers Name Type Description/Values OUT MessageID String Error Message ID may be used to look-up in the Dell Message registry files. For more information, see Error Message Registry.
PAGE 39
546 547 548 549 Table 59 – DCIM_LCService.BackupImage() Method: Parameters Qualifiers Name Type Description/Values IN IPAddress String IP address of the NFS or CIFS share such as 192.168.10.12. The parameter shall be required, if the ShareType parameter has value 0 (NFS), 2 (CIFS), or not specified. IN ShareName String Share name for the network share such as “imageshare”. The parameter shall be required, if the ShareType parameter has value 0 (NFS), 2 (CIFS), or not specified.
PAGE 40
550 Table 60 – DCIM_LCService.BackupImage() Method: Standard Messages MessageID (OUT parameter) Message MessageArguments[] LC002 General failure LC017 Invalid value of parameter "ShareType" LC023 Cannot access network share NA LC051 Cannot create multiple Export jobs. NA SUP017 Invalid start time. SUP018 Invalid until time.
PAGE 41
554 Table 61 – DCIM_LCService.RestoreImage() Method: Return Code Values Value Description 2 Error occurred 1 A DCIM_ConcreteJob is returned1 4096 555 Table 62 – DCIM_LCService.RestoreImage() Method: Parameters Qualifiers Name Type Description/Values IN IPAddress String IP address of the NFS or CIFS share. The parameter shall be required, if the ShareType parameter has value 0 (NFS), 2 (CIFS), or not specified. IN.
PAGE 42
Qualifiers Name Type Description/Values OUT Message String Error Message in English corresponding to MessageID is returned if the method fails to execute OUT MessageArguments[] string Substitution variables for dynamic error messages 556 557 558 NOTE: 1 – If return code is 4096 (Job Created), the newly created job will not execute if the LC core services are not running (DCIM_LCEnumeration with AttributeName equal to “LifecycleControllerState” has the CurrentValue property equal to “Disabled”).
PAGE 43
565 Table 64 – DCIM_LCService.GetRSStatus() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 566 Table 65 – DCIM_LCService.GetRSStatus() Method: Parameters Qualifiers Name Type Description/Values OUT Status string The status for the Data Manager: Ready Not Ready Reloading OUT MessageID string Error Message ID may be used to look-up in the Dell Message registry files. For more information, see Error Message Registry.
PAGE 44
575 Table 67 – DCIM_LCService.GetRemoteServicesAPIStatus() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred 576 Table 68 – DCIM_LCService.
PAGE 45
579 9 580 See Lifecycle Controller (LC) Integration Best Practices Guide 581 10 582 No additional requirements have been defined. 583 11 584 585 586 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.
PAGE 46
ENUMER ATE, GET Login LM_REMOTE_CONFI GURATION DCIM_LCService ENUMER ATE, GET Login NONE DCIM_LCService. SetAttribute() INVOKE Login, Configure LM_REMOTE_CONFI GURATION DCIM_LCEnumeration Lifecycle Controller State DCIM_LCService. SetAttributes() INVOKE Login, Configure LM_REMOTE_CONFI GURATION DCIM_LCService. CreateConfigJob() INVOKE Login, Configure LM_REMOTE_CONFI GURATION DCIM_LCService. ReInitiateDHS() INVOKE Login, Configure LM_AUTO_DISCOVE RY DCIM_LCService.
PAGE 47
Login, System Operations LM_REMOTE_CONFI GURATION Login NONE Login NONE INVOKE Login, System Control LM_BACKUP_REST ORE INVOKE Login, System Control LM_BACKUP_REST ORE DCIM_LCService.. InsertCommentInLCLog() INVOKE DCIM_LCService. GetRSStatus() INVOKE DCIM_LCService. GetRemoteServicesAPIStatus () INVOKE DCIM_LCService.BackupImag e() DCIM_LCService.RestoreImag e() DCIM_LCRegisteredProfile ENUMER ATE, GET Login None. DCIM_LCElementConformsTo Profile ENUMER ATE, GET Login None.