Imaging Engine (img Command)

Purpose

Use this command at the Linux prompt after booting a computer from an imaging device to do any of the following:

Take an image of the computer's hard disks
Lay down an image on the computer's hard disks
View or manipulate the computer's hard disk partitions
View the computer's hardware configuration or image-safe data

Location

The imaging engine is installed to the bin folder on the imaging boot device. If the imaging boot device is dikettes or a CD, the bin folder is actually archived in the root.tgz file, which gets expanded during the imaging bootup process.

Format and Function

Because the imaging engine is a Linux application, the command syntax is case-sensitive. The overall syntax is:

img [mode]

where mode is any of the modes described in the sections below.

HINT: Each mode can be abbreviated to the first letter of its name. For example, img dump can be abbreviated img d.

Help Mode

Purpose

This is the default mode if you type the img command with no parameters. Use it to get help with the syntax of the img command if you don't have this documentation available.

Format and Function

img [h [mode]]

where mode is the mode whose command syntax you want help with.

Examples

`img`	Displays a short description of each mode.
`img h m`	Displays information on how to use the make mode.
`img h p`	Displays information on how to use the partition mode.

Auto Mode

Purpose

Use this mode to image the computer automatically, based on any applicable NDS policies and settings. The imaging engine runs in this mode if you let the imaging bootup process proceed without interruption, or if you type the command below at the Linux prompt.

Format and Function

img a

In this mode, the imaging engine queries the imaging server specified in the PROXYADDR environment variable for any work to do. The imaging server checks the relevant NDS policies and settings to determine what imaging tasks should be performed (if any), such as taking or laying down an image. It then instructs the imaging engine to perform those tasks. If any tasks involve storing or retrieving images on other imaging servers, the imaging server refers the imaging engine to those servers to complete those tasks. After the imaging engine has completed its work, it communicates the results to the original imaging server, and the results are logged on that server.

For information on configuring the NDS policies and settings that control what happens in this mode, see Setting Up Imaging Services in Workstation Imaging in Deployment.

Make Mode

Purpose

Use this mode to take an image of the computer and store it in a specified location. Normally, all partitions on hard disks and other storage devices (such as Jaz drives) are included in the image, but there are some exceptions noted below.

The image size will correspond roughly to the size of the data in the Windows partitions plus the entire size of any non-Windows partitions (such as NetWare partitions). Linux partitions and Compaq configuration partitions are always excluded. The data from Windows partitions is stored in an intelligent, file-by-file format so you can customize it later using the Image Explorer (IMGEXP.EXE) utility. Non-Windows partitions are stored in a raw, bit-by-bit format that cannot be customized.

Format and Function

The syntax of this mode depends on whether you will store the image locally or on an imaging (proxy) server, as explained in the subsections below:

Make Locally

Purpose

Use this make mode to take an image of the computer and store it in a partition on a local (writeable) device, such as a hard disk or Jaz drive. For the basic procedure to use this mode, see Setting Up Disconnected Imaging Operations in Setting Up Imaging Services in Workstation Imaging in Deployment.

Format and Function

img ml[partition] filepath [xpartition]

Parameter Specifies

Parameter	Specifies
ml[partition]	The partition number (as displayed by `img dump`) of the local partition to store the image in. It must be a primary FAT16 or FAT32 partition. This partition is excluded from the image that's created. If you omit the partition number from this parameter, the image is stored in the local ZfD imaging (Linux) partition.
filepath	The image filename, including a .zmg extension and the complete path from the root of the partition. The directories in the path must exist. If the file already exists, it will be overwritten.
xpartition	The partition number (as displayed by `img dump`) of a local partition to exclude from the image. You can repeat this parameter as needed to exclude multiple partitions. If you omit this parameter, all partitions are included in the image except the one where the image will be stored.

ml[partition]

The partition number (as displayed by img dump) of the local partition to store the image in. It must be a primary FAT16 or FAT32 partition. This partition is excluded from the image that's created.

If you omit the partition number from this parameter, the image is stored in the local ZfD imaging (Linux) partition.

filepath

The image filename, including a .zmg extension and the complete path from the root of the partition. The directories in the path must exist. If the file already exists, it will be overwritten.

xpartition

The partition number (as displayed by img dump) of a local partition to exclude from the image. You can repeat this parameter as needed to exclude multiple partitions.

If you omit this parameter, all partitions are included in the image except the one where the image will be stored.

Examples

`img ml8 /imgs/dellnt.zmg`	Takes an image of all partitions except the one in slot 8 and saves the image to imgs/dellnt.zmg in the partition in slot 8. (Assumes slot 8 contains a primary FAT16 or FAT32 partition.)
`img ml /imgs/dellnt.zmg`	Takes an image of all partitions and saves it to imgs/dellnt.zmg in the ZfD imaging (Linux) partition. (Assumes the ZfD partition has been installed.)
`img ml /imgs/dellnt.zmg x2 x3`	Takes an image of all partitions except those in slots 2 and 3 and saves the image to imgs/dellnt.zmg in the ZfD imaging (Linux) partition. (Assumes the ZfD partition has been installed.)

Make on Proxy

Purpose

Use this make mode to take an image of the computer and store it on an imaging (proxy) server. For the basic procedure to use this mode, see Taking an Image of a Workstation Manually in Testing Basic Imaging Operations in Workstation Imaging in Getting Started.

Format and Function

img mp IPaddress filepath [xpartition]

Parameter Specifies

Parameter	Specifies
IPaddress	The IP address or DNS name of the imaging server to store the image on.
filepath	The image filename, including a .zmg extension and the complete path in UNC style. The directories in the path must exist. If the file already exists, the imaging server won't overwrite it unless you enable this behavior in the imaging server's policy in NDS. If no folders are specified in the path, the image is created at the root of the volume or drive where the ZfD imaging server software is installed. IMPORTANT: Because Linux doesn't recognize backslashes, you must use forward slashes in the UNC path or enclose the entire path in quotes.
xpartition	The partition number (as displayed by `img dump`) of a local partition to exclude from the image. You can repeat this parameter as needed to exclude multiple partitions. If you omit this parameter, all partitions are included in the image.

IPaddress

The IP address or DNS name of the imaging server to store the image on.

filepath

The image filename, including a .zmg extension and the complete path in UNC style. The directories in the path must exist. If the file already exists, the imaging server won't overwrite it unless you enable this behavior in the imaging server's policy in NDS. If no folders are specified in the path, the image is created at the root of the volume or drive where the ZfD imaging server software is installed.

IMPORTANT: Because Linux doesn't recognize backslashes, you must use forward slashes in the UNC path or enclose the entire path in quotes.

xpartition

The partition number (as displayed by img dump) of a local partition to exclude from the image. You can repeat this parameter as needed to exclude multiple partitions.

If you omit this parameter, all partitions are included in the image.

Examples

`img mp 137.65.95.127 //xyz_server/sys/imgs/dellnt.zmg`	Takes an image of all partitions and saves it to sys/imgs/dellnt.zmg on xyz_server. (Assumes 137.65.95.127 is the IP address of xyz_server.)
`img mp img.xyz.com //xyz_server/sys/imgs/dellnt.zmg x2 x3`	Takes an image of all partitions except those in slots 2 and 3 and saves the image to sys/imgs/dellnt.zmg on xyz_server. (Assumes img.xyz.com is the DNS name of xyz_server.)

Restore Mode

Purpose

Use this mode to retrieve an image from a specified location and lay it down on the computer.

Normally, if the image to be laid down is a base image (one created previously by the imaging engine), all existing partitions except Linux and Compaq configuration partitions are removed from all local writeable devices (such as hard disks and Jaz drives) before the new image is laid down. When the image is laid down, the sizes of the original partitions from which the image was taken are preserved if possible. If there's insufficient space, the last partition is shrunk to fit unless this would result in data loss, in which case the imaging engine denies the requested operation. If there's extra space left after all partitions in the image have been restored to their original sizes, that space is left unpartitioned.

If the image to be laid down is an add-on image (one produced from an Application object or created by the Image Explorer (IMGEXP.EXE) utility), or if it's a base image and you specify a certain parameter described below, none of the existing physical partitions are removed. Instead, the appropriate partitions are merely updated with the files from the image. The update process does not remove any existing files or overwrite any existing files of the same names if they are newer.

Format and Function

The syntax of this mode depends on whether you will retrieve the image from a local device or from an imaging (proxy) server, as explained in the subsections below:

Restore from Local

Purpose

Use this restore mode to retrieve an image from a local device and lay it down on the computer. For the basic procedure to use this mode, see Setting Up Disconnected Imaging Operations in Setting Up Imaging Services in Workstation Imaging in Deployment.

Format and Function

img rl[partition] filepath [sfileset] [apartition:ppartition]

Parameter	Specifies
rl[partition]	The partition number (as displayed by `img dump`) of the local partition to retrieve the image from. It must be a primary FAT16 or FAT32 partition. This partition will not be changed by the imaging operation. If you omit the partition number from this parameter, the image is retrieved from the local ZfD imaging (Linux) partition.
filepath	The filename of the image to retrieve, including the .zmg extension and the complete path from the root of the partition.
sfileset	The number of the image fileset (variant) to lay down. Valid values are 1 through 10. For information on creating variants of an image, see Preparing Images. If you omit this parameter, fileset 1 is used.
apartition:ppartition	A mapping between a partition in the image archive (apartition) and a target physical partition on the local machine (ppartition). Use this parameter to selectively restore a specific part of the image to a specific local partition. IMPORTANT: If you use this parameter, none of the existing local partitions are removed, and only the target local partition is updated. The update process does not remove any existing files or overwrite any existing files of the same names if they are newer. If you want to remove all existing files from the target partition before updating it, first use `img pd` and `img pc` to delete and recreate the partition. For apartition, use the partition number displayed for the source partition in the Image Explorer (IMGEXP.EXE) utility. For ppartition, use the partition number displayed by `img dump` for the target partition. The target partition must be a Windows partition. You can repeat this parameter as needed to request multiple selective restorations in a single operation. In doing so, you can apply multiple parts of the image to a single local partition, but you can't apply the same part of an image to multiple local partitions in a single operation.

Examples

`img rl8 /imgs/dellnt.zmg`	Removes all existing local partitions except the one in slot 8, retrieves the image from imgs/dellnt.zmg in slot 8, and lays down the partitions and contents of that image on the available local writeable devices. (Assumes there's sufficient local space and that slot 8 contains a primary FAT16 or FAT32 partition.)
`img rl /imgs/dellnt.zmg`	Removes all existing local partitions, retrieves the image from imgs/dellnt.zmg in the ZfD imaging (Linux) partition, and lays down the partitions and contents of that image on the available local writeable devices (assuming there's sufficient space).
`img rl /imgs/dellnt.zmg s2`	Removes all existing local partitions, retrieves the image from imgs/dellnt.zmg in the ZfD imaging (Linux) partition, and lays down the partitions and contents of variant 2 of that image on the available local writeable devices (assuming there's sufficient space).
`img rl /imgs/dellnt.zmg a2:p1 a3:p1`	Retrieves the image from imgs/dellnt.zmg in the ZfD imaging (Linux) partition, updates local partition 1 with the data from partitions 2 and 3 of that image, and leaves the other local partitions unchanged. (Assumes there's sufficient space in local partition 1.)

Restore from Proxy

Purpose

Use this restore mode to retrieve an image from an imaging (proxy) server and lay it down on the computer. For the basic procedure to use this mode, see Putting an Image on a Workstation Manually in Testing Basic Imaging Operations in Workstation Imaging in Getting Started.

Format and Function

img rp IPaddress filepath [sfileset] [apartition:ppartition]

Parameter	Specifies
IPaddress	The IP address or DNS name of the imaging server to retrieve the image from.
filepath	The filename of the image to retrieve, including the .zmg extension and the complete path in UNC style. IMPORTANT: Because Linux doesn't recognize backslashes, you must use forward slashes in the UNC path or enclose the entire path in quotes.
sfileset	The number of the image fileset (variant) to lay down. Valid values are 1 through 10. For information on creating variants of an image, see Preparing Images. If you omit this parameter, fileset 1 is used.
apartition:ppartition	A mapping between a partition in the image archive (apartition) and a target physical partition on the local machine (ppartition). Use this parameter to selectively restore a specific part of the image to a specific local partition. IMPORTANT: If you use this parameter, none of the existing local partitions are removed, and only the target local partition is updated. The update process does not remove any existing files or overwrite any existing files of the same names if they are newer. If you want to remove all existing files from the target partition before updating it, first use the Partition Mode to delete and recreate the partition. For apartition, use the partition number displayed for the source partition in the Image Explorer (IMGEXP.EXE) utility. For ppartition, use the partition number displayed by `img dump` for the target partition. The target partition must be a Windows partition. You can repeat this parameter as needed to request multiple selective restorations in a single operation. In doing so, you can apply multiple parts of the image to a single local partition, but you can't apply the same part of an image to multiple local partitions in a single operation.

Examples

`img rp 137.65.95.127 //xyz_server/sys/imgs/dellnt.zmg`	Removes all existing local partitions, retrieves the image from sys/imgs/dellnt.zmg on xyz_server, and lays down the partitions and contents of that image on the available local writeable devices. (Assumes there's sufficient local space and that 137.65.95.127 is the IP address of xyz_server.)
`img rp img.xyz.com //xyz_server/sys/imgs/dellnt.zmg s2`	Removes all existing local partitions, retrieves the image from sys/imgs/dellnt.zmg on xyz_server, and lays down the partitions and contents of variant 2 of that image on the available local writeable devices. (Assumes there's sufficient local space and that img.xyz.com is the DNS name of xyz_server.)
`img rp img.xyz.com //xyz_server/sys/imgs/dellnt.zmg a2:p1`	Retrieves the image from sys/imgs/dellnt.zmg on xyz_server, updates local partition 1 with the data from partition 2 of that image, and leaves the other local partitions unchanged. (Assumes there's sufficient space in local partition 1 and that img.xyz.com is the DNS name of xyz_server.)

Dump Mode

Purpose

Use this mode to view information about the storage devices and partitions on the computer.

Format and Function

img d[g]

Parameter	Specifies to
d	List the existing partitions on all local writeable devices, such as hard disks and Jaz drives. For each partition, the type, size, and slot number of the partition are given. NOTE: Linux and Compaq configuration partitions are not listed.
g	Display additional information about the geometry (cylinders, heads, and sectors) and capacity of each storage device, including read-only devices such as CD drives.

Parameter

Specifies to

List the existing partitions on all local writeable devices, such as hard disks and Jaz drives. For each partition, the type, size, and slot number of the partition are given.

NOTE: Linux and Compaq configuration partitions are not listed.

Display additional information about the geometry (cylinders, heads, and sectors) and capacity of each storage device, including read-only devices such as CD drives.

Examples

`img d`	Lists the current partitions on all local writeable devices.
`img dg`	Lists all storage devices, their geometry and capacity, and the current partitions on the writeable devices.

Partition Mode

Purpose

Use this mode to create, delete, or activate (make bootable) a partition on the computer.

Format and Function

img poperation

where operation is one of the following:

Operation Specifies to

Operation	Specifies to
cpartition type [size] [cclustersize]	Create a new partition, where: partition is the number of the partition slot (as displayed by `img d`) to create the partition in type is FAT12, FAT16, FAT32, NTFS, or Extended size is a valid size for the partition type in MB If you omit this parameter, the largest valid size for the partition type is used, given the available unpartitioned space on the drive. clustersize is the cluster size for an NTFS partition Don't use this parameter unless you have a specific reason to do so. It must be a power of 2 (2, 4, 8, 16, ...128). If you omit this parameter, the imaging engine uses a reasonable cluster size for the NTFS partition size. The new partition is also formatted enough to be recognizable by other operating systems, but you must put a base image in the partition before Windows can store any files in it.
dpartition	Delete the partition from slot number partition. Use `img d` to get the slot number.
apartition	Activate (make bootable) the partition in slot number partition. Use `img d` to get the slot number.

cpartition type [size] [cclustersize]

Create a new partition, where:

partition is the number of the partition slot (as displayed by img d) to create the partition in
type is FAT12, FAT16, FAT32, NTFS, or Extended
size is a valid size for the partition type in MB
If you omit this parameter, the largest valid size for the partition type is used, given the available unpartitioned space on the drive.
clustersize is the cluster size for an NTFS partition
Don't use this parameter unless you have a specific reason to do so. It must be a power of 2 (2, 4, 8, 16, ...128). If you omit this parameter, the imaging engine uses a reasonable cluster size for the NTFS partition size.

The new partition is also formatted enough to be recognizable by other operating systems, but you must put a base image in the partition before Windows can store any files in it.

dpartition

Delete the partition from slot number partition. Use img d to get the slot number.

apartition

Activate (make bootable) the partition in slot number partition. Use img d to get the slot number.

Examples

`img pc1 fat16`	Creates a FAT16 partition in slot 1 using all the available unpartitioned space on the drive.
`img pc5 fat32 5671`	Creates a FAT32 partition in slot 5 using 5,671 MB on the drive.
`img pd3`	Deletes the partition from slot 3.
`img pa5`	Activates (makes bootable) the partition in slot 5. (Assumes a partition exists in that slot.)

Information Mode

Purpose

Use this mode to view the following:

Information about the hardware devices on the computer
This information is detected during the imaging bootup process. If the imaging engine runs in auto-imaging mode, this information is sent to the imaging server to help determine which image to put on the computer, if necessary.
The data currently stored in the image-safe area on the computer
This data is saved off by the imaging agent during each Windows session to ensure that it can be restored after the computer is reimaged. If the computer is brand new and doesn't have Windows yet, an initial set of data is supplied from an NDS policy via the imaging server to the imaging engine when the first base Windows image is laid down.
Name of the base image that was last laid down on the computer

Format and Function

img i [z]

Parameter	Specifies to
i	List the detected hardware devices on the computer, including: CPU chipset Video adapter Network adapter MAC address Sound card Hard drive controller Hard disk capacity RAM
z	List the data currently stored in the image-safe area on the computer. The items that comprise this data are listed in Imaging Agent (ZISWIN.EXE). In addition to the image-safe data, the last base image that was laid down on the computer is also listed.

Parameter

Specifies to

List the detected hardware devices on the computer, including:

CPU chipset
Video adapter
Network adapter
MAC address
Sound card
Hard drive controller
Hard disk capacity
RAM

List the data currently stored in the image-safe area on the computer. The items that comprise this data are listed in Imaging Agent (ZISWIN.EXE).

In addition to the image-safe data, the last base image that was laid down on the computer is also listed.

Examples

`img i`	Lists the detected hardware devices on the computer.
`img i z`	Lists the ZfD image-safe data currently stored on the computer and the last base image that was laid down.

Session (Multicast) Mode

Purpose

Use this mode to take an image of one computer and lay it down on multiple other computers simultaneously over the network in a single operation without NDS or ZfD server involvement. For the basic procedure to use this mode, see Multicasting Images.

For multicasting to work, each participating computer must boot from an imaging device and run the imaging engine in this mode, as explained below. The computer from which the image is taken is called the master, and the computers that receive the image are called slaves.

NOTE: For multicasting to work properly, the routers and switches on the network must have multicast features configured. Otherwise, multicast packets might not be routed properly.

Format and Function

img s name [m] [c=count [t=seconds]]

Parameter	Specifies
name	The name of the multicast session. Each computer joining the session uses the same value for this parameter. NOTE: The name must be unique among concurrent multicast sessions. It is hashed by the imaging engine to produce a Class D (temporary) IP address for the multicast session. To facilitate troubleshooting (wire sniffing), all ZfD imaging multicast addresses start with 231. For example, the session name `doug` produces the multicast address 231.139.79.72.
m	That this computer is the master and all other participating computers are slaves. If you omit this parameter, the imaging engine waits for a user on one of the computers to press `m` to designate that computer as the master.
c=count	The number of slaves that must register with the master before imaging will begin. If you omit this parameter, the imaging engine waits for the master user to press `g` before starting the imaging process. Once imaging has begun, any slaves attempting to register are denied.
t=seconds	The number of seconds the master computer will wait for the next slave to register before starting the imaging process without reaching count registered slaves. If you omit this parameter, the imaging process won't start until count is reached or the master user presses `g`. After that, any slaves attempting to register are denied.

Examples

`img s doug`	Starts a multicast session named `doug`. Each successive computer that issues this same command before the imaging begins joins the session. Imaging doesn't start until one of the users presses `m` to designate himself as master and presses `g` to start the imaging.
`img s doug m`	Starts a multicast session named `doug` and designates this computer as the master. Each successive computer that issues `img s doug` before the imaging begins joins the session as a slave. Imaging doesn't start until the master user presses `g`.
`img s doug c=5`	Starts a multicast session named `doug`. Each successive computer that issues img s doug before the imaging begins joins the session. Imaging doesn't start until one of the users presses `m` to designate himself as master and five other computers register with the master as slaves.
`img s doug c=5 t=20`	Starts a multicast session named `doug`. Each successive computer that issues img s doug before the imaging begins joins the session. Imaging doesn't start until one of the users presses `m` to designate himself as master and either five other computers register with the master as slaves or more than 20 seconds elapses between any consecutive slave registrations, whichever occurs first.