Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-NetAdapterAdvancedProperty

New-NetAdapterAdvancedProperty

msft_netadapteradvancedproperty.cmdletdefinition.cdxml

Synopsis

Creates a new advanced property for the network adapter.

Syntax

New-NetAdapterAdvancedProperty [-Name] [-AsJob] [-CimSession] [-IncludeHidden] [-NoRestart] [-RegistryDataType] [-ThrottleLimit] [-RegistryKeyword] [-RegistryValue] [-Confirm] [-WhatIf] [<CommonParameters>]

New-NetAdapterAdvancedProperty [-AsJob] [-CimSession] [-IncludeHidden] [-NoRestart] [-RegistryDataType] [-ThrottleLimit] [-InterfaceDescription] [-RegistryKeyword] [-RegistryValue] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The New-NetAdapterAdvancedProperty cmdlet creates a new advanced property for the network adapter. The intention is that network adapter manufacturers can use this cmdlet to manage advanced properties that are not directly supported by Windows Server® 2012 and later. Note: This cmdlet is the cmdlet in the network adapter family that creates a registry key. All other cmdlets read or modify existing registry entries. Note: The use of wildcards in the network adapter identifier, either in the Name parameter or InterfaceDescription parameter, is not supported.

Parameters

-AsJob <SwitchParameter>

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.

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

-IncludeHidden <SwitchParameter>

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

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

true (ByPropertyName)

Accept wildcard characters?

true

-Name <String>

Specifies the name of the network adapter.

Aliases

ifAlias, InterfaceAlias

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-NoRestart <SwitchParameter>

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

-RegistryDataType <RegDataType>

Specifies the type of the value data to be set in the registry. The acceptable values for this parameter are:  None, REG_SZ, REG_DWORD, REG_QWORD, and REG_MULTI_SZ.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-RegistryKeyword <String>

Specifies the name of the registry keyword to be created.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-RegistryValue <String[]>

Specifies the value of the advanced property.

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

Prompts you for confirmation before running the cmdlet.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData

Notes

None

Examples

EXAMPLE 1

This example creates a new advanced property on the network adapter named MyAdapter with the registry keyword MyKeyword of type REG_SZ with the value 1.

PS C:\> New-NetAdapterAdvancedProperty –Name MyAdapter -RegistryKeyword "MyKeyword" -RegistryValue "1" -RegistryDataType REG_SZ

EXAMPLE 2

This example creates a new advanced property on the network adapter named MyAdapter with the registry keyword MyKeyword of type REG_SZ with the value 1 and the network adapter is specified to not restart. Note: Many advanced properties require restarting the network adapter before the new settings take effect.

PS C:\> New-NetAdapterAdvancedProperty -Name MyAdapter -RegistryKeyword "MyKeyword" -RegistryValue "1" -RegistryDataType REG_SZ -NoRestart

EXAMPLE 3

This example gets a network adapter and creates a new advanced property on the network adapter named Ethernet 3.

PS C:\> $networkAdapter3 = Get-NetAdapter –Name "Ethernet 3"
PS C:\> New-NetAdapterAdvancedProperty –InputObject $networkAdapter3 -RegistryKeyword "MyKeyword" -RegistryValue "1" -RegistryDataType REG_SZ

This is a version of the cmdlet that creates a new advanced property on the network adapter named Ethernet 3 using wildcard characters and the pipeline. Note: Use of wildcard characters is not allowed for the network adapter identifier as part of this cmdlet, but can be used via the pipeline.
PS C:\> Get-NetAdapter –Name "Ethernet 3" | New-NetAdapterAdvancedProperty -RegistryKeyword "MyKeyword" -RegistryValue "1" -RegistryDataType REG_SZ

Online Version
Get-NetAdapterAdvancedProperty
Remove-NetAdapterAdvancedProperty
Reset-NetAdapterAdvancedProperty
Set-NetAdapterAdvancedProperty