What's new in the Hardware Lab Kit
What's new in this release
With each new release, anyone who builds tools that utilize the HLK object model should rebuild those tools to use the latest versions of the object model files. In addition, be sure to always use the same version of each object model file (i.e. do not mix object model files from different kit releases).
|HLK version||Compatible server OS versions|
|22H2||Windows Server 2016, Windows Server 2019|
|21H2||Windows Server 2016, Windows Server 2019|
|1903||Windows Server 2012, Windows Server 2012 R2, Windows Server 2016|
|1809||Windows Server 2012, Windows Server 2012 R2, Windows Server 2016|
|1803||Windows Server 2012, Windows Server 2012 R2, Windows Server 2016|
|1709||Windows Server 2012, Windows Server 2012 R2, Windows Server 2016|
|1703||Windows Server 2012, Windows Server 2012 R2, Windows Server 2016|
|1607||Windows Server 2008 R2 SP1, Windows Server 2012, Windows Server 2012 R2, Windows Server 2016|
Windows Server 2022 is not supported as a host OS for the HLK Controller. However, it is supported as a client OS.
Windows Server 2019 is not supported as a host OS for the 1809 or 1903 HLK Controller. However, it is supported as a client OS. HLK versions released in 2021 or later will add support for hosting the HLK Controller Role on Windows Server 2019.
Updated test content
Test content updated for better coverage for 1809 testing, across various architectures.
Known issues this release
HLK install fails with a database-related error
This error can occur when uninstalling and then reinstalling HLK. When the new instance of HLK is installed, one of the following error messages appears when installing and rolls back
- There is already an object named DSLinkType in the database.
- The database database_name already exists.
- Failed to create SQL database.
When uninstalling HLK, database uninstall can fail if the database is locked by another process. The HLK uninstall reports success, but the database is left behind. To recover, follow these steps:
- From an elevated command prompt, run
- From the SQL Shell command line, enter the following:
ALTER DATABASE WTTIdentity SET SINGLE_USER WITH ROLLBACK IMMEDIATE
DROP DATABASE WTTIdentity
ALTER DATABASE HLKJobs SET SINGLE_USER WITH ROLLBACK IMMEDIATE
DROP DATABASE HLKJobs
- Verify that
C:\Program Files\Microsoft SQL Server\MSSQL(sql version).MSSQLSERVER\MSSQL\DATAcontains no files starting with WTTIdentity or HLKJobs
- Install the HLK
HLK does not update existing SQL database with latest security fix
If your existing SQL Server database is unpatched, installing the HLK will not update the database with the latest security fixes.
To patch SQL Server: Option 1: Uninstall SQL Server before installing the HLK. The HLK will install SQL Server and the most recent hotfix as of RTM. At this point, you may use Windows Update to keep your SQL Server instance updated. Option 2: Manually patch your existing SQL Server before HLK install.
What's new in previous releases
Virtual Hardware Lab Kit (VHLK)
New for 1809! The Microsoft Virtual Hardware Lab Kit (VHLK) is the entire Hardware Lab Kit pre-installed and pre-configured on a VHDX, ready to boot. Use the VHLK to save setup time, quickly stand up a controller, and run Windows Hardware Certification from a virtual machine. For more details, check out the VHLK Getting Started Guide.
- Ready to boot and use
- Run the HLK Controller as a virtual machine
- Host the HLK Controller virtual machine on developer machines instead of dedicated Controller hardware
Improved playlist support
The process for loading and using playlists has been improved and simplified. For more information, see Step 6: Select and run tests in the Getting Started guide
Support for Arm64 desktop
HLK tests can now target Arm64 desktop machines.
Nano Server testing
HLK now includes tests for Nano Server.
Improved diagnosability of failed HLK tests
The Results tab now indicates when a test fails due to a system crash. The tab also shows information from the associated Bug Check along with a link to help documentation for further information.
See the following topics for more information:
- <a href"/windows-hardware/test/hlk/getstarted/step-7-view-test-results-and-log-files">Step 7: View test results and log files (Getting started guide)
- <a href"/windows-hardware/test/hlk/user/hlk-studio---results-tab">HLK Studio - Results Tab
- <a href"/windows-hardware/test/hlk/user/troubleshooting-windows-hlk-test-failures">Troubleshooting Windows HLK Test Failures (system crashes)
Exporting failed HLK jobs
You can now export a failed job and re-run it on a machine that does not have the HLK Client installed. For more information, see Exporting a Failed HLK Job>.
Support for Mobile testing
Mobile devices running Test and Health images are now supported for testing with the HLK. For more information, see HLK Proxy Client Getting Started Guided.
SQL Server 2012 Express SP2
The HLK setup process now installs SQL Server 2012 Express SP2 if no other SQL installation is present on the controller at the time of installation.
Test levels have been replaced by Development Phases to better align with the hardware and system development cycle. Tests are organized by their applicability during Bring Up, Development and Integration, Reliability, and Tuning and Validation.
Playlists describe a collection of tests and can be created from the HLK Studio and Object Model to define custom test passes.
Learn more about playlists in the Getting Started Guide.
Windows Hardware Compatibility Program
Hardware certification is no longer required. Instead, the Windows Hardware Compatibility Program is an optional program in which you can participate. For more information, see Windows Hardware Compatibility Program.
- Compatibility Playlist - Levels are no longer used to identify tests required for the Compatibility Program. To create a Compatibility Program test pass, download the official Hardware Compatibility Program Playlist and apply to your HLK project.
- Windows Hardware Certification blog -This blog provides up-to-date news about the Windows Compatibility Program. Including Compatibility Playlist update announcements.
The Hardware Lab Kit supports Windows 10 testing only. Use the Hardware Certification Kit for testing downlevel operating systems.
Merge .hckx Packages
To support unified driver submissions, results from HCK and HLK projects can be merged together using HLK Studio. When merging, open the HLK project or package first, and then merge in the HCK package(s).
Virtual machine support
The HLK Controller now supports installation and execution in a virtual machine. When configuring your virtual machines, ensure the virtual machine meets the minimum requirements for the HLK Controller.
You can now package a subset of test results within an HLK project, tailoring the packaging experience to key scenarios. This allows you to capture, share, and diagnose test failures without having to run tests individually in a new project.
To use this feature, select one or more tests from the Test tab, right-click the selection, and choose Create Partial Package of Highlighted Tests. Note that this package will be saved as a partial package (.hlkp). This extension will be deprecated in future HLK releases.
Rate this Test
You can now provide feedback on tests in the HLK. To rate tests, you must opt-in to CEIP. To rate a test, right-click on the desired test in the Results Pane, and select Rate This Test.
The Preview pane in File Explorer provides project and package information including Name, Creation Date, Targets, and Type.
To use the Preview pane in File Explorer, choose the View menu group, and then choose Preview pane. You can then choose any .hlkx file to view details of the package.
The HLK now supports 64-bit SQL editions exclusively. Previously, the HCK supported only 32-bit SQL editions exclusively.
SQL 2019 Support
Versions of HLK released in 2021 or later will support using SQL Server 2019 for the HLK Controller role. For these releases of HLK if a compatible version of SQL is not found on the target system HLK will install SQL Server 2019 Express.
Windows Server 2019 Support
Versions of HLK released in 2021 or later will support installing the HLK Controller role onto Windows Server 2019. These versions will drop support for Windows Server 2012 R2 and earlier. Windows Server 2022 is currently not supported for the HLK Controller role.