Configuring Features with Windows PowerShell*

Intel® Ethernet Adapters and Devices User Guide

ID	Date	Version	Classification
705831	11/28/2024		Public

A newer version of this document is available. Customers should click here to go to the newest version.

You can use Microsoft PowerShell* cmdlets to configure and manage the Intel® Ethernet devices present in your system. This functionality applies for the following:

Intel® Ethernet cmdlets
Intel® PROSet for Windows PowerShell* software

Note:

Refer to Compatibility Notes for Intel® Ethernet Cmdlets and Intel® PROSet for information on support limitations.

Module Names

The following table lists the module name in Windows PowerShell for each component.

Component	Module Name
Intel Ethernet cmdlets	IntelEthernetCmdlets
Intel PROSet for Windows PowerShell software	IntelNetCmdlets

Importing New Cmdlets

After installing Intel PROSet, use the Import-Module cmdlet to import the new cmdlets. You may need to restart Windows PowerShell to access the newly installed cmdlets. Refer to Module Names above for the available cmdlet modules.

To use the Import-Module cmdlet, you must specify the path. For example:

PS c:\> Import-Module -Name "C:\Program Files\Intel\Wired Networking\IntelNetCmdlets"

Note:

If you include a trailing backslash (\) at the end of the Import-Module command, the import operation will fail. In Microsoft Windows* 10 and Windows Server* 2016, the auto-complete function appends a trailing backslash. If you use auto-complete when entering the Import-Module command, delete the trailing backslash from the path before pressing Return to execute the command.
If you encounter issues with Intel Ethernet cmdlets, you may need to manually import the module using the instructions provided above.

See Microsoft TechNet for more information about the Import-Module cmdlet.

Changing Intel Ethernet Settings via Microsoft Windows PowerShell

You can use Windows PowerShell software to change most Intel Ethernet settings.

To configure Intel Ethernet device features using Windows PowerShell software, follow these general steps:

Install Intel PROSet or Intel Ethernet cmdlets, if you haven’t already. See the following for more information:
- Installing Intel® Ethernet Cmdlets
- Installing Intel® PROSet
Open PowerShell.
At the PowerShell prompt, run your desired cmdlet.

Help Information for PowerShell Cmdlets

To get help information for both Intel Ethernet cmdlets and Intel PROSet for Windows PowerShell software:

For a complete list of the cmdlets and their descriptions, type the following at the Windows PowerShell prompt. Refer to Module Names for the available cmdlet modules:
```
PS C:\>get-help <module name>
```
For detailed usage information for each cmdlet (including examples), type the following at the Windows PowerShell prompt:
```
PS C:\> get-help <cmdlet_name> -full
```
To show only examples for a cmdlet, type the following at the Windows PowerShell prompt:
```
PS C:\> get-help <cmdlet_name> -examples
```

To use the Minihelp property for any cmdlet in the module, append | Select Minihelp. For example:

PS C:\> Get-IntelNetAdapterSetting -Name "<adapter_name>" -RegistryKeyword *RSS | Select Minihelp

Note:

Online help (get-help -online) is not supported.

Additional Notes

IntelNetCmdlets are digitally signed. Microsoft Windows operating systems check digital signatures online. Depending on your internet connection, this may result in a delay before any cmdlet operation (including get-help). If you have not already done so, make sure you use Import-Module to import the IntelNetCmdlets.
If an adapter is bound to an Intel® Advanced Network Services (Intel® ANS) team, do not change settings using the Set-NetAdapterAdvanceProperty cmdlet from Windows PowerShell, or any other cmdlet not provided by Intel. Doing so may cause the team to stop using that adapter to pass traffic. You may see this as reduced performance or the adapter being disabled in the Intel ANS team. You can resolve this issue by changing the setting back to its previous state, or by removing the adapter from the Intel ANS team and then adding it back.
The Get-IntelNetAdapterStatus -Status General cmdlet may report the status “Link Up - This device is not linked at its maximum capable speed.” In that case, if your device is set to auto-negotiate, you can adjust the speed of the device’s link partner to the device’s maximum speed. If the device is not set to auto-negotiate, you can adjust the device’s speed manually, but you must ensure the link partner is set at the same speed.