SGTKWinPE user settings

The information in this section is provided to help you customize the image produced by the SGTKWinPE.cmd command.

The SGTKWinPE settings .ini file provides input to the SGTKWinPE.cmd file that controls which options and processes of the ServerGuide Scripting Toolkit are turned on or off. This allows you to create a wide array of Windows PE solutions, for example, a default image from Microsoft that will simply boot to a command prompt, a DVD for local deployment, or a CD for network deployment.

The Toolkit provides example SGTKWinPE settings .ini files for deploying each supported operating system for both local and network deployments in the sgdeploy\SGTKWinPE\ScenarioINIs directory. For best results, before modifying these files or any other Toolkit files, create backup copies of the files you are modifying.

Table 1 describes the user definable parameters in the .ini files used by SGTKWinPE.cmd.

Note: Note that while some examples are broken across multiple lines for formatting reasons, when using these settings, you must include all the information for each variable on a single line.

Table 1. User definable settings for SGTKWinPE.cmd
Setting	Description
[SGTKWinPE Build Settings]
`TK_Build_ScenarioOutputDirectory`	Specifies the name of the directory to build the scenario in. Multiple scenarios of the same type can be maintained by changing this value at the start of each build, for example by appending a number. Default: blank
`TK_Build_WinPE_Arch_Type`	The architecture of the Windows PE image to create. Valid values are: `x86`, `x64` Default: `x86` for Windows Server 2008 x86 deployments `x64` for Windows Server 2008 x64 deployments
`TK_Build_WinPEPackages`	Lists additional packages to install to the Windows PEimage through the peimg /install=pckg command. The Toolkit will automatically install the following packages: Scripting, MDAC, WMI. Valid values are described in the Advanced Installation Kit documentation. Default: blank
`TK_Build_PEImgPrep`	Reduces the size of the Windows PE image by removing packages that are not installed from the image to reduce the size of the image. Valid values are: `Yes`, `No` Default: `No` Note: This setting applies only to the Automated Installation Kit (AIK) for Windows Vista SP1 and Windows Server 2008. If you are using the AIK for Windows 7 and Windows Server 2008 R2, this setting is ignored.
`TK_Build_ForceWinPEBoot`	Forces the Windows PE CD or DVD to boot without prompting when a file system is present. Ordinarily, when a file system is present when Windows PE boots, it prompts for user input and allows 8 seconds for the the user to press a key. The ForceWinPEBoot option disables this feature and forces the Windows PE CD or DVD to always boot. Valid values are: `Yes`, `No` Default: `Yes`
`TK_Build_InstallWinPEDrivers`	Installs the IBM Windows PE driver set as part of the Windows PE image. Valid values are: `Yes`, `No` Default: `Yes`
`TK_Build_EnableSGToolkitEnvironment`	Enables the ServerGuide Scripting Toolkit environment in the Windows PE image. If the environment is disabled, then no Toolkit files or environment are copied to the Windows PE image. Valid values are: `Yes`, `No` Default: Yes
`TK_Build_CreateISO`	Automatically create the ISO image. Valid values are: `Yes`, `No` Default: `Yes`
`TK_Build_StartISO`	Starts the software associated with ISO files. Typically this will start the CD or DVD burning process for the created ISO or RamdiskISO file. The RamdiskISO file takes precedence if it exists. Valid values are: `Yes`, `No` Default: `Yes`
`TK_Build_SuppressPrompts`	Suppresses interactive prompts during SGTKWinPE script execution. Valid values are: `Yes`, `No` Default: `Yes`
`TK_Build_DisplayBuildSettings`	Display the Toolkit settings from the input SGTKWinPE settings .ini file during SGTKWinPE script execution. Valid values are: `Yes`, `No` Default: `Yes`
[Toolkit Environment Settings]
`TK_Environment_ToolkitFilesLocation`	Defines whether the Scripting Toolkit binary and script files are to be copied to the local bootable media or run live over the network from the Toolkit source server. Valid values are: `Local`, `Network` Default: Local for local deployment scenarios Network for network deployment scenarios
`TK_Environment_PerformToolkitProcesses`	Automatically perform Toolkit processes after booting the Windows PE CD or DVD (depending on the values of the individual process settings). Valid values are: `Yes`, `No`, `Disabled` Default: `Yes` If set to `No`, the Toolkit processes may be run manually. If set to `Disabled`, the Toolkit processes can not be run manually for local scenarios since the required files are not copied to the DVD.
TK_Environment_DisplayToolkitSettings	Display the relevant Toolkit settings from the SGTKWinPE settings .ini file during deployment scenario execution. Valid values are: `Yes`, `No` Default: `Yes`
[Toolkit Process Settings]
`TK_Process_DataFilesLocation`	Specifies whether the NOS, driver files and PRAID policy files should be copied to the local bootable media or obtained over the network from the Toolkit source server (local deployment versus network deployment). Valid values are: `Local`, `Network` Default: Local for local deployment scenarios Network for network deployment scenarios
`TK_Process_PerformRAIDConfiguration`	Automatically perform the RAID configuration task. Valid values are: `Yes`, `No`, `Disabled` Default: `Yes` If set to `Disabled`, the files required for local RAID configuration scenarios are not copied to the DVD.
`TK_Process_PerformFibreConfiguration`	Automatically perform the Fibre configuration task. Valid values are: `Yes`, `No`, `Disabled` Default: `Disabled`
`TK_Process_PerformASUConfiguration`	Automatically perform the ASU configuration task. Valid values are: `Yes`, `No`, `Disabled` Default: `Disabled` If this variable is set to `Disabled`, the files required for local ASU configuration scenarios are not copied to the DVD.
`TK_Process_PerformPartitioning`	Automatically perform the partitioning task. Valid values are: `Yes`, `No`, `Disabled` Default: `Yes` If set to `Disabled`, the files required for local partitioning scenarios are not copied to the DVD.
`TK_Process_PerformNOSInstallation`	Automatically perform the NOS Installation task. Valid values are: `Yes`, `No`, `Disabled` Default: `Yes` If set to `Disabled`, the files required for local NOS installation scenarios are not copied to the DVD.
`TK_Process_AutomaticallyRestart`	Specifies that the system be restarted after the selected tasks are complete. Valid values are: `Yes`, `No` Default: `No`
`TK_Process_AutoStartToolkitProcesses`	Enable automatic start of the Toolkit processes. Set this value to `Yes` to have the Toolkit processes start automatically when the Windows PE CD is booted without prompting the user to press a key. Attention: If the RAID or partitioning processes are set to `Yes`, this will re-partition or reformat the hard drive automatically without warning when the CD or DVD is booted. Valid values are: `Yes`, `No` Default: `No`
`TK_Process_AutoStartTimer`	Automatic start countdown timer in seconds. Default: `60`
`TK_Process_AutoContinueToolkitProcesses`	Enable automatic continuation of Toolkit processes during required reboots. Turning this off causes the user to be prompted to continue the Toolkit processes when Windows PE is rebooted from CD or DVD. Useful for debugging. Valid values are: `Yes`, `No` Default: `Yes`
[PRAID Settings]
`TK_PRAID_PolicyFile`	Specifies the PRAID policy file to use for the configuration. This value should not contain any path information. The specified PRAID policy file must exist in the SGTKWinPE\PolicyFiles directory. Default: RAIDAuto.ini
`TK_PRAID_Flags`	Modifies the behavior of RAID configuration or replication. Valid values are: blank, `/r:n`, `/e1`, `/e2`, `/e3`, `/v:n` where `n` is 1, 3, or 5. See PRAID.EXE for more information. Default: `/r`
[Fibre Settings]
`TK_FIBRE_COUNT`	Specifies the number of HBA ports to configure. Valid values are 1–`n`, where `n` is the number of HBA ports available. This variable affects the use of the following variables: `TK_FIBRE_N_HBA_ID` `TK_FIBRE_N_BOOT_DISABLE` `TK_FIBRE_N_BOOT_PRIM` `TK_FIBRE_N_BOOT_ALT1` `TK_FIBRE_N_BOOT_ALT2` `TK_FIBRE_N_BOOT_ALT3` Where `N` is the HBA number to be configured. Note: You must complete one of each of these variables for every HBA port you configure. So if `TK_FIBRE_COUNT=2`, you must complete one set of these variables for the first port and one for the second.
`TK_FIBRE_N_HBA_ID`	Identifies the Qlogic/Emulex HBA to be configured, where `N` is the HBA number to be configured. Valid values are: `hba_instance` the instance number of an HBA port. Valid values are integers from 0 to n-1, where `n` is the number of HBAs in the system. For example, to configure HBA instance 0: `TK_FIBRE_1_HBA_ID=0`. `hba_wwpn` the World Wide Port Name of an HBA port, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxxxx`. For example, to configure HBA: 90-87-AA-BB-65-34-BB-E0: `TK_FIBRE_1_HBA_ID= 90-87-AA-BB-65-34-BB-E0` Default: 0
`TK_FIBRE_N_HBA_ID`	Identifies the Brocade HBA to be configured, where `N` is the HBA number to be configured. Valid values are: `hba_instance` the instance number of an HBA port. The valid format is `N/P`, where `N` is the adapter number from 1 to `N`, and `P` is the port number from 0 to p-1. For example: `TK_FIBRE_1_HBA_ID=1/0`. `hba_wwpn` the World Wide Port Name of an HBA port, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxxxx`. For example, to configure HBA: 90-87-AA-BB-65-34-BB-E0: `TK_FIBRE_1_HBA_ID= 90-87-AA-BB-65-34-BB-E0` Default: 0
`TK_FIBRE_N_BOOT_DISABLE`	Disable the selected current boot device settings on the specified HBA port, where `N` is the HBA number to be configured. Valid values are No Does not clear or disable any boot settings. All Disables the primary and all alternate boot settings: `Prim`, `Alt1`, `Alt2`, and `Alt3`. Prim Disables only the primary boot setting. Alt1 Disables the Alternative 1 boot setting. Alt2 Disables the Alternative 2 boot setting. Alt3 Disables the Alternative 3 boot setting. Default: `No`
`TK_FIBRE_N_BOOT_PRIM = target_wwnn target_wwpn lun_id`	Defines the primary boot target settings, where `N` is the HBA number to be configured, and: `target_wwnn` is the World Wide Node Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `target_wwpn` is the World Wide Port Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `lun_id` is the Logical Unit Number of a device. Default: `0 0 0` Example: `TK_FIBRE_1_BOOT_PRIM= BB-CC-AA-BB-65-34-BB-F1 BB-CC-AA-BB-FF-34-BB-F1 9`
`TK_FIBRE_N_BOOT_ALT1 = target_wwnn target_wwpn lun_id`	Configures the operating system to use the indicated target as the first alternate boot device, where `N` is the HBA number to be configured, and `target_wwnn` is the World Wide Node Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `target_wwpn` is the World Wide Port Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `lun_id` is the Logical Unit Number of a device. Default: blank Example: `TK_FIBRE_1_BOOT_ALT1= BB-CC-AA-BB-65-34-BB-FD BB-CC-AA-BB-FF-40-BB-F1 5`
`TK_FIBRE_N_BOOT_ALT2 = target_wwnn target_wwpn lun_id`	Configures the operating system to use the indicated target as the second alternate boot device, where `N` is the HBA number to be configured, and `target_wwnn` is the World Wide Node Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `target_wwpn` is the World Wide Port Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `lun_id` is the Logical Unit Number of a device. Default: blank Example: `TK_FIBRE_1_BOOT_ALT2= BB-CC-AA-BB-65-34-BB-FD BB-CC-AA-BB-FF-40-BB-F1 5`
`TK_FIBRE_N_BOOT_ALT3 = target_wwnn target_wwpn lun_id`	Configures the operating system to use the indicated target as the third alternate boot device, where `N` is the HBA number to be configured, and `target_wwnn` is the World Wide Node Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `target_wwpn` is the World Wide Port Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `lun_id` is the Logical Unit Number of a device. Default: blank Example: `TK_FIBRE_1_BOOT_ALT3= BB-CC-AA-BB-65-34-BB-FD BB-CC-AA-BB-FF-40-BB-F1 5`
[ASU Settings]
`TK_ASU_File`	Specifies the ASU configuration file to use. This value cannot contain any path information. The specified ASU configuration file must exist in the SGTKWinPE\ASUFiles directory. Default: default_settings.ini
[Partition Settings]
`TK_Partition_DiskNum`	Specifies the disk number on which to create new partition. Valid values are the disk numbers found by diskpart.exe. Default: `AUTO` Note: The AUTO setting is the first disk on the system.
`TK_Partition_Size`	Specifies the partition size in MB. Valid values are: `Max` `number` `Max` indicates to use all available disk space. Default: `Max`
`TK_Partition_FileSystem`	Specifies the file system type to use when formatting the drive. Valid values are: `NTFS`, `FAT32` Default: `NTFS` Note: `NTFS` is the only valid value for Windows Server 2008 installations.
`TK_Partition_SR_Size`	Specifies the partition size, in MB, for a System Reserved Partition. The System Reserved Partition is a primary active partition created during the partitioning step. The BitLocker Drive Encryption function requires this partition active partition and formatted NTFS. Valid values are integers greater than 108. The default is 108 MB. `k2` Note: This setting is supported only for Windows Server 2008 R2. This setting is ignored when booting WinPE in native uEFI mode. For more information about BitLocker Drive Encryption, see: http://technet.microsoft.com/en-us/library/cc731549%28WS.10%29.aspx

[NOS Installation Settings]
`TK_NOS_NetworkOperatingSystem`	Specifies the NOS to use for the deployment. This must be a valid directory name within the sgdeploy\os directory in the Toolkit source server. Default: Varies per scenario based on the NOS being deployed. For example, for Windows Server 2008 Enterprise Edition x86 deployments, the .ini file name is Win2008_x86_EE.ini. The corresponding OS directory in the .ini file is `Win2008_x64`.
`TK_NOS_AnswerFile`	Specifies the answer file to use for the deployment. This must be a valid file name within the SGTKWinPE\AnswerFiles directory in the Toolkit source server. Default: win2008.xml for Windows Server 2008 x86 win2008x64.xml for Windows Server 2008 x64 win2012x64.xml for Windows Server 2012 x64
`TK_NOS_DeploymentDriverLibrary`	Specifies the deployment driver library to use for the deployment. Valid values are: `Auto`, `dirname` If set to `Auto`, the Toolkit searches all directories within the sgdeploy\drvs directory and selects the newest DDL present that supports the machine and OS being deployed. If `dirname` is specified, this must be a valid directory name within the sgdeploy\drvs directory in the Toolkit source server. For example, `w23_drv` would be specified for sgdeploy\drvs\w23_drv. Default: `Auto`
`TK_NOS_PerformDirectorAgentInstallation`	Automatically perform the Director Agent application installation task. Valid values are: `Yes`, `No`, `Disabled` Default: `Disabled` If set to `Disabled`, the files required to install the Director Agent are not copied to the DVD for local deployment scenarios.
`TK_NOS_PerformPostOSInstallUXSPUpdates`	Automatically perform the post-OS install UXSP updates task. Valid values are: `Yes`, `No`, `Disabled` Default: `Yes` If set to `Disabled`, the files required to install UpdateXpress System Packs are not copied to the DVD for local deployment scenarios.
`TK_NOS_ProductKey`	Specifies the product key to be used when using the answer files provided with the Toolkit. Default: blank
`TK_NOS_Win2008_ImageName`	Sets the Image Name within the Windows 2008 installation image. This variable selects the Windows 2008 Edition. Valid values are: Windows Longhorn SERVERSTANDARD Windows Longhorn SERVERSTANDARDV Windows Longhorn SERVERDATACENTER Windows Longhorn SERVERDATACENTERV Windows Longhorn SERVERENTERPRISE Windows Longhorn SERVERENTERPRISEV Windows Longhorn SERVERWEB Windows Server 2008 R2 SERVERSTANDARD Windows Server 2008 R2 SERVERDATACENTER Windows Server 2008 R2 SERVERENTERPRISE 7 Windows Server 2008 R2 SERVERWEB This value is set by the scenario .ini file. Note: To install the core version of an edition, append `CORE` to the image name. For example, to install the core version of Windows Server 2008 Standard Edition, use the value `Windows Longhorn SERVERSTANDARDCORE`.
`TK_NOS_Win2008_UILanguage`	Specifies the language to install from the Windows 2008 installation image. The default for this value is en-us, which allows the unattended installation of English copies of Windows Server 2008. To perform an unattended installation of Windows Server 2008 images in other languages, change this setting to the value for the language you want to install, for example ja-JP for Japanese. See the lang.ini file from the Windows 2008 media or the Windows Automated Installation Kit documentation for valid values for this variable. Default: `en-us`
[Director Agent Settings]
`TK_DirAgent_DirectorAgent`	Specifies the path to the IBM Director Agent application files within the sgdeploy\apps directory. Default: `dawin`
[UXSP Settings]
`TK_UXSP_FilesLocation`	Specifies whether the UpdateXpress System Packs should be copied to the local bootable media or obtained over the network from the Toolkit source server or from the specified remote server. Valid values are: `Local`, `Network` Default: Local for local deployment scenarios Network for network deployment scenarios
`TK_UXSP_MakeLocal_Copy`	Specifies whether or not the UXSP files should be copied to the target server before they are installed. If `TK_UXSP_FilesLocation = Network`, the files will be copied to the C:\IBMSGTK\uxsp directory. If `TK_UXSP_FilesLocation = Local`, the UXSP files are always copied to the target server before they are installed. Valid values are: `Yes`, `No` Default: `No`
`TK_UXSP_RemoteServer`	If `TK_UXSP_FilesLocation = Network`, specifies the network path to the shared directory containing the UXSP files. If blank (no value is specified), then theUXSPs are obtained from the Toolkit source server. Example value: \\MyServerName\UXSPsDirectory Default: blank
`TK_UXSP_RemoteServer_UserName`	Specifies the user name and optionally the domain name with which to access the server specified with TK_UXSP_RemoteServer. Valid syntax: `UserName` `UserName@DomainName` `DomainName\UserName` Default: blank
`TK_UXSP_RemoteServer_Password`	Specifies the password that corresponds to the user name specified with TK_UXSP_RemoteServer_UserName. Default: blank
`TK_UXSP_ApplyLatest`	Specifies whether UXSPi should apply the latest updates to the target system if no UXSPfiles are found for the target system. Set this variable to `Yes` to force the UpdateXpress System Pack Installer (UXSPi) to apply the latest updates to the target system if no UXSP files are found for that system. Valid values: `Yes`, `No` Default: `No` Note: In order for individual updates to be installed properly, any XML files included with the update must have lowercase file extensions (for example, xml not XML).
`TK_UXSP_UXSPIUpdateFlags`	Specifies user-provided command line arguments for processing by the UpdateXpress System Pack Installer (UXSPi) in Update mode. To provide command line arguments to be processed by UXSPi, set this variable to the command line arguments. See UpdateXpress System Pack Installer for a list of command line arguments to use with UXSPi in Update mode. Default: blank
[Network TCP/IP Settings]
`TK_NetTCPIP_UseDHCP`	Specifies whether the Windows PE networking should use DHCP. If this option is turned on, then the static specifications for network settings below are disabled automatically by Windows PE. Valid values are: `Yes`, `No` Default: `Yes`
`TK_NetTCPIP_ClientIPAddress`	Specifies the client IP address to use for the networking Windows PE environment. Default: 192.168.0.131
`TK_NetTCPIP_Gateway`	Specifies the Gateway IP address to use for the networking Windows PE environment. Default: `192.168.0.2`
`TK_NetTCPIP_WinPEFirewall`	Specifies whether the Windows PE firewall should be activated. Valid values are: `Yes`, `No` Default: `Yes`
`TK_NetTCPIP_Identifier`	Specifies the network adapter to configure with static IP settings Default: Local Area Connection
[Network Share Settings]
`TK_NetShare_ServerName`	Specifies the Toolkit source server computer name. Valid values are: either the host name or IP address of the Toolkit source server. Default: sgtksrv
`TK_NetShare_ShareName`	Specifies the Toolkit source server shared directory name. Default: `sgshare`
`TK_NetShare_UserName`	Specifies the user name, and optionally the domain name, to use when establishing a network connection to the Toolkit source server. Valid syntax: `UserName` `UserName@DomainName` `DomainName\UserName` Default: `sgtk0clnt`
`TK_NetShare_Password`	Specifies the password to use when establishing a network connection to the Toolkit source server. Default: `sgtk0clnt`
`TK_NetShare_ShareDriveAssignment`	Specifies the Share Drive Assignment to use when establishing a network connection to the Toolkit Source Server. Default: `Y:`
[SGTKWinPE Paths]
`TK_Path_WinPE_Output`	Specifies the path for the Windows PE Build Output directory. Default: %TK_Path_SGDeploy%\WinPE_ScenarioOutput
`TK_Path_WAIK_Source`	This variable has been deprecated. The AIK information is found automatically in the registry. You can uncomment this variable and use it to bypass the registry check, but it is not required. Default (if used): `%ProgramFiles%\Windows AIK`
[SGTKWinPE Filenames]
`TK_File_WinPE_ISO_Filename`	The Windows PE ISO file name Default: WinPE_%TK_Build_WinPE_Arch_Type%.iso
`TK_File_WinPE_Log_Filename`	The Windows PE build process log file name. Default: WinPE_%TK_Build_WinPE_Arch_Type%.log
[SGTKWinPE Custom Scripts]
`TK_Path_BeforeWIMMounted_Custom_Script`	Specifies a custom script to run during the SGTKWinPE build process before the WinPE WIM image is mounted for editing. Use the Template.cmd script as a starting point for writing custom scripts, and then put the custom script in the correct location.
`TK_Path_WhileWIMMounted_Custom_Script`	Specifies a custom script to run during the SGTKWinPE build process while the WinPE WIM image is mounted for editing. Use the Template.cmd script as a starting point for writing custom scripts, and then put the custom script in the correct location.
`TK_Path_AfterWIMMounted_Custom_Script`	Specifies a custom script to run during the SGTKWinPE build process after the WinPE WIM image is mounted for editing. Use the Template.cmd script as a starting point for writing custom scripts, and then put the custom script in the correct location.