Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-NetAdapterAdvancedProperty

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

Gets the advanced properties for a network adapter.

SYNTAX

ByName (Default)

Get-NetAdapterAdvancedProperty [[-Name] <String[]>] [-IncludeHidden] [-AllProperties]
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

ByNameRegistryKeyword

Get-NetAdapterAdvancedProperty [[-Name] <String[]>] -RegistryKeyword <String[]> [-IncludeHidden]
 [-AllProperties] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

ByNameDisplayName

Get-NetAdapterAdvancedProperty [[-Name] <String[]>] -DisplayName <String[]> [-IncludeHidden] [-AllProperties]
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

ByInstanceIDKeyword

Get-NetAdapterAdvancedProperty -InterfaceDescription <String[]> -RegistryKeyword <String[]> [-IncludeHidden]
 [-AllProperties] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

ByInstanceIDDisplayName

Get-NetAdapterAdvancedProperty -InterfaceDescription <String[]> -DisplayName <String[]> [-IncludeHidden]
 [-AllProperties] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

ByInstanceID

Get-NetAdapterAdvancedProperty -InterfaceDescription <String[]> [-IncludeHidden] [-AllProperties]
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

DESCRIPTION

The Get-NetAdapterAdvancedProperty cmdlet gets the advanced properties for a network adapter. By default this cmdlet returns advanced properties that have display name values, meaning that these advanced properties are visible in the Advanced pane of the Adapter Properties in the Windows UI. Advanced properties that do not have display names require that the AllProperties parameter is specified. Individual advanced properties can also be selected either by DisplayName or RegistryKeyword parameters. Both of these parameters support the use of wildcard characters. The advanced properties are normally found in the following location in the registry HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class\{4D36E972-E325-11CE-BFC1-08002BE10318}\xxxxxxxx where xxxx is a four character string representing an integer such as 0007. The standardized keywords have a RegistryKeyword name that begins with an asterisk "". The valid values for these keywords are available by piping the output into the **Format-List* cmdlet with the ValidDisplayValues or the ValidRegistryValues properties specified.

EXAMPLES

Example 1: Get all advanced properties from all visible network adapters by the specified display name

PS C:\> Get-NetAdapterAdvancedProperty -Name "*"

This command gets all of the advanced properties that have a display name from all visible network adapters.

Example 2: Get all advanced properties from all visible network adapters

PS C:\> Get-NetAdapterAdvancedProperty -Name "*" -AllProperties

This command gets all of the advanced properties from all visible network adapters.

Example 3: Get all registry properties from all visible network

PS C:\> Get-NetAdapterAdvancedProperty -Name "*" -RegistryKeyword "*"

This command gets all of the registry properties from all visible network adapters.

Example 4: Get all advanced properties from hidden and visible network adapters

PS C:\> Get-NetAdapterAdvancedProperty -Name "*" -AllProperties -IncludeHidden

This command gets all of the advanced properties from all visible and hidden network adapters.

Example 5: Get all advanced properties from all network adapters

PS C:\> Get-NetAdapterAdvancedProperty -Name "*" -RegistryKeyword "*" -IncludeHidden

This command gets all of the advanced properties from all network adapters.

Example 6: Get all unformatted advanced properties from the specified network adapter

PS C:\> Get-NetAdapterAdvancedProperty -Name "MyAdapter" | Format-List -Property "*"

This command gets all of the unformatted, advanced properties from the network adapter named MyAdapter.

Example 7: Get the advanced properties for network adapters with a search string for the display name

PS C:\> Get-NetAdapterAdvancedProperty -Name "*" | Where-Object -FilterScript { $_.DisplayName -Like "TCP*" }

This command gets the advanced properties for network adapters that have a display name that starts with TCP.

PARAMETERS

-AllProperties

Indicates that the cmdlet gets 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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AsJob

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
Parameter Sets: (All)
Aliases: 

Required: False
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisplayName

Specifies the advanced property name, as an array, shown in the Advanced tab under the network adapter properties in Windows Server® 2012 and later.

Type: String[]
Parameter Sets: ByNameDisplayName, ByInstanceIDDisplayName
Aliases: DispN

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IncludeHidden

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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InterfaceDescription

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[]
Parameter Sets: ByInstanceIDKeyword, ByInstanceIDDisplayName, ByInstanceID
Aliases: ifDesc, InstanceID

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies an array of network adapter names.

Type: String[]
Parameter Sets: ByName, ByNameRegistryKeyword, ByNameDisplayName
Aliases: ifAlias, InterfaceAlias

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RegistryKeyword

Specifies the name of the registry value that this cmdlet reads, such as one of the registry values found in HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class{4D36E972-E325-11CE-BFC1-08002BE10318}\0007.

Type: String[]
Parameter Sets: ByNameRegistryKeyword, ByInstanceIDKeyword
Aliases: RegKey

Required: True
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

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.

NOTES

New-NetAdapterAdvancedProperty

Remove-NetAdapterAdvancedProperty

Reset-NetAdapterAdvancedProperty

Set-NetAdapterAdvancedProperty

© 2017 Microsoft