2.3 Setting Up the Preboot Services Methods for ZENworks Imaging

The Novell ZENworks Imaging Engine that performs the actual imaging of a device is a Linux application. Unless you use automated Preboot Services with PXE-enabled devices, you need to prepare a boot medium that has the Linux kernel, ZENworks Imaging Engine, and network drivers installed.

The following sections contain additional information:

2.3.1 Using Preboot Services (PXE)

Preboot Execution Environment (PXE) is an Intel specification that allows a device to boot from the network, instead of its hard drive or other local media. ZENworks can use PXE to launch Preboot Services.

Preboot Services uses PXE to find out if there is imaging work specified for a device and to provide the device with the files necessary to boot to the ZENworks imaging environment.

Before you can use Preboot Services with automated Preboot bundles, you need to do the following:

Install ZENworks on your Imaging Server.
Enable PXE on the device.
Have a standard DHCP server, either on your Imaging Server or on another network server.

Automated Preboot Services functions can also be performed using a ZENworks partition. For more information, see Creating a ZENworks Partition.

Manual Preboot Services functions can be performed using CDs or DVDs. For more information, see Preparing Imaging Boot CDs or DVDs.

2.3.2 Preparing Imaging Boot CDs or DVDs

If you have software for burning CDs or DVDs, you can create an imaging boot CD or DVD for imaging operations.

For information on how to use the CD or DVD to perform disconnected imaging operations, see Setting Up Disconnected Imaging Operations.

Creating a Boot CD or DVD with Additional Files

This section describes how to create an imaging CD or DVD that contains more than the files provided in the bootcd.iso image.

This method allows you to include the settings.txt file on the boot CD or DVD to provide the required imaging parameters. For more information on the settings.txt file, see Imaging Configuration Parameters (settings.txt).

This method also allows you to add other files and drivers that you need to do the imaging.

To create an imaging boot CD or DVD that includes settings.txt and other files:

Copy the bootcd.iso file to a temporary location.

On the Imaging Server where ZENworks is installed, the bootcd.iso file is located in:

Windows: %ZENWORKS_HOME%\bin\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/
In an ISO editor, open the temporary copy of the bootcd.iso file.

If you experience ISO corruption after adding files into the ISO, such as a checksum error, use a more reliable ISO editor. Also, some ISO editors do not work very well with DVDs.
Using the temporary bootcd.iso file, copy the settings.txt file to the root of the bootcd.iso image.

On the Imaging Server where ZENworks is installed, the settings.txt file is located in:

Windows: %ZENWORKS_HOME%\bin\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/
Copy any other files or drivers that you want included on the CD or DVD to the addfiles directory in the temporary bootcd.iso image.

Any files or subdirectories that you add under the /addfiles directory are placed at the root of the client when booting the CD or DVD.

IMPORTANT:When booting from the CD or DVD, the imaging engine is read into RAM. Because the imaging engine uses some of the RAM that exists on the client device, the combined size of any files that you add under the addfiles directory cannot exceed the amount of remaining RAM.
Save the updated bootcd.iso image file to its temporary location.
Use your software for burning CDs or DVDs to burn the updated bootcd.iso image onto the CD or DVD.
Boot the device to be imaged from your newly created imaging boot CD or DVD.

Booting from a SCSI CD-ROM device is currently not supported.

To create an imaging boot CD or DVD by changing the default menu option in the /boot/i386/loader/isolinux.cfg file.

Copy the bootcd.iso file to a temporary location.

On the Imaging Server where ZENworks is installed, the bootcd.iso file is located in:

Windows: %ZENWORKS_HOME%\bin\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/
In an ISO editor, open the temporary copy of the bootcd.iso file.

If you experience ISO corruption after adding files into the ISO, such as a checksum error, use a more reliable ISO editor. Also, some ISO editors do not work very well with DVDs.
In the temporary bootcd.iso file, open the isolinux.cfg file located in the /boot/i386/loader directory.
Edit the isolinux.cfg file to change the following line

default linux

to

default manual
Save the updated bootcd.iso image file to its temporary location.
Use your software for burning CDs or DVDs to burn the updated bootcd.iso image onto the CD or DVD.
Boot the device to be imaged from your newly created imaging boot CD or DVD.

Booting from a SCSI CD-ROM device is currently not supported.

The zmgbootcd imaging utility is a part of the following MSI/RPM files:

https://primary_server_IP_address:port/zenworks-downloads/msi/novell-zenworks-zmgbootcd-xxxxx.msi

https://primary_server_IP_address:port/zenworks-downloads/rpm/novell-zenworks-zmgbootcd-xxxxx.i586.rpm

Alternate procedure for creating a Boot CD or DVD with Additional Files

You can create an Imaging boot CD or DVD by changing the default menu option in the /boot/i386/loader/isolinux.cfg file.

To create a boot CD or DVD:

Unzip the bootcd.zip file to the following locations:

Windows: %ZENWORKS_HOME%\bin\preboot\ . For example, C:\Program Files (x86)\Novell\ZENworks\bin\preboot

Linux: /opt/novell/zenworks/preboot/bin/winutils/
Take backup of the settings.txt and other files.
Modify the settings.txt or add files to bootcd. The settings.txt is located at files/settings.txt. Insert other files or copy the files to the files/addfiles folder.
Create a new bootcd.zip file from modified folder files.

Windows: Use any Windows tool to create bootcd.zip file

Linux: #zip bootcd.zip -r files

#chown zenworks:zenworks bootcd.zip
Delete the extracted files directory.
To create bootcd_tntfs.iso:

For Windows:
1. Open the command prompt as an administrator.
2. Type the cd C:\Program Files (x86)\Novell\ZENworks\bin\preboot command.
3. Execute the bootcd-editor.bat script with the required parameter.
  
  bootcd-editor.bat <path to Tuxera driver folder> <output directory>
  
  For example, C:\Program Files (x86)\Novell\ZENworks\bin\preboot>bootcd-editor.bat "C:\Program Files (x86)\Novell\ZENworks\share\tftp\11.3”
  
  You can see the following message on the console:
```
C:\Program Files (x86)\Novell\ZENworks\bin\prebootprocessing....... Done.. Injected bootcd => C:\\bootcd_tntfs.iso 
Bootcd iso file is created at the output directory as bootcd_tntfs.iso
```
For Linux:
1. Execute the bootcd-editor.sh script with the required parameter for creating the bootcd.
  
  bootcd-editor.sh <path to tuxera driver folder> <output directory>
  
  For example, ./bootcd-editor.sh /srv/tftp/11.3/ / tmp
  
  The Bootcd ISO file is created at the output directory as bootcd_tntfs.iso.
  
  NOTE:The bootcd_tntfs.iso file creation fails on RHEL Servers having the tntfs.zip file. For more information, see ZENworks 11 SP4 Readme.

Creating a Boot CD or DVD without Additional Files

If you do not want to include the settings.txt file or any other files or drivers in the imaging boot CD or DVD, you can simply create the imaging boot CD or DVD from the bootcd.iso image provided with ZENworks.

However, you need to provide the settings.txt file on a floppy diskette to provide the required imaging parameters. For more information on the settings.txt file, see Imaging Configuration Parameters (settings.txt).

To create an imaging boot CD or DVD that contains only the bootcd.iso image:

Copy the settings.txt file containing the settings you want for the imaging boot process onto a floppy diskette.

On the Imaging Server where ZENworks is installed, the settings.txt file is located in:

Windows: %ZENWORKS_HOME%\bin\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/
Use your software for burning CDs or DVDs to burn the bootcd.iso image onto the CD or DVD.

On the Imaging Server where ZENworks is installed, the bootcd.iso file is located in:

Windows: %ZENWORKS_HOME%\bin\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/
Boot the device to be imaged from your newly created imaging boot CD or DVD.

You will be prompted for the diskette that contains the settings.txt file.

Booting from a SCSI CD-ROM device is currently not supported.

Modifying Kernel Boot Parameters for ZENworks Imaging

Modify the Boot parameters using any of the following options:

Adding the boot parameter using the imaging bootcd

Add a boot parameter of your choice while selecting the boot mode (Automatic or Manual) from the ZENworks Preboot Options screen.

Adding the boot parameter using PXE Options

Go to Configuration>Device Management>Preboot Services>PXE > Options.
In the PXE Kernel Boot Parameters field add the boot parameter.

Adding the boot parameters in the respective configuration files

This procedure should be followed to set the vga= parameter in place of the vga=0x314 parameter which is set by default.The configuration files end with extension *.cfg (for BIOS) or *.conf (for UEFI) For example, z_auto.cfg, and z_maint.conf. The path to configuration files in the server is as follows:

BIOS: $TFTP_ROOT/
UEFI: $TFTP_ROOT/efi/x86_64/

Creating a Tuxera Boot CD

Tuxera Boot CD, or the bootcd_tntfs.iso file is generated whenever you import the Tuxera driver. You can create a Tuxera bootcd ISO file from the bootcd-editor script.

On the ZENworks server, browse to the winutils folder.
Run the following command to create the bootcd_tntfs.iso file:

Windows: bootcd-editor.bat <location of the downloaded tuxera driver folder> <destination to the save the ISO file>

Linux: ./bootcd-editor.sh <location of the downloaded tuxera driver folder> <destination to the save the ISO file>

2.3.3 Creating USB Drives for Imaging

You can create a bootable USB flash drive for booting either BIOS or UEFI firmware to perform Imaging operations.

Boot a system by using the Imaging boot CD.
At the # prompt, run the ZENUsbcreator command. You can see three menu options as follows:
Use the following options to create a USB drive to boot systems:

To boot systems with BIOS firmware: Enter 1.

To boot systems with UEFI firmware: Enter 2.

To format all partitions on USB drive: Enter .

You can see a list of detected USB drives. In the following example, there are two detected USB devices. Enter 1 to select a Transcend device and enter 2 to select a SanDisk.
```
Detected USB device(s):
***********************************************************************

              Device    Vendor    Model          Size(Bytes)
            1. /dev/sdb JetFlash Transcend_16GB   1621937356bB
            2. /dev/sdc SanDisk  CruzerBlade_16GB 1621937356bB

***********************************************************************
```
Select Yes or No, when you are prompted to continue or exit. The selected device will be formatted and partitioned.

The command execution completes processing the USB drive with 160 MB boot partition and the rest of the disk space can be used for second partition to store images or data.

2.3.4 Configuring with ZENworks Imaging Media Creator

This utility allows you to create a bootable diskette for Preboot Services imaging functions in ZENworks. For example, you can do the following:

Modify the settings.txt file
Create a bootable diskette to enable booting a device from a CD or DVD when it normally cannot do so
Create a Preboot Bootable Image (PBI) file from a bootable diskette

IMPORTANT:This utility is a .NET application, and therefore requires the .NET framework to be installed on the Windows device being used to run it.

For more information, see:

ZENworks Imaging Media Creator Features

The ZENworks Imaging Media Creator utility dialog box contains two tabs:

CD Media Boot

The CD Media Boot tab allows you to make an image of a bootable diskette suitable for use with PXE devices. You can:

Create a bootable diskette to enable booting devices with a CD or DVD (when they normally can’t do so) to perform imaging tasks
Specify configuration settings that are saved in the settings.txt file on the bootable diskette, which are used when you boot devices with the diskette
Modify the configuration settings after creating the bootable diskette by editing the settings.txt file contained on the diskette

For more information, see Creating a Bootable Diskette.

Preboot Bootable Image

You can create a PXE Linux configuration file that points to a Preboot Bootable Image (PBI) file, which is a raw image of a bootable diskette. This enables you to use PXE to utilize the bootable diskette information from a .pbi file on a TFTP server, instead of booting from the diskette for that Preboot information.

For more information, see Creating a Preboot Bootable Image.

Managing the Settings.txt File

There two settings.txt files shipped with ZENworks:

Windows: %ZENWORKS_HOME%\share\tftp\boot\

Linux: /srv/tftp/boot/

PXE devices use this version of the file for automated preboot work. This file exists on the Imaging Server and usually does not need to be modified. During the boot process, this settings.txt file is read and the necessary settings information is discovered and used.
Windows: %ZENWORKS_HOME%\bin\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/

The Imaging Server copy of this file needs to be modified for your network environment and a working copy of it should be maintained at the root of the imaging boot device (imaging CD or DVD, or a blank floppy diskette). When burning the imaging CD or DVD, be sure to include the edited copy of this settings.txt file.

You can manage the content of this copy of the settings.txt file with the ZENworks Imaging Media Creator utility, as outlined in the following steps.

To edit the settings.txt file, see Imaging Configuration Parameters (settings.txt).

For more information, see Imaging Configuration Parameters (settings.txt).

To manage the settings.txt file using the ZENworks Imaging Media Creator utility:

On a management device, run zmediacreator.exe from your Imaging Server:

Windows: %ZENWORKS_HOME%\bin\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/

For the Linux server path, to use a Windows management device to access to this directory you might need to configure Samba.

The following dialog box is displayed:
Click Load, browse for and select the settings.txt file, then click Open.

The default location is A:\. Browse to the following directory for the copy to be modified:

Windows: %ZENWORKS_HOME%\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/

When the file is loaded, the fields in this dialog box are populated from the information contained in the settings.txt file.
(Optional) In the Settings.txt Options section on the CD Media Boot tab, fill in the fields:

Prompt for Configuration When Booting from Diskette: Specifies whether to prompt for these configuration settings when you boot a device with the bootable diskette and CD or DVD. If you leave this option deselected, the device boots using the configuration settings that you make here and you are not able to override the settings during bootup. If you select this option, you are given the chance to change each setting during bootup.

Reboot : Specifies whether you must reboot a device after it was booted with the bootable diskette in automatic mode. (If the device was booted with the bootable diskette in manual mode, you must always reboot the device .)

If you boot a device with the bootable diskette and you let the bootup process proceed in automatic mode, the imaging engine starts and checks the Preboot server to see if an automatic imaging operation should be performed. If so, it performs the imaging operation on the device and quits. If not, it quits without doing anything. What happens next depends on whether you select this option.

If you leave this option deselected, you are prompted to remove the bootable diskette and press any key to reboot the device automatically to its native operating system. If you select this option, the device doesn’t reboot automatically, but instead displays the imaging maintenance mode prompt, allowing you to perform additional imaging-related tasks at the prompt. This is helpful if you want to do things like check the current partition information or the image-safe data before rebooting to the native operating system.

ZENworks Partition Size (MB): Specifies the number of megabytes to allocate to the ZENworks partition if you choose to create one locally on a device when you boot the device with the bootable diskette. The default size is 150 MB, which is the smallest you should make the partition. The maximum size allowed is 2048 MB (2 GB).
(Optional) In the Workstation IP Settings section on the CD Media Boot tab, fill in the fields:

Use DHCP: Specifies to obtain an IP address dynamically through DHCP. Use this option only if DHCP is configured on your network.

Use the Following Static Address Information: Specifies to use a static IP address. If you select this option, fill in the IP address, subnet mask, and gateway to be used.

DNS Button: This option is active only if a static IP address for the device is specified.
- DNS Nameserver: You must specify a nameserver if you want to use DNS to connect to servers.
  
  You can specify the addresses of as many DNS nameservers as you want. You can edit or remove the nameserver addresses, or you can move the addresses up and down in the list to specify the order used for contacting them.
- Domain Suffix: You can also specify as many DNS domain suffixes as you want. The editing, moving, and removal functions are also available for the suffixes.
(Required) In the Imaging Proxy Server Address section on the CD Media Boot tab, specify either the fixed IP address or the full DNS name of Preboot server (where novell-pbserv is running).

This specifies which Preboot server to connect to when you boot a device with the bootable diskette.

Use a DNS name only if it is working on your network and the Imaging Server has an entry in your DNS server’s name resolution table.
Click Save, browse for where you want to save the settings.txt file, then click Save.

Saves the configurations made in the Settings.txt Options section to the settings.txt file in the specified location. The default location is A:\, such as for a bootable diskette (see Creating a Bootable Diskette).

You can save to a different location for use in burning to an imaging CD or DVD.
When you are finished using this utility, click Close.

IMPORTANT:If you edit the settings.txt file to provide paths to executables, make sure that you provide the full path, or the executable might not run.

Creating a Bootable Diskette

If you have devices that cannot normally boot a CD or DVD, but has the CD or DVD hardware installed, you can use the ZENworks Imaging Media Creator utility to create a diskette that enables the device to boot from a CD or DVD.

To create a bootable diskette:

On a management device, run zmediacreator.exe from your Imaging Server:

Windows: %ZENWORKS_HOME%\bin\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/

For the Linux server path, to use a Windows management device to access to this directory you might need to configure Samba.

The following dialog box is displayed:
If you want to modify a settings.txt file that is to be included on this diskette, follow Step 2 through Step 4 in Managing the Settings.txt File, then continue with Step 3 in this section.
(Required) In the Imaging Proxy Server Address section on the CD Media Boot tab, specify either the fixed IP address or the full DNS name of Preboot server (where novell-pbserv is running).

This specifies which Preboot server to connect to when you boot a device with the bootable diskette.

Use a DNS name only if it is working on your network and the Imaging Server has an entry in your DNS server’s name resolution table.
Format one high-density diskette, or insert a preformatted blank diskette in the diskette drive of the Windows device.
Click Create CD Boot Disk.

This creates a bootable diskette that enables a device that cannot otherwise boot from a CD or DVD to boot from the imaging CD or DVD. Any settings.txt configurations made here are included in the copy written to the bootable diskette.
After the diskette is created, click Close.
Insert both this diskette and the imaging CD or DVD on the device to be imaged, then boot the device.

The diskette enables the imaging CD or DVD to be booted by the device.

Creating a Preboot Bootable Image

To create a PBI configuration file and then the PBI file:

On a management device, run zmediacreator.exe from your Imaging Server:

Windows: %ZENWORKS_HOME%\bin\preboot\

Linux: /opt/novell/zenworks/preboot/bin/winutils/

For the Linux server path, to use a Windows management device to access to this directory you might need to configure Samba.

The following dialog box is displayed after you click the Preboot Bootable Image tab:
In the Configuration File Settings section on the Preboot Bootable Image page, fill in the fields:

Kernel Parameters: To use the kernel parameters in the keeppxe option, select the Keep PXE and UNDI Stacks in Memory option.

PBI Filename: Specify a filename for the PBI file, including the .pbi filename extension. Do not specify a path here.

TFTP Relative Path: Specify the path for the PBI file, relative to the TFTP server’s default path. This is where the PBI file will be accessed by the device booting with PXE.

Load: Load a previously defined PBI configuration file, which populates the fields on this page with its information. You can edit those settings.

Save: Save the PBI configuration file to a location where you can access it again from this dialog box.
To create the PBI file, click Create PBI and fill in the fields:

Source Path: Source of the information to be imaged to a PBI file. This is normally a bootable diskette that was created on the CD Media Boot tab of this dialog box.

Destination File: Where the PBI file should be written. Browse for the location and type the PBI filename. The .pbi filename extension is automatically added.
After the PBI is created, click Close.

This PBI file can now be used by a PXE-enabled device when booting so you can access Preboot Services functionality as if you were booting the device with the bootable diskette.

2.3.5 Managing ZENworks Partitions

A ZENworks partition is used by a device when booting for automated Preboot Services work when the device does not have PXE available. The following sections explain how to manage ZENworks partitions:

Creating a ZENworks Partition

If you want to set up a device for unattended imaging operations and are unable to use Preboot Services (PXE), you can create a ZENworks partition on the hard disk. If you make the partition large enough, you can even store an image of the device’s hard disk, which can be useful if the device becomes misconfigured or corrupted when the network connection is lost.

WARNING:Installing the ZENworks partition destroys all data on that hard drive. Use this only on devices where you plan to reinstall the operating system and software programs.

To create a ZENworks partition, you must first create an imaging CD or DVD to boot the device from. (If the device cannot boot from a CD or DVD, see Configuring with ZENworks Imaging Media Creator.) Then, do the following:

Boot the device with the imaging CD or DVD, then select Install/Update ZEN partition from the menu.

This starts the process of creating the ZENworks partition in the first partition slot. It destroys all existing partitions, except an existing ZENworks partition or the Dell or Compaq configuration partitions. By default, the ZENworks partition size is 150 MB.

If the ZENworks partition already exists, it is upgraded, and your existing partitions are left intact.

NOTE:You can also update an existing ZENworks partition by running the following commands:

#img -a

#. /bin/update.s

#. /bin/grub.s

#reboot
After the ZENworks partition is installed or updated, remove the CD or DVD and press any key to continue.
After removing the CD or DVD and reboot the device, install the operating system on the device.

IMPORTANT:During installation of the operating system, you must install the boot loader where the root (/) partition is being installed. In other words, the active partition must be the root partition. You can use fdisk to verify that the active partition is root.
To take an image of the device using the ZENworks partition, see Using the Imaging Maintenance Mode Prompt to Create an Image.
When the imaging maintenance mode prompt is displayed, reboot the device.

The device should boot to Linux.

Disabling a ZENworks Partition

If you decide to enable PXE on a device, but have previously installed a ZENworks partition on it, you can disable or delete the partition, because it is no longer necessary. For information on deleting the partition, see Removing a ZENworks Partition.

When you boot to Linux using any imaging boot device or method other than booting from the ZENworks partition, you can disable (or enable) the ZENworks partition. Just select the menu option to do so when the Novell Preboot Services Menu is presented.

Removing a ZENworks Partition

Because you should not delete the ZENworks partition if you booted using the partition, you should boot the device from an imaging boot method other than the ZENworks partition.

WARNING:After you have deleted the ZENworks partition, you need to make sure that the image you place on the device was made on a device without a ZENworks partition. Otherwise, the wrong MBR (Master Boot Record) is restored, and the device fails to boot. You should only remove the ZENworks partition if you are going to restore an image that does not have the partition to the device.

The following are ways you can remove a ZENworks partition from a device:

Using an Imaging CD or DVD

If you cannot perform a full restoration of the ZENworks partition at this time, you should consider removing it.

To remove a ZENworks partition:

Boot the device using the ZENworks imaging CD or DVD.
Select the Manual mode option.
At the imaging maintenance mode prompt, enter:
```
img -zenpart -remove
```
After the removal is complete, eject the CD or DVD (if you are not going to use it to reimage the device).
If you want to restore an image before rebooting, enter the following at the prompt:
```
unset ZENDEVICE
```
Otherwise, reboot the device when ready.
Restore an image or install an operating system.

When the device boots, its ZENworks partition is removed, then the device can be imaged from the CD or DVD without a ZENworks partition.

If the device is assigned to a Preboot bundle, it is imaged according to that bundle.

Using an Imaging Script Bundle

If you are using Preboot Services, but formerly booted from the ZENworks partition on the device, you can delete the ZENworks partition at the same time you restore an image. However, the new image should not contain a ZENworks partition.

For example, you can do the following:

In ZENworks Control Center, create a Imaging Script bundle.
In the Script text field in the Create New Bundle Wizard, enter:
```
img -zenpart -remove
```
In the Script text field (after the above command), enter the other commands necessary for the imaging work you want for the device.

For more information, see Section E.0, ZENworks Imaging Engine Commands.
On the Summary page of the wizard, click Finish (not Next).
Reboot the device.

Using Fdisk

You can remove a ZENworks partition by simply using fdisk to reconfigure the device’s hard drive. Then, you can either image the device using a ZENworks imaging CD or DVD, or enable PXE on the device and assign a Preboot bundle to it, then reboot it to use that bundle.