Set-NetAdapter

Set-NetAdapter [-Name*] <String[]> [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-MacAddress <String>][-NoRestart] [-PassThru] [-ThrottleLimit <Int32>] [-VlanID <UInt16>] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetAdapter [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-MacAddress <String>] [-NoRestart][-PassThru] [-ThrottleLimit <Int32>] [-VlanID <UInt16>] -InterfaceDescription* <String[]> [-Confirm] [-WhatIf][<CommonParameters>]

Set-NetAdapter [-AsJob] [-CimSession <CimSession[]>] [-MacAddress <String>] [-NoRestart] [-PassThru][-ThrottleLimit <Int32>] [-VlanID <UInt16>] -InputObject* <CimInstance[]> [-Confirm] [-WhatIf] [<CommonParameters>]

The Set-NetAdapter cmdlet sets the basic properties of a network adapter such as virtual LAN (VLAN) identifier (ID) and MAC address. These changes could disrupt proper networking functionality. Other network adapter properties may be set by using a cmdlet such as the Set-NetAdapterRss, Set-NetAdapterLso, or Set-NetAdapterAdvancedProperty cmdlets.

Parameters

-AsJob [<SwitchParameter>]

ps_cimcommon_asjob

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

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

-InputObject <CimInstance[]>

This value is required
Accepts pipeline input ByValue

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

-InterfaceDescription <String[]>

This value is required
Accepts pipeline input ByPropertyName
Accepts wildcard characters

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.

-MacAddress <String>

Specifies the current MAC address of the network adapter. Dashes are optional as part of the input. Not all network adapters support setting the MAC address. The address passed in is also saved in the network addresses property without dashes.

-Name <String[]>

This value is required
Accepts wildcard characters

Specifies an array of network adapter names.

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

-PassThru [<SwitchParameter>]

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

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

-VlanID <UInt16>

Specifies the VLAN ID of the network adapter. Not all network adapters support setting the VLAN ID.

-Confirm [<SwitchParameter>]

Default value is false

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

-WhatIf [<SwitchParameter>]

Default value is false

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.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter[]

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_NetAdapter

Examples

Set the specified network adapter to a different VLAN ID:
```
PS C:\> Set-NetAdapter -Name "Ethernet 1" -VlanID 10
```
This command sets the network adapter named Ethernet 1 to have VLAN ID 10.
Set the MAC address of the specified network adapter:
```
PS C:\> Set-NetAdapter -Name "Ethernet 1" -MacAddress "00-10-18-57-1B-0D"
```
This command sets the MAC address of the network adapter named Ethernet 1.
Set the MAC address for network adapters matching an interface description with a specific pattern:
```
PS C:\> Set-NetAdapter -InterfaceDescription "B*2" -MacAddress "00-10-18-57-1B-0D"
```
This command sets the MAC address of a network adapter with the interface description matching the pattern B*2.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands