Share via


Image Builder Wizard Command-Line Options (Standard 8)

7/8/2014

Review the use, syntax, options, and parameters of Image Builder Wizard (IBW) for Windows Embedded 8 Standard (Standard 8).

Image Builder Wizard (IBW) is the program that installs and configures Windows Embedded 8 Standard (Standard 8) and Windows Welcome. IBW supports custom installations and unattended installations.

Syntax

setup.exe
    [/1394debug:<channel>]
    [/debug:<port> [baudrate:<baudrate>]]
    [/emsport:{com1 | com2 | usebiossettings | off} [/emsbaudrate:<baudrate>]]
    [/noreboot]
    [/m:<folder_name>]
    [/tempdrive:<drive_letter>]
    [/unattend:<path_to_unattend.xml>]
    [/usbdebug:<hostname>]
    [/catalog:<path_to_catalog>]
    [/netdebug:hostip=<ip_address>,port=<port>,key=<ip_address>]
    [/busparams:<bus.device.function>]

Where to Find IBW

IBW is found in the root directory of your installation media. For example, if drive E contains a Windows Embedded 8 Standard Toolkit (Standard 8 Toolkit) installation disk, you would run E:\Setup.exe. If you start your device off the Standard 8 Toolkit installation disk, IBW runs automatically.

Command-Line Options and Parameters

Option

Description

/1394debug

Enables kernel debugging over an IEEE 1394 (FireWire) port when Standard 8 is running and during the windowsPE configuration pass of IBW.

<channel>

The debugging channel. The default value is 1.

For example:

setup.exe /1394debug:1

/debug

Enables kernel debugging over a communications (COM) port when Standard 8 is running and during the windowsPE configuration pass of IBW.

<port>

The debugging port. The default value is 1.

[/baudrate:<baudrate>]

Specifies the baud to use when transferring data during debugging. The default is 19200. /baudrate can also be set to 115200 or 57600.

For example:

setup.exe /1394debug:1 /baudrate:115200

/emsport

Enables or disables Emergency Management Services during IBW and after the server operating system has been installed. The following arguments are used to specify the behavior of EMS during IBW.

com1

Enables EMS over COM1. Supported for x86 systems only.

com2

Enables EMS over COM2. Supported for x86 systems only.

usebiossettings

Uses the setting specified in the BIOS. For x86 systems, the value from the Serial Port Console Redirection (SPCR) table is used. For Itanium-based systems, the Extensible Firmware Interface (EFI) is used. If no SPCR table or EFI console device path is specified in the BIOS, usebiossettings will be disabled.

off

Disables EMS. If EMS is disabled in Image Builder, you can later enable EMS by modifying the boot settings. For more information, see the Resource Kits for the Windows Server 2003 family.

[/emsbaudrate:<baudrate>]

Specifies the baud to use when transferring data during debugging. The default is 19200. /emsbaudrate can also be set to 115200 or 57600.

For example:

setup.exe /emsport:COM1 /emsbaudrate:115200

/noreboot

Instructs IBW not to restart the computer after the downlevel phase of IBW finishes. The /noreboot option enables you to execute additional commands before Standard 8 restarts. This suppresses only the first restart. Successive restarts, if they are required, are not suppressed.

For example:

setup.exe /noreboot

/m

Specifies IBW to copy alternative files from another location. This option instructs IBW to look in the alternative location first, and, if files are present, to use them instead of the files from the default location.

<folder_name>

The name and location of the folder that contains the replacement files. <folder_name> can be any local drive location. UNC paths are not supported.

You must know where the files will be installed on the Standard 8 installation. All the additional files must be copied to a $OEM$ folder in your installation sources or in the <folder_name> location. The $OEM$ structure provides a representation of the destination installation disk. For example:

$OEM$\$1

Maps to %SYSTEMDRIVE%, for example, drive C.

$OEM$\$$

Maps to %WINDIR%, for example, C:\Standard 8\.

$OEM$\$progs

Maps to the program files directory.

$OEM$\$docs

Maps to the Users folder.

For example, to copy an updated C:\Program Files\Messenger\Msmsgs.exe file into the Standard 8 installation, create the following folder structure on the installation source (Pro\Sources\$OEM$\$progs\Messenger\Msmsgs.exe) by using the Image Builder command:

pro\sources\setup.exe /m

If you replace a file protected by Standard 8 file protection, you must also copy the updated file to the local sources to be installed with Standard 8 (C:\Standard 8\i386). The file name must be the same as what is used in IBW. For example, add this file and folder structure to your $OEM$ directory:

pro\sources\$OEM$\$$\i386\msmsgs.ex_

If you use files that are not on an installation share, specify the folder name. For example:

setup.exe /m:C:\additional_files

Where C:\additional_files is your customized $OEM$ directory.

For example:

C:\additional_files\$$\i386\msmsgs.ex_

If you make resource changes in your replacement files, you must add the updated MUI files to the installation.

/tempdrive

Instructs IBW to copy temporary installation files to the root directory of the specified partition.

For example:

setup.exe /tempdrive:H

/unattend

Enables unattended IBW mode. You can also specify a value for <path_to_unattend.xml>. If you specify a value for <path_to_unattend.xml>, IBW applies the values in the configuration file during installation. If you do not specify a value for <path_to_unattend.xml>, IBW upgrades your existing version of Standard 8. All settings are taken from the previous installation so that minimal user intervention is required.

<path_to_unattend.xml>

The file path and file name of the IBW configuration file. The path of a configuration file can be a local path or UNC path.

For example:

setup.exe /unattend:\\server\share\unattend.xml

/usbdebug

Sets up debugging on a USB port. Debug data is effective on the next restart.

<hostname>

The name of the computer to debug.

For example:

setup.exe /usbdebug:testmachine01

/catalog

Sets the path of the catalog that contains the modules, CBS packages, drivers and other files referenced by your configuration file. If this location requires credentials, you may have to log on before you use this command.

For example:

setup.exe /catalog:\\myserver\catalog

/netdebug

Sets up kernel debugging over a network.

/busparams

Specifies the target controller when multiple controllers exist. Used to point to the PCI address of the debugger that is being used. The PCI bus, device and function are used. This is generally used to identify the location of a 1394 or USB debug port. Decimal values are used for Standard 8.

For example:

setup.exe /busparams:0.29.0

See Also

Other Resources

Image Builder Wizard Technical Reference
Build Images