Setup (Standard 8 Module Reference)

7/8/2014

Review the settings, dependencies and any notes for the Setup section of the Embedded Core module in the Windows Embedded 8 Standard (Standard 8) module catalog.

These settings select the Windows Embedded 8 Standard (Standard 8) image that you install, configure the disk that you install Standard 8 to, and configure the Windows Preinstallation Environment (Windows PE) 4.0 operating system.

Some of the settings apply only to Windows PE 4.0, and some settings apply to the installed Standard 8 image. Each setting describes which operating system the setting applies to.

Settings

This module includes the following settings.

• Catalog
  • Credentials
    • Domain
    • Password
    • Username
  • SourceLocation
• ComplianceCheck
  • DisplayReport
• Diagnostics
  • OptIn
• DiskConfiguration
  • Disk
    • CreatePartitions
      • CreatePartition
        • Extend
        • Order
        • Size
        • Type
    • ModifyPartitions
      • ModifyPartition
        • Active
        • Extend
        • Format
        • Label
        • Letter
        • Order
        • PartitionID
        • TypeID
    • DiskID
    • WillWipeDisk
  • DisableEncryptedDiskProvisioning
  • WillShowUI
• Display
  • ColorDepth
  • HorizontalResolution
  • RefreshRate
  • VerticalResolution
• ImageInstall
  • DataImage
    • InstallFrom
      • Credentials
        • Domain
        • Password
        • Username
      • MetaData
        • Key
        • Value
      • Path
    • InstallTo
      • DiskID
      • PartitionID
    • Order
  • OSImage
    • InstallFrom
      • Credentials
        • Domain
        • Password
        • Username
      • MetaData
        • Key
        • Value
      • Path
    • InstallTo
      • DiskID
      • PartitionID
    • InstallToAvailablePartition
    • WillShowUI
• OemFolderPaths
  • PathAndCredentials
    • Credentials
      • Domain
      • Password
      • Username
    • Path
• PageFile
  • Path
  • Size
• RunAsynchronous
  • RunAsynchronousCommand
    • Credentials
      • Domain
      • Password
      • Username
    • Description
    • Order
    • Path
• RunSynchronous
  • RunSynchronousCommand
    • Credentials
      • Domain
      • Password
      • Username
    • Description
    • Order
    • Path
• UserData
  • ProductKey
    • Key
    • WillShowUI
  • AcceptEula
  • FullName
  • Organization
• WindowsDeploymentServices
  • ImageSelection
    • InstallImage
      • Filename
      • ImageGroup
      • ImageName
    • InstallTo
      • DiskID
      • PartitionID
    • WillShowUI
  • Login
    • Credentials
      • Domain
      • Password
      • Username
    • WillShowUI
• CreateSeparateSystemPartition
• EnableFirewall
• EnableNetwork
• LogPath
• Restart
• UseConfigurationSet

Notes

The following sections provide more information about Setup settings.

Comparison of Product Key Settings

Setting path	Description
Setup\UserData\ProductKey\Key	Specifies the Standard 8 image to install during Windows Setup.
Shell-Setup\ProductKey	Specifies a product key to activate Standard 8. This setting can be used with Setup\UserData\ProductKey\Key, and the two product keys can be different. Note: If keys are specified for both settings, the key specified for this setting takes precedence.

For an example of how to configure end-user settings that the system uses during Standard 8 setup, see User Data XML Example.

CreatePartition

This setting specifies a single partition to create on the hard disk.

If you are installing Standard 8 to a blank hard disk, you must use CreatePartition and ModifyPartitions to create and to format partitions on the disk. You must also add values to either InstallTo or InstallToAvailablePartition to specify where to install Standard 8.

Warning

Do not both set Extend to true and specify a value for Size. If this combination of settings is specified, no partition is created, an error is logged, and installation terminates.

You can use the Action setting attribute to specify the action to take when you use the configuration file to create or modify an image. The following table shows the possible values.

Value	Description
AddListItem	Adds the item or items to an image.
ModifyListItem	Modifies the value or the item as specified in Key or Value in an image.
RemoveListItem	Removes the item or items in an image.

DataImage

You can use the Action setting attribute to specify the action to take when you use the configuration file to create or modify an image. The following table shows the possible values.

Value	Description
AddListItem	Adds the item or items to an image.
ModifyListItem	Modifies the value or the item as specified in Key or Value in an image.
RemoveListItem	Removes the item or items in an image.

You can add additional data on top of a Standard 8 operating system image by adding one or more data images. Data images can include applications, device drivers, and other configuration files. Do not use a data image to overwrite existing Standard 8 system data. You can create a data image by using ImageX. For more information, see ImageX Technical Reference.

The OSImage is installed before any data images. Never use a data image to overwrite Windows system data. Use data images only to add files.

To determine what data images are available to be installed

1. Use the DISM /Get-WimInfo command to determine which images and editions are included on your Windows image (.wim) file, such as in the following example:

   DISM /Get-WimInfo /WimFile:N:\Drivers\FNBDrivers.wim
   

2. Information about the available images will be displayed; for example:

   Deployment Image Servicing and Management toolVersion: 6.1.7108.0 Details for image : N:\Drivers\FNBDrivers.wim Index : 1Name : FNB1DriversDescription : FabriKam Model FNB1 DriversSize : 1,234,567 bytes Index : 2Name : FNB2DriversDescription : FabriKam Model FNB2 DriversSize : 2,234,567 bytes Index : 3Name : FNB3DriversDescription : FabriKam Model FNB3 DriversSize : 3,234,567 bytes
   

Disk

This setting contains all of the settings that are used to partition and to format hard disks on 32-bit and 64-bit versions of Standard 8. For 32-bit systems, the format for basic disks is always master boot record (MBR). 64-bit systems can support both MBR and GUID partition table (GPT) formats, but 64-bit systems cannot boot from MBR disks.

DiskConfiguration contains entries for configuring and partitioning one or more physical hard disks. DiskConfiguration is supported only in the Windows PE configuration pass.

DiskConfiguration can contain one or more Disk settings that represent a single hard disk on the computer that you configure.

However, partitions are not automatically created. The values in Disk are required to complete installation. If you do not specify any Disk elements and WillShowUI is set to Never, an error is logged, and installation terminates.

Disk specifies the disk settings to add or to edit on the destination device. Each instance of Disk in an unattended installation configuration file applies to a single hard disk (specified by DiskID).

DiskConfiguration contains the settings that Standard 8 uses to partition and to configure one or more physical hard disks. Valid disk partition configurations vary depending on whether you are using a BIOS-based computer or a Unified Extensible Firmware Interface (UEFI)-based computer. For more information, see the Manage Hard Disks and Partitions topic in the Windows Assessment and Deployment Kit (Windows ADK) Technical Reference. For information about modifying a partition for a BIOS/MBR-based computer with two hard drives, see Disk Configuration XML Example. For information about configuring a UEFI-based system with one hard drive, see Extending a Partition XML Example. For information about configuring a UEFI-based system with two hard drives, see System with Two Hard Drives XML Example.

The following list shows how CreateSeparateSystemPartition works with disk partition settings for Setup/DiskConfiguration:

• If disk-partition settings are specified, then CreateSeparateSystemPartition is ignored.
• If no disk-partition settings are specified yet, Image Builder Wizard (IBW) determines that a system partition is needed for your configuration, and IBW creates a 100 MB system partition in your image.

You can use the Action setting attribute to specify the action to take when you use the configuration file to create or modify an image. The following table shows the possible values.

Value	Description
AddListItem	Adds the item or items to an image.
ModifyListItem	Modifies the value or the item as specified in Key or Value in an image.
RemoveListItem	Removes the item or items in an image.

Display

This setting contains display settings for a video adapter.

The Display setting configures only Windows PE 4.0 and is not applied to the Standard 8 installation. To change the display settings for the Standard 8 installation, use the Display setting in the Shell-Setup component.

Note

We recommend that you use the default settings. If you select a value for this setting that is not supported by Windows PE 4.0, your video adapter, or the display monitor, then Windows PE 4.0 might show only a blank screen without displaying an error.

Dynamic Updates

This setting specifies whether to enable Dynamic Updates during Standard 8 Setup. Dynamic Updates search for new Setup files, including drivers and other files, to be used to install the Standard 8 operating system.

FirewallGroup

You can use the Action setting attribute to specify the action to take when you use the configuration file to create or modify an image. The following table shows the possible values.

Value	Description
AddListItem	Adds the item or items to an image.
ModifyListItem	Modifies the value or the item as specified in Key or Value in an image.
RemoveListItem	Removes the item or items in an image.

ImageInstall

This setting specifies the path to the source and destination of a Windows image (.wim) file that contains the Standard 8 image to install. For an example of how to install an operating system image, see Setting the ImageInstall Setting XML Example.

LocalAccount

You can use the Action setting attribute to specify the action to take when you use the configuration file to create or modify an image. The following table shows the possible values.

Value	Description
AddListItem	Adds the item or items to an image.
ModifyListItem	Modifies the value or the item as specified in Key or Value in an image.
RemoveListItem	Removes the item or items in an image.

ModifyPartition

This setting specifies a single partition on a disk to be modified by one or more of the ModifyPartition child elements.

The following table shows the modifications that you can make to each partition type.

Partition type	Child element supported
Primary	Active, Extend, Format, Letter, Label, TypeID
Extended	None
Logical	Extend, Format, Letter, Label, TypeID
EFI	Format, Letter, Label
MSR	None

You can use the Action setting attribute to specify the action to take when you use the configuration file to create or modify an image. The following table shows the possible values.

Value	Description
AddListItem	Adds the item or items to an image.
ModifyListItem	Modifies the value or the item as specified in Key or Value in an image.
RemoveListItem	Removes the item or items in an image.

OemFolderPaths PathAndCredentials

You can use the Action setting attribute to specify the action to take when you use the configuration file to create or modify an image. The following table shows the possible values.

Value	Description
AddListItem	Adds the item or items to an image.
ModifyListItem	Modifies the value or the item as specified in Key or Value in an image.
RemoveListItem	Removes the item or items in an image.

You use the Key attribute to specify a unique association for the PathAndCredential, and the Value attribute to specify information to associate with the path or credential.

OSImage

This setting identifies a Windows image (.wim) file to install by specifying the unique index, name, or description stored in the .wim file metadata.

When you create a Windows image file, you can specify unique values for the Name and Description in the metadata for that image. The image number, or index, is automatically created. To view the metadata for a .wim file, use the imagex /info command. To modify the Name and Description values, use the imagex command..

The following is an example of .wim file metadata:

<WIM>
   <IMAGE INDEX="1">
      <NAME>FabrikamDriverFiles</NAME>
      <DESCRIPTION>FabrikamOutOfBoxDrivers</DESCRIPTION>
   </IMAGE>
</WIM>

RunAsynchronous

This setting specifies one or more commands to run asynchronously during the windowsPE configuration pass. Asynchronous commands are executed in the order specified, but the computer does not wait for the previous command to finish before it runs. Running a service is an example of an asynchronous command.

These commands run in the system context and are always executed after RunSynchronous commands in the same pass.

RunAsynchronousCommand specifies a single command to run asynchronously on the device and specifies the credentials to use when accessing a data image file specified Path.

RunSynchronous

This setting specifies one or more commands to run synchronously on the system during the windowsPE configuration pass. Synchronous commands are executed in the order specified in the unattended installation configuration file; each command must finish before the next command starts.

RunSynchronous commands run in the user context in the auditUser configuration pass and in the system context in the specialize configuration pass. For more information about configuration passes, see Image Builder Configuration Passes.

RunSynchronousCommand specifies a single command to run synchronously on the computer during the specified configuration pass, and specifies the credentials to use when accessing an application over a network and when accessing a data image file specified Path.

WindowsDeploymentServices

This setting specifies settings for Windows Deployment Services, the updated and redesigned version of Remote Installation Services (RIS). You can use WindowsDeploymentServices to set up new computers through a network-based, unattended installation.

These settings are specific to Windows Deployment Services installations and are necessary for fully automating installations with the Windows Deployment Services client.

For an example of a complete Windows Deployment Services deployment, see Complete Windows Deployment Services deployment XML Example.

See Also

Concepts

Embedded Core