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. © 2013 Dell Inc.
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.......................................................................................................................................................................30 Documentation.......................................................................................................................................................
lininst................................................................................................................................................................ 54 suseinst............................................................................................................................................................ 55 6 Running The Deployment Scripts ..........................................................................................
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 pre-operating system environment in a reliable way, without changing their current deployment processes.
– Red Hat Enterprise Linux 5.8 (64–bit and 32–bit) NOTE: For the list of supported operating systems and Dell servers, see the Dell Systems Software Support Matrix in the required version of OpenManage Software at dell.com/openmanagemanuals. Other Documents You May Need In addition to this guide, you can access the following guides available at dell.com/support/manuals. See Accessing Documents From The Dell Support Site.
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.
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. Visit dell.com/support 2. Select your support category. 3. Verify your country or region in the Choose a Country/Region drop-down menu at the top of page. 4. Select the appropriate service or support link based on your need.
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.
• Red Hat Enterprise Linux 5.9 (64–bit and 32–bit) • SUSE Linux Enterprise Server 11 SP2 • SUSE Linux Enterprise Server 10 SP4 (64-bit) NOTE: The RPMs are available in the RPMs folder of DTK ELI ISO and also at linux.dell.com/repo/hardware. 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.
• A workstation with the following capabilities: – Writable media drive – 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.
Drivers Purpose 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\x32\Drivers or \Dell \x64\Drivers, into the customized Windows PE 4.0 image.
Additional Tools Purpose Source Save in DTK location Systems Management Tools NOTE: For legacy and Documentation DVD. 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.
• 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. For information on the deployment methods, see Running The Deployment Scripts.
Deployment Methods Complexity Deployment solution framework from a third‑party vendor Mixed Advantages • • • PXE boot for Linux High • • • • • 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. Everything is in one place on a network share. Easy to manage — changes have to be made in only in one place.
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.BAT scripts or for Linux from DTK Linux ISO image and running the syscap.sh, raidcap.sh, and raccap.sh scripts.
RAC And BIOS Configuration Configure RAC on your source system using the RACADM.EXE (Windows) or racadm (Linux) utility, if applicable. From 12G onwards, BIOS options can be configured using racadm. 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.
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. DTK utilities for 32-bit systems are located in the following directories: • Utilities: \Dell\x32\Toolkit\Tools • Sample scripts: \Dell\x32\Toolkit\Template\Scripts • Sample configuration files:\Dell\x32\T
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. To extract DTK components to a workstation running a Linux operating system perform the following steps. 1. Download the ISO image dtk_X.X_XXX_Linux.iso from support.dell.
Directory Structure On The Target System The following figure displays the directory structure, when you boot the media on a target system.
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 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 A .ini file used with syscfg.exe. IDRAC Configures iDRAC 6. NOTE: This feature may not be supported on all systems. IDRAC7 Configures iDRAC 7. NOTE: This feature may not be supported on all systems.
Toolkit Components Purpose • 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.sh. Sample Configuration Files For Windows The following table describes examples of Windows configuration files used to perform a scripted deployment.
Toolkit Components Purpose autoinstsles11sp2.xml Sample file used with unattended installation of SUSE Linux Enterprise Server (version 11 SP2) operating system in BIOS mode. ks.cfg Sample file used with unattended installation of Red Hat Enterprise Linux Server (versions 3 and 4) operating system in BIOS mode. ks-rhel5.cfg Sample file used with unattended installation of Red Hat Enterprise Linux Server (version 5) operating system in BIOS mode. ks-rhel6.
Toolkit Components Purpose RAIDCAP.BAT Captures the RAID settings and saves them to a file. RAIDCFG.BAT Configures the selected RAID controllers on the system. 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.
Table 12. RPMs RPMs Purpose syscfg Configures server BIOS, BMC/DRAC settings, DTK state settings, PCI device detection, and so on. raidcfg Configures all supported RAID controllers. racadm Configures RAC. NOTE: Besides the listed RPMs, a set of dependency RPMs are also available at this location. Documentation The following table describes documents containing reference information for each DTK utility and instructions for using DTK utilities and sample scripts.
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. X:\Dell\Toolkit\Tools net use z: \\
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 Captures RAC settings to a file for DRAC 4. Associated Files • 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 NOTE: Both grub and grub2 uses the following images in conjunction with the unattended answer file to perform unattended operations: – • • • • 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.
Table 20. Other Scripts for Windows Script Name Description TKENVSET.BAT Sets the path of DTK installation and variables for the system to be deployed and configured. The variables and paths specified in this file must be specified before any of the other supporting scripts can be used. RAIDCFG.BAT Configures the selected RAID controller detected in the system. Associated Files • SYSCFG.EXE — Used by TKENVSET.BAT to discover the system type. • TKENVSET.BAT — Used by RAIDCFG.
Script Name Description UEFI mode, creates deployment partition (GPT type) on a specific disk. The partcfg.shscript uses a / tmpfolder to store a few temporary files critical to its execution. Associated Files • fdisk — Used to create partitions on your disk in BIOS mode. When creating an embedded Linux ISO image, make sure that fdisk is present in the embedded Linux environment you created. parted — Used to create partitions on your disk in UEFI mode.
On systems running Linux: DT_PATH=$dt_drive/opt/dell/toolkit DT_TOOLS=$dt_path/bin DT_SYSTEMS=$dt_path/systems DT_SCRIPTS=$dt_path/template/scripts DT_STOP_ON_ERROR=FALSE DT_DRMK=$dt_path/opt/dell/drmk Confirming Or Editing DTK Installation Path Variables Perform the following steps to confirm and/or edit the installation path variables: 1. On systems running Windows, set the variable that defines the path to the full set of DTK deployment files (DT_DRIVE).
In syscap.sh on systems running Linux: DT_SYS_REPFILE=$dt_systems/$dt_platform/syscfg.ini NOTE: If the replication requires a change in the memory redundancy mode, reboot the target server and execute the script again to complete the replication. Specifying The RAC Configuration Variables The IP address for your target system RAC is set in the sample script as 10.98.8.121 by default. Edit this value to reflect the actual IP address of your target system RAC, if applicable.
:: RAIDCFG section:: default size for virtual disk set DT_VD_SIZE=10480 :: default size for virtual disk In partcfg.sh in BIOS mode: DT_PARTN_UP=on # Default Hard Drive DT_HD=/dev/sda # deployment section set DT_DP_SIZE=64 # DELL UP section set DT_UP_SIZE=32 set DT_UP_IMAGE=$dt_systems/upimg.bin # RAIDCFG section DT_VD_SIZE=10480 # default size for virtual disk CAUTION: DT_MOUNT specifies the mount point of the Dell utility partition.
Editing DTK Task Scripts The task scripts called by the master batch file do not require any edits (with the following exceptions) if the default variable values are utilized in the TKENVSET.BAT or tkenvset.sh scripts. However, if you make any changes to the default values set by the TKENVSET.BAT or tkenvset.sh, you must make the same edits to the matching default values set in the appropriate task scripts.
parameter is not passed, the default variables values used in this script are set in the SYSREP.BAT or sysrep.sh scripts. The syscfg.ini file is generated with the SYSCAP.BAT or syscap.sh sample script. For information about using the SYSCAP.BAT or syscap.sh sample script to capture BIOS and BMC settings, see SYSCAP.BAT Or syscap.sh. The second 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.
Running The SYSCAP.BAT Or Syscap.sh To run the SYSCAP.BAT or syscap.sh sample script to capture the BIOS and BMC configuration information in the syscfg.ini file: 1. Edit the startnet.cmd file (on your Windows PE image) or start-up script file (on your embedded Linux image) to call the SYSCAP.BAT or syscap.sh script after the network share with the pre-built DTK directory structure is mounted. For example, add: On systems running Windows: call Z:\Dell\Toolkit\Template\Scripts\SYSCAP.
NOTE: Do not replicate the RAC IP address when creating a .cfg file. Replicating the RAC IP address can leave the system inaccessible because multiple systems are configured with the same IP address. NOTE: On Dell PowerEdge 9G or later systems, raccap.sh and syscap.sh have duplicate functions. If you run raccap.sh followed by syscap.sh, the latter overwrites the former settings. RACCAP.BAT Or raccap.sh The RACCAP.BAT or raccap.
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.
lininst The lininst.sh sample script is used to perform an unattended installation of the supported Red Hat Enterprise Linux Server operating system in both BIOS and UEFI mode. The variables and paths must be specified before the operating system can be installed. 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.
Perform the following steps to install Red Hat Enterprise Linux using the lininst.sh script: 1. On the source system, navigate to the location of the required Red Hat Enterprise Linux operating system image. 2. Create a NFS share using the following command: vi /etc/exports. 3. Share /home/rhelshare. NOTE: If the folder you want to share is /home, then the /etc/exports file must contain the “/home *(rw)” line. 4. Restart the NFS service. 5. Copy the operating system image to the NFS share. 6.
grub2 — Used with the kernel image and initial ramdisk files, along with the unattended answer file to install the operating system in UEFI mode. Variables Used • DT_OS_DISK — Sets the disk on which to deploy the SUSE Linux Enterprise Server operating system. • DT_OS_SRC — Sets the location from where to copy the kernel image and initial ramdisk files. • DT_OS_PART — Sets the valid partition to install the grub files.
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).
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. 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.
• Accessing scripts, configuration files, and operating system installation files from the network. Preparing And Populating The Network Share This process includes: • 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.
– Windows PE or embedded Linux, as the case maybe, is installed from the media. – The DTK scripts execute the necessary DTK utilities from the media. – 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.
– 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.
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.
Post Installation Of RPMs After installing the RPMs, perform the following: 1. For the binaries syscfg and raidcfg, export the PATH environment variable /opt/dell/toolkit/bin. 2. To start the services, navigate to /opt/dell/srvadmin/sbin, and type: srvadmin-services.sh start NOTE: To execute the commands to configure the system as per the requirements, see the Dell OpenManage Deployment Toolkit Command Line Interface Reference Guide available at dell.com/openmanagemanuals.
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 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.
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: 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.
A: You can apply driver disks as follows: 1. During operating system installation, after the first reboot, attach the driver-disk.iso file to the DVD-ROM or virtual media. 2. At the grub prompt, press followed by - and, then press . Q: Why DTK ELI (32–bit) does not successfully boot up a Dell server running in UEFI mode? A: On a Dell server running in UEFI mode, DTK supports only 64–bit ELI.
