Username (Standard 8 Module Reference)

7/8/2014

Review the applicable Embedded Core modules and any examples for the Username setting in Windows Embedded 8 Standard (Standard 8).

This setting contains a string that specifies a user name, account name, or a universal principal name (UPN).

Modules

The following table shows the modules that you can apply this setting to. In Image Configuration Editor (ICE), you can follow the corresponding path to set this setting for a module.

Module

Path

Setting Description

Deployment

Products/Embedded Core/Deployment/RunAsynchronous/RunAsynchronousCommand/Credentials/Username

Specifies the user name of the account to use for authentication when running the program specified in Path to run asynchronously during deployment.

Deployment

Products/Embedded Core/Deployment/RunSynchronous/RunSynchronousCommand/Credentials/Username

Specifies the user name of the account to use for authentication when accessing the Path if the command is on a network share.

Do not create an empty value for this setting.

PnpCustomizationsNonWinPE

Products/Embedded Core/PnpCustomizationsNonWinPE/DriverPaths/PathAndCredentials/Credentials/Username

Specifies the user name of the account to use to authenticate the Path. This setting can be empty.

PnpCustomizationsWinPE

Products/Embedded Core/PnpCustomizationsWinPE/DriverPaths/PathAndCredentials/Credentials/Username

Specifies the name of the account to use to authenticate the Path.

Setup

Products/Embedded Core/Setup/Catalog/Credentials/Username

Specifies the name of the account used for authentication when the catalog is in a network location.

Setup

Products/Embedded Core/Setup/ImageInstall/DataImage/InstallFrom/Credentials/Username

Specifies the name of the account used for authentication for the data image.

Setup

Products/Embedded Core/Setup/ImageInstall/OSImage/InstallFrom/Credentials/Username

Specifies the user name of the account used for authentication when accessing a Windows image (.wim) file. Do not create an empty value for this setting.

Setup

Products/Embedded Core/Setup/OemFolderPaths/PathAndCredentials/Credentials/Username

Specifies the name of the account to use for authentication to an OEM folder that contains non-Microsoft files that you want to deploy to your image.

Setup

Products/Embedded Core/Setup/RunAsynchronous/RunAsynchronousCommand/Credentials/Username

Specifies the name of the account to use for authentication for a program specified by Path to run asynchronously during Setup.

Do not create an empty value for this setting.

Setup

Products/Embedded Core/Setup/RunSynchronous/RunSynchronousCommand/Credentials/Username

Specifies the name of the account to use for authentication when accessing an application over a network.

Do not create an empty value for this setting.

Setup

Products/Embedded Core/Setup/WindowsDeploymentServices/Login/Credentials/Username

Specifies the user name for Windows Deployment Services login. This setting can be either a regular user name or UPN, in the format of an email address. If this setting is a UPN, Domain is not required.

Do not create an empty value for this setting.

Shell-Setup

Products/Embedded Core/Shell-Setup/AutoLogon/Username

Specifies a local account or a domain user account on the domain that is specified by Domain and used for automatic logon. Do not create an empty value for this setting or Setup will fail.

If you are deploying a multilingual Standard 8 image, specify s and group names by using the language-neutral names. Because the shell account settings are processed before a default UI language is applied, language-neutral account and group names are specified in English. For example, Administrators, Power Users, and Guest are language-neutral group names.

UnattendedJoin

Products/Embedded Core/UnattendedJoin/Identification/Credentials/Username

Specifies the name of the user account that has permission to create a computer account in a domain or to use an existing computer account in a domain. This value is in UPN format (user@fully_qualified_DNS_domain_name), domain\username format, or fully-qualified-DNS-domain\username format.

This value is used for a device to join a domain during the specialize configuration pass. You must set a value in either Domain or Username, but you cannot set a value in both. Do not create an empty value for this setting.

XML Example

The following examples show how to set Username.

Data Image Install

The following XML output shows how to set the credentials for data image.

<ImageInstall>
    <DataImage wcm:action="add">
        <InstallFrom>
            <Credentials>
                <Domain>FabrikamDomain</Domain>
                <Password>MyPassword</Password>
                <Username>MyUsername</Username>
            </Credentials>
        </InstallFrom>
        <Order>1</Order>
    </DataImage>
</ImageInstall>

OS Image Install

The following example shows how to specify credentials for an IT professional or other authorized user to use when accessing a Windows image (.wim) file.

<ImageInstall>
    <OSImage>
        <InstallFrom>
            <Credentials>
                <Domain>FabrikamDomain</Domain>
                <Password>MyPassword</Password>
                <Username>MyUsername</Username>
            </Credentials>
        </InstallFrom>
    </OSImage>
</ImageInstall>

For an XML example that shows how to set the ImageInstall setting to install both an OS image and a data image, see Setting the ImageInstall Setting XML Example.

Deployment Run Synchronous Command

The following XML example shows how to set credentials for synchronous commands.

<RunSynchronous>
      <RunSynchronousCommand wcm:action="add">
         <Credentials>
            <Domain>MyDomain</Domain>
            <Password>MyPassword</Password>
            <Username>MyUsername</Username>
         </Credentials>
         <Description>MySynchCommand1</Description>
         <Order>1</Order>
         <Path>\\network\server\share\filename</Path>
         <WillReboot>OnRequest</WillReboot>
      </RunSynchronousCommand>
</RunSynchronous>

For another example, see Deployment with Synchronous Command XML Example.

Deployment Run Asynchronous Command

The following XML example shows how to set credentials for asynchronous commands.

<RunAsynchronous>
    <RunAsynchronousCommand wcm:action="add">
        <Credentials>
            <Domain>MyDomain</Domain>
            <Password>MyPassword</Password>
            <Username>MyUsername</Username>
        </Credentials>
        <Description>AsynchCommand1</Description>
        <Order>1</Order>
        <Path>\\network\server\share\filename</Path>
    </RunAsynchronousCommand>
</RunAsynchronous>

Deployment Services

The following example shows how to set the domain, password, and user name used for Windows Deployment Services login.

<WindowsDeploymentServices>
    <Login>
        <Credentials>
           <Username>Administrator</Username>
           <Domain>MY-DOMAIN-NAME</Domain>
           <Password>********</Password>
        </Credentials>
    </Login>
</WindowsDeploymentServices>

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

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

Setup Run Synchronous Command

The following XML example shows how to configure commands to run synchronously.

<RunSynchronous>
    <!-- First synchronous command to execute -->
    <RunSynchronousCommand>
         <Order>1</Order>
         <Path>\\MyNetworkShare\MyApplication.exe</Path>
         <Description>DescriptionOfMyApplication</Description>
         <Credentials>
            <Domain>FabrikamDomain</Domain>
            <UserName>MyUserName</UserName>
            <Password>MyPassword</Password>
         </Credentials>
    </RunSynchronousCommand>
<!-- Second synchronous command to execute -->
    <RunSynchronousCommand>
         <Order>2</Order>
         <Path>C:\AnotherApplication.exe</Path>
         <Description>DescriptionOfMyApplication</Description>
    </RunSynchronousCommand>
</RunSynchronous>

Setup Run Asynchronous Command

The following XML example shows how to configure commands to run asynchronously.

<RunAsynchronous>
      <RunAsynchronousCommand>
         <Order>1</Order>
         <Path>\\MyNetworkShare\MyApplication.exe</Path>
         <Description>DescriptionOfMyApplication</Description>
         <Credentials>
            <Domain>FabrikamDomain</Domain>
            <UserName>MyUserName</UserName>
            <Password>MyPassword</Password>
         </Credentials>
      </RunAsynchronousCommand>
      <RunAsynchronousCommand>
         <Order>2</Order>
         <Path>C:\AnotherApplication.exe</Path>
         <Description>DescriptionOfMyApplication</Description>
      </RunAsynchronousCommand>
</RunAsynchronous>

Shell Setup

The following XML example shows how to set automatic logon.

<AutoLogon>
      <Password>
         <Value>MyPassword</Value>
      </Password>
      <Domain>FabrikamDomain</Domain>
      <Enabled>true</Enabled>
      <LogonCount>2</LogonCount>
      <Username>MyUserName</Username>
</AutoLogon>

UnattendedJoin

The following XML example shows how to use the Credentials settings to specify the domain, the user name, and the password used to join a domain during Standard 8 Setup.

<Identification>
   <Credentials>
      <Domain>fabrikam.com</Domain>
      <Password>MyPassword</Password>
      <Username>MyUserName</Username>
   </Credentials>
   <JoinDomain>fabrikam.com</JoinDomain>
   <MachinePassword>ComputerPassword</MachinePassword>
</Identification>

See Also

Concepts

Embedded Core Settings