Remove-NetAdapterAdvancedProperty

Remove-NetAdapterAdvancedProperty

Removes an advanced property from the network adapter.

Syntax

Parameter Set: ByName
Remove-NetAdapterAdvancedProperty [[-Name] <String[]> ] -DisplayName <String[]> [-AllProperties] [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByInstanceID
Remove-NetAdapterAdvancedProperty -DisplayName <String[]> -InterfaceDescription <String[]> [-AllProperties] [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByInstanceIDKeyword
Remove-NetAdapterAdvancedProperty -InterfaceDescription <String[]> -RegistryKeyword <String[]> [-AllProperties] [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByNameRegistryKeyword
Remove-NetAdapterAdvancedProperty [[-Name] <String[]> ] -RegistryKeyword <String[]> [-AllProperties] [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Remove-NetAdapterAdvancedProperty -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-NetAdapterAdvancedProperty cmdlet removes an advanced property from the network adapter. Note: Advanced properties with a display name may not be removed. Removing advanced properties could cause unpredictable network behavior.

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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DisplayName<String[]>

Specifies the transport or filter name shown in the Networking tab under the network adapter properties in Windows Server® 2012 and later.

Aliases	none
Required?	true
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.

Aliases	none
Required?	false
Position?	named
Default Value	none
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.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-InterfaceDescription<String[]>

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.

Aliases	ifDesc
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	true

-Name<String[]>

Specifies the name of the network adapter.

Aliases	ifAlias, InterfaceAlias
Required?	false
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.

Aliases	none
Required?	false
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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RegistryKeyword<String[]>

Specifies the name of the registry keyword to be removed.

Aliases	none
Required?	true
Position?	named
Default Value	none
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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• 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

The output type is the type of the objects that the cmdlet emits.

• 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.

Examples

EXAMPLE 1

This example removes an advanced property named myKeyword from the network adapter named MyAdapter and restarts the network adapter. Note: The advanced property named myKeyword does not have a display name, therefore the AllProperties parameter must be used.

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

Related topics

Get-NetAdapterAdvancedProperty

New-NetAdapterAdvancedProperty

Reset-NetAdapterAdvancedProperty

Set-NetAdapterAdvancedProperty