White Papers

ManualsBrandsDell ManualsConverged InfrastructureSystems Management Solution Resources

Lifecycle Controller

(LC) Management Profile

Document Number: DCIM1039

Document Type: Specification

Document Status: Published

Document Language: E

Date: 2012-10-25

Version: 1.3.3

Summary of content (45 pages)

PAGE 1
Lifecycle Controller (LC) Management Profile Document Number: DCIM1039 Document Type: Specification Document Status: Published Document Language: E Date: 2012-10-25 Version: 1.3.
PAGE 2
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. ABSENT A SEPARATE AGREEMENT BETWEEN YOU AND DELL™ WITH REGARD TO FEEDBACK TO DELL ON THIS PROFILE SPECIFICATION, YOU AGREE ANY FEEDBACK YOU PROVIDE TO DELL REGARDING THIS PROFILE SPECIFICATION WILL BE OWNED AND CAN BE FREELY USED BY DELL. © 2011 Dell Inc. All rights reserved.
PAGE 3
CONTENTS 1 2 3 4 5 6 7 8 9 Scope .................................................................................................................................................... 7 Normative References........................................................................................................................... 7 2.1 Approved References ................................................................................................................. 7 2.2 Other References..................
PAGE 4
9.19 Export and view the hardware inventory as shipped from the factory ...................................... 43 10 CIM Elements ...................................................................................................................................... 43 ANNEX A (informative) Related MOF Files ............................................................................................... 44 ANNEX B..................................................................................................
PAGE 5
Figures Figure 1 – LC Management Profile: Class Diagram ................................................................................... 10 Tables Table 1 – Related Profiles ............................................................................................................................. 9 Table 2 – Class Requirements: Power State Management Profile............................................................. 11 Table 3 – DCIM_LCService - Operations ...........................................
PAGE 6
Table 39 – DCIM_LCService.ExportFactoryConfiguration() Method: Parameters ..................................... 32 Table 40 – DCIM_LCService.LCWipe() Method: Return Code Values ...................................................... 33 Table 41 – DCIM_LCService.LCWipe() Method: Parameters .................................................................... 33 Table 42 – DCIM_LCService.BackupImage() Method: Return Code Values ............................................. 34 Table 43 – DCIM_LCService.
PAGE 7
Lifecycle Controller (LC) Management 1 Scope The Lifecycle Controller (LC) Management Profile extends the management capabilities of referencing profiles by adding the capability to represent the configuration attributes for the Dell Lifecycle Controller. The LC configuration attributes are modeled as attribute collections for an individual LC; typically there is one LC per system platform. This profile is a specialization of the BIOS Management Profile.
PAGE 8
3.3 conditional indicates requirements to be followed strictly in order to conform to the document when the specified conditions are met 3.4 mandatory indicates requirements to be followed strictly in order to conform to the document and from which no deviation is permitted 3.5 may indicates a course of action permissible within the limits of the document 3.6 need not indicates a course of action permissible within the limits of the document 3.
PAGE 9
3.14 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 4 Symbols and Abbreviated Terms 4.1 CIM Common Information Model 4.2 LC Lifecycle Controller 5 Synopsis Profile Name: LC Management Version: 1.3.0 Organization: DCIM CIM Schema Version: 2.19.
PAGE 10
6 Description The LC Management Profile describes the LC attribute configuration service and the attributes instances that the service manages. The profile also describes the relationship of the LC attribute service to the Dell profile version information. Figure 1 represents the class schema for the Lifecycle Controller (LC) Management. The LC service in a managed system is represented by the instance of the DCIM_LCService class.
PAGE 11
7 Implementation Requirements This section describes the implementation of Dell LC Management. Table 2 – Class Requirements: Power State Management Profile Element Name Requirement Description DCIM_LCService Mandatory The class shall be implemented in the Implementation Namespace. See section 7.1. DCIM_LCEnumeration Mandatory The class shall be implemented in the Implementation Namespace. See section 7.2. DCIM_LCString Mandatory The class shall be implemented in the Implementation Namespace.
PAGE 12
“http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/DCIM_LCService?__cimnamespace=+SystemCreationClas sName=DCIM_ComputerSystem+SystemName=DCIM:ComputerSystem+CreationClassName=DCI M_LCService+Name=DCIM:LCService” 7.1.2 Operations The following table details the implemented operations on DCIM_LCService.
PAGE 13
7.2.2 Operations The following table details the implemented operations on DCIM_LCEnumeration. Table 2 – DCIM_LCEnumeration - Operations Operation Name Get Enumerate DCIM_LCService.SetAttributte() DCIM_LCService.SetAttributes() Requirements Mandatory Mandatory Mandatory Mandatory Required Input Instance URI Class URI See section 8.1 See section 8.2 7.2.3 Properties The following table details the implemented properties for DCIM_LCEnumeration instance representing a LC enumeration attribute.
PAGE 14
Table 4 – DCIM_LCEnumeration Attributes AttributeName Description IsReadOnly PossibleValues Whether the Component Configuration Recovery feature is licensed. Licensed True “Yes”, “No” False “Disabled”, “Apply always”, “Apply only if firmware match” Part Configuration Update Part cofiguration update method. Part Firmware Update Disable (default) = firmware update is not allowed. Allow version upgrade only = Allow firmware update only on up-revision.
PAGE 15
7.3.1 Resource URIs for WinRM® The class Resource URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LCString?__cimnamespace=” The key property shall be the InstanceID. The instance Resource URI for DCIM_LCString instance shall be: “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LCString?__cimnamespace=+InstanceID= ” 7.3.2 Operations The following table details the implemented operations on DCIM_LCString.
PAGE 16
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. Mandatory The property value shall match the format described in “Value Expression” column at the corresponding row in Table 7.
PAGE 17
AttributeName SYSID Description Dell System ID. IsReadOnly MinLength MaxLength TRUE N/A N/A Provisioning Server Provisioning server address and port. FALSE 0 255 VirtualAddressManage mentApplication* The console name of the Virtual Address Management Application, if the DCIM_LCEnumeration VirtualAddressManage ment attribute is set to CurrentValue equals “Console”. FALSE* 0 32 Value Expression Examples: hostname hostname.domai n.com 1.1.1.1 Mypc:8080 Myps.dell.com(1. 2.3.
PAGE 18
Table 8 – DCIM_LCRegisteredProfile - Operations Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 7.4.3 Properties The following table details the implemented properties for DCIM_LCRegisteredProfile instance representing Lifecycle Controller (LC) Management implementation. The “Requirements” column shall denote the implementation requirement for the corresponding property.
PAGE 19
Return code values for the SetAttribute( ) method are specified in Table 10 and parameters are specified in Table 11. Invoking the SetAttribute( ) method multiple times can result in the earlier requests being overwritten or lost. Table 10 – DCIM_LCService.SetAttribute() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 11 – DCIM_LCService.
PAGE 20
8.2 DCIM_LCService.SetAttributes() The SetAttributes( ) method is used to set or change the values of a group of attributes. Invocation of the SetAttributes( ) method shall change the values of the DCIM_LCAttribute.CurrentValue or PendingValue properties that correspond to the names specified by the AttributeName parameter and the values specified by the AttributeValue parameter if the respective DCIM_LCAttribute.IsReadOnly property is FALSE. Invocation of this method when the respective DCIM_LCAttribute.
PAGE 21
Table 12 – DCIM_LCService.SetAttributes() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 13 – DCIM_LCService.SetAttributes() Method: Parameters Qualifiers Name Type Description/Values IN, REQ AttributeName string [ ] Array of DCIM_LCAttribute.
PAGE 22
8.3 DCIM_LCService.CreateConfigJob() The CreateConfigJob( ) method is used to apply the pending values created by the SetAttribute and SetAttributes methods. The successful execution of this method creates a job for application of pending attribute values. Return code values for the CreateConfigJob( ) method are specified in Table 14, and parameters are specified in Table 15. Subsequent calls to CreateConfigJob after the first CreateConfigJob will result in error until the first job is completed.
PAGE 23
8.4 DCIM_LCService.ReInitiateDHS() A method used to reinitiate the provisioning server discovery and handshake. Table 16 – DCIM_LCService.ReInitiateDHS() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 17 – DCIM_LCService.
PAGE 24
Table 18 – DCIM_LCService.ClearProvisioningServer() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 19 – DCIM_LCService.ClearProvisioningServer() Method: Parameters Qualifiers Name Type Description/Values OUT MessageID string Error MessageID is returned if the method fails to execute OUT Message string Error Message in English corresponding to MessageID is returned if the method fails to execute 8.
PAGE 25
Table 22 – DCIM_LCService.DownloadClientCerts() Method: Return Code Values Value Description 1 Method is unsupported. 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 23 – DCIM_LCService.DownloadClientCerts() Method: Parameters Qualifiers Name Type Description/Values IN, OctetString, REQ KeyContent string Base64 encoded private key content.
PAGE 26
Table 24 – DCIM_LCService.DeleteAutoDiscoveryClientCerts() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 25 – DCIM_LCService.
PAGE 27
8.9 DCIM_LCService.SetCertificateAndPrivateKey() This method is used to update iDRAC certificate and private key pairs using the contents of a PKCS#12 file. Table 26 – DCIM_LCService.SetCertificateAndPrivateKey() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 27 – DCIM_LCService.
PAGE 28
8.10 DCIM_LCService.SetPublicCertificate() This method is used to update a public SSL Certificate on the iDRAC. Table 28 – DCIM_LCService.SetPublicCertificate() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 29 – DCIM_LCService.SetPublicCertificate() Method: Parameters Qualifiers Name Type Description/Values IN, REQ Type string This parameter specifies the service the certificate is for.
PAGE 29
Table 30 – DCIM_LCService.DeleteAutoDiscoveryServerPublicKey() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 31 – DCIM_LCService.
PAGE 30
Table 34 – DCIM_LCService.ExportLCLog() Method: Return Code Values Value Description 1 Method is unsupported. 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 35 – DCIM_LCService.
PAGE 31
8.14 DCIM_LCService.ExportHWInventory() This method is used to export the hardware inventory from the Lifecycle Controller to a file on a remote share. Table 36 – DCIM_LCService.ExportHWInventory() Method: Return Code Values Value Description 1 Method is unsupported. 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 37 – DCIM_LCService.
PAGE 32
8.15 DCIM_LCService.ExportFactoryConfiguration() This method is used to export the factory configuration from the Lifecycle Controller to a file on a remote share. Table 38 – DCIM_LCService.ExportFactoryConfiguration() Method: Return Code Values Value Description 1 Method is unsupported. 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 39 – DCIM_LCService.
PAGE 33
8.16 DCIM_LCService.LCWipe() This method is called to delete all configurations from the Lifecycle controller before the system is retired. Table 40 – DCIM_LCService.LCWipe() Method: Return Code Values Value Description 1 Method is unsupported. 2 Error occurred 4096 Job started: REF returned to started CIM_ConcreteJob Table 41 – DCIM_LCService.
PAGE 34
Table 42 – DCIM_LCService.BackupImage() Method: Return Code Values Value Description 1 Method is unsupported. 2 Error occurred 4096 A DCIM_ConcreteJob is returned Table 43 – DCIM_LCService.BackupImage() Method: Parameters 34 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), or 2 (CIFS) or not specified.
PAGE 35
8.18 DCIM_LCService.RestoreImage() This method is used to import System Profile by restoring the firmware and configurations for the Lifecycle Controller. The successful method execution shall import only the values of the settable attributes in the BIOS and Boot Management, Simple NIC, RAID, Lifecycle Controller (LC) Management and IDRAC Card profiles. Note that settings that are NOT settable through these attributes shall NOT be imported. Version 1.3.
PAGE 36
Table 44 – DCIM_LCService.RestoreImage() Method: Return Code Values Value Description 1 Method is unsupported. 2 Error occurred 4096 A DCIM_ConcreteJob is returned Table 45 – DCIM_LCService.RestoreImage() Method: Parameters 36 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), or 2 (CIFS) or not specified. IN ShareName String Share name for the network share.
PAGE 37
Qualifiers Name Type Description/Values OUT MessageArguments string[] Substitution variables for dynamic error messages 8.19 DCIM_LCService.GetRSStatus() This method is used to get the Data Manager Status. Table 46 – DCIM_LCService.GetRSStatus() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred Table 47 – DCIM_LCService.
PAGE 38
http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/DCIM_LCRegisteredProfile?__cimnamespace=root/interop+InstanceID=DCIM:LCMan agement:1.1.0 Results for the InstanceID of DCIM:LCManagement:1.1.0 shown below. If no instance is returned, the profile is not supported. DCIM_LCRegisteredProfile AdvertiseTypeDescriptions = WS-Identify, Interop Namespace AdvertiseTypes = 1, 1 InstanceID = DCIM:LCManagement:1.1.
PAGE 39
on:CCR5 http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_NICAttribute?__cimnamespace=root/dcim The instance containing the attribute will be returned. 9.4 Get “Part Firmware Update” attribute The URI for getting particular instance information is deterministic (i.e the InstanceID will be unique for each instance) GET the DCIM_LCEnumeration instance using an InstanceID of DCIM_LCEnumeration:CCR4. See section 3.14 for a definition of GET. Class URI: http://schemas.dmtf.
PAGE 40
em+CreationClassName=DCIM_LCService+SystemName=DCIM:ComputerSystem+Na me=DCIM:LCService D) Examine output parameters per Table 11 and Table 13 E) Apply the pending values per Section 9.7 F) Repeat A) and examine the applicable instances to confirm successful execution of the method 9.7 Apply pending values A) To invoke the CreateConfigJob( ) method, construct input parameters per Table 15 B) INVOKE CreateConfigJob( ) method Class URI: http://schemas.dmtf.
PAGE 41
em+CreationClassName=DCIM_LCService+SystemName=DCIM:ComputerSystem+Na me=DCIM:LCService C) Examine output parameters per Table 19 9.10 Replace auto discovery public key A) Replace the auto discovery Server public key using the DownloadServerPublicKey() method, construct the input parameters per Table 21 B) INVOKE the DownloadServerPublicKey() method Class URI: http://schemas.dmtf.
PAGE 42
9.13 Delete auto discovery client certificate, private key and password A) Delete the auto discovery client certificate, private key and password using the DeleteAutoDiscoveryClientCerts() method, construct the input parameters per Table 25 B) INVOKE the DeleteAutoDiscoveryClientCerts() method Class URI: http://schemas.dmtf.
PAGE 43
C) Examine output parameters per Table 33 9.17 Export and view the content of the Lifecycle log A) To invoke the ExportLCLog() method, construct the input parameters per Table 35 B) INVOKE the ExportLCLog() method Class URI: http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_LCService?SystemCreationClassName=DCIM_ComputerSyst em+CreationClassName=DCIM_LCService+SystemName=DCIM:ComputerSystem+Na me=DCIM:LCService C) Examine output parameters per Table 35 9.
PAGE 44
ANNEX A (informative) Related MOF Files Dell Tech Center MOF Library: http://www.delltechcenter.com/page/DCIM.Library.MOF Related Managed Object Format (MOF) files: DCIM_LCAttribute.mof DCIM_LCElementConformsToProfile.mof DCIM_LCEnumeration.mof DCIM_LCRegisteredProfile.mof DCIM_LCService.mof DCIM_LCString.mof 44 Version 1.3.
PAGE 45
Version 1.3.