DCIM Operating System (OS) Deployment Profile Document Number: DCIM1035 Document Type: Specification Document Status: Published Document Language: E Date: 2011-03-22 Version: 1.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. © 2008 – 2010 Dell Inc. All rights reserved.
CONTENTS 1 2 Scope .................................................................................................................................................... 5 Normative References ........................................................................................................................... 5 2.1 Approved References ................................................................................................................. 5 2.2 Other References .................................
Figures Figure 1 – Operating System (OS) Deployment Profile: Class Diagram ...................................................... 8 Figure 2 – Operating System (OS) Deployment Profile: Object Diagram ................................................... 23 Tables Table 1 – Related Profiles ............................................................................................................................. 7 Table 2 – JobStatus ..........................................................................
Operating System (OS) Deployment Profile 1 Scope The Operating System (OS) Deployment Profile extends the management capabilities of referencing profiles by adding the capability to represent OS deployment configuration features. The OS deployment feature consists of: Provide the supported OS and version information from the embedded OS driver pack.
3.1 can used for statements of possibility and capability, whether material, physical, or causal 3.2 cannot used for statements of possibility and capability, whether material, physical, or causal 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.
3.12 should not indicates that a certain possibility or course of action is deprecated but not prohibited 4 Symbols and Abbreviated Terms 4.1 CIM Common Information Model 5 Synopsis Profile Name: Operating System (OS) Deployment Version: 1.2.0 Organization: DCIM CIM Schema Version: 2.19.
6 Description The Operating System (OS) Deployment Profile describes the OS deployment configuration service, and the methods exposed to manage the service processor OS deployment features. The profile also describes the relationship of the OS Deployment Profile classes to DMTF and Dell profile version information. The interface for the OS deployment feature consists of the following functionality: Identify the list of OS drivers.
7 Implementation Requirements Requirements and guidelines for propagating and formulating certain properties of the classes are discussed in this section. 7.1 DCIM_OSDeploymentService One instance of DCIM_OSDeploymentService shall be instantiated. 7.1.1 ElementName The value of ElementName shall be formulated using the following pattern: ElementName = “OSD” 7.2 CIM_ConcreteJob At most one instance of CIM_ConcreteJob shall be instantiated.
8 Job Name JobStatus JobStatus Description the network share. “UnpackAndShare” Success Successfully executed the method. “UnpackAndShare” Failed Failed to execute the method, refer to MessageID and Message properties of the DCIM_OSDConcreteJob instance for detailed information. BootToNetworkISO Rebooting to ISO Attaching the network ISO image as a local CDROM to the host and booting to it. BootToNetworkISO Success Successfully executed the method.
Output parameters are Version and OSList. Table 3 – DCIM_OSDeploymentService.GetDriverPackInfo() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is not supported in the implementation. 2 Error occurred. 4096 Job started: REF returned to started CIM_ConcreteJob Table 4 – DCIM_OSDeploymentService.GetDriverPackInfo() Method: Parameters Qualifiers Name Type Description/Values OUT (required) Version String NULL or version of the driver pack.
Table 6 – DCIM_OSDeploymentService.UnpackAndAttach() Method: Parameters Qualifiers Name Type Description/Values IN OSName String Name of the OS to unpack drivers for, this value shall match one of the strings in OSList returned for GetDriverPackInfo IN ExposeDuration DateTime Identifies the amount of time up to 18 hours for the drivers to be exposed as an USB device to the host. OUT Job CIM_ConcreteJob REF Returned to keep track of OSD – USB attach job.
Table 9 – DCIM_OSDeploymentService.UnpackAndShare() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is not supported in the implementation. 2 Error occurred. 4096 Job started: REF returned to started CIM_ConcreteJob Table 10 – DCIM_OSDeploymentService.UnpackAndShare() Method: Parameters Qualifiers Name Type Description/Values IN IPAddress String CIFS or NFS share IPv4 address. Example 192.168.10.100 IN ShareName String NFS/CIFS share name.
Table 12 – DCIM_OSDeploymentService.BootToNetworkISO() Method: Parameters Qualifiers Name Type Description/Values IN IPAddress String NFS or CIFS share IPv4 address. Example 192.168.10.100 IN ShareName String NFS or CIFS share name. Here is an example for share name. NFS share name "/home/guest".
Table 13 – DCIM_OSDeploymentService.DetachISOImage() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported. 2 Error occurred. Table 14 – DCIM_OSDeploymentService.DetachISOImage() Method: Parameters Qualifiers Name Type Description/Values OUT (optional) MessageID String If the method fails to execute, the error message ID is returned. OUT (optional) Message String If the method fails to execute, the error message in English is returned.
Table 17 – DCIM_OSDeploymentService.DownloadISOToVFlash() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is not supported in the implementation. 2 Error occurred. 4096 Job started: REF returned to started CIM_ConcreteJob Table 18 – DCIM_OSDeploymentService.DownloadISOToVFlash() Method: Parameters Qualifiers Name Type Description/Values IN IPAddress String TFTP, CIFS, or NFS share IPv4 address. Example 192.168.10.
Table 19 – DCIM_OSDeploymentService.BootToISOFromVFlash() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is not supported in the implementation. 2 Error occurred. 4096 Job started: REF returned to started CIM_ConcreteJob Table 20 – DCIM_OSDeploymentService.
8.11 Method: DCIM_OSDeploymentService.DeleteISOFromVFlash() This method will delete the ISO Image from vFlash. Return values for DeleteISOFromVFlash() shall be as specified in Table 23, where the method-execution behavior matches the return-code description. DeleteISOFromVFlash() method’s parameters are specified in Table 24. Table 23 – DCIM_OSDeploymentService.DeleteISOFromVFlash() Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is unsupported.
Table 26 – DCIM_OSDeploymentService.ConnectNetworkISOImage () Method: Parameters Qualifiers Name Type Description/Values IN IPAddress String CIFS, or NFS share IPv4 address. Example 192.168.10.100 IN ShareName String Network share point. Here is an example for share name. NFS share name "/home/guest".
Table 27 – DCIM_OSDeploymentService.DisconnectNetworkISOImage () Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is not supported in the implementation. 2 Error occurred. Table 28 – DCIM_OSDeploymentService.DisconnectNetworkISOImage () Method: Parameters Qualifiers Name Type Description/Values OUT (optional) MessageID String If the method fails to execute, the error message ID is returned.
Table 30 – DCIM_OSDeploymentService. GetNetworkISOImageConnectionInfo () Method: Parameters Qualifiers Name Type Description/Values OUT IPAddress String CIFS, or NFS share IPv4 address. Example 192.168.10.100 OUT ShareName String Network share point. Here is an example for share name. NFS share name "/home/guest".
Table 31 – DCIM_OSDeploymentService.SkipISOImageBoot () Method: Return Code Values Value Description 0 Request was successfully executed. 1 Method is not supported in the implementation. 2 Error occurred. Table 32 – DCIM_OSDeploymentService.SkipISOImageBoot () Method: Parameters Qualifiers Name Type Description/Values OUT (optional) MessageID String If the method fails to execute, the error message ID is returned.
RegisteredProfile RegisteredProfile = “OS Deployment” OwningEntity = “DCIM” Version = 1.0.
b. SupportedOperatingSystems = String array of OS names a. CIM_ConcreteJob 9.4 Unpack drivers and Attach to Host OS Following sequence of CIM Operations shall be used to unpack drivers for the selected OS to a local partition, and attach the partition to the host OS. 1. Follow the steps (1,2,3) from 9.2 2. Follow the steps (2, 3) from 9.3 3. Invoke extrinsic method using the following parameters: a. Object path = object path returned from 9.3.3 b. Method name = “UnpackAndAttach” c.
9.7 Boot to PXE Following sequence of CIM Operations shall be used to boot to a PXE. 1. Follow the steps (1,2,3) from 9.2 2. Follow the steps (2, 3) from 9.3 3. Invoke extrinsic method using the following parameters: a. Object path = object path returned from 9.3.3 b. Method name = “BootToPXE” 9.8 Detach Drivers Following sequence of CIM Operations shall be used to detach the USB device containing the drivers from the host server. 1. Follow the steps (1,2,3) from 9.2 2. Follow the steps (2, 3) from 9.
4. Refer to dcim_osdeploy.mof for method input and out parameters and data types. 9.11 Detach ISO Image from vFlash Following sequence of CIM Operations shall be used to detach the ISO Image from vFlash that is attached as a CD-ROM device to host server. 1. Follow the steps (1,2,3) from 9.2 2. Follow the steps (2, 3) from 9.3 3. Invoke extrinsic method using the following parameters: a. Object path = object path returned from 9.3.3 b. Method name = “DetachISOFromVFlash” 9.
9.15 Get ISO Image connection Status Following sequence of CIM Operations shall be used to get ISO Image connection status. 10. Follow the steps (1,2,3) from 9.2 11. Follow the steps (2, 3) from 9.3 12. Invoke extrinsic method using the following parameters: a. Object path = object path returned from 9.3.3 b. Method name = “GetNetworkISOImageConnectionInfo” 9.16 One time ISO boot skip Following sequence of CIM Operations shall be used to skip ISO boot once. 13. Follow the steps (1,2,3) from 9.2 14.
Table 33 – CIM Elements: Operating System (OS) Deployment Profile Element Name Requirement Description DCIM_OSDeploymentService Mandatory See section 10.1 CIM_ConcreteJob Conditional See section 10.2 CIM_RegisteredProfile Mandatory See section 10.3 CIM_ElementConformsToProfile Mandatory See section 10.4 Classes 10.1 DCIM_OSDeploymentService DCIM_OSDeploymentService is used to provide a central class for the OS Deployment profile.
RegisteredVersion Mandatory This property shall have a value of “1.0.0”. RegisteredOrganization Mandatory This property shall have a value of 1 (Other).
OSD32 OSD33 OSD34 OSD35 OSD36 OSD37 OSD38 OSD39 OSD40 OSD41 OSD42 OSD43 OSD44 OSD45 OSD46 OSD47 OSD48 OSD49 OSD50 OSD51 OSD52 OSD53 OSD54 OSD55 30 ISO image is not attached Installed BIOS version does not support this method Unable to continue with BootToPXE - ISO image is attached to the system Lifecycle Controller is disabled Boot to ISO Image has been cancelled by user using CTLR+E option on the server ISO image size too large Copying the ISO image from the network failed Unable to find the VFlash VFla
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_OSDeploymentService.mof Version 1.2.
