Dell OpenManage Deployment Toolkit Version 4.
Notes, Cautions, and Warnings NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2012 Dell Inc.
Contents Notes, Cautions, and Warnings...................................................................................................2 1 Introduction..................................................................................................................................7 What's New In This Release....................................................................................................................................7 Other Documents You May Need.......................................
Sample Configuration Files For Linux.....................................................................................................................27 Sample Scripts For Windows.................................................................................................................................28 Sample Scripts For Linux........................................................................................................................................29 RPMs...............................
W2K8INST.BAT And W2K12INST.BAT.............................................................................................................50 UNATTEND.XML...............................................................................................................................................51 lininst................................................................................................................................................................51 suseinst..................................
Introduction 1 The Dell OpenManage Deployment Toolkit (DTK) includes a set of utilities, sample scripts, and sample configuration files that you need to deploy and configure your Dell system. You can use DTK to build script-based and RPM-based installation for deploying large number of systems on a preoperating system environment in a reliable way, without changing their current deployment processes.
– • • • Listing global hot spares. NOTE: For more information, see Dell OpenManage Deployment Toolkit Command Line Interface Reference Guide available at dell.com/support/manuals.
• The Integrated Dell Remote Access Controller 7 (iDRAC7) User's Guide provides information about configuring and using iDRAC7 for yx2x rack, tower, and blade servers to remotely manage and monitor your system and its shared resources through a network.
Prerequisites And Deployment 2 The Deployment ToolKit (DTK) is a collection of Windows PE and Linux-based utilities and scripts that assist in performing operating system tasks and deployment on Dell systems. An advanced knowledge of Windows PE and Linux is required for users who want to use the DTK utilities to perform pre-operating system and post-operating system configuration tasks or to run a scripted deployment in the respective environments.
• SUSE Enterprise Linux 11 SP2 (64-bit) • SUSE Enterprise Linux 10 SP4 (64-bit) NOTE: The RPMs are available in the RPMs folder of DTK ELI ISO and also at linux.us.dell.com/repo/hardware/ OMSA_7.1.1/. Supported BIOS Firmware Versions The latest (n) version or the n-1 version of BIOS firmware that is available at support.dell.com. Prerequisites And Requirements The prerequisites and requirements to run DTK utilities are as given below. NOTE: The target system must not have Fibre Channel (FC) devices.
– Network access • A target system with a media drive, if performing a local deployment. • A target system with a media drive and network access, if performing a network deployment. • All DTK utilities, sample scripts, and sample configuration files. • Dell Systems Management Tools and Documentation DVD. Your operating system software and documentation. An optimally configured source system with network access. • • NOTE: You can download the latest drivers from support.dell.com.
Drivers Purpose winpe4.x\WINPE4.0_driverinst.bat Used to install Dell-provided drivers, from \Dell\x32\Drivers or \Dell \x64\Drivers, into the customized Windows PE 4.0 image. Other Supporting Tools And System Files While DTK provides all the necessary utilities and scripts for deploying Dell systems, there are additional applications, utilities, and system files needed to create the pre-operating system environment in which this toolkit is used. NOTE: Ensure that the tools are 32-bit compatible.
Additional Tools Purpose Source Save in DTK location NOTE: For legacy operating systems, you may need to use the driver disk. At the end of the Red Hat Enterprise Linux Server installation, you may need to install the drivers available on the Systems Build and Update Utility. Deploying Operating Systems After the system hardware is versioned and configured, an operating system can be installed using unattended setup files, samples of which are provided as part of DTK.
DTK is designed to be flexible enough to fit into almost any deployment plan. DTK components can be used in many different ways to assist IT staff in deploying Dell systems in large numbers. Because all the tools and scripts are task oriented, many of them can be used separately to perform a specific task on many systems or collectively to perform many tasks on many systems at once. For information on the deployment methods, see Running The Deployment Scripts.
Deployment Methods Complexity Advantages • • PXE boot for Linux High • • • • • Disadvantages deployment solution deployment solution framework. framework. Third-party deployment solution framework is used as the deployment transport mechanism. Tasks and scripts can be pushed to the target systems. Everything is in one place on a network share. Easy to manage— changes have to be made in only in one place. High flexibility for remote deployment. No media required. Faster deployment.
NOTE: You can obtain the system BIOS, BMC, RAID, and/or RAC configuration files from DTK Windows PE ISO image and running the SYSCAP.BAT, RAIDCAP.BAT, and RACCAP.BAT scripts or for Linux from DTK Linux ISO image and running the syscap.sh, raidcap.sh, and raccap.sh scripts. NOTE: In previous releases, you could use a system profile generated on a specific Dell system to deploy only that same system model. From DTK version 2.
NOTE: For more information on configuring RAC and BIOS options on your source system, see the Integrated Dell Remote Access Controller 7 (iDRAC7) User Guide. 4. DTK carries racadm for DRAC/iDRAC configurations – one of the important feature that racadm picks up the BIOS configurations available with racadm for 12G Servers, this needs to be highlighted as we want Customers to start adopting racadm for 12G BIOS configurations as we move forward to an Unified CLI.
Downloading DTK 3 This section describes some of the procedures necessary to begin the deployment process, including: • Downloading and unzipping the Deployment Toolkit (DTK) components, including a comprehensive matrix of DTK components. • Setting up a directory structure to facilitate a successful deployment, including a list of the supporting components that are not included with DTK, but are needed to use DTK. • Setting up an optimally configured source system.
DTK Components On Systems Running Windows Workstation is the system on which the DTK components are extracted. Source system is an optimally configured system from which the system settings are captured. Target system is the system on which the settings captured from the source system are replicated.
Extracting DTK Components On Systems Running Linux DTK components are provided as an ISO image at support.dell.com. You can use a CD/DVD burning software to burn the ISO image on a bootable CD/DVD or loop mount the ISO image to access the image contents. Perform the following steps to extract DTK components to a workstation running a Linux operating system. 1. Download the ISO image dtk_X.X_XXX_Linux.iso from support.dell.
The following table describes the contents of the directory structure on the target system. Table 6. Target System Directory Structure Contents Contents Details /lib The libraries and drivers required for embedded Linux to function. /bin Basic utilities (ls, chmod, and so on). /sbin Utilities that are required by the system superuser to perform administrative tasks. /opt The libraries, binaries, and scripts required for the toolkit to function.
Contents Details /tmp The only safe, writable area. However, all data in this folder is lost every time you reboot. /usr Miscellaneous tools and libraries for embedded Linux to function. DTK Contents DTK contains Windows PE-based or Linux-based utilities, sample scripts, sample configuration files, drivers, RPMs, and documentation for automating the deployment on Dell systems. For a more information on DTK utilities, see the Dell OpenManage Deployment Toolkit Command Line Interface Reference Guide.
Toolkit Components Purpose NOTE: This feature may not be supported on all systems. RAC 4 Configures Dell Remote Access Controller (DRAC) 4/P and DRAC 4/I. RAC 5 Configures DRAC 5/iDRAC. pci.ids Reports PCI devices when used with syscfg.exe. disclaimer.txt Displays the disclaimer for the tools. racadmErrorCodes.txt Lists the error codes and messages for the racadm.exe tool. RaidcfgErrorCodes.txt Lists the error codes and messages for the raidcfg.exe tool. SyscfgErrorCodes.
Sample Configuration Files For Windows The following table describes examples of Windows configuration files used to perform a scripted deployment. The Windows files for 32-bit and 64-bit supported systems are located in the following directories: • \Dell\x32\Toolkit\Template\Configs • \Dell\x64\Toolkit\Template\Configs NOTE: All configuration files are provided as examples only. These sample configuration files must be edited before they can be used in any deployment tasks. Table 8.
Toolkit Components Purpose raidcfg.ini Sample output file to enable RAID replication. syscfg.ini Sample configuration file for SYSCFG utility to configure the BIOS, DRAC, and BMC settings. Sample Scripts For Windows The following table lists Windows sample scripts necessary to perform a scripted deployment. The sample scripts for Windows are located at Toolkit\Template\Scripts. NOTE: All DTK scripts are provided as examples only.
Sample Scripts For Linux The following table lists Linux sample scripts necessary to perform a scripted deployment. NOTE: All DTK scripts are provided as examples only. The batch scripts and configuration files must be modified to reflect the unique information for each deployed system. Table 11. Sample Scripts For Linux Toolkit Components Purpose errhndl.sh Handles errors returned in DTK scripts. lininst.
Documentation The following table describes documents containing reference information for each DTK utility and instructions for using DTK utilities and sample scripts. On systems running the Windows operating system, documentation can be found at \Dell\Docs. On systems running the Linux operating system, documentation can be found at mnt/cdrom/docs. Table 13.
4 Setting Up A Directory Structure For Deployment To perform a Deployment ToolKit (DTK)-enabled deployment, you must create a deployment directory structure on either a network share or your local workstation hard drive. The deployment directory structure is a central repository for all deployment files that can be used for network deployment and to build a bootable deployment media. It can also be used successively as a testing space.
Operating System Installation Files The operating system file structure for Windows Server 2008 is shown in the following figure. Creating Operating System Installation Directories On Systems Running Windows Server 2008 Operating System NOTE: The following procedures are provided as best practice guidelines for creating operating system distribution folders compatible with DTK sample scripts.
NOTE: If required, modify the unattend.xml for DiskID under the tags DiskConfiguration and ImageInstall. Default value is 0 for DiskID. NOTE: Make sure that DiskID specified in the unattend.xml is actually available to install the operating system. You can run the DiskPart utility to check disk details. 6. Boot your system with DTK Windows PE image. 7. Run the following command to connect the target system to the shared folder W2K8_deploy.
Creating Operating System Installation Directories For Systems Running Supported Linux Operating Systems NOTE: The following procedures are provided as a best practices guideline for creating operating system distribution folders compatible with DTK sample scripts. For complete instructions on setting up an installation directory structure for an unattended installation, see your operating system documentation.
NOTE: If you choose to create a directory structure for the Linux installation files that is different from the one suggested in this guide, be sure to carefully review and edit each sample script (where necessary) to reflect the different directory structure.
Preparing The Script Files 5 This chapter describes the steps required to use the Deployment Toolkit (DTK) sample scripts to perform a full deployment on a target system in the Microsoft Windows PE and embedded Linux environment.
Editing The Sample Batch Files To Perform A Complete System Deployment The sample scripts utilize DTK utilities, the additional supporting utilities, the source system configuration files, the target system hardware drivers, and the operating system installation files to perform a full deployment on the target system. The sample scripts provided with DTK can be edited and customized using any ASCII text editor that conforms to the hardware available on the target systems.
Table 15. Capture Scripts for Linux Script Name Description raccap.sh Associated Files Captures RAC settings to a file for DRAC 4. • tkenvset.sh — Used by raccap.sh to inform the task scripts where to find the DTK utilities, scripts, and configuration files. racadm — Used by raccap.sh to retrieve RAC information and to configure settings. The wrapper script, racadm, invokes racadm4, racadm5, or racadm6 depending on the system configuration. syscfg— Used by raccap.sh to configure DRAC. • • raidcap.
Table 17. Replication Scripts for Linux Script Name Description racrep.sh Associated Files Applies the RAC configuration settings saved in a file to the current system. • tkenvset.sh — Used by racrep.sh to inform the task scripts about where to find the DTK utilities, scripts, and configuration files. racadm — Used by racrep.sh to replicate the RAC information and to configure settings. The wrapper script, racadm invokes racadm4 , racadm5 , or racadm6 depending on the system configuration.
Script Name Description Associated Files – • • • suseinst.sh Performs an unattended installation of a supported SUSE Linux Enterprise Server operating system. • • initial ramdisk — Available on the Dell Systems Build and Update Utility. – kernel image — Available on the Linux operating system media. ks.cfg — Used by lininst.sh in conjunction with grub to install the Red Hat Enterprise Linux Server (versions 3 and 4) operating system files. ks-rhel5.cfg — Used by lininst.
Script Name PARTCFG.BAT Description Creates and populates the Dell utility partition (UP) and the operating system partition on a specified disk. Associated Files • RAIDCFG.EXE — Used by RAIDCFG.BAT to retrieve RAID information and configure settings. • TKENVSET.BAT — Used by PARTCFG.BAT to inform the task scripts about where to find the DTK utilities, scripts, and configuration files. DISKPART.EXE — Provided by Windows; this script is used to create partitions on your disk.
Script Name Description upinit.sh Creates and populates the Dell utility partition. NOTE: Do not make any modifications to the upinit.sh script. Associated Files • • • • • • • tkenvset.sh — Used by upinit.sh to inform the task scripts about where to find the DTK utilities, scripts, and configuration files. fdisk — Used to create partitions on your disk. mbr — File necessary to create a bootable Dell utility partition. sysdrmk — Used by upinit.sh to patch the boot sector. unzip — Used by upinit.
$dt_drive/opt/dell/toolkit by default in the sample script. Edit this drive letter to reflect the actual drive letter for DTK deployment files, if necessary. 2. Set the variable that defines the path to the full set of DTK deployment files (DT_PATH). This variable is set to %DT_DRIVE%\Dell\Toolkit (Windows) or $dt_drive/opt/dell/toolkit (Linux) by default in the sample script. Edit this path to reflect the actual location of DTK deployment files, if necessary. 3.
To edit the RAC configuration variables, locate the following lines: In RACCAP.BAT: set DT_RAC_CAPFILE=%DT_SYSTEMS%\%DT_PLATFORM%\raccfg.ini In raccap.sh: DT_RAC_CAPFILE=$dt_systems/$dt_platform/raccfg.ini To edit the RAC configuration variables, locate the following lines: In RACREP.BAT: :: RAC section set DT_NICCFG=10.98.8.121 set DT_RAC_CAPFILE=%DT_SYSTEMS%\%DT_PLATFORM%\raccfg.ini In racrep.sh: # RAC section DT_NICCFG=10.98.8.121 set DT_RAC_CAPFILE=$dt_systems/$dt_platform/raccfg.
# RAIDCFG section DT_VD_SIZE=10480 # default size for virtual disk CAUTION: DT_MOUNT specifies the mount point of the Dell utility partition. If your RAMDRIVE, hard drive, or other device already owns this designation, mount does not override the setting and the utility partition is not created. Editing The Default Partition Configuration Values Perform the following steps to edit the default partition configuration default values, as necessary: 1.
syscfg utility (depending on the version of RAC on your system) to configure RAC in the target system. The raccfg.ini is passed as the first parameter to these scripts. If this parameter is not passed, the default variables values used in these scripts are set in the TKENVSET.BAT or tkenvet.sh scripts. You can specify the IP address to be used to configure the RAC as an optional parameter. The raccfg.ini file is generated with the RACCAP.BAT or raccap.sh sample script.
Using DTK Sample Scripts To Capture Configuration Information The SYSCFG and RACADM utilities can read the source system configuration and duplicate that configuration on a target system using a sample DTK script file. These configuration files are used during a full deployment to configure the BIOS, BMC, and RAC settings on the target system.
Capturing The RAC Configuration With The RACCAP Or raccap.sh Sample Script If your system has a RAC, you can replicate the RAC configuration from the RAC of a source Dell system to an identical target Dell system with an identical RAC. For example, from one PowerEdge R720 with iDRAC7 to another PowerEdge R720 with iDRAC7. NOTE: For the script to complete successfully, the source system must have access to the network share that includes the pre-built DTK directory structure. Running RACCAP.BAT Or raccap.
NOTE: You can use this script to create a new Dell utility partition only if there are no existing partitions on your hard disk. You can also use this script to upgrade or downgrade an existing Dell utility partition. Upgrades or downgrades can be made only to existing Dell utility partitions to capture BIOS and BMC settings using the overwrite option. CAUTION: The existing Dell utility partition must be the first primary partition on the hard disk.
Specifying The Windows Installation Variables And Installation Paths To edit the Windows operating system installation variables, locate the following lines in W2K8INST.BAT or W2128INST.BAT: :: Location of Unattend.xml file set DT_UNATTEND=%DT_SYSTEMS%\%DT_PLATFORM%\unattend.xml UNATTEND.XML The UNATTEND.XML file is the default name of the answer file that you use to automate Windows setup during an unattended installation. A sample copy of the UNATTEND.
parameters that instruct the installation utility to perform various configuration tasks. Before a full deployment can be run, you must edit all appropriate headings and parameters, as necessary. NOTE: The sample file provided to install Red Hat Enterprise Linux Server (version 5) is named ks-rhel5.cfg. To use the sample ks-rhel5.cfg file to install Red Hat Enterprise Linux Server (version 5) using lininst.sh, ensure that you rename the file to ks.cfg.
suseinst The suseinst.sh sample script is used to perform an unattended installation of a supported SUSE Linux Enterprise Server operating system. The variables and paths must be specified before the operating system can be installed.
Running The Deployment Scripts 6 This chapter provides best practices, procedures, and scenarios for using the Deployment Toolkit (DTK) to perform pre‑operating system configuration tasks and to install supported operating systems on supported Dell systems. After you have populated the deployment directory structure with all necessary files and carefully edited the deployment scripts and configurations files, you are ready to begin the final stage of the deployment process.
Creating And Customizing Images For Windows PE 4.0 If you are using Windows PE 4.0, download Windows Assessment and Deployment Kit (ADK) from microsoft.com. By default, Windows ADK is copied to the C:\Program Files\Windows Kits directory. Integrating DTK Directory Structure DTK provides WINPE3.0_driverinst.bat (for Windows PE 3.0) and WINPE4.0_driverinst.bat (for Windows PE 4.0) , to preinstall the Dell drivers into a base Windows PE 3.0 or Windows PE 4.0 image (winpe.wim).
1. Click Start, navigate to All Programs → Microsoft Windows AIK . 2. Click Windows PE Tools Command Prompt to open a command prompt window. 3. Navigate to C:\program files\Windows AIK\Tools\x32 or C:\program files\Windows AIK\Tools\amd64 directory based on the system. 4. Run the following command: oscdimg -n -bc:\winpe_30\etfsboot.com c:\winpe_30\ISO c: \winpe_30\WinPE3.0.iso WinPE3.0 iso, a media bootable ISO image is created.
• Creating a network share on a system that is always available over the network for the target systems to be deployed. • Ensuring that a large amount of space is available for storing operating system installation files. • Ensuring that proper permissions are assigned to this share so that the target systems can read files from and write files to the share.
Network Based Deployment For Windows For Windows PE environments, deployment using Remote Installation Services (RIS) is recommended. For details, see the Microsoft RIS documentation. You can also use any other deployment tool such as Automated Deployment Services (ADS).
NOTE: The network share on which you have the scripts and DTK files are mounted to /opt/dell/toolkit/ systems. NOTE: Ensure that you specify the correct RAMDISK size in the PXE config file before booting through PXE. A sample pxe config file is provided in /mnt/cdrom/isolinux/isolinux.cfg. Media-Based Deployment The two ways of media deployment are as follows: • Using Custom Scripts • Using RPMs Using Custom Scripts 1. Obtain the ISO image of the embedded Linux at support.dell.com. 2.
NOTE: To resolve the RPM dependency related issues, install the missing RPMs from /mnt/cdrom/RPMs directory. If the RPMs are not available in this directory, install these RPMs from the operating system media. Installing Using YUM To install DTK RPMs using YUM: 1. Install YUM and the dependency RPMs. 2. Mount the DTK iso to /mnt/cdrom. 3. Create a repository file (for example, dtk.repo) for the required operating system in a writable location.
Using A Third-Party Deployment Solution Framework For Linux You can use DTK with any existing third-party deployment solution framework that provides a PXE booting infrastructure that can be used as transport mechanism for the DTK utilities. Because each third-party deployment framework is unique, these solutions are beyond the scope of this document.
Running Dell Update Packages On Systems Running Embedded Linux 7 You can run the Dell Update Packages in Embedded Linux environments on supported Dell systems. The common scenarios for running update packages are: • Running Update Packages In Dell-Provided Embedded Linux • Running Update Packages In Customized Embedded Linux Running Update Packages In Dell-Provided Embedded Linux 1. Obtain the required update packages from the Dell Server Updates DVD or from support.dell.com. 2.
Update Packages Dependency Dependencies Available On grep sed awk less fmt tar.gz compat-libstdc proc-mail libxml2 After you have met all the dependencies, run the update packages in your customized embedded Linux environment. For more information, see Running Update Packages In Dell-Provided Embedded Linux.
Known Issues And Frequently Asked Questions 8 This section describes known issues with the Deployment Toolkit (DTK) utilities and scripts, including answers to some frequently asked questions. Known Issues The following issues are organized by DTK utility or other function. General Issues • Virtual disk creation and/or deletion takes a long time on Microsoft Windows PE.
Frequently Asked Questions The following questions are organized by DTK utility or other function. General Deployment Questions Q: While running SYSCFG.EXE on a Windows PE image, the SYSCFG.EXE tool silently fails. A: Ensure that you have built your Windows PE image with the /WMI option. For more details, see Running The Deployment Scripts.
When dealing with SAS devices, the array disk location is displayed as channel:target:enclosure. It is possible to have the enclosure value as non-zero. If the enclosure has a non-zero value, then all three numbers (channel, target, and enclosure) have to be included on the command line. Q: Do I need to specify RAID type and size when creating virtual disk(s)? A: No. The default RAID type is RAID 0. If RAID size is not provided, the maximum size allowed for virtual disk is created.
A: No. The Baseboard Management Controller (BMC) firmware does not support PPP configurations for the serial port. Q: The SYSCFG utility --lancfgparams option has suboptions that configure the IP address, Gateway, and Subnet Mask for the system BMC. There is also a MAC address. Are these the same as the operating system network parameter of the managed system? A: No. The Baseboard Management Controller (BMC) has its own IP address, Gateway, Subnet Mask, and MAC address values.
Windows PE Questions Q: My system gets the error Illegal or Missing File Types Specified in Section Files.SCSI.Name during an unattended installation of a supported Windows operating system on supported Dell systems. A: This behavior can occur when the line in the Txtsetup.oem file under the [Files.SCSI. name] heading is not a supported file type. To resolve this behavior, you must remove the line in the Txtsetup.oem file.
