2 Operating System (OS) Deployment 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: DCIM1035 Document Type: Specification Document Status: Published Document Language: E Date: 2012-03-08 27 Version: 1.4.
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.
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 CONTENTS 1 2 3 4 5 6 7 8 9 10 11 Scope .................................................................................................................................................... 7 Normative References........................................................................................................................... 7 Terms and Definitions .......................................
103 Figures 104 105 Figure 1 – Operating System (OS) Deployment Profile: Class Diagram .................................................... 11 106 Tables 107 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 ...........................................................................................................................
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 42 – DCIM_OSDeploymentService.DeleteISOFromVFlash() Method: Parameters ......................... 32 Table 43 – DCIM_OSDeploymentService.DeleteISOFromVFlash() Method: Standard Messages ........... 32 Table 44 – DCIM_OSDeploymentService.ConnectNetworkISOImage () Method: Return Code Values ... 32 Table 45 – DCIM_OSDeploymentService.ConnectNetworkISOImage() Method: Parameters ......
Operating System (OS) Deployment Profile 181 182 1 183 184 185 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: Scope 186 • Provide the supported OS and version information from the embedded OS driver pack.
213 o DCIM_OSDConcreteJob.mof 214 o DCIM_LCElementConformsToProfile.mof 215 o DCIM_LCRegisteredProfile.mof 216 3 217 For the purposes of this document, the following terms and definitions apply. 218 219 220 3.1 221 222 223 3.2 224 225 3.3 226 227 3.4 228 229 3.5 230 231 3.6 232 233 3.7 234 235 236 3.8 237 238 239 3.9 Terms and Definitions Conditional – Indicates requirements to be followed strictly in order to conform to the document when the specified conditions are met.
240 241 242 3.10 243 244 245 3.11 246 247 3.12 248 249 3.13 250 251 252 3.14 253 254 255 3.15 256 257 258 3.16 259 3.17 260 261 262 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 263 shall not – Indicates requirements to be followed strictly in order to conform to the document and from which no deviation is permitted.
276 Scoping Class: CIM_ComputerSystem 277 278 279 The Operating System (OS) Deployment Profile extends the management capability of the referencing profiles by adding the capability to support OS deployment activities by manipulating the OS deployment features provided by the service processor. These features include: 280 • Identify the list of OS drivers. 281 282 • Unpack the OS DUP and extract drivers for a specified OS; the drivers are placed on a local flash drive (nvram).
304 305 306 Figure 1 represents the class schema for the Operating System (OS) Deployment Profile. For simplicity, the prefix CIM_ has been removed from the names of the classes that are standard DMTF classes. 307 308 309 310 The OS Deployment feature in a service processor is represented by the instance of the DCIM_OSDeploymentService class. The DCIM_OSDeploymentService has extrinsic methods for accomplishing the various OS deployment features described above.
313 7 314 315 Requirements and guidelines for propagating and formulating certain properties of the classes are discussed in this section. 316 This section describes the implementation of Dell OS Deployment. Implementation Requirements 317 Table 2 – Class Requirements: Power State Management Profile Element Name Requirement Description DCIM_OSDeploymentService Mandatory The class shall be implemented in the “root/dcim” namespace. See section 7.
334 7.1.2 Operations 335 The following table details the implemented operations on DCIM_OSDeploymentService. 336 Table 3 –DCIM_OSDeploymentService - Operations Operation Name Get Enumerate Invoke Requirements Mandatory Mandatory Mandatory Required Input Instance URI Class URI Instance URI and Method parameters 337 338 7.1.3 Class Properties 339 340 341 342 The following table details the implemented properties for DCIM_OSDeploymentService instance in a system.
357 7.2.2 Class Properties 358 359 360 361 The following table lists the implemented properties for DCIM_OSDConcreteJob instance in a system. The “Requirements” column shall denote whether the property is implemented (for requirement definitions, see section 3). The “Additional Requirements” column shall denote either possible values for the property, or requirements on the value formulation.
Job Name DownloadISOToVFlash ConnectNetworkISOImage ConnectRFSISOImage Job Status JobStatus Description CD-ROM to the host and booting to it. Success Successfully executed the method. Failed Failed to execute the method, refer to MessageID and Message properties on the returned DCIM_OSDConcreteJob instance for detailed information. Downloading Copying the ISO image from network share to vFlash SD card. Success Successfully executed the method. Failed Failed to execute the method.
380 Table 6 – DCIM_LCRegisteredProfile - Operations Operation Name Get Enumerate Requirements Mandatory Mandatory Required Input Instance URI Class URI 381 382 7.3.3 Class Properties 383 384 385 386 387 The following table lists the implemented properties for DCIM_LCRegisteredProfile instance representing Operating System (OS) Deployment Profile implementation. The “Requirements” column shall denote whether the property is implemented (for requirement definitions, see section 3).
390 8 391 392 This section details the requirements for supporting extrinsic methods for the CIM elements defined by this profile. 393 394 395 8.1 396 397 The following table lists the return values for GetDriverPackInfo() method, where the method-execution behavior matches the return-code description. DCIM_OSDeploymentService.
400 Table 9 – DCIM_OSDeploymentService.GetDriverPackInfo() Method: Parameters Qualifiers Name Type Description/Values OUT, REQ Version String NULL or version of the driver pack. OUT, REQ OSList[] String NULL or contains the list of operating systems supported for this server. OUT MessageID String If the method fails to execute, the error message ID is returned. OUT Message String If the method fails to execute, the error message in English is returned.
409 410 Table 12 – DCIM_OSDeploymentService.UnpackAndAttach() Method: Parameters Qualifiers Name Type Description/Values IN, REQ OSName String Name of the OS to unpack drivers for, this value shall match one of the strings in OSList returned for GetDriverPackInfo IN, REQ 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, REQ Job CIM_ConcreteJob REF Returned to keep track of OSD – USB attach job.
412 8.3 DCIM_OSDeploymentService.DetachDrivers() 413 414 415 416 This OSDeploymentService.DetachDrivers() method is used to detach the USB device containing the drivers from the host server. The following table lists the return values for DetachDrivers() method,, where the method-execution behavior matches the return-code description. 417 Table 14 – DCIM_OSDeploymentService.DetachDrivers() Method: Return Code Values 418 Value Description 0 Request was successfully executed. 2 Error occurred.
428 429 Table 18 – DCIM_OSDeploymentService.UnpackAndShare() Method: Parameters Qualifiers Name Type Description/Values IN, REQ IPAddress String CIFS or NFS share IPv4 address.For example, 192.168.10.100 IN, REQ ShareName String NFS or CIFS share name. For example, “/home/guest” or “guest_smb” respectively. IN, REQ OSName String Operating System name IN, REQ ShareType Uint32 0 = NFS or CIFS = 2 IN, REQ Workgroup String Workgroup name, if applicable.
431 8.5 DCIM_OSDeploymentService.BootToNetworkISO() 432 433 434 The BootToNetworkISO() method is used to boot to the iDRAC pre-operating system image that was already downloaded. The following table lists the return values for BootToNetworkISO() method, where the method-execution behavior matches the return-code description. 435 436 Table 20 – DCIM_OSDeploymentService.BootToNetworkISO() Method: Return Code Values Value Description 2 Error occurred.
437 438 Table 21 – DCIM_OSDeploymentService.BootToNetworkISO() Method: Parameters Qualifiers Name Type Description/Values IN, REQ IPAddress String NFS or CIFS share IPv4 address. For example, 192.168.10.100 IN, REQ ShareName String NFS or CIFS share name. For example, "/home/guest" or “guest_smb” respectively. IN, REQ ImageName String ISO image name IN, REQ ShareType Uint32 0=NFS or CIFS = 2 IN, REQ Workgroup String Workgroup name, if applicable.
MessageID (OUT parameter) Message MessageArguments[] cancelled by user using CTLR+E option on the server OSD47 Inaccessible network share OSD50 Lifecycle Controller is in field service mode OSD51 Reboot the system to run pending Lifecycle Controller Tasks 439 440 8.6 DCIM_OSDeploymentService.DetachISOImage() 441 442 443 444 445 The DetachISOImage() method is used to detach the ISO Image from the host server.
448 Table 24 – DCIM_OSDeploymentService.DetachISOImage() Method: Parameters Qualifiers Name Type Description/Values OUT MessageID String If the method fails to execute, the error message ID is returned. OUT Message String If the method fails to execute, the error message in English is returned. OUT MessageArguments [] String Substitution variables for dynamic error messages 449 Table 25 – DCIM_OSDeploymentService.
457 Table 27 – DCIM_OSDeploymentService.BootToPXE() Method: Parameters Qualifiers Name Type Description/Values OUT MessageID String If the method fails to execute, the error message ID is returned. OUT Message String If the method fails to execute, the error message in English is returned. OUT MessageArguments [] string Substitution variables for dynamic error messages 458 Table 28 – DCIM_OSDeploymentService.
468 Table 31 – DCIM_OSDeploymentService.BootToHD() Method: Standard Messages MessageID (OUT parameter) Message MessageArguments[] OSD3 Lifecycle Controller is being used by another process OSD8 Setting Boot to PXE through IPMI failed OSD9 Failed to reboot the system using IPMI command OSD35 Lifecycle Controller is disabled 469 470 471 472 8.9 DCIM_OSDeploymentService.
479 480 Table 33 – DCIM_OSDeploymentService.DownloadISOToVFlash() Method: Parameters Qualifiers Name Type Description/Values IN, REQ IPAddress String TFTP, CIFS, or NFS share IPv4 address. For example, 192.168.10.100 IN, REQ ShareName String NFS or CIFS network share point. For example, "/home/guest" or “guest_smb.” IN, REQ ImageName String ISO Image name IN, REQ ShareType Uint32 IN Workgroup String Workgroup name, if applicable. IN UserName String User name, if applicable.
MessageID (OUT parameter) Message MessageArguments[] OSD37 ISO image size too large OSD40 VFlash is not Dell-licensed OSD42 Downloading ISO File to VFlash failed OSD43 VFlash unavailable OSD47 Inaccessible network share OSD48 ISO Image more than 4GB not supported OSD52 VFlash is Disabled OSD53 VFlash is write-protected OSD54 VFlash already has 16 partitions OSD55 ISO Image is attached to host 481 482 8.10 DCIM_OSDeploymentService.
MessageID (OUT parameter) Message MessageArguments[] OSD19 The fork() command for a child process to do the task failed OSD21 Unable to boot to ISO image OSD36 Boot to ISO Image has been cancelled by user using CTLR+E option on the server OSD40 VFlash is not Dell-licensed OSD41 ISO Image not found on VFlash OSD43 VFlash unavailable OSD50 Lifecycle Controller is in field service mode OSD51 Reboot the system to run pending Lifecycle Controller Tasks OSD52 VFlash is Disabled OSD53 VFlash
499 500 Table 39 – DCIM_OSDeploymentService.DetachISOFromVFlash() Method: Parameters Qualifiers Name Type Description/Values OUT MessageID String If the method fails to execute, the error message ID is returned. OUT Message String If the method fails to execute, the error message in English is returned. OUT MessageArguments [] string Substitution variables for dynamic error messages. Table 40 – DCIM_OSDeploymentService.
510 Table 42 – DCIM_OSDeploymentService.DeleteISOFromVFlash() Method: Parameters 511 Qualifiers Name Type Description/Values OUT MessageID String If the method fails to execute, the error message ID is returned. OUT Message String If the method fails to execute, the error message in English is returned. OUT MessageArguments [] String Substitution variables for dynamic error messages Table 43 – DCIM_OSDeploymentService.
530 531 Table 45 – DCIM_OSDeploymentService.ConnectNetworkISOImage() Method: Parameters Qualifiers Name Type Description/Values IN, REQ IPAddress String CIFS or NFS share IPv4 address. For example, 192.168.10.100 IN, REQ ShareName String NFS or CIFS network share point. For example, "/home/guest" or “guest_smb.” IN, REQ ImageName String ISO image name IN, REQ ShareType Uint32 IN Workgroup String Workgroup name, if applicable IN UserName String User name, if applicable.
MessageID (OUT parameter) Message MessageArguments[] OSD61 IP Address is Invalid 532 533 534 535 536 537 8.14 DCIM_OSDeploymentService.DisconnectNetworkISOImage() The DisconnectNetworkISOImage() method is used to disconnect and detach the ISO Image from the host system. The following table lists the return values for the DisconnectNetworkISOImage() method, where the method-execution behavior matches the return-code description. 538 539 540 Table 47 – DCIM_OSDeploymentService.
552 553 Table 50 – DCIM_OSDeploymentService.GetNetworkISOImageConnectionInfo() Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred. 554 555 The following table lists the the output parameters for the GetNetworkISOImageConnectionInfo() method. 556 557 Table 51 – DCIM_OSDeploymentService.
565 566 Table 53 – DCIM_OSDeploymentService.SkipISOImageBoot () Method: Return Code Values Value Description 0 Request was successfully executed. 2 Error occurred. The following table lists the output parameters for the SkipISOImageBoot() method. 567 Table 54 – DCIM_OSDeploymentService.SkipISOImageBoot() Method: Parameters Qualifiers Name Type Description/Values OUT MessageID String If the method fails to execute, the error message ID is returned.
577 578 Table 57 – DCIM_OSDeploymentService.DisconnectRFSISOImage() Method: Parameters Qualifiers Name Type Description/Values OUT, REQ MessageID String If the method fails to execute, the error message ID is returned. OUT, REQ Message String If the method fails to execute, the error message in English is returned. OUT MessageArguments[] string Substitution variables for dynamic error messages Table 58 – DCIM_OSDeploymentService.
595 Table 60 – DCIM_OSDeploymentService.ConnectRFSISOImage() Method: Parameters Qualifiers Name Type Description/Values IN, REQ IPAddress String IP address of the host system that hosts the ISO Image IN, REQ ShareName String Share name of the host system that hosts the ISO Image IN, REQ ImageName string ISO Image name on the host system. IN, REQ ShareType Uint16 Type of the share: • 0 (NFS) • 2 (CIFS) IN Username string User name of the account to access the network share.
597 8.19 DCIM_OSDeploymentService.GetRFSISOImageConnectionInfo() 598 599 600 601 The GetRFSISOImageConnectionInfo() method is used to provide the status of the ISO Image connection that has been exposed to the host system. The following method returns the values for GetRFSISOImageConnectionInfo() method, where the method-execution behavior matches the returncode description. 602 603 604 605 606 607 Table 62 – DCIM_OSDeploymentService.
612 Table 66 – DCIM_OSDeploymentService.GetHostMACInfo() Method: Parameters Qualifiers Name Type Description/Values OUT, REQ MACList String Contains the list of mac addresses from the system OUT, REQ MessageID String If the method fails to execute, the error message ID is returned. OUT, REQ Message String If the method fails to execute, the error message in English is returned. OUT MessageArguments [] String Substitution variables for dynamic error messages.
Class and Method Operation User Privilege Required License Required DCIM_OSDeploymentService. UnpackAndShare() INVOKE Login, System Control LM_REMOTE_OS_DEPLOY MENT DCIM_OSDeploymentService. BootToNetworkISO() INVOKE Login, System Control LM_REMOTE_OS_DEPLOY MENT DCIM_OSDeploymentService. BootToPXE() INVOKE Login, System Control LM_REMOTE_OS_DEPLOY MENT DCIM_OSDeploymentService. DownloadISOToVFlash() INVOKE Login, System Control LM_REMOTE_OS_DEPLOY MENT DCIM_OSDeploymentService.