Lifecycle Controller 2 (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-12-30 27 Version: 1.6.0 24 25 28 29 Version 1.6.
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.
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.6.
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 104 105 106 107 108 109 CONTENTS 1 2 3 4 5 6 7 Scope .................................................................................................................................................... 8 Normative References ........................................................................................................................... 8 Terms and Definitions ......................
110 Version 1.6.
111 Figures 112 113 Figure 1 – LC Management Profile: Class Diagram ................................................................................... 12 114 Tables 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 149 150 151 152 153 154 155 Table 1 – Related Profiles ...........................................................................................................................
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 Table 36 – DCIM_LCService.SetCertificateAndPrivateKey() Method: Standard Messages ...................... 35 Table 37 – DCIM_LCService.SetPublicCertificate() Method: Return Code Values .................................... 36 Table 38 – DCIM_LCService.SetPublicCertificate() Method: Parameters ...........................................
Lifecycle Controller (LC) Management 201 202 1 203 204 205 206 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.
3.1 232 233 234 Conditional – Indicates requirements to be followed strictly in order to conform to the document when the specified conditions are met. 235 236 237 Mandatory – Indicates requirements to be followed strictly in order to conform to the document and from which no deviation is permitted. 3.2 3.3 238 239 May – Indicates a course of action permissible within the limits of the document. 240 241 Optional – Indicates a course of action permissible within the limits of the document. 3.4 3.
3.10 254 255 256 shall not – Indicates requirements to be followed strictly in order to conform to the document and from which no deviation is permitted. 257 258 259 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. 3.11 3.
289 Central Class: DCIM_LCService 290 Scoping Class: CIM_ComputerSystem 291 292 293 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. 294 295 296 The DCIM_LCService class shall be the Central Class. The DCIM_ComputerSystem class shall be the Scoping Class.
DCIM_LCRegisteredProfile root/interop root/dcim DCIM_LCElementConformsToProfile DCIM_LCService DCIM_LCAttribute DCIM_LCEnumeration DCIM_LCString 309 Figure 1 – LC Management Profile: Class Diagram 310 311 7 312 This section describes the implementation of Dell LC Management.
314 7.1 DCIM_LCService 315 This section describes the implementation for the DCIM_LCService class. 316 This class is instantiated in the Implementation Namespace. 317 318 The DCIM_LCElementConformsToProfile association’s ManagedElement property shall references the DCIM_LCService instance(s). 319 7.1.1 Resource URIs for WinRM® 320 The class Resource URI is: 321 322 “http://schemas.dell.
339 7.2 DCIM_LCEnumeration 340 This section describes the implementation for the DCIM_LCEnumeration class. 341 This class shall be instantiated in the Implementation Namespace. 342 7.2.1 Resource URIs for WinRM® 343 344 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LCEnumeration?__cimnamespace=root/dcim” 345 The key property shall be the InstanceID. 346 347 348 The instance Resource URI for DCIM_LCEnumeration instance shall be: “http://schemas.dell.
Table 3 – Class: DCIM_LCEnumeration 358 359 360 361 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.
Table 4 – DCIM_LCEnumeration Attributes 362 AttributeName Licensed IsReadOnly True Part Configuration Update PossibleValues Description Yes No Whether the Part Replacement feature is licensed. Disabled Apply always Apply only if firmware match Part cofiguration update method. False Part Firmware Update False Disable Allow version upgrade only Match firmware of replaced part Disable (default) – firmware update is not allowed.
366 7.3.1 Resource URIs for WinRM® 367 368 The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LCString?__cimnamespace=root/dcim” 369 The key property shall be the InstanceID. 370 371 372 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=” 373 7.3.2 Operations 374 The following table details the implemented operations on DCIM_LCString.
Table 6 – Class: DCIM_LCString 381 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.
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* 387 388 389 390 FALSE FALSE* 0 0 Hostname hostname.domain.com 1.1.1.1 Mypc:8080 Myps.dell.com(1.2.3.
Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 405 406 7.4.3 Class Properties 407 408 409 410 411 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).
417 8.1 DCIM_LCService.SetAttribute() 418 The SetAttribute( ) method is used to set or change the value of an LC attribute. 419 420 421 422 423 424 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.
Table 12 – DCIM_LCService.
Table 13 – DCIM_LCService.SetAttributes() Method: Return Code Values 445 Value Description 0 Request was successfully executed. 2 Error occurred Table 14 – DCIM_LCService.SetAttributes() Method: Parameters 446 Qualifiers Name Type Description/Values IN, REQ AttributeName[] string The array parameter shall contain the AttributeName property values for the attributes to be modified.
Qualifiers Name Type Description/Values OUT MessageArguments[] string Substitution variables for dynamic error messages Table 15 – DCIM_LCService.
Table 16 – DCIM_LCService.CreateConfigJob() Method: Return Code Values 457 Value Description 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 17 – DCIM_LCService.CreateConfigJob() Method: Parameters 458 Qualifiers Name Type Description/Values OUT Job CIM_ConcreteJob REF Returned to keep track of config job status 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.
Table 19 – DCIM_LCService.ReInitiateDHS() Method: Return Code Values 464 Value Description 0 Request was successfully executed. 2 Error occurred Table 20 – DCIM_LCService.ReInitiateDHS() Method: Parameters 465 Qualifiers Name Type Description/Values 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.
468 8.5 DCIM_LCService.ReInitiateAutoDiscovery() 469 470 471 472 473 The ReInitiateAutoDiscovery() method is used to reinitiate the discovery and handshake with static IP configuration. If the method successfully executes, the iDRAC shall be in the static IP mode after the auto-discovery is initiated and thus, shall not require DHCP setup.
Table 22 – DCIM_LCService.ReInitiateAutoDiscovery() Method: Return Code Values 489 Value Description 0 Request was successfully executed. 2 Error occurred Table 23 – DCIM_LCService.ReInitiateAutoDiscovery() Method: Parameters 490 Qualifiers Name Type IN ProvisioningServer string IN, REQ PerformAutoDiscovery uint16 IN IPAddress string Description/Values An optional parameter to specify provisioning server addresses and ports used for auto discovery.
Qualifiers Name Type Description/Values IN Gateway string An optional parameter for specifying the iDRAC static IP configuration after the reset to the factory defaults occurs. The parameter shall be IPv4 address. The iDRAC shall be set to this gateway IP address after the reset of iDRAC configuration. NOTE: If this parameter is not specified then iDRAC shall be set to the value of the Gateway attribute in the IPv4 Information group in the iDRAC Card Profile.
492 493 MessageID (OUT parameter) Message MessageArguments[] LC008 Unsupported method parameter value NA LC009 Insufficient method parameters NA LC065 Static IP information is not configured correctly . attribute key 8.6 DCIM_LCService.ClearProvisioningServer() The ClearProvisioningServer() method is used to clear the provisioning server values. Table 25 – DCIM_LCService.
Table 28 – DCIM_LCService.DownloadServerPublicKey() Method: Return Code Values 502 Value Description 2 Error occurred 4096 Job started Table 29 – DCIM_LCService.DownloadServerPublicKey() Method: Parameters 503 Qualifiers Name Type Description/Values IN, OctetString, REQ KeyContent string Base64 encoded public CA certificate. OUT Job CIM_ConcreteJob REF Returned to track the setting of the public key.
510 511 certificate and sign it using the CA cert and private key. The CA cert then needs to be added to the provisioning server trusted Root CA list before performing auto-discovery. 32 Version 1.6.
Table 31 – DCIM_LCService.DownloadClientCerts() Method: Return Code Values 512 Value Description 2 Error occurred 4096 Job started Table 32 – DCIM_LCService.DownloadClientCerts() Method: Parameters 513 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.
517 518 The DeleteAutoDiscoveryClientCerts() method is used to wipe all configurations from the Lifecycle controller before the system is retired. Table 34 – DCIM_LCService.DeleteAutoDiscoveryClientCerts() Method: Return Code Values 519 Value Description 0 Request was successfully executed. 2 Error occurred Table 35 – DCIM_LCService.
523 524 525 526 527 8.10 DCIM_LCService.SetCertificateAndPrivateKey() 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. Table 37 – DCIM_LCService.
533 8.11 DCIM_LCService.SetPublicCertificate() 534 535 536 537 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. 538 Table 40 – DCIM_LCService.
544 Table 43 – DCIM_LCService.DeleteAutoDiscoveryServerPublicKey() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred Table 44 – DCIM_LCService.DeleteAutoDiscoveryServerPublicKey() Method: Parameters 545 546 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.
554 Table 48 – DCIM_LCService.InsertCommentInLCLog() Method: Standard Messages 555 556 557 MessageID (OUT parameter) Message MessageArguments[] LC002 General failure LC008 Unsupported method parameter value LC014 Comment length must be between 1 and 255 characters 8.14 DCIM_LCService.ExportLCLog() The ExportLCLog() method is used to export the log from the Lifecycle Controller to a remote share. Table 49 – DCIM_LCService.
Table 51 – DCIM_LCService.
Table 54 – DCIM_LCService.ExportHWInventory() Method: Return Code Values 567 Value Description 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 55 – DCIM_LCService.ExportHWInventory() Method: Parameters 568 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.
MessageID (OUT parameter) Message MessageArguments[] successful LC029 Filepath is invalid LC030 Filepath is a read-only file system LC038 An instance of Hardware Inventory 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 completed or is cancelled JCP019 Restore Job is running, cannot create new jobs until the existing Restore job is completed or i
Table 59 – DCIM_LCService.ExportFactoryConfiguration() Method: Return Code Values 576 Value Description 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 60 – DCIM_LCService.ExportFactoryConfiguration() Method: Parameters 577 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.
MessageID (OUT parameter) Message MessageArguments[] 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 completed or is cancelled JCP019 Restore Job is running, cannot create new jobs until the existing Restore job is completed or is cancelled NA 579 580 581 582 8.17 DCIM_LCService.
Table 64 – DCIM_LCService.ExportSystemConfiguration() Method: Return Code Values 583 Value Description 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 65 – DCIM_LCService.ExportSystemConfiguration() Method: Parameters 584 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.
586 587 588 589 590 591 592 593 8.18 DCIM_LCService.ImportSystemConfiguration() This method is used to import the system configuration from the Lifecycle Controller from a file on a remote share. The successful invocation of this method shall return a job. The job execution results shall be logged in the Lifecycle log as part of configuration results. The Dell Record Log Profile provides the DCIM_LCRecordLog.
MessageID (OUT parameter) Message MessageArguments[] LC017 Invalid value of parameter Parameter name, see Table 65 LC023 Cannot access network share LC040 Resource Allocation Failure LC062 An instance of Export or Import System Configuration is already running. LC063 Cannot create new jobs until the existing running jobs are completed or deleted.
Table 70 – DCIM_LCService.LCWipe() Method: Return Code Values 602 Value Description 0 Request was successfully executed. 2 Error occurred Table 71 – DCIM_LCService.LCWipe() Method: Parameters 603 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.
Table 74 – DCIM_LCService.TestNetworkShare() Method: Parameters 608 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.
Table 77 – DCIM_LCService.BackupImage() Method: Parameters 613 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.
614 615 616 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”). 617 Table 78 – DCIM_LCService.
Table 79 – DCIM_LCService.RestoreImage() Method: Return Code Values 621 Value Description 2 Error occurred 4096 1 A DCIM_ConcreteJob is returned 1 Table 80 – DCIM_LCService.RestoreImage() Method: Parameters 622 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.
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 623 624 625 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”).
Table 82 – DCIM_LCService.GetRSStatus() Method: Return Code Values 632 Value Description 0 Request was successfully executed. 2 Error occurred Table 83 – DCIM_LCService.GetRSStatus() Method: Parameters 633 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.
Table 67 – DCIM_LCService.GetRemoteServicesAPIStatus() Method: Return Code Values 642 Value Description 0 Request was successfully executed. 2 Error occurred Table 68 – DCIM_LCService.
Table 71 – DCIM_LCService.ExportCertificate() Method: Return Code Values 648 Value Description 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 72 – DCIM_LCService.ExportCertificate() Method: Parameters 649 Qualifiers Name Type Description/Values IN, REQ Type uint16 The type of the certificate 2 = Custom Signing Certificate IN, REQ IPAddress string The IP address of the target export server.
MessageID (OUT parameter) Message MessageArguments[] configured correctly LC066 An instance of Export Certificate is already running LC067 Export SSL Certificate success LC069 Certificate does not Exist on the System.
Provisioning Server ENUMER ATE, GET Login LM_AUTO_DISCOVE RY Auto Discovery ENUMER ATE, GET Login LM_AUTO_DISCOVE RY Discovery Factory Defaults ENUMER ATE, GET Login LM_AUTO_DISCOVE RY Part Configuration Update ENUMER ATE, GET Login LM_PART_REPLACE MENT Part Firmware Update ENUMER ATE, GET Login LM_PART_REPLACE MENT Collect System Inventory on Restart ENUMER ATE, GET Login VirtualAddressMan agement ENUMER ATE, GET Login LM_REMOTE_CONFI GURATION VirtualAddressMan agementApplication
Login, System Control LM_REMOTE_CONFI GURATION Login, System Control LM_AUTO_DISCOVE RY INVOKE Login, System Control LM_REMOTE_CONFI GURATION DCIM_LCService. SetPublicCertificate() INVOKE Login, System Control LM_REMOTE_CONFI GURATION DCIM_LCService. DeleteAutoDiscoveryServerPu blicKey() INVOKE Login, System Control LM_AUTO_DISCOVE RY DCIM_LCService.
DCIM_LCService.ExportSyste mConfiguration() INVOKE DCIM_LCService.ImportSyste mConfiguration() INVOKE Login, System Control LM_REMOTE_CONFI GURATION Administrat or LM_REMOTE_CONFI GURATION DCIM_LCRegisteredProfile ENUMER ATE, GET Login None. DCIM_LCElementConformsTo Profile ENUMER ATE, GET Login None. Version 1.6.
ANNEX A (informative) 661 662 663 664 Change Log 665 Version Date 1.6.0 Description Added the IPAddress, Mask, Gateway, DNS, Domain optional parameters to the DCIM_LCService.ReInitiateDHS() method. Added the DCIM_LCService.ExportSystemConfiguration() method. 1.6.0 4/23/2012 Added optional MaxExecutionTime input parameter to DCIM_LCService.ExportSystemConfiguration() method. Added messages LC016 and LC017 to methods DCIM_LCService.ExportLCLog(), DCIM_LCService.ExportHWInventory(), DCIM_LCService.
668 669 670 Version 1.6.
