NCR Imaging Suite User Guide - 4.0.0.3
NCR Imaging Suite User Guide - 4.0.0.3
Table of Contents
Document Revision History.............................................................................................................................................. 3
Introduction............................................................................................................................................................................ 4
Assumptions.........................................................................................................................................................4
NCR Imaging Suite Overview............................................................................................................................................ 5
Hardware and Software Requirements................................................................................................................5
Imaging Suite Package Components.....................................................................................................................6
Imaging Use Cases................................................................................................................................................................ 8
Local USB boot to capture or apply an image.......................................................................................................8
Network boot Client and connect to Server to capture or apply an image..........................................................8
Creating a Bootable USB drive......................................................................................................................................... 9
Applying an image from a USB flash drive............................................................................................................... 13
Using an Auto-Imaging USB flash drive..............................................................................................................13
Using a generic Imaging Client USB flash drive..................................................................................................13
Capturing an image to a USB flash drive................................................................................................................... 17
Configuring the Imaging Server.................................................................................................................................... 20
Capturing an image over the Network...............................................................................................................24
Applying an image over the Network.................................................................................................................30
Command Line Options.................................................................................................................................................... 35
Imaging Server Options......................................................................................................................................35
Imaging Client Options.......................................................................................................................................36
Modifying an image file.................................................................................................................................................... 37
Mounting an image using DISM GUI..................................................................................................................37
Customizing the PE Boot Image.................................................................................................................................... 43
Mount the Windows PE boot.wim file.............................................................................................................43
Updating Recovery Tool................................................................................................................................................... 47
Requirements.....................................................................................................................................................47
From within the Recovery Tool...........................................................................................................................47
From Windows...................................................................................................................................................47
RadsImageX.......................................................................................................................................................................... 48
Overview............................................................................................................................................................48
Major Differences from ImageX.........................................................................................................................48
Capture/Append Operations..............................................................................................................................49
Apply Operation.................................................................................................................................................50
UEFI / Secure Boot Operation....................................................................................................................................... 51
Legacy Images Are Compatible...........................................................................................................................51
Changes to MakeBootablePeDisk.......................................................................................................................52
Changes to TFTPD32 (PXE BOOT).......................................................................................................................53
Changes to Recovery Update.............................................................................................................................54
Introduction
NCR has transitioned most of our imaging infrastructure to Microsoft’s Windows Imaging technology (often
referred to as ImageX). To facilitate this transition, we created a package of applications based on Windows
Imaging technology called the “NCR Imaging Suite” that will enable users to capture and apply system images in
the Microsoft Windows Imaging (.WIM) format.
The Imaging Suite application is GUI based, and provides support for the typical imaging activities previously
available with Symantec Ghost to make the transition as easy as possible.
This document should provide the user with a general overview of the Imaging Suite package, how to configure
the system to run it, and how to use the applications to capture and apply system images.
Assumptions
The target audience for this document is primarily those in image creation roles both within NCR and within
customer organizations. Some knowledge of the Microsoft Windows 7, Windows 10 and Server Operating
Systems is assumed. Prior experience performing system imaging using Symantec Ghost and PXE network
booting may be helpful to the reader for some of the more advanced user scenarios, but is not required.
The Imaging Client application is typically run from within the Windows PE environment on the target device.
The Imaging Suite provides tools and instructions for booting to this environment from your network or from a
bootable USB device.
Any existing imaging infrastructure used for Ghost can also be used for the Imaging Suite applications with some
minor changes to existing TFTPD32 configurations for PXE booting. It is recommended that Windows 7 and
Server 2008 R2 be used as the imaging server OS but XP Pro will also work.
Clients
At least 512MB RAM Installed.
Supports PXE or USB Drive booting.
Utilities
ImageSigner
Use this application after using DISM to manually modify the contents of an image. This can reapply
the NCR proprietary image hash to the WIM file.
This can also check the signature of an image file. The signature controls the type and size of
recovery partition (if applicable) the Client will create when applying the image to a terminal.
Only NCR can sign images to create a recovery partition, but a signature is not necessary to capture
and apply images.
ImagingServer
Server application which can create network imaging “sessions”. Clients can connect over a network
to capture and apply images.
MakeBootablePeDisk
Utility used to create a bootable Windows PE USB drive that contains the Imaging Client. An option
allows the drive to “auto-image” a terminal with a provided image.
RadsImageX
This utility is typically consumed by other software applications (e.g. Command Center). This is a
compact, command line driven version of the Imaging Client with a graphical progress bar used in
automated imaging tasks. The command line is intended match a subset of the stock ImageX.exe to
allow easy drop in replacement of the NCR Imaging Client and WIM format in existing utilities calling
ImageX.exe. Most users will instead use the main Imaging Client to capture and apply images.
RecoveryToolLogExtractor
The Recovery Tool logs its activity in the normally hidden recovery partition, which can make this
information difficult to access. Running this command-line tool from Windows will retrieve the logs
for reading or submission to support.
DISM GUI
This tool is distributed by Microsoft. A copy is included with Imaging Suite for convenience. This tool
will mount a WIM image captured by the Imaging Suite for offline editing. Be sure to run
ImageSigner (above) to complete image changes made using this method.
PXEBOOT-WINPE
This folder contains all the application and support files necessary for PXE network client booting.
Recovery_Update
RecoveryUpdate
This application can be run from Windows to replace the current version of Recovery_Tool on the
terminal with the latest version.
Prerequisites
NCR Imaging Suite dependency packages.
TFTPD32 4.0
.NET 4.0
VC++ 2010 Redistributable X86 and X64
****WARNING****: Drive will be formatted and all data on USB drive will be lost. Back-
up any important data located on drive before proceeding.
4. We supply a WinPE Pre-installation environment boot.wim and select it by default. This will
automatically launch the Imaging Client when WinPE boots. Advanced users, if required, can browse
to an alternate bootable WinPE boot.wim.
5. The USB drive can optionally be made to automatically apply a specific image. To do this, click the
“Auto Apply” check box and browse to the image (.WIM) that will be applied upon boot of the USB
drive.
7. If the “Verify image integrity before creation” checkbox is clicked, the image’s proprietary hash is
verified prior to confirming disk creation. This can be useful in detecting corruption that can be
caused by file transfer operations.
4. The system will boot into the Windows PE OS environment and start a script that will request
confirmation to completely re-image the terminal, destroying all existing user data.
6. Reboot the system by either closing the Command Prompt, invoking the command wpeutil
reboot, or pressing and holding the power button for 5 seconds to power off, then pressing once
more to power on.
2. Attach the USB Flash boot drive to the target client PC or terminal you wish to image.
Note: On most systems, this can be done by pressing F8 during the boot, and choosing the USB
option, or entering BIOS setup and modifying the boot order.
5. The system will boot into the Windows PE OS environment and start the Imaging Client application
automatically.
6. To apply an image from the USB drive, select the “Apply Image” button.
7. Select the Removable Drive and the image in the list, then click Next.
9. After confirmation, the unit will be re-imaged, destroying all existing user data.
4. The system will boot into the Windows PE OS environment and start the Imaging Client application
automatically.
5. To capture an image from the USB drive, click the “Capture Drive” button.
6. Select the Source Drive you wish to capture, then click the Next button.
7. Select the destination drive and input the image filename into the bottom-most text field, then click
the Next button.
8. After confirmation, the new image will be captured to the destination drive, provided there is
sufficient free space available.
a. All dependencies and pre-requisites can be found in the Prerequisites folder in the Imaging
Suite package.
i. The first time the application is run, there may be an error message about binding
DHCP/TFTP ports to an IP address not available for your system. These settings will
be changed later and you can ignore this error.
c. When prompted allow program exception for Windows Firewall or manually create a port
exception for tftpd32 TCP port 69.
f. Select the Global Tab and the enable the TFTP Server and DHCP options.
i. Option Negotiation.
k. Select the DHCP tab and enter a starting IP pool address one number higher than the NIC
LAN static IP.
l. Set size pool to 10 or higher. This indicates the number of IP addresses the DHCP server will
supply to clients.
n. Set the WINS/DNS Server to the LAN NIC’s static IP address. (Required for Imaging Client
name resolution)
q. Enable Bind DHCP to this address, and set to the LAN NIC’s Static IP.
r. Click OK.
1. Create a new local folder on the server and share it. This folder will be used as a path to which images
will be captured.
3. Launch the Imaging Server application (ImagingServer.exe). If no other ImagingServer instances are
running, the session name will start automatically with “A”. The session ID will increment accordingly
with each additional ImagingServer instance that is started.
Indicates
Session
Name
6. Select the share name created earlier in the drop down list.
7. Enter the user name and password used to access the shared folder, then click OK.
11. Click the Browse button, then browse to a path within the share. Enter a unique filename for the
captured image, then click Save.
12. (optional, recommended) If you would like for the image to include file integrity metadata, check the
Verify Data checkbox.
Note: This will slow the capture process, but will allow users to optionally verify file integrity while
files are being copied during an apply operation.
b. Connect the client machine to LAN, then turn power the machine on.
c. Boot from the network PXE agent (press F12 on most systems). Windows PE will start
loading over the network, which may take some time.
d. Once booted to Windows PE, the Imaging Client application should start automatically.
f. Press the Join button for the server session to be connected to (in this example case, group
“A”).
g. The capture will then begin on the client, and its status will be shown on ImagingServer.
3. Launch the Imaging Server application (ImagingServer.exe). If no other ImagingServer instances are
running, the session name will start automatically with “A”. The session ID will increment accordingly
with each additional ImagingServer instance that is started.
Indicates
Session
Name
7. Enter the user name and password used to access the shared folder, then click OK.
8. Click the Browse button, then browse to an image within the share. Select a file, then click Open.
9. If imaging multiple clients, change the Clients field value under Start Options.
10. (optional) If you would like for the apply process to include verification of file integrity metadata, check
the Verify Data checkbox.
Note: This will slow the apply process.
12. The image’s proprietary hash should now be validated prior to starting the session.
b. Connect the client machine to LAN, then turn power the machine on.
c. Boot from the network PXE agent (press F12 on most systems). Windows PE will start loading
over the network, which may take some time.
d. Once booted to Windows PE, the Imaging Client application should start automatically.
f. Press the Join button for the server session to be connected to (in this example case, group “A”).
g. The apply will then begin on the client, and its status will be shown on ImagingServer.
/group=<string>
A unique group ID to identify the server session for clients to connect to (Max length is 10 characters)
/disk=<N>
The disk index on the client to be applied to/captured from.
/file=<path>
The filepath (relative to the root of the share folder) to the file to apply, or the location where the capture will be
saved.
/sharename=<string>
The name and folder path of the share folder to be mapped for the imaging operation.
/username=<string>
The username used to access the network share.
/password=<string>
The password for the account credentials used to access the share folder.
/clients=N
The number of clients that are allowed to connect to sever session.
/wait=N
The maximum time, in minutes, to wait for clients to connect.
/confirm
The client must click confirm before operation will begin
Example:
Assumptions:
Folder Named “Share” is being shared.
Username = TestUser
Password = 12345
Image is located \\Share\Images\
/join=<string>
A string to identify which server session to connect to (this string is case sensitive, and must match the group ID
of the server exactly).
Example:
Assumptions:
A server session has been launched with a group ID as ABC.
To mount a WIM file, one can use the DISM tool built into Windows 7 and 2008 R2 server from the command
line, or use a third party application to do the job. In this case, we are using a third party application named
DISM GUI that is available from the Microsoft CodePlex site: http://dismgui.codeplex.com.
2. Create a scratch directory for where the image will be mounted to (for example, C:\Mount).
4. To the right of the WIM File field, you will see an Index drop down. This selects the proper image or
image partition within the WIM file to mount.
For most XP based images (XPE, WES, WEPOS, POSReady2009), you should select Index 1.
For most Windows7, POSReady7, Windows 10, Server 2008/2012/2016 images, you should select
Index 2.
6. Under Mount Location, click on the Choose Folder button, and browse to the scratch directory you just
created.
The system will work for a few moments, and then display an operation completed message.
7. Click on the Open Mounted Folder button. This will open the scratch directory.
The actual image contents will be displayed. Make any needed changes to the image.
NCR ©2017 All rights reserved. 38
NCR Imaging Suite / User Guide
9. When prompted to commit changes, select YES if you want to save your changes.
The system will save the modified image. This process may take a few minutes or longer depending on your
local hard drive speed.
To recalculate the hash, navigate to the .\ImagingSuite_X.X.X.X\Utilities folder and run the
ImageSigner application.
Browse to the recently mounted image file, and then click the Rehash button.
4. Once mounting is complete, navigate to the mount directory and make any needed changes.
5. When changes are complete, unmount the image using the following command:
6. If you received and error unmounting the image, run the following command:
DISM.exe /Cleanup-Wim
To recalculate the hash, navigate to the .\ImagingSuite_X.X.X.X\Utilities folder and run the
ImageSigner application.
Browse to the recently mounted image file, and then click the Rehash button.
The WinPE boot image file (boot.wim) calls a command file named startnet.cmd that is called when
WinPE starts. This file can be edited to add custom startup actions.
Once boot.wim is mounted, open the mount directory, and navigate to startnet.cmd. It can be found in
.\Windows\System32.
Example customizations
Add lines to map to a network share
wpeinit
@ECHO OFF
set path=%path%;X:\ImagingTools
ImagingClient.exe
@ECHO OFF
set path=%path%;X:\ImagingTools
REM Use a custom menu to launch apps, reboot or shutdown client from within WinPE
:MENU
cls
ECHO.
ECHO ===============================================
ECHO.
ECHO Please select the desired program, or press 5 to EXIT Menu.
ECHO.
ECHO.===============================================
ECHO.
ECHO.
ECHO 1 - Run Ghost32
ECHO 2 - Start Imaging Client
ECHO 3 - Reboot System
ECHO 4 - Shutdown System
ECHO 5 - EXIT
ECHO.
ECHO.
:GHOST
REM Symantec Ghost32.exe can be run from mapped drive.
cd /d H:\YourDirectoryLocation of Ghost32.exe
ghost32.exe
goto MENU
:IMAGINGCLIENT
X:
ImagingClient
goto MENU
:REBOOT
X:
wpeutil reboot
goto MENU
:SHUTDOWN
X:
wpeutil shutdown
goto MENU
:EXIT
break
Once all customizations have been added, save the startnet.cmd file, and close the mount folder.
Using DISM GUI, unmount boot.wim and choose to commit the changes, or from an elevated
Command Prompt, run:
DISM /Unmount-Wim /MountDir:C:\mount /commit
Boot customization is completed. There is no need to recalculate a proprietary hash for the boot WIM.
Note: There is no need to update the Recovery Tool to a later version unless a new feature was added that you
wish to use.
Requirements
USB drive that is 2GB or greater
From Windows
1. Copy the .\ImagingSuite_X.X.X.X\Recovery_Update folder to a USB drive.
2. While running Windows, attach the USB drive to the POS.
3. Launch .\ImagingSuite_X.X.X.X\Recovery_Update\RecoveryUpdate.exe.
4. Select physical disk 0.
5. Browse to .\ImagingSuite_X.X.X.X\Recovery_Update\Legacy\Recovery.wim.
6. Click the Update Recovery button.
7. The Recovery Update operation will begin and will prompt the user when complete.
RadsImageX
Overview
RadsImageX.exe is intended for use by application developers that have historically been using Microsoft’s
ImageX.exe.
RadsImageX was created as a simple, graphical replacement for Microsoft’s ImageX. At the time of initial
development, there were a few applications already using ImageX for image management. The intent for
RadsImageX was to be backward compatible with the existing ImageX command line parameters and the WIMs
already created by these supported applications while still providing the additional image features available in
the full NCR Imaging Suite.
The documentation below references use of ImageX command lines with which RadsImageX is backward
compatible; however, it is highly recommended to use the new, enhanced RadsImageX command line which
provides additional features and will always use the enhanced NCR WIM format.
Capture/Append Operations
RadsImageX Enhanced Command Line
Command Line:
RadsImageX.exe </capture | /append> <disk num> <image filename> <slot name>
[description]
Where:
- <disk num> is the physical disk number whose partitions are to be captured. This number can be seen
from Disk Management or DiskPart.
- <image filename> is the fully qualified path of the WIM file to which to capture/append.
- <slot name> is the name of the slot to which to capture. This can be “Site” or “User”.
Sample usage:
RadsImageX.exe /append 0 F:\backup.wim Site
This operation will capture the contents of physical disk 0 into the “Site” slot of the existing WIM file
F:\backup.wim.
The difference in /capture and /append is that /capture uses the WIM_CREATE_ALWAYS flag instead of the
WIM_OPEN_EXISTING flag. It is important to use the correct flag based on whether the file already exists or
not. If /capture is used on an existing WIM file, its existing contents will be lost. If /append is used on a non-
existent WIM file, the operation will fail because the file does not exist.
Note: RadsImageX will not capture or append to the Factory slot of a WIM file. This is disallowed to prevent
interference with the Factory slot that exists in WIMs directly from NCR manufacturing. Applying from the
Factory slot is, of course, allowed and is described in a later section.
Sample usage:
RadsImageX.exe /append C: F:\backup.wim backup
This operation will append the contents of the C: volume in the WIM file F:\backup.wim and name the image
“backup”.
Note: If capturing to a new WIM file, or appending to a WIM that already contains an image that was captured
using the NCR Imaging Suite (e.g. a WIM that has a manufacturing factory image in it), the <slot name> field is
ignored, and is instead captured into our “User” slot.
Apply Operation
RadsImageX Enhanced Command Line
Where:
- <image filename> is the fully qualified path of the WIM file to apply
- <slot name> is the name of the slot to apply. This can be the following: Site, User or Factory
- <disk num> is the physical disk number to which to apply the image. This number can be seen from
Disk Management or DiskPart.
Sample usage:
RadsImageX.exe /apply F:\backup.wim Factory 0
This operation applies the Factory slot from WIM F:\backup.wim onto disk 0. In the case of a signed WIM, the
Recovery Partition type specified in the metadata of the WIM will be created.
Sample usage:
RadsImageX.exe /apply F:\backup.wim 1 C:
The behavior of this operation will vary depending on whether <image filename> points to a generic WIM or
one that was captured using the NCR Imaging Suite.
If <image filename> refers to a generic WIM captured with ImageX, this operation applies the contents of the
first index contained in F:\backup.wim onto the C: partition.
If <image filename> refers to a WIM created with the NCR Imaging Suite or with RadsImageX using
/capture (instead of /append), multiple, named image slots may be available. Because the original ImageX
command line does not specify this slot name, a priority scheme will determine which slot to apply. From
highest to lowest priority, the first slot that exists in the WIM will be applied: User, Site, Factory.
***Important***
These steps only apply on a terminal that has been reconfigured for UEFI or Secure Boot. NCR Terminals ship
configured in Legacy boot mode.
Once an image is applied, the boot mode on that terminal cannot be changed without reapplying the original
image. Without reimaging, neither the Windows image nor Recovery Tool will boot properly.
Changes to MakeBootablePeDisk
When creating a bootable USB drive for a POS that has been configured for UEFI boot, check the UEFI 64-bit
checkbox above the boot.wim path.
If your POS is configured for Secure Boot, you must temporarily disable Secure Boot to boot to the Imaging Suite
bootable USB drive. All other UEFI and Compatibility Support Mode settings can remain the same. Secure Boot
can be re-enabled after your imaging operation is complete.
To make this easier, two separate configurations of TFTPD32 are included with Imaging Suite.
1. Navigate to .\ImagingSuite_X.X.X.X\PXEBOOT-WINPE\UEFI.
2. Run tftpd32.exe.
3. Change Current Directory to .\ImagingSuite_X.X.X.X\PXEBOOT-WINPE\UEFI