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. Copyright © 2014 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws.
Contents 1 Introduction................................................................................................................7 What's New In This Release...................................................................................................................7 Other Documents You May Need........................................................................................................ 8 Other Supporting Documents You May Need..........................................................
Sample Scripts For Systems Running Linux....................................................................................... 30 RPMs.....................................................................................................................................................31 Documentation....................................................................................................................................31 Drivers And Dell Real Mode Kernel ...........................................
Deployment Using Removable Boot Media With A Network Connection (Media-Based) For Systems Running Windows.................................................................................................................55 Media-Based Local Deployment For Systems Running Microsoft Windows .................................. 56 Creating And Customizing Images For Windows PE 3.0.............................................................56 Creating And Customizing Images For Windows PE 4.0 And 5.0..............
Introduction 1 The Dell OpenManage Deployment Toolkit (DTK) includes a set of utilities, sample scripts, and sample configuration files that you can use to deploy and configure the Dell systems. You can use DTK to build script-based and RPM-based installation for deploying large number of systems on a pre-operating system environment in a reliable way, without changing their current deployment processes.
* Power State * Disk State * S.M.A.R.T. State * Maximum Device Link Rate * Negotiated Link Rate * Secured State * Encryption Capability NOTE: For more details on array disk enumeration, see the Dell OpenManage Deployment Toolkit Command Line Interface Reference Guide available at dell.com/ openmanagemanuals.
• TheDell OpenManage Installation and Security User's Guide provides additional information about performing an unattended installation of Server Administrator on systems running supported Windows, Red Hat Enterprise Linux Server, and SUSE Linux Enterprise Server operating systems.
Accessing Documents From Dell Support Site You can access the required documents in one of the following ways: • From the following links: – For all Systems Management documents — dell.com/softwaresecuritymanuals – For Enterprise Systems Management documents — dell.com/openmanagemanuals – For Remote Enterprise Systems Management documents — dell.com/esmmanuals – For Serviceability Tools documents — dell.com/serviceabilitytools – For Client Systems Management documents — dell.
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.
You can install the DTK Linux RPM utilities on the following operating systems: • Red Hat Enterprise Linux 6.5 (64-bit) • Red Hat Enterprise Linux 5.9 (64-bit and 32-bit) • SUSE Linux Enterprise Server 11 SP3 (64-bit) NOTE: The RPMs are available in the RPMs folder of DTK ELI ISO, at linux.dell.com/repo/hardware, and also in the Dell Systems Management Tools and Documentation DVD. Supported BIOS Firmware Versions The latest (n) version or the n-1 version of BIOS firmware that is available at support.
• Working knowledge of Microsoft Remote Installation Services (RIS) and Automated Deployment Services (ADS) (including setting up of RIS and ADS environments) or any other third-party deployment system or tool for Windows PE. • Working knowledge of Windows Deployment Services (WDS) or any other third-party deployment system or tool for Windows PE.
Table 1. Drivers Required to Build Your Windows PE Environment Drivers Purpose common\hapi Essential files for DTK tools to work. common\raidcfg Essential files for raidcfg to work. winpe3.x\WINPE3.0_driverinst.bat Used to install Dell-provided drivers, from \Dell\x32\Drivers or \Dell \x64\Drivers, into the customized Windows PE 3.0 image. winpe4.x\WINPE4.0_driverinst.bat Used to install Dell-provided drivers, from \Dell\x64\Drivers, into the customized Windows PE 4.0 image. winpe5.x\WINPE5.
Additional Tools Purpose Source Save in DTK location Management Tools and NOTE: In the Documentation DVD. previous releases, each Dell system required a unique upimg file. The upimg file is common for all Dell systems. kernel image Used during a Linux unattended installation. initial ramdisk Used during a Linux unattended installation. Available on the Linux media.
Deployment Dell systems can be deployed using several methods. The most common method is using the Systems Build and Update Utility (SBUU) on the Dell Systems Management Tools and Documentation DVD that is shipped with your system. Currently, this method is used to deploy a single system at a time with the installation wizard. SBUU will not be available in the releases following OpenManage 7.4. Dell recommends using Dell Lifecycle Controller 2 as replacement for SBUU.
Table 4. Deployment Method Matrix Deployment Methods Complexity Advantages Disadvantages Local deployment (bootable media) • • Relatively simple • • Necessary if a network connection is not available or is too slow. Can install supported Windows operating systems. Can perform a minimal installation of supported Linux operating systems.
Deployment Methods Complexity Advantages • • • made in only in one place. High flexibility for remote deployment. No media required. Faster deployment. Disadvantages • Set up time is longer. After you have determined which deployment method best suits the needs of your organization, you are ready to begin building the DTK deployment directory structure on a network volume.
Deployment After you have prepared all scripts, files, and utilities, you are ready to proceed with the deployment process. While there are many ways to use DTK utilities to deploy Dell systems, this guide focuses on the two most common methods for Windows PE and Linux: media‑based deployment (local) and networkbased deployment (remote).
How To Obtain Dell Utility Partition Files Obtain the Dell utility partition files from /opt/dell/toolkit/systems, or the Systems Build and Update Utility on the Dell Systems Management Tools and Documentation DVD.
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.
4. Click Unzip. By default, files are unzipped to C:\. You can unzip the DTK components to your local hard drive and then copy them later to a network volume, or you can change the installation path to an available network share. For example, you can unzip the files directly to the network share (for example, Z:\) that you plan to use in the deployment process. NOTE: Do not copy the DTK components to a Novell NetWare network volume.
• Sample scripts: \Dell\x64\Toolkit\Template\Scripts • Sample configuration files: \Dell\x64\Toolkit\Template\Configs The directory \Dell\x32\Toolkit\Systems or \Dell\x64\Toolkit\Systems is a placeholder that can be used for all system information that is captured using sample scripts and tools (for example, the system specific BIOS) and Baseboard Management Controller (BMC) configuration files used by the DTK utilities for configuring a system).
Table 5. Mounted Media Contents Contents Details Location docs Contains Quick Installation Guide. /mnt/cdrom/docs LICENSIN G Contains all the licenses for the open source components used in the media. /mnt/cdrom/ LICENSING README Provides the latest product information. /mnt/cdrom sa.1 Contains the Linux kernel images. /mnt/cdrom/isolinux sa.2 Initial RAM disk containing the embedded Linux component and DTK tools.
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.
Toolkit Components Purpose sysdrmk.exe Used by UPINIT.BAT to patch the boot sector and Master Boot Record (MBR). config.ini Configuration file used by raidcfg.exe. CAUTION: Do not edit this file. Incorrect edits might cause raidcfg.exe to fail. stsvc.ini Configuration file used by raidcfg.exe. CAUTION: Do not edit this file. Incorrect edits might cause raidcfg.exe to fail. sys.ini Configuration file used by DTK for deployment. IDRAC Configures iDRAC 6.
Toolkit Components Purpose RaidcfgErrorCodes.txt Lists the error codes and messages for the raidcfg tool. stsvc.ini Configuration file used by raidcfg. syscfg • • • Reports and configures BIOS, BMC, and DRAC. Maintains the system state between reboots. Reports hardware devices and other system-related information. SyscfgErrorCodes.txt Lists the error codes and messages for the syscfg tool. sys.ini A .ini file used with syscfg. UpinitErrorCodes.txt Lists the error codes and messages for upinit.
Table 9. Sample Configuration Files for Linux Toolkit Components Purpose autoinst.xml Sample file used during an unattended installation of SUSE Linux Enterprise Server operating systems in BIOS mode. autoinstsles11.xml Sample file used with unattended installation of SUSE Linux Enterprise Server (version 11) operating system in BIOS mode. autoinst_sles11_u efi.xml Sample file used with unattended installation of SUSE Linux Enterprise Server (version 11) operating system in UEFI mode. ks.
Toolkit Components Purpose PARTCFG.BAT Creates and populates the Dell utility partition and creates the operating system partition on a specified hard drive. The script cleans out all existing partitions on your system before creating and populating the partition. RACCAP.BAT Captures Remote Access Controller (RAC) settings to a file for DRAC 4 remote access controllers. RACREP.BAT Applies (replicates) the RAC settings saved in a file to the target system. RAIDCAP.
Toolkit Components Purpose sysdrmk Used by upinit.shto patch the boot sector. sysrep.sh Applies (replicates) BIOS and BMC configuration settings and configures the target system. tkenvset.sh Sets the path of DTK installation and variables for the specific system being deployed. upinit.sh Creates and populates the Dell utility partition. RPMs The following table describes all DTK RPMs at mnt/cdrom/RPMs.
Setting Up A Directory Structure For Deployment 4 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.
following figure. These files can then be accessed from this directory when deploying multiple PowerEdge R720 systems. NOTE: If you choose to create a directory structure for the system-specific files that is different from the one suggested in this guide, ensure that you carefully review and edit each sample script (wherever necessary) to reflect the different directory structure.
Operating System Installation Files The operating system file structure for Windows Server 2008 is shown in the following figure. For more details on installing Windows Server and Linux operating system using DTK, see the Dell OpenManage Deployment Toolkit Installation Guide available at dell.com/openmanagemanuals.
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 Associated Files raccap.sh 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 Associated Files racrep.sh 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.
Deployment Scripts For Systems Running Linux Operating Systems The following table lists the deployment scripts for systems running Linux. Table 19. Deployment Scripts For Linux Script Name Description lininst.sh Performs an unattended installation of a supported Red Hat Enterprise Linux operating system in BIOS and UEFI mode. Associated Files • • • tkenvset.sh — Used by lininst.sh to inform the task scripts about where to find the DTK utilities, scripts, and configuration files.
Script Name Description Associated Files • • autoinst-sles11.xml — Used by suseinst.sh in conjunction with grub to install the SUSE Linux Enterprise Server (version 11) operating system files in BIOS mode. autoinst_sles11_uefi.xml — Used by suseinst.sh in conjunction with grub2 to install the SUSE Linux Enterprise Server (version 11) operating system files in UEFI mode. Other Scripts For Systems Running Windows Operating Systems The following table lists the other scripts for systems running Windows.
Table 21. Other Scripts for Linux Script Name Description tkenvset.sh Sets the path for DTK installation and variables for the system to be deployed and configured. The variables and paths in this file must be specified before any of the other supporting scripts can be used. raidcfg.sh Configures the selected RAID controller detected in the system. Associated Files • syscfg — Used by tkenvset.sh to discover the system type. • tkenvset.sh — Used by raidcfg.
may require edits in certain situations. These optional edits are discussed in Editing DTK Task Scripts. The TKENVSET.BAT or tkenvset.sh script sets the path of DTK utilities and scripts and sets the variables for the system to be deployed and configured. The variables and paths specified in this file before other supporting scripts are used. Specifying DTK Installation Paths The TKENVSET.BAT or tkenvset.sh sample script is provided with the following default values.
7. For Linux, set the variable that defines the directory containing the DRMK system files necessary to create a Dell utility partition (DT_DRMK). This variable is set to $dt_path/opt/dell/drmk by default in the sample script. Edit this path to reflect the actual location of the DRMK files, if necessary. Specifying The SYSCFG Variables The SYSCFG replication file is set to syscfg.ini by default. If you used the SYSCAP.BAT (for Windows) or syscap.
The PARTCFG.BAT (Windows) or partcfg.sh (Linux) sample script provides the following disk partitioning default values. These values must be confirmed in some cases, and modified in other cases, before performing a deployment. Locate the partn label to find the following lines: In PARTCFG.
Editing The Default Partition Configuration Values Perform the following steps to edit the default partition configuration default values, as necessary: 1. Edit the default utility partitioning variable (DT_PARTN_UP), if necessary. Set this variable f you want to install the Dell utility partition. 2. Edit the default variable value for the default hard drive (DT_HD for Windows and DT_HD for Linux), if applicable.
NOTE: For 9G or later systems, racrep.sh and sysrep.sh have duplicate functions. If you run racrep.sh followed by sysrep.sh, the latter overwrites the settings of the former. RAIDCFG.BAT Or raidcfg.sh The RAIDCFG.BAT or raidcfg.sh sample script configures RAID controllers detected on the system. User input is optional to run this script. The input parameter is a name or path to a log file. This parameter is not set to any value by default, and no log file is generated.
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: Ensure that you run RACCAP.BAT in a writable environment. If you run RACCAP.BAT in a read-only environment, DTK displays the message has been generated. UPINIT.BAT Or upinit.sh The UPINIT.BAT or upinit.sh is a tool used to create and populate a new Dell utility partition and to upgrade or downgrade an existing utility partition. NOTE: You can use this script to create a new Dell utility partition only if there are no existing partitions on your hard disk.
External Dependencies W2K8INST.BAT and W2K12INST.BAT scripts uses two environment variables: DT_PLATFORM and DT_DRIVE. The DT_PLATFORM variable is set by TKENVSET.BAT using platform discovery. The DT_DRIVE denotes the network drive letter to the network shared path containing the Windows Server 2008 or the Windows Server 2012 operating system source and the UNATTEND.XML (in BIOS mode) or UNATTEND_UEFI.XML file (in UEFI mode). The W2K8INST.BAT script uses the UNATTEND.
Utilities Used By lininst grub — Used with the kernel image and initial ramdisk files, along with the unattended answer file to install the operating system in BIOS mode. grub2 — Used with the kernel image and initial ramdisk files, along with the unattended answer file to install the operating system in UEFI mode. The following are the variables used in grub and grub2: • DT_OS_DISK — Sets the disk to deploy the Red Hat Enterprise Linux Server operating system.
NOTE: While installing Linux, ensure that you install grub in the boot partition. Otherwise, you cannot boot to the utility partition by pressing the key during reboot. Utilities Used By suseinst grub — Used with the kernel image and initial ramdisk files, along with the unattended answer file to install the operating system in BIOS mode. grub2 — Used with the kernel image and initial ramdisk files, along with the unattended answer file to install the operating system in UEFI mode.
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.
Media-Based Local Deployment For Systems Running Microsoft Windows This deployment method is easy to assemble, but is the least flexible. Any change to the system configuration, for example, requires the creation of a new bootable media. This method does not provide a writable media, making it necessary to use predefined and tested configuration files. For the media-based deployment methods, the following tasks need to be completed: • Creating And Customizing Images For Windows PE 3.
Creating A Bootable Media For Windows PE 3.0 To create a bootable media: 1. Click Start and 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 on the system. 4. Execute the script: WINPE3.0_driverinst.
Bootable Windows PE Media With Networking Enabled This process includes: • Creating a bootable Windows PE media with the appropriate network drivers. This step enables networking services to start, get an IP address, and bring the target system into a functioning network. NOTE: For more details on how to create a customized version of a single Windows PE bootable media that works across all Dell supported systems and provides an underlying networking stack, see Running The Deployment Scripts.
Network Based Deployment For Systems Running 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).
5. Copy isolinux.cfg file into the PXE configuration folder. 6. Create your own start-up script and place it in the network share specified in your modified isolinux.cfg/efidefault file. The modified script is picked up and executed during the boot process. 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.
4. In /mnt/cdrom/isolinux/isolinux.cfg (for BIOS mode) or in /mnt/cdrom/EFI/BOOT/dtk_grub.cfg (for UEFI mode), edit the cd install section to point to your customized start-up script. In other words, add the share_script option and then use mkisofs to create the ISO image as follows: mkisofs -o output.iso -b isolinux/isolinux.bin -c isolinux/boot.cat -noemul-boot -boot-load-size 4 -boot-info-table -pad -r -J -hide-joliet-transtbl -eltorito-alt-boot -e efiboot.
To install DTK RPMs using DTK tools: 1. Mount the DTK media at /mnt/cdrom. 2. Navigate to the /mnt/cdrom/SYSMGMT/dtktools/ directory. NOTE: The /mnt/cdrom/SYSMGMT/dtktools directory contains all DTK RPMs and the dependency RPMs. 3. Install the required DTK RPMs using dtktools-setup.sh. NOTE: To resolve the RPM dependency related issues, install the missing RPMs from the /mnt/ cdrom/SYSMGMT/srvadmin/linux/RPMS directory.
NOTE: For more information on how Dell‑provided utilities and drivers are installed, see startstage3.sh, start-hapi.sh, or start-raid.sh available in /mnt/cdrom/tools. NOTE: The /opt/dell/srvadmin/sharedand /opt/dell/srvadmin/hapi directories must have read-write permissions. For more details, see start-stage3.sh and start-hapi.sh.
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 Any Update Package RPMs sysvinit grep sed awk less fmt tar.gz compat-libstdc proc-mail libxml2 Linux media or any open source website 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.
A: The nexus used to display array disks is "channel:target:lun." The Logical Unit Number (LUN) is always "0." The channel and the target IDs are necessary to identify array disks when dealing with SCSI devices. 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: PARTCFG cannot enumerate the virtual disks created by RAIDCFG. What must be done? A: A reboot is required for PARTCFG to enumerate virtual disks after creating a virtual disk using the RAIDCFG command. SYSCFG Questions Q: Can I use the SYSCFG utility to configure Point-to-Point Protocol (PPP) over the serial port to access my RAC? A: No. The Baseboard Management Controller (BMC) firmware does not support PPP configurations for the serial port.
Q: After the DTK deployment is complete, the Red Hat Enterprise Linux Server installation keeps going into attended mode or halts with the message ks.cfg not found. A: If the initrd.img is not available in the operating system, get the latest update of Red Hat Enterprise Linux Server or prepare driver disks for your network or disk controller. Q: How to apply driver disks during operating system installation? A: You can apply driver disks as follows: 1.
