microsoft / test-nethlk

Validates the default IHV Adapter settings according to the MSFT definitions and Switch Requirements for Azure Stack HCI

Overview

Test-NetHLK is a module used for testing the advanced properties for Network Adapters and determining if a network switch supports the Azure Stack HCI requirements.

Installation

This module is available on the PowerShell gallery using the following command: Install-Module Test-NetHLK -Force

For a disconnected system, please use: Save-Module Test-NetHLK -Path <SomeFolderPath>

Then move all downloaded module to the disconnected system in the PowerShell module path. For example: C:\Program Files\WindowsPowerShell\Modules\Test-NetHLK\...

Updating the module

We recommend the following process for ensuring you're running the latest version of the module.

First uninstall the old module: Uninstall-Module Test-NetHLK -AllVersions

Next, install the latest version of the module: Install-Module Test-NetHLK -Force

Test-NICAdvancedProperties

This cmdlet tests the properties returned from Get-NetAdapterAdvancedProperty. For syntatical help, please use the PowerShell help with the following command help Test-NICAdvancedProperties

Example Use: Test-NICAdvancedProperties -InterfaceName Ethernet

Property Definitions

Test-NICAdvancedProperties

Test-NICAdvancedProperties validate various aspects of the advanced registry keys. This section defines some of the lesser known properties being validated.

DisplayParameterType

Description: The advanced registry key type

Value	Type	Min	Max
1	int	-32768	32767
2	long	-2147483648	2147483647
3	word	0	65535
4	dword	0	4294967295
5	enum	N/A	N/A

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

test-nethlk's Issues

*NumaNodeId NumericParameterMaxValue is 65535

The test is expecting *NumaNodeId NumericParameterMaxValue as 65535 which is not inline with (https://docs.microsoft.com/en-us/windows-hardware/drivers/network/standardized-inf-keywords-for-rss)

NumaNodeId	Preferred NUMA node	Int	65535 (Any node)	0	System specific - cannot exceed 65534

*** ERROR: [FAIL] *NumaNodeId NumericParameterMaxValue is 65535

Win2K22 failures

1. ****** ERROR: [FAIL] The in use NDIS version for adapter Ethernet 2 was below the required versionfor this OS (Required: 6.85; Actual: 6.82)
   https://docs.microsoft.com/en-us/windows-hardware/drivers/network/introduction-to-ndis-6-83
   Is 6.85 is an incremental update to 6.83 or any features are required to implement ?

2. *MaxRssProcessors DisplayParameterType is -ge 5 and -lt 5 => What should be the DisplayParameterType ? enum ?
   ****** ERROR: [FAIL] *MaxRssProcessors DisplayParameterType is -ge 5 and -lt 5
   ****** ERROR: [FAIL] *MaxRssProcessors NumericParameterBaseValue is
   ****** ERROR: [FAIL] *MaxRssProcessors NumericParameterStepValue is
   ****** ERROR: [FAIL] *MaxRssProcessors NumericParameterMinValue is -le

3. NumRSSQueues DefaultRegistryValue is 65535, is this like *NumaNodeId 65535 => (-1) ? What should be the Max queues ?
   *NumRSSQueues NumericParameterMinValue is -le 0 => How to interpret 0 RSS Queues ? non-rss queues ?
   ****** ERROR: [FAIL] *NumRSSQueues DefaultRegistryValue is 65535
   ****** ERROR: [FAIL] *NumRSSQueues NumericParameterMaxValue is -ge 65535
   ****** ERROR: [FAIL] *NumRSSQueues NumericParameterMinValue is -le 0

4. What should be the values filled for NicSwitch parameters
   https://docs.microsoft.com/en-us/windows-hardware/drivers/network/standardized-inf-keywords-for-sr-iov
   Is Win2K22 is expecting other values than mentioned in the above document ?
   ****** ERROR: [FAIL] NicSwitch on name is
   ****** ERROR: [FAIL] NicSwitch SwitchType is

The same .inf is passing with Win2K19 but failing with Win2K22. Kindly update the doc accordingly.

HLK test NICStrictPropertyValidation failed due to Test-NetHLK module date

The last release was 12 July 2023
Today 11 January 2024
It is 183 days between these dates, not including the end date but test check that module must be within 180 days of today`s date.

Virtual Adapter not supported

The script calls get-netadapter with the switch -Physical which rules out virtual network adapters.

During HLK testing of a virtual network adapter (tap6-windows) this module is used in the test NICSTrictPropertyValidation and results in the test not passing as the virtual adapter is not recognized.

RegistryValue is not tested

DisplayValue and RegistryValue should be added for well known properties.

ACTION REQUIRED: Microsoft needs this private repository to complete compliance info

There are open compliance tasks that need to be reviewed for your Validate-NIC repo.

Action required: 4 compliance tasks

To bring this repository to the standard required for 2021, we require administrators of this and all Microsoft GitHub repositories to complete a small set of tasks within the next 60 days. This is critical work to ensure the compliance and security of your microsoft GitHub organization.

Please take a few minutes to complete the tasks at: https://repos.opensource.microsoft.com/orgs/microsoft/repos/Validate-NIC/compliance

• The GitHub AE (GitHub inside Microsoft) migration survey has not been completed for this private repository
• No Service Tree mapping has been set for this repo. If this team does not use Service Tree, they can also opt-out of providing Service Tree data in the Compliance tab.
• No repository maintainers are set. The Open Source Maintainers are the decision-makers and actionable owners of the repository, irrespective of administrator permission grants on GitHub.
• Classification of the repository as production/non-production is missing in the Compliance tab.

You can close this work item once you have completed the compliance tasks, or it will automatically close within a day of taking action.

If you no longer need this repository, it might be quickest to delete the repo, too.

GitHub inside Microsoft program information

More information about GitHub inside Microsoft and the new GitHub AE product can be found at https://aka.ms/gim or by contacting [email protected]

FYI: current admins at Microsoft include @dcuomo

*JumboPacket DisplayParameterType is long ?

The test is expecting *JumboPacket DisplayParameterType to be long not 'int' as per documentation (https://docs.microsoft.com/en-us/windows-hardware/drivers/network/keywords-that-can-be-edited)
****** ERROR: [FAIL] *JumboPacket DisplayParameterType is -ge 2 and -lt 5

Is it expected to be long ?