Set-Net
Adapter
Advanced
Property
Syntax
Set-NetAdapterAdvancedProperty
[[-Name] <String[]>]
[-DisplayName <String[]>]
[-RegistryKeyword <String[]>]
[-IncludeHidden]
[-AllProperties]
[-DisplayValue <String>]
[-RegistryValue <String[]>]
[-NoRestart]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-NetAdapterAdvancedProperty
-InterfaceDescription <String[]>
[-DisplayName <String[]>]
[-RegistryKeyword <String[]>]
[-IncludeHidden]
[-AllProperties]
[-DisplayValue <String>]
[-RegistryValue <String[]>]
[-NoRestart]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-NetAdapterAdvancedProperty
-InputObject <CimInstance[]>
[-DisplayValue <String>]
[-RegistryValue <String[]>]
[-NoRestart]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-NetAdapterAdvancedProperty cmdlet sets the advanced properties of a network adapter. Changes are made directly into the registry for the computer. Many of the common advanced properties can be controlled through a cmdlet, such as the Set-NetAdapterRss or Set-NetAdapterLso cmdlets.
Examples
Example 1: Set the value of an advanced property on the specified network adapter
PS C:\> Set-NetAdapterAdvancedProperty -Name "MyAdapter" -DisplayName "Flow Control" -DisplayValue "Rx and Tx Enabled"
This command sets the value of the Flow Control advanced property on the network adapter named MyAdapter.
Example 2: Set the value of an registry value on the specified network adapter
PS C:\> Set-NetAdapterAdvancedProperty -Name "MyAdapter" -RegistryKeyword "*Flo*rol" -RegistryType "REG_SZ" -RegistryValue "Disable"
This command sets the value of the Flow Control registry value on the network adapter named MyAdapter using wildcard characters in the keyword name.
Required Parameters
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Type: | CimInstance[] |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
Specifies an array of network adapter interface descriptions.
For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as
Contoso 12345 Gigabit Network Device
.
Type: | String[] |
Aliases: | ifDesc, InstanceID |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Optional Parameters
Indicates that the cmdlet gets all the advanced properties of a network adapter. If this parameter is not specified, then only advanced properties that are specified in the DisplayName parameter are returned.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Runs the cmdlet as a background job.
Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
You can continue to work in the session while the job completes.
To manage the job, use the
*-Job
cmdlets.
To get the job results, use the
Receive-Job
cmdlet.
For more information about Windows PowerShell® background jobs, see
about_Jobs
.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Aliases: | Session |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the display name of the advanced property as an array. This parameter is normally used in conjunction with the DisplayValue parameter.
Type: | String[] |
Aliases: | DispN |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Specifies the new value of the advanced property named with the DisplayName parameter.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Indicates that the cmdlet includes both visible and hidden network adapters in the operation. By default only visible network adapters are included. If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies an array of network adapter names.
Type: | String[] |
Aliases: | ifAlias, InterfaceAlias |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Indicates that the cmdlet does not restart the network adapter after completing the operation. Many advanced properties require restarting the network adapter before the new settings take effect.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the name of the registry keyword as an array that this cmdlet sets. This parameter is normally used in conjunction with the RegistryValue parameter.
Type: | String[] |
Aliases: | RegKey |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Specifies the value of the advanced property as an array named in the RegistryKeyword parameter.
Type: | String[] |
Position: | Named |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of
0
is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Type: | Int32 |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData[]
The
Microsoft.Management.Infrastructure.CimInstance
object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
The path after the pound sign (
#
) provides the namespace and class name for the underlying WMI object.
Outputs
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData
The
Microsoft.Management.Infrastructure.CimInstance
object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
The path after the pound sign (
#
) provides the namespace and class name for the underlying WMI object.