< Back

Remove-NetAdapterAdvancedProperty

Tue Jan 29, 2019 10:26 pm

NAME Remove-NetAdapterAdvancedProperty



SYNOPSIS

Removes an advanced property from the network adapter.





SYNTAX

Remove-NetAdapterAdvancedProperty [[-Name] <String[]>] [-AllProperties] [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-NoRestart]

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



Remove-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit

<Int32>] -InterfaceDescription <String[]> -RegistryKeyword <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit

<Int32>] -DisplayName <String[]> -InterfaceDescription <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-NetAdapterAdvancedProperty [[-Name] <String[]>] [-AllProperties] [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-NoRestart]

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



Remove-NetAdapterAdvancedProperty [-AsJob] [-CimSession <CimSession[]>] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32>] -InputObject

<CimInstance[]> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-NetAdapterAdvancedProperty cmdlet removes an advanced property from the network adapter. Advanced properties with a display name may

not be removed. Removing advanced properties could cause unpredictable network behavior.





PARAMETERS

-AllProperties [<SwitchParameter>]

Indicates that the cmdlet gets all the advanced properties from the network adapter. If this parameter is not specified, then only advanced

properties that have a display name, specified using 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 an array of transport or filter names shown in the Networking tab under the network adapter properties in Windows Server???? 2012 and

later.



Required? true

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 to be removed as an array.



Required? true

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: Remove an advanced property from the specified network adapter then restart it



PS C:\\>Remove-NetAdapterAdvancedProperty -Name "MyAdapter" -RegistryKeyword "myKeyword" -AllProperties



This command removes an advanced property named myKeyword from the network adapter named MyAdapter and restarts the network adapter. The advanced

property named myKeyword does not have a display name, therefore the AllProperties parameter must be used.







RELATED LINKS

Online Version:

Get-NetAdapterAdvancedProperty

New-NetAdapterAdvancedProperty

Reset-NetAdapterAdvancedProperty

Reset-NetAdapterAdvancedProperty