Set-NetAdapterBinding
Set-NetAdapterBinding
Sets the binding state of a transport or filter on a network adapter.
Syntax
Parameter Set: ByName
Set-NetAdapterBinding [-Name] <String[]> [-AllBindings] [-AsJob] [-CimSession <CimSession[]> ] [-ComponentID <String[]> ] [-DisplayName <String[]> ] [-Enabled <Boolean> ] [-IncludeHidden] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByInstanceID
Set-NetAdapterBinding -InterfaceDescription <String[]> [-AllBindings] [-AsJob] [-CimSession <CimSession[]> ] [-ComponentID <String[]> ] [-DisplayName <String[]> ] [-Enabled <Boolean> ] [-IncludeHidden] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Set-NetAdapterBinding -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Enabled <Boolean> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-AllBindings
Sets filters or transports that are not visible by default.
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 |
-ComponentID<String[]>
Specifies the underlying name of the transport or filter in the following form.
● ms_xxxx, such as ms_tcpip.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-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? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-Enabled<Boolean>
Sets the enabled state of the transport or filter. The acceptable values for this parameter are: $true or $false.
Aliases |
none |
Required? |
false |
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.
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? |
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 |
-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 |
-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_NetAdapter BindingSettingData[]
The
Microsoft.Management.Infrastructure.CimInstanceobject 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_NetAdapter BindingSettingData
The
Microsoft.Management.Infrastructure.CimInstanceobject 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 enables TCP/IPv4 on the network adapter named MyAdapter.
PS C:\> Set-NetAdapterBinding -Name MyAdapter -DisplayName "Internet Protocol Version 4 (TCP/IPv4)" -Enabled $true
EXAMPLE 2
This example disables TCP/IPv4 on the network adapter named MyAdapter.
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
EXAMPLE 3
This example enables TCPv4/IPv4 on the network adapter named MyAdapter using the component ID.
PS C:\> Set-NetAdapterBinding -Name MyAdapter -ComponentID ms_tcpip -Enabled $true