Dell OpenManage Deployment Toolkit Version 5.0.
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........................................................................................................... 6 What Is New In This Release................................................................................................................. 6 Other Documents You May Need.........................................................................................................7 Other Supporting Documents You May Need..............................................................
Sample Scripts For Systems Running Linux........................................................................................27 RPMs.................................................................................................................................................... 28 Documentation................................................................................................................................... 28 Drivers And Dell Real Mode Kernel ...........................................
Deployment Using Removable Boot Media With A Network Connection (Media-Based) For Systems Running Windows................................................................................................................ 50 Media-Based Local Deployment For Systems Running Microsoft Windows ...................................51 Creating And Customizing Images For Windows PE 3.0............................................................. 51 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.
– Managing Security Key NOTE: For more details, see the Command Line Interface Reference Guide at dell.com/ openmanagemanuals. • PERC 9 extended support for the following controllers running PERC 9.1 firmware: – PERC H830 Adapter, PERC H330 Adapter, PERC H330 Embedded, PERC H730 Adapter, and PERC H730P Adapter – PERC H330 Mini Monolithic, PERC H730 Mini Monolithic, and PERC H730P Mini Monolithic • Support for PERC S130 controller.
Other Supporting Documents You May Need Besides the Dell-provided documentation, there are numerous other resources to aid you in planning and executing a DTK-assisted deployment. • Operating system documentation to prepare for and execute the unattended installation process. In addition, you should consult the available web-based resources such as: – The Microsoft Tech Net database at microsoft.com/technet – The Red Hat Enterprise Linux support pages at redhat.
Contacting Dell NOTE: If you do not have an active Internet connection, you can find contact information on your purchase invoice, packing slip, bill, or Dell product catalog. Dell provides several online and telephone-based support and service options. Availability varies by country and product, and some services may not be available in your area. To contact Dell for sales, technical support, or customer service issues: 1. Go to dell.com/support. 2. Select your support category. 3.
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.
– Windows 7 (64-bit) using Windows PE 3.0 (64-bit) in BIOS and UEFI mode – Windows 7 (32-bit) using Windows PE 3.0 (32-bit) in BIOS mode For Linux, the DTK utilities support deploying the following operating systems: • Red Hat Enterprise Linux 7.0 (64-bit) in BIOS and UEFI mode • Red Hat Enterprise Linux 6.
Deployment Prerequisites Before beginning the deployment process for Windows PE, ensure that you have all of the following tools, software, and information ready to use or consult: • Windows Automated Installation Kit (AIK) for Windows Server 2008 R2 to build Windows PE 3.0. • Windows Assessment and Deployment Kit (ADK) for Windows Server 2012 and Windows Server 2008 to build Windows PE 4.0. • Windows Assessment and Deployment Kit (ADK) for Windows Server 2012 R2 to build Windows PE 5.0.
• 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 The following table describes the essential and optional drivers required for Dell‑supported hardware to build your Windows PE environment. NOTE: The drivers provided have been tested successfully in the Windows PE environment. Table 1.
The following table is a matrix of Linux system files and other tools to use with DTK utilities and its sample scripts. Table 3. Supporting Tools and System Files for Linux Additional Tools Purpose Source Save in DTK location mkfs.* Formats hard-drive partitions. Any system running the Linux operating system. In the PATH variable. fdisk To create Master Boot Record (MBR) partitions in BIOS mode. Any system running the Linux operating system. In the PATH variable.
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. The sample configuration files are operating system specific, and have been enhanced for Dell systems. For information on modifying the sample configuration files, see your operating system documentation.
• • Selecting the optimum Dell OpenManage systems management software configuration for your system Choosing a deployment method DTK is 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.
Deployment Methods Complexity Deployment solution framework from a third‑party vendor Mixed Advantages • Can install supported Windows or Linux operating systems. • DTK can be used in context of third-party deployment solution framework. Third-party deployment solution framework is used as the deployment transport mechanism. Tasks and scripts can be pushed to the target systems. Must either acquire and learn to use or have an existing third-party deployment solution framework.
NOTE: You can also download the latest drivers from support.dell.com. 4. Generate a system BIOS, BMC (Baseboard Management Controller), RAID, and/or RAC configuration profile from the optimally configured source system. Copy the generated configuration files to a read/write share onto the workstation. 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.
Copy all necessary files in the \Toolkit\Systems\ directory (Windows) or /opt/dell/toolkit/ systems/
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.
• Sample scripts: \Dell\x32\Toolkit\Template\Scripts • Sample configuration files:\Dell\x32\Toolkit\Template\Configs DTK utilities for 64-bit systems are located in the following directories: • Utilities: \Dell\x64\Toolkit\Tools • 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 sa
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. NOTE: The /opt/dell/srvadmin directory must be writable.
Toolkit Components Purpose • • – IDRAC settings and options Maintains system state between reboots. Reports hardware devices and other system-related information. 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.
Toolkit Components Purpose pci.ids Used with syscfg to report PCI devices. racadm Wrapper script, which invokes racadm4, racadm5, or racadm6 depending on the Remote Access Controller (RAC) on your system. racadm4 Configures DRAC 4/P and DRAC 4/I RACs. racadm5 Configures DRAC 5 RACs. racadm6 Configures iDRAC 6. NOTE: This feature may not be supported on all systems. racadm7 Configures iDRAC 7. raidcfg Creates and reports RAID information. RaidcfgErrorCodes.
Table 8. Sample Configuration Files for Windows Toolkit Components Purpose Location raccfg.ini Sample configuration file for DRAC 4 remote access controllers. \Toolkit\Systems\ raidcfg.ini Sample output file to enable RAID replication. \Toolkit\Systems\ winbom.ini Sample file used to start the racsvc and mr2kserv services. \Toolkit\Template\Configs winpeoem.sif Sample file to add support for Dell mass storage drivers. \Toolkit\Template\Configs Sample Configuration Files For L
Toolkit Components Purpose syscfg.ini Sample configuration file for SYSCFG utility to configure the BIOS, DRAC, and BMC settings. Sample Scripts For Systems Running 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.
Toolkit Components Purpose RAIDREP.BAT Applies (replicates) RAID settings saved in a file to the target system. SYSCAP.BAT Captures BIOS and BMC configuration settings and saves them to a file. SYSREP.BAT Applies (replicates) BIOS and BMC configuration settings and configures the target system. TKENVSET.BAT Sets the path of DTK installation and variables for the specific system being deployed. UPINIT.BAT Creates and populates the Dell utility partition.
Toolkit Components Purpose 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. The syscfg and raidcfg RPMs are also available in Dell Systems Management Tools and Documentation DVD. Table 12.
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.
required for the systems. On systems running Windows, you can store all profile configuration files for an optimally configured Dell PowerEdge server in the directory Toolkit\Systems\. These files can then be accessed from this directory when deploying multiple similar PowerEdge servers.
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.
::%DT_TOOLS%\syscfg --bootseq=hdd.emb.0 ::call WIN2K8.BAT 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.
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 Associated Files lininst.sh and lininst7.sh Performs an unattended installation of a supported Red Hat Enterprise Linux operating system in BIOS and UEFI mode. • • • • • • • suseinst.sh Performs an unattended installation of a supported SUSE Linux Enterprise Server operating system.
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 Associated Files 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. • syscfg — Used by tkenvset.sh to discover the system type. raidcfg.sh Configures the selected RAID controller detected in the system. • 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.
In racrep.sh: # RAC section DT_NICCFG=10.98.8.121 set DT_RAC_CAPFILE=$dt_systems/$dt_platform/raccfg.ini Specifying Variables Used To Create Disk Partitions And Install The Dell Utility Partition NOTE: If the primary deployment state (DT_PARTN) is set to OFF, the partitioning deployment state subsection is skipped. The PARTCFG.BAT (Windows) or partcfg.sh (Linux) sample script provides the following disk partitioning default values.
In partcfg.sh in UEFI mode: DT_PARTN_UP=OFF # Default Hard Drive DT_HD=/dev/sda # PARTCFG section set DT_DP_SIZE_GPT=125 # RAIDCFG section DT_VD_SIZE=10480 # default size for virtual disk 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.
RACREP.BAT Or racrep.sh The RACREP.BAT or racrep.sh sample script applies RAC options to the target system based on configuration information that has been saved in the configuration file. User input is optional, depending on the variables set in the RACREP.BAT or racrep.sh sample script. On systems running Windows, RACREP.BAT script uses RACADM.EXE to configure RAC in the target system. On systems running Linux the racrep.
PARTCFG.BAT Or partcfg.sh In BIOS mode, the PARTCFG.BAT or partcfg.sh sample script creates and populates the Dell utility partition using UPINIT.BAT or upinit.sh and creates the deployment partition on a specified disk. In UEFI mode, the partcfg.sh sample script creates the deployment partition on a specified disk. For more information about using the UPINIT.BAT or upinit.sh tool, see UPINIT.BAT Or upinit.sh. User input is not required to run this script.
On systems running Linux: /opt/dell/toolkit/template/scripts /syscap.sh 2. Boot the source system into Windows PE or embedded Linux. The script runs and saves the configuration information in the \Toolkit\Systems\ directory in Windows and /opt/dell/toolkit/systems/ directory in Linux. 3. Edit the startnet.cmd file (Windows PE image) or start-up script file (embedded Linux image) to remove the text you added in step 1. NOTE: The racrep.sh and sysrep.
RACCAP.BAT Or raccap.sh The RACCAP.BAT or raccap.sh sample script captures RAC configuration settings and saves them to a specified location. An optional user input can be passed as a parameter. You can provide the path or file name as an input to this script. The default variable values used in this script are set to the correct default values to perform a scripted deployment. On systems running Windows, the RACCAP.BAT uses the RACADM.
W2K8INST.BAT And W2K12INST.BAT The W2K8INST.BAT and W2K12INST.BAT sample scripts are used to perform an unattended installation of the Windows Server 2008 and Windows Server 2012 operating systems respectively. The variables and paths must be specified before the operating system can be installed.
various setup options, including how to partition disks and the location of the Windows image you want to install. Before a full deployment can be run, edit all appropriate headings and parameters, as necessary. NOTE: On systems running Windows Server 2012 operating system, save the default answer files as UNATTEND2K12.XML or UNATTEND2K12_UEFI.XML.
dell/toolkit/template/configs directory. The ks-rhel6.cfg/ks-rhel7.cfg files contain the headings and parameters that instruct the installation utility to perform various configuration tasks. Before a full deployment can be run, edit all appropriate headings and parameters, as necessary. NOTE: The sample files provided to install Red Hat Enterprise Linux Server (version 6) are ksrhel6.cfg (in BIOS mode), and ks_rhel6_uefi.cfg (in UEFI mode). To use the sample ks-rhel6.
The suseinst.sh script uses the unattended answer file in conjunction with the grub utility and kernel image and initial ramdisk files to install the operating system files. autoinst.xml or autoinst_uefi.xml For SUSE Linux Enterprise Server The autoinst.xml and autoinst_uefi.xml file is the default name of the answer file that you use to automate an unattended SUSE Linux Enterprise Server installation in BIOS and UEFI modes respectively. A sample copy of the autoinst.xml/autoinst_uefi.
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.
• The operating system is installed from a network share. This installation may happen after your system reboots. 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.
NOTE: The destination folder (C:\winpe_50) is created as part of the process, and must not be an existing directory. The destination path and the path to the Dell drivers must not contain any blank space. 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
This deployment method is easy to assemble and provides great flexibility in changing the scripts and configuration files. Any change to the system configuration, for example, does not require re‑creation of the bootable media. This method also provides access to the remote share as writable media. Hence, the configuration files captured during the deployment automation process can be saved to the remote share.
• Configuration information is read from the media. • The operating system is installed from the media. 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).
• Share path of the network share • Name of your startup script The isolinux.cfg/efidefault file is ready for PXE-booting. 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: Your scripts must also take care of copying miscellaneous items to unlock the media, so that the media can be mounted and ejected as per the operating system’s installation process. 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.
NOTE: For both installations, the raidcfg and syscfg binaries and libraries are installed at /opt/ dell/toolkit/bin. The racadm binaries are installed at /opt/dell/srvadmin/bin and /opt/dell/ srvadmin/sbin. Installing DTK RPMs Using DTK Tools 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.
• Basic libraries and utilities for Linux to execute customized scripts. • Installed DTK and the dependency RPMs. • Necessary entries in the ld.so.config file so that the libraries are installed. Integrate all the above mentioned libraries, Dell toolkit libraries, tools, and utilities into your embedded Linux environment and proceed with deployment. NOTE: For more information on how Dell‑provided utilities and drivers are installed, see startstage3.sh, start-hapi.sh, or start-raid.
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 racser4.sh RAC 5 Instrumentation drivers /mnt/cdrom/tools iDRAC Instrumentation drivers /mnt/cdrom/tools Dell PowerVault 220S SCSI drivers Kernel SAS SAS drivers Kernel Any Update Package RPMs Linux media or any open source website sysvinit 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.
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.
Q: When I use the sample DTK scripts to deploy multiple systems, do I edit the configuration files to reflect unique information (such as unique system names, IP address, and BIOS asset tags) for each system? A: The sample scripts are provided as examples for users who want to develop their own deployment process. The scripts may work perfectly in your environment. If not, you may need to develop your own scripts entirely from scratch.
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 disks? 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: Ensure that the RAID controllers can be seen in the BIOS during POST. If the BIOS does not detect the controller, then RAIDCFG does not detect it. Also ensure that the controller is set to RAID mode and not any other mode in the controller BIOS. Q: What is span length? A: Span length enables you to select the number of array disks in a span for the nested RAID levels (RAID-10, RAID-50, and RAID-60). The default (minimum permissible) span length value is 2 for RAID-10, 3 for RAID-50, and 4 for RAID-60.
Q: In --solcfgparams, when I set the Serial Over LAN (SOL) character send threshold using solcharsendthreshold to be 225, I get a Hardware subsystem error. Invalid data field in request. What are the valid values? A: The range of valid values for --solcfgparams and --solcharsendthreshold are from 1 to 220. Q: How do I enable console redirection on a modular system? A: Set the --serialcomm option value to enableconred. For example, syscfg -serialcomm=enableconred.
2. Delete the entry: Run efibootmgr -b XYZ –B 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.
