< Back

Set-NetAdapterAdvancedProperty

Tue Jan 29, 2019 10:26 pm

NAME Set-NetAdapterAdvancedProperty



SYNOPSIS

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]

[<CommonParameters>]



Set-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession <CimSession[]>] [-DisplayValue <String>] [-IncludeHidden] [-NoRestart]

[-PassThru] [-RegistryValue <String[]>] [-ThrottleLimit <Int32>] -InterfaceDescription <String[]> -RegistryKeyword <String[]> [-Confirm] [-WhatIf]

[<CommonParameters>]



Set-NetAdapterAdvancedProperty [[-Name] <String[]>] [-AllProperties] [-AsJob] [-CimSession <CimSession[]>] [-DisplayValue <String>]

[-IncludeHidden] [-NoRestart] [-PassThru] [-RegistryValue <String[]>] [-ThrottleLimit <Int32>] -RegistryKeyword <String[]> [-Confirm] [-WhatIf]

[<CommonParameters>]



Set-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession <CimSession[]>] [-DisplayValue <String>] [-IncludeHidden] [-NoRestart]

[-PassThru] [-RegistryValue <String[]>] [-ThrottleLimit <Int32>] -DisplayName <String[]> -InterfaceDescription <String[]> [-Confirm] [-WhatIf]

[<CommonParameters>]



Set-NetAdapterAdvancedProperty [-AsJob] [-CimSession <CimSession[]>] [-DisplayValue <String>] [-NoRestart] [-PassThru] [-RegistryValue <String[]>]

[-ThrottleLimit <Int32>] -InputObject <CimInstance[]> [-Confirm] [-WhatIf] [<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.





PARAMETERS

-AllProperties [<SwitchParameter>]

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AsJob [<SwitchParameter>]

ps_cimcommon_asjob



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



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

or Get-CimSession cmdlet. The default is the current session on the local computer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DisplayName <String[]>

Specifies the display name of the advanced property as an array. This parameter is normally used in conjunction with the DisplayValue

parameter.



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-DisplayValue <String>

Specifies the new value of the advanced property named with the DisplayName parameter.



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-IncludeHidden [<SwitchParameter>]

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-InputObject <CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-InterfaceDescription <String[]>

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.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? true



-Name <String[]>

Specifies an array of network adapter names.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? true



-NoRestart [<SwitchParameter>]

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RegistryKeyword <String[]>

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.



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-RegistryValue <String[]>

Specifies the value of the advanced property as an array named in the RegistryKeyword parameter.



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ThrottleLimit <Int32>

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



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.





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.







RELATED LINKS

Online Version:

Get-NetAdapterAdvancedProperty

New-NetAdapterAdvancedProperty

Remove-NetAdapterAdvancedProperty

Reset-NetAdapterAdvancedProperty

Set-NetAdapterLso

Set-NetAdapterRss