Dell EMC OpenManage Deployment Toolkit Version 6.0.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. 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 © 2017 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 Introduction..................................................................................................................... 6 DTK Deprecation Message................................................................................................................................................. 6 What is new in this release................................................................................................................................................. 6 DTKTORACADM............
Sample scripts for deployment on Linux system.........................................................................................................30 RPMs................................................................................................................................................................................ 31 Documentation..................................................................................................................................................................
Integrating DTK directory structure ........................................................................................................................... 52 Creating a bootable media for Windows PE 5.0..........................................................................................................52 Running the image.....................................................................................................................................................
1 Introduction 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.
• Support for the following PowerEdge servers: – PER740 – PER740XD – PER640 – PEC6420 – R940 • Added Support for the Precision Rack System: – PR7920 • Added support for below Network Cards: – NetXtreme BCM5719/5720 1Gbps devices – NetXtreme-E BCM574xx 10Gbps/25Gbps devices – Mellanox ConnectX-4 Dual Port 100 GbE QSFP Network Adapter – QLogic 10GE BASE-T 2Port PCIe FH/LP – QLogic 10GE SFP+ 2Port PCIe FH/LP – QLogic 25GE SFP28 2Port PCIe FH/LP – Intel X550 rNDC – Intel 10GbE 4P X710 NOTE: For the list of
The set of converted commands are available in dtktoracadm_dict.map. For more information see, Dell EMC OpenManage Deployment Toolkit User's Guide or Dell EMC OpenManage Deployment Toolkit Installation Guide. The following table lists the set of commands available: Table 3. SYSCFG equivalent RACADM commands Group SYSCFG Commands Equivalent RACADM Commands iDRAC Settings lcp --dnsdhcp iDRAC.IPv4.DNSFromDHCP lcp --domainname iDRAC.NIC.DNSDomainName lcp --dnsracname iDRAC.NIC.
Group Integrated Devices Memory Settings Miscellaneous Settings Processor Settings SYSCFG Commands Equivalent RACADM Commands --SetBootOrderFqddn BIOS.BiosBootSettings.SetBootOrderFqddn --SetLegacyHddOrderFqddn BIOS.BiosBootSettings.SetLegacyHddOrderFqddn --EmbVideo BIOS.IntegratedDevices.EmbVideo --IoatEngine BIOS.IntegratedDevices.IoatEngine --IntegratedNetwork1 BIOS.IntegratedDevices.IntegratedNetwork1 --IntegratedNetwork2 BIOS.IntegratedDevices.
Group SATA Settings 10 SYSCFG Commands Equivalent RACADM Commands --cpuspeed BIOS.ProcSettings.ProcCoreSpeed --logicproc BIOS.procsettings.LogicalProc --proc1brand BIOS.procsettings.Proc1Brand --proc1id BIOS.procsettings.Proc1Id --proc1l2cache BIOS.procsettings.Proc1L2Cache --proc1l3cache BIOS.procsettings.Proc1L3Cache --proc1numcores BIOS.procsettings.Proc1NumCores --proc2brand BIOS.procsettings.Proc2Brand --proc2id BIOS.procsettings.Proc2Id --proc2l2cache BIOS.procsettings.
Group SYSCFG Commands Equivalent RACADM Commands --sataportgdrivetype BIOS.SataSettings.SataPortGDriveType --sataportgcapacity BIOS.SataSettings.SataPortGCapacity --sataporth BIOS.SataSettings.SataPortH --sataporthmodel BIOS.SataSettings.SataPortHModel --sataporthdrivetype BIOS.SataSettings.SataPortHDriveType --sataporthcapacity BIOS.SataSettings.SataPortHCapacity --sataporti BIOS.SataSettings.SataPortI --sataportimodel BIOS.SataSettings.SataPortIModel --sataportidrivetype BIOS.
• TheDell OpenManage Installation Guides provides additional information about performing an unattended installation of Server Administrator on systems running supported Windows, Red Hat Enterprise Linux Server, SUSE Linux Enterprise Server, and Citrix Xen Sever operating systems. • The Dell Systems Software Support Matrix provides information about the various Dell systems and the operating systems supported by these systems.
– Serviceability Tools – Dell Client Command Suite – Connections Client Systems Management d. • To view a document, click the required product version. Using search engines: – Type the name and version of the document in the search box. 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.
2 Pre-requisites and deployment The Deployment Toolkit (DTK) is a collection of Windows PE and Linux-based utilities and scripts that help 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 preoperating system and postoperating system configuration tasks or to run a scripted deployment in the respective environments.
• Red Hat Enterprise Linux 7.3 (64-bit) • Red Hat Enterprise Linux 6.9 (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 EMC 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 www.dell.com/support.
• Your operating system software and documentation. • An optimally configured source system with network access. NOTE: You can download the latest drivers from www.dell.com/support. For Linux, ensure that you have all of the following tools, software, and information ready to use or consult: • Advanced knowledge of Linux and Linux scripting (bash), Linux networking, installing and working with RPM Package Managers, and creating and modifying loop file systems.
Table 5. Supporting Tools and System Files for Windows Additional Tools Purpose Source Windows ADK for Windows Server 2012 R2 and Windows 8.1 (64-bit) Create a bootable media for Windows PE 5.1. microsoft.com Windows ADK for Windows Server 2016 and Windows 10.0 (64-bit) Create a bootable media for Windows PE 10.0. microsoft.com The following table is a matrix of Linux system files and other tools to use with DTK utilities and its sample scripts. Table 6.
NOTE: For the latest supported operating systems, see the Windows PE documentation. DTK helps to deploy the Linux operating systems in BIOS and UEFI mode, for supported OS information refer Supported operating systems. The sample configuration files contain examples to deploy the supported operating systems. Deployment DTK offers a complete set of utilities, sample scripts, and RPM packages that can be used to automate deployment on large numbers of Dell systems.
Deployment Methods Complexity Advantages • Deployment solution framework from a third‑party vendor Mixed • • • PXE boot for Linux High • • • • • Disadvantages Can install supported Windows or Linux operating systems. Must either acquire and learn to DTK can be used in context use or have an existing thirdof third-party deployment party deployment solution solution framework. framework. Third-party deployment solution framework is used as the deployment transport mechanism.
NOTE: You can use a system BIOS configuration profile generated for all systems belonging to the same generation. 5. Create an operating system answer file that contains unattended operating system software installation information. 6. Edit the DTK sample script files that read the system configuration files to set up the system BIOS, BMC, RAID, and RAC and then install an operating system on a target system.
3 Downloading DTK 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.
Extracting DTK components on systems running Linux DTK components are provided as an ISO image at www.dell.com/support. 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 www.dell.
Command Line Interface Reference Guide at dell.com/openmanagemanuals for complete information about the capabilities of each DTK utility. Table 10. System Utilities and Supported Files for Windows Toolkit Components Purpose mr2kserv.exe Service required to run raidcfg.exe functions. raidcfg.exe Creates and reports Redundant Array of Independent Disks (RAID) information. syscfg.
Toolkit Components Purpose unchanged_tokens.log Displays the RACADM scripts logs which are not converted. System utilities and supported files For Linux The following table lists the files, at /opt/dell/toolkit/bin and the supporting libraries located in /opt/dell/toolkit/lib on systems running the Linux operating system. The files are the core tools (utilities) that perform preoperating system configuration and deployment tasks.
and Linux operating systems. The list of DTK sample scripts are present in \Toolkit\Tools\CONVERTER\ windows_scripts.lst for Microsoft Windows operating systems and toolkit/Converter/ linux_scripts.lst for Linux operating system. The converted scripts are available in the folder racscripts. The set of converted commands are available in dtktoracadm_dict.map. The following table lists the set of commands: Table 12.
Group SYSCFG Commands Equivalent RACADM Commands Boot Settings --BootMode BIOS.BiosBootSettings.BootMode --BootSeqRetry BIOS.BiosBootSettings.BootSeqRetry --HddFailover BIOS.BiosBootSettings.HddFailover --SetBootOrderFqddn BIOS.BiosBootSettings.SetBootOrderFqddn --SetLegacyHddOrderFqddn BIOS.BiosBootSettings.SetLegacyHddOrderFqddn --EmbVideo BIOS.IntegratedDevices.EmbVideo --IoatEngine BIOS.IntegratedDevices.IoatEngine --IntegratedNetwork1 BIOS.IntegratedDevices.
Group SATA Settings SYSCFG Commands Equivalent RACADM Commands --logicproc BIOS.procsettings.LogicalProc --proc1brand BIOS.procsettings.Proc1Brand --proc1id BIOS.procsettings.Proc1Id --proc1l2cache BIOS.procsettings.Proc1L2Cache --proc1l3cache BIOS.procsettings.Proc1L3Cache --proc1numcores BIOS.procsettings.Proc1NumCores --proc2brand BIOS.procsettings.Proc2Brand --proc2id BIOS.procsettings.Proc2Id --proc2l2cache BIOS.procsettings.Proc2L2Cache --proc2l3cache BIOS.procsettings.
Group SYSCFG Commands Equivalent RACADM Commands --sataportg BIOS.SataSettings.SataPortG --sataportgmodel BIOS.SataSettings.SataPortGModel --sataportgdrivetype BIOS.SataSettings.SataPortGDriveType --sataportgcapacity BIOS.SataSettings.SataPortGCapacity --sataporth BIOS.SataSettings.SataPortH --sataporthmodel BIOS.SataSettings.SataPortHModel --sataporthdrivetype BIOS.SataSettings.SataPortHDriveType --sataporthcapacity BIOS.SataSettings.SataPortHCapacity --sataporti BIOS.SataSettings.
Sample deployment configuration files for Windows The following table describes examples of Windows configuration files used to perform a scripted deployment. The Windows files for 64-bit supported systems are located in the following directories: • \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 13.
Sample scripts for deployment on Windows system The following table lists Windows sample scripts necessary to perform a scripted deployment. The sample scripts for Windows are at Toolkit\Template\Scripts. 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 15. Sample Scripts For Deployment on Windows System Toolkit Components Purpose createup.cfg This file is used by UPINIT.BAT.
Table 16. Sample Scripts For Deployment on Linux system Toolkit Components Purpose errhndl.sh Handles errors returned in DTK scripts. lininst.sh Performs an unattended installation of a supported Red Hat Enterprise Linux Server (version 6) operating system. lininst7.sh Performs an unattended installation of a supported Red Hat Enterprise Linux Server (version 7) operating system. partcfg.
Drivers and Dell real mode kernel Hardware application programing interface (HAPI) drivers are essential for DTK tools to work in the embedded Linux environment. Dell Real Mode Kernel (DRMK) contains the mbr file necessary to create a bootable Dell Utility Partition.
4 DTK Seamless package The DTK Seamless package is a single installer package that carries Linux DTK RPMs (RHEL, SLES) and its dependency. Seamless package — Downloading and Installing This section describes the downloading and installing of DTK seamless package. The seamless package auto recognizes the OS type and its respective dependency during the installation and installs SYSCFG, RAIDCFG, and RACADM tools on post Linux operating system.
5 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.
6 Preparing the script files 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.
Script Name syscap.sh Description Captures BIOS, DRAC, and BMC configuration settings and saves them to a file. Associated Files • raidcfg — Used by raidcap.sh to retrieve RAID information and to configure settings. • tkenvset.sh — Used by syscap.sh to inform the task scripts where to find the DTK utilities, scripts, and configuration files. syscfg — Used by syscap.sh to configure the BIOS, DRAC, and BMC settings.
Table 23. Deployment Scripts For Windows Script Name Description Associated Files W2K12INST.BAT Performs an unattended installation of • supported Windows Server 2012 operating systems. NOTE: From Windows Server • 2012 onwards, Server Core is • the default deployment configuration setting. However, • you can modify the xml files to change the setting. W2K16INST.BAT Performs an unattended installation of • supported Windows Server 2012 R2 operating systems.
Script Name Description Associated Files NOTE: Both grub and grub2 use the following images with the unattended answer file to perform unattended operations: • • • – initial ramdisk — Available on the SUSE Linux Enterprise Server operating system media – kernel image — Available on the SUSE Linux Enterprise Server operating system media autoinst.xml — Used by suseinst.sh with grub to install the operating system files. autoinst-sles12.xml — Used by suseinst.
Script Name Description Associated Files specified before any of the other supporting scripts can be used. raidcfg.sh Configures the selected RAID controller detected in the system. • • partcfg.sh In BIOS mode, creates and populates • the Dell utility partition and the deployment partition (MBR type) on a specified disk. In 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.
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).
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. Additionally, the RAC configuration file used to configure your RAC is set by default to raccfg.ini. If you use the RACCAP.BAT or raccap.sh sample script to generate the raccfg.ini file, there is no need to edit this default setting.
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. 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. In partcfg.
script. On systems running Windows, RACREP.BAT script uses RACADM.EXE to configure RAC in the target system. On systems running Linux the racrep.sh script uses racadm wrapper script or the 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.
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.
On systems running Windows: Z:\Dell\x64\Toolkit\Template\Scripts\RACCAP.BAT Z:\raccfg.ini On systems running Linux: /opt/dell/toolkit/template/scripts/raccap.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 on systems running Windows and /opt/dell/toolkit/systems/ directory on systems running Linux. 3. Edit the startnet.
NOTE: It is recommended that you consult your Windows or Red Hat Enterprise Linux Server operating system documentation and unattended deployment documentation to develop a thorough understanding of the unattended installation process before attempting to perform a full scripted deployment. 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. W2K12INST.BAT and W2K16INST.
After you have successfully edited your deployment scripts, you are ready to create your deployment media and run your deployment. For instructions on creating the deployment media and running a full deployment, see Running The Deployment Scripts. Linux scripts The lininst.sh (for Red Hat Enterprise Linux 6) and lininst7.
NOTE: The sample files provided to install CentOS Server (version 7.x) are ks-centos7.cfg (in BIOS mode), and ks_centos7_uefi.cfg (in UEFI mode). To use the sample ks-centos7.cfg file to install CentOS Server (version 7.x) using centinst7.sh, ensure that you rename the file to ks.cfg . To use the sample ks_centos7_uefi.cfg file to install CentOS Server (version 7.x) using centinst7.sh, ensure that you rename the file to ks_uefi.cfg.
After you have successfully edited your deployment scripts, you are ready to create the deployment media and run the deployment. For instructions on creating the deployment media and running a full deployment, see Deployment Using Dell Provided Embedded Linux . NOTE: During an unattended SUSE Linux Enterprise Server installation, if the installer lists out missing packages, delete the listed packages from autoinst.xml/autoinst_uefi.xml.
7 Running the deployment scripts 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.
• Integrating The DTK Directory Structure • Creating A Bootable Media For WIN PE 5.0 • Running The Image Creating and customizing images for Windows PE 5.1 If you are using Windows 5.1, 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 WINPE5.x_driverinst.BAT (for Windows PE 5.1), and WINPE10.x_driverinst.
Running the image You are now ready to use your bootable media to access the deployment components from the directory structure on the media: 1. Boot the target system with the bootable deployment media. 2. Execute the master batch file, which calls individual task scripts and utilities from the media to complete the deployment process. Media-Based local deployment with Networking enabled for systems running windows This method provides greater flexibility and is highly recommended in large deployments.
Deployment using removable boot media without a network (mediabased) connection for systems running windows For media-based deployment without a network connection: 1. Create a deployment media containing a bootable image with the appropriate drivers. The media must also include the complete deployment directory structure, which contains all DTK utilities, scripts, and configuration files, an operating system installation answer file, and the required operating system installation files and drivers. 2.
PXE-Based deployment The procedure enables you to boot DTK over network and pass parameters (startup script location and name) during boot using the Preboot eXecution Environment (PXE) configuration file. This automatically launches the start-up script off the network share, when DTK is booted. 1. Obtain the ISO image of the embedded Linux available at www.dell.com/support. 2.
Deployment using custom scripts 1. Obtain the ISO image of the embedded Linux at www.dell.com/support. 2. Extract the contents of the ISO image to a folder (for example, isoimage) on your hard drive. 3. Copy the custom scripts into the same folder. 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.
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. 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.
beyond the scope of this document. If you plan to utilize a third-party deployment solution framework, make sure that the deployment solution framework supports embedded Linux as a pre-operating system environment.
8 Running Dell update packages on systems running embedded Linux 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 EMC Server Updates DVD or from www.dell.com/support. 2.
Update Packages Dependency Dependencies Available On 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.
9 Known issues and frequently asked questions 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 change my hard drive controller from SCSI to RAID (or RAID to SCSI), the system prompts me for confirmation during POST. How can I stop this from happening? A: Use the --noraidprompt option with the --embscsiraid option to prevent the system from prompting during POST. Data loss results from changing the state of the disk controller, so you must be certain before skipping the prompt. There is no method for using the ‑‑noraidprompt in the input file.
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: 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.
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. Q:How to delete the Unavailable: RHEL_DTK_UEFI and Unavailable: SLES_DTK_UEFI entries displayed on the F11 UEFI boot manager? A: Do the following to delete the entries: 1. Identify the boot entry number (for example, BootXYZ) of the entry to be deleted: Run efibootmgr from the command line. 2.
