Set-NetAdapterAdvancedProperty

Sets the advanced properties of a network adapter.

Syntax

Set-NetAdapterAdvancedProperty
   [[-Name] <String[]>]
   [-AllProperties]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-DisplayValue <String>]
   [-IncludeHidden]
   [-NoRestart]
   [-PassThru]
   [-RegistryValue <String[]>]
   [-ThrottleLimit <Int32>]
   -DisplayName <String[]>
   [-Confirm]
   [-WhatIf]
Set-NetAdapterAdvancedProperty
   [-AllProperties]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-DisplayValue <String>]
   [-IncludeHidden]
   [-NoRestart]
   [-PassThru]
   [-RegistryValue <String[]>]
   [-ThrottleLimit <Int32>]
   -InterfaceDescription <String[]>
   -RegistryKeyword <String[]>
   [-Confirm]
   [-WhatIf]
Set-NetAdapterAdvancedProperty
   [[-Name] <String[]>]
   [-AllProperties]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-DisplayValue <String>]
   [-IncludeHidden]
   [-NoRestart]
   [-PassThru]
   [-RegistryValue <String[]>]
   [-ThrottleLimit <Int32>]
   -RegistryKeyword <String[]>
   [-Confirm]
   [-WhatIf]
Set-NetAdapterAdvancedProperty
   [-AllProperties]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-DisplayValue <String>]
   [-IncludeHidden]
   [-NoRestart]
   [-PassThru]
   [-RegistryValue <String[]>]
   [-ThrottleLimit <Int32>]
   -DisplayName <String[]>
   -InterfaceDescription <String[]>
   [-Confirm]
   [-WhatIf]
Set-NetAdapterAdvancedProperty
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-DisplayValue <String>]
   [-NoRestart]
   [-PassThru]
   [-RegistryValue <String[]>]
   [-ThrottleLimit <Int32>]
   -InputObject <CimInstance[]>
   [-Confirm]
   [-WhatIf]

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 via a cmdlet, such as the Set-NetAdapterRss or Set-NetAdapterLso cmdlets.

Examples

EXAMPLE 1

PS C:\>Set-NetAdapterAdvancedProperty -Name MyAdapter -DisplayName "Flow Control" -DisplayValue "Rx and Tx Enabled"

This example sets the value of the Flow Control advanced property on the network adapter named MyAdapter.

EXAMPLE 2

PS C:\>Set-NetAdapterAdvancedProperty -Name MyAdapter -DisplayName "Flow Control" -DisplayValue "Disable"

This example sets the value of the Flow Control advanced property on the network adapter named MyAdapter.

EXAMPLE 3

PS C:\>Set-NetAdapterAdvancedProperty -Name MyAdapter -RegistryKeyword "*Flo*rol" -RegistryType "REG_SZ" -RegistryValue "Disable"

This example sets the value of the Flow Control advanced property on the network adapter named MyAdapter using wildcard characters in the keyword name.

Required Parameters

-DisplayName

Specifies the display name of the advanced property. Note: This parameter is normally used in conjunction with the DisplayValue parameter.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-InputObject

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
-InterfaceDescription

Specifies the network adapter interface description. 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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:True
-RegistryKeyword

Specifies the name of the registry keyword to be set. Note: This parameter is normally used in conjuction with the RegistryValue parameter.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AllProperties

Returns all the advanced properties of the network adapter. If this parameter is not specified, then only advanced properties that have a DisplayName parameter are returned.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CimSession

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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DisplayValue

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
-IncludeHidden

Specifies both visible and hidden network adapters should be included. 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
-Name

Specifies the name of the network adapter.

Type:String[]
Aliases:ifAlias, InterfaceAlias
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:True
-NoRestart

Specifies that the network adapter is not restarted as part of running this cmdlet. Note: 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
-PassThru

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
-RegistryValue

Specifies the value of the advanced property named in the RegistryKeyword parameter.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ThrottleLimit

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
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
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.