Set-NetAdapterBinding

Module:
netadapter
Sets the binding state of a transport or filter on a network adapter.

Syntax

Set-NetAdapterBinding
   [-Name] <String[]>
   [-AllBindings]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-ComponentID <String[]>]
   [-DisplayName <String[]>]
   [-Enabled <Boolean>]
   [-IncludeHidden]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-Confirm]
   [-WhatIf]
Set-NetAdapterBinding
   [-AllBindings]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-ComponentID <String[]>]
   [-DisplayName <String[]>]
   [-Enabled <Boolean>]
   [-IncludeHidden]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   -InterfaceDescription <String[]>
   [-Confirm]
   [-WhatIf]
Set-NetAdapterBinding
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Enabled <Boolean>]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   -InputObject <CimInstance[]>
   [-Confirm]
   [-WhatIf]

Description

The Set-NetAdapterBinding cmdlet sets the binding state of a transport or filter on a network adapter. By default only visible bindings are set unless the AllBindings parameter is specified. If only enabling or disabling bindings, then the Enable-NetAdapterBinding or Disable-NetAdapterBinding cmdlets can be used. Note: Disabling and enabling a network adapter binding can automatically enable or disable other network adapter bindings.

Examples

EXAMPLE 1

PS C:\>Set-NetAdapterBinding -Name MyAdapter -DisplayName "Internet Protocol Version 4 (TCP/IPv4)" -Enabled $true

This example enables TCP/IPv4 on the network adapter named MyAdapter.

EXAMPLE 2

PS C:\>Set-NetAdapterBinding -Name MyAdapter -DisplayName "Internet Protocol Version 4 (TCP/IPv4)" -Enabled $false


This is a version of the cmdlet that disables TCP/IPv4 on the network adapter named MyAdapter using wildcard characters in the display name.
PS C:\>Set-NetAdapterBinding -Name MyAdapter -DisplayName "Inter* (TCP/IPv4)" -Enabled $false

This example disables TCP/IPv4 on the network adapter named MyAdapter.

EXAMPLE 3

PS C:\>Set-NetAdapterBinding -Name MyAdapter -ComponentID ms_tcpip -Enabled $true

This example enables TCPv4/IPv4 on the network adapter named MyAdapter using the component ID.

Required Parameters

-InputObject

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

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-InterfaceDescription

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.

Type:String[]
Aliases:ifDesc
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:True
-Name

Specifies the name of the network adapter.

Type:String[]
Aliases:ifAlias, InterfaceAlias
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:True

Optional Parameters

-AllBindings

Sets filters or transports that are not visible by default.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ComponentID

Specifies the underlying name of the transport or filter in the following form. ● ms_xxxx, such as ms_tcpip.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:True
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DisplayName

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

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:True
-Enabled

Sets the enabled state of the transport or filter. The acceptable values for this parameter are: $true or $false.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
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.

Type:SwitchParameter
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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

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

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 BindingSettingData

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.