Dell OpenManage Deployment Toolkit Version 5.
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 What is new in this release................................................................................................................................................... 6 DTKTORACADM...................................................................................................................................................................
Documentation.................................................................................................................................................................... 30 Drivers and Dell real mode kernel ..................................................................................................................................... 30 4 DTK Seamless package................................................................................................................
Media-Based local deployment with Networking enabled for systems running windows......................................... 54 Bootable Windows PE media with Networking enabled...........................................................................................54 Preparing and populating the network share.............................................................................................................
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.
Valid Arguments dtktoracadm.exe or dtktoracadm.exe windows_scripts.lst debug Applicable Systems All PowerEdge 12 and later systems. Table 2. DTKTORACADM Command on Linux Operating System Valid Arguments python dtktoracadm.py or python dtktoracadm.py linux_scripts.lst debug Description On the system running Linux operating system, in the prompt type the command, where linux_scripts.
Group SYSCFG Commands Equivalent RACADM Commands --solprivlevel iDRAC.IPMISOL.MinPrivilege --solcharsendthreshold iDRAC.IPMISOL.SendThreshold BIOS Option Settings --HddSeq BIOS.BiosBootSettings.HddSeq Boot Settings --BootMode BIOS.BiosBootSettings.BootMode --BootSeqRetry BIOS.BiosBootSettings.BootSeqRetry --HddFailover BIOS.BiosBootSettings.HddFailover --SetBootOrderFqddn BIOS.BiosBootSettings.SetBootOrderFqddn --SetLegacyHddOrderFqddn BIOS.BiosBootSettings.
Group SYSCFG Commands Equivalent RACADM Commands --RedirAfterBoot BIOS.SerialCommSettings.RedirAfterBoot Slot Disablement --Slotn BIOS.SlotDisablement.Slotn System Information --svctag BIOS.SysInformation.SystemServiceTag System Security --AcPwrRcvryDelay BIOS.SysSecurity.AcPwrRcvryDelay --PwrButton BIOS.SysSecurity.PwrButton --SetupPassword BIOS.SysSecurity.SetupPassword --SysPassword BIOS.SysSecurity.SysPassword --maxpowercap System.Power.Cap.MaxThreshold --minpowercap System.Power.
• Imaging software documentation, if you are creating a bootable media or are planning to deploy from an image (deploying from an image is not covered in this guide). Accessing documents from the Dell EMC support site You can access the required documents using the following links: • • • • • • • • For Dell EMC Enterprise Systems Management documents — www.dell.com/SoftwareSecurityManuals For Dell EMC OpenManage documents — www.dell.
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.
For Linux, the DTK utilities support deploying the following operating systems in BIOS and UEFI mode: • • • • • SUSE Linux Enterprise Server 12 SP2 (64-bit) SUSE Linux Enterprise Server 11 SP4 (64–bit) Red Hat Enterprise Linux 7.3 (64-bit) Red Hat Enterprise Linux 6.8 (64-bit) CentOS 7.3 (64-bit) NOTE: CentOS deployment is supported only on DSS1510, DSS1500, DSS2500 platforms.
• • Working knowledge of Windows Deployment Services (WDS) or any other third-party deployment system or tool for Windows PE. 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.
Drivers Purpose winpe5.x\WINPE5.x_driverinst.bat Used to install Dell-provided drivers, from \Dell\x64\Drivers, into the customized Windows PE 5.1 image. winpe10.x \WINPE10.x_driverinst.bat Used to install Dell-provided drivers, from \Dell\x64\Drivers, into the customized Windows PE 10.0 image.
Additional Tools Purpose Source Save in DTK location initial ramdisk Used during a Linux unattended installation. Available on the Linux operating system media or on the Systems Build and Update Utility on the Dell Systems Management Tools and Documentation DVD. /opt/dell /toolkit / systems NOTE: For legacy operating systems, you may need to use the driver disk.
Table 7.
Compute sled to PowerEdge FD332 setup Operating system installation support SYSCFG/RAIDCFG Description configuration support No Yes dual PERC mapped to the compute sleds (split mode) + multiple boot VD Compute sled with PERC + PowerEdge FD332 (single/multiple) with a single PERC mapped to the compute sled + multiple boot VD No scenario to install operating system with multiple boot VD Deployment matrix Depending on the scope, current business needs, network setup, and process, you can select any of t
Deployment Methods Complexity Advantages • • • • Disadvantages Easy to manage — changes • can be made in only in 1 place. High flexibility for remote deployment. No media required. Faster deployment. 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.
SBUU is replaced with Lifecycle Controller on Dell 13G servers. iDRAC with Lifecycle Controller is an Embedded Systems Management application for operating system deployment and lifecycle management of PowerEdge servers. You can access Dell Lifecycle Controller by pressing during system boot up.
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. Configuring supported RAID controllers.
• • • 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 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).
Contents Details /var Any run-time variable data that might be required for embedded Linux and tools to function. /tmp The only safe, writable area. However, all the data in this folder is lost every time you reboot. /usr Miscellaneous tools and libraries for embedded Linux to function.
Toolkit Components Purpose pci.ids Reports PCI devices when used with syscfg.exe. disclaimer.txt Displays the disclaimer for the tools. RaidcfgErrorCodes.txt Lists the error codes and messages for the raidcfg.exe tool. SyscfgErrorCodes.txt Lists the error codes and messages for the syscfg.exe tool. CONVERTER Has the utility dtktoracadm.exe to convert the SYSCFG scripts to equivalent RACADM scripts. The file is located in Toolkit\Tools\CONVERTER. dtktoracadm_dict.
Toolkit Components Purpose • • 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 An .ini file used with syscfg. UpinitErrorCodes.txt Lists the error codes and messages for upinit.sh. Converter Has the sample utility using python script. Type in the terminal python dtktoracadm.py command to convert the SYSCFG scripts to equivalent RACADM scripts.
Group SYSCFG Commands Equivalent RACADM Commands --dnsserver1v6 get iDRAC.IPv6.DNS1 --dnsserver2v6 get iDRAC.IPv6.DNS2 --gatewayv6 iDRAC.IPv6.Gateway --ipv6address1 iDRAC.IPv6.Address1 --ipv6address2 iDRAC.IPv6.Address2 --linklocaladdrv6 iDRAC.IPv6.LinkLocalAddress --prefixlengthv6 iDRAC.IPv6.PrefixLength --connectionmode iDRAC.IPMISerial.ConnectionMode --msgcommbitrate iDRAC.IPMISerial.BaudRat --msgcommflowctrl iDRAC.IPMISerial.FlowControl --tmcfghandshakectrl iDRAC.IPMISerial.
Group SYSCFG Commands Equivalent RACADM Commands --NumLock BIOS.MiscSettings.NumLock --ForceInt10 BIOS.MiscSettings.ForceInt10 --DcuIpPrefetcher BIOS.ProcSettings.DcuIpPrefetcher --DcuStreamerPrefetcher BIOS.ProcSettings.DcuStreamerPrefetcher --LogicalProc BIOS.ProcSettings.LogicalProc --ProcExecuteDisable BIOS.ProcSettings.ProcExecuteDisable --ProcHwPrefetcher BIOS.ProcSettings.ProcHwPrefetcher --ProcVirtualization BIOS.ProcSettings.ProcVirtualization --RtidSetting BIOS.ProcSettings.
Table 14. Sample Configuration Files for Windows Toolkit Components Purpose Location raccfg.ini Sample configuration file for DRAC4 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 deployment configuration f
Toolkit Components Purpose ks-centos7_uefi.cfg Sample file used with unattended installation of CentOS Server (version 7) operating system in UEFI mode. raccfg.ini Sample configuration file for DRAC 4 RACs. raidcfg.ini Sample output file to enable RAID replication. syscfg.ini Sample configuration file for SYSCFG utility to configure the BIOS, DRAC, and BMC settings.
Toolkit Components Purpose 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. Sample scripts for deployment on Linux system The following table lists Linux sample scripts necessary to perform a scripted deployment. NOTE: All DTK scripts are provided as examples only.
RPMs Purpose 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. On systems running the Windows operating system, documentation can be found at \Dell\Docs.
4 DTK Seamless package The DTK Seamless package is a single installer package that carries Linux DTK RPMs (RHEL, SLES) and its dependency. Topics: • Seamless package — Downloading and Installing 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.
The seamless package uninstalls the older DTK tool set version, and upgrades it to a newer version if Server Administrator is not present in the 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.
Operating system installation files 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.
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.
::%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.
Script Name Description Associated Files raidcap.sh Captures the RAID settings and saves them to a file. • tkenvset.sh — Used by raidcap.sh to inform the task scripts where to find the DTK utilities, scripts, and configuration files. raidcfg — Used by raidcap.sh to retrieve RAID information and to configure settings. • syscap.sh Captures BIOS, DRAC, and BMC • configuration settings and saves them to a file. • tkenvset.sh — Used by syscap.
Deployment scripts for systems running windows operating systems The following table lists the deployment scripts for Windows. Table 24. Deployment Scripts For Windows Script Name Description Associated Files W2K8INST.BAT Performs an unattended installation of supported Windows Server 2008 operating systems. • TKENVSET.BAT — Used by W2K8INST.BAT to inform the task scripts about where to find the DTK utilities, scripts, and configuration files. SETUP.EXE — Used by W2K8INST.
Script Name Description Associated Files • • • • suseinst.sh Performs an unattended • installation of a supported SUSE Linux Enterprise Server • operating system. • ks-rhel6.cfg — Used by lininst.sh with grub to install the Red Hat Enterprise Linux Server (versions 6) operating system files in BIOS mode. ks_rhel6_uefi.cfg — Used by lininst.sh with grub2 to install the Red Hat Enterprise Linux Server (versions 6) operating system files in UEFI mode. ks-rhel7.cfg — Used by lininst.
Script Name Description Associated Files RAIDCFG.BAT Configures the selected RAID controller • detected in the system. • PARTCFG.BAT Creates and populates the Dell utility • partition (UP) and the operating system partition on a specified disk. • TKENVSET.BAT — Used by RAIDCFG.BAT to inform the task scripts about where to find the DTK utilities, scripts, and configuration files. RAIDCFG.EXE — Used by RAIDCFG.BAT to retrieve RAID information and configure settings. TKENVSET.BAT — Used by PARTCFG.
Script Name Description Associated Files • • • • sysdrmk — Used by upinit.sh to patch the boot sector. unzip — Used by upinit.sh for populating the Dell utility partition. mke2fs — Used to create a ext2 file system. upimg.bin — Contains the zipped contents of the Dell utility partition. Editing example of TKENVSET and tkenvset The majority of editing required for DTK sample scripts involves the TKENVSET.BAT (for Windows) or tkenvset.sh (for Linux) script.
5. Set the variable that defines the directory containing DTK deployment scripts (DT_SCRIPTS). This variable is set to %DT_PATH% \Template\Scripts (Windows) or $dt_path/template/scripts (Linux) by default in the sample script. Edit this path to reflect the actual location of DTK deployment scripts, if necessary. 6. Set the variable that indicates whether you want the deployment process to exit when any error is returned (DT_STOP_ON_ERROR).
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.
# 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. Edit the default variable value for the default hard drive (DT_HD for Windows and DT_HD for Linux), if applicable.
first controller discovered, if RAIDCFG.EXE or raidcfg.sh discovers only one attached hard drive, the script tries to create RAID 0; if two hard drives are discovered, a RAID 1 configuration is enabled; if three or more hard drives are discovered, a RAID 5 configuration is enabled. NOTE: On the detected controller, a RAID virtual disk is created only if the array disks connected to that particular controller have space available and, where applicable, are not part of existing array group. SYSREP.
values used in this script are set to the correct default values to perform a scripted deployment. The SYSCAP.BAT or syscap.sh script uses the SYSCFG utility to retrieve BIOS and BMC configuration settings from the source system and to save the settings in a file named syscfg.ini in the Z:\Dell\Toolkit\Systems\ directory. 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.
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: The racrep.sh and sysrep.sh have duplicate functions. If you run racrep.sh followed by sysrep.sh, the latter overwrites the former settings. RACCAP.BAT or raccap.sh The RACCAP.BAT or raccap.sh sample script captures RAC configuration settings and saves them to a specified location.
Utilities used SETUP.EXE — Used to install the operating system in conjunction with the UNATTEND.XML and UNATTEND_UEFI.XML answer files. External dependencies W2K8INST.BAT,W2K12INST.BATand W2K16INST.BATscripts uses two environment variables: DT_PLATFORM and DT_DRIVE. The DT_PLATFORM variable is set by TKENVSET.BAT using platform discovery.
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 6 operating system. DT_OS_NFS_LOC — Sets the disk to deploy the Red Hat Enterprise Linux Server 7 operating system. DT_OS_SRC — Sets the location from where to copy the kernel image and initial ramdisk files.
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.
When you have completed all necessary modifications of the autoinst.xml/ autoinst_uefi.xml file, save the completed file in the /opt/ dell/toolkit/systems/ directory. 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 .
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.
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.
4. Execute the script: WINPE3.0_driverinst.bat where is the destination path to create the directory structure for Windows PE and is the path for the Dell drivers in the extracted DTK toolkit. For example, WINPE3.0_driverinst.bat C:\winpe_30 C:\DELL\x64\DRIVERS. This pre-installs the Dell drivers into Windows PE image. The successful execution of the above commands creates a bootable ISO image for Windows PE 3.0 at . NOTE: The destination folder (C:\winpe_30)
You can also use the bootable media to call the deployment components from the directory structure on the media and the remaining components from the network share. 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 network share to complete the deployment process.
• Media Based Deployment Network-based deployment The two common scenarios for network-based deployment are: • • PXE-Based Deployment Network File System or SMBFS File System Based Deployment 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.
Media-based deployment The different media-based deployments are as follows: • • • Deployment Using Custom Scripts Deployment Using RPMs Deployment Using USB 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.
baseurl=file:///mnt/cdrom/RPMs/rhel6/ enabled=true 4. Use the following command to install DTK RPMs: yum install -c dtk.repo -y , where can be DTK binaries. 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.
Using a third-party deployment solution framework for systems running Linux You can use DTK with any existing third-party deployment solution framework that provides a PXE booting infrastructure that can be used as transport mechanism for the DTK utilities. Because each third-party deployment framework is unique, these solutions are beyond the scope of this document.
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 Topics: • • Running update packages in Dell-provided embedded Linux Running update packages in customized embedded Linux Running update packages in Dell-provided embedded Linux 1.
Update Packages Dependency Dependencies Available On 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. 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. Topics: • • Known issues 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.
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.
Features that have been removed from the MS-DOS version include: • • • The --name and --wait options in the create command The --runlocation and the --scratchlocation options The --getpercentcomplete environment variables Q: What is the minimum virtual disk size that I can create? A: For PERC 5 controllers: • • • RAID 0: 100 MB RAID 1: 100 MB RAID 5: 100 MB For PERC 6 controllers: • • • • • RAID 0: 100 MB RAID 1: 100 MB RAID 5: 100 MB RAID 6: 100 MB RAID 60: 100 MB Q: Why cannot I see any controllers
Embedded Linux questions Q: After installing Linux, I am not able to boot to the utility partition by pressing the key during reboot. A: Re-create the utility partition using the upinit.sh script and install grub in the boot partition. Q: When booting DTK through PXE, my system displays error messages, unknown behavior, and also leads to a kernel panic sometimes. However, booting from the media causes no problems.
