Disable-NetAdapterBinding
Disables a binding to a network adapter.
Syntax
Disable-NetAdapterBinding
[-Name] <String[]>
[-ComponentID <String[]>]
[-DisplayName <String[]>]
[-IncludeHidden]
[-AllBindings]
[-PassThru]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disable-NetAdapterBinding
-InterfaceDescription <String[]>
[-ComponentID <String[]>]
[-DisplayName <String[]>]
[-IncludeHidden]
[-AllBindings]
[-PassThru]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disable-NetAdapterBinding
-InputObject <CimInstance[]>
[-PassThru]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Disable-NetAdapterBinding cmdlet disables a binding to a network adapter. Running this cmdlet causes loss of network connectivity depending on the binding that is disabled. Disabling some adapter bindings can automatically enable other network adapter bindings.
Examples
Example 1: Disable TCP/IPv4 on a network adapter then restart it
PS C:\> Disable-NetAdapterBinding -Name "MyAdapter" -DisplayName "Internet Protocol Version 4 (TCP/IPv4)"
This command disables TCP/IPv4 on the network adapter named MyAdapter using the display name Internet Protocol Version 4 (TCP/IPv4) and restarts the network adapter.
Example 2: Disable TCP/IPv4 on a specific adapter using a component ID
PS C:\> Disable-NetAdapterBinding -Name "MyAdapter" -ComponentID ms_tcpip
This command disables TCP/IPv4 on the network adapter named MyAdapter using the component ID ms_tcpip and restarts the network adapter.
Example 3: Disable TCP/IPv4 on a specified adapter using a wildcard character
PS C:\> Disable-NetAdapterBinding -Name "MyAdapter" -DisplayName "Inter* (TCP/IPv4)"
This command disables TCP/IPv4 on network adapter named MyAdapter using a wildcard character in the display name and restarts the network adapter.
Parameters
-AllBindings
Indicates that this cmdlet disables all protocols and filters associated with this network adapter that can be disabled. Some protocols and filters may be mandatory and therefore cannot be disabled. Disabling some network adapter bindings can cause other network adapter bindings to automatically be enabled. Each network adapter binding is disabled only once so after running with this parameter there may still be network adapter bindings that are enabled.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
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 |
Position: | Named |
Default value: | None |
Required: | False |
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[] |
Aliases: | Session |
Position: | Named |
Default value: | None |
Required: | False |
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 asms_tcpip
.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | 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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IncludeHidden
Indicates that the cmdlet includes both visible and hidden network adapters in the operation. If a wildcard character is used to identify a network adapter, then the wildcard character is matched against both hidden and visible adapters.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
Required: | True |
Accept pipeline input: | True |
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[] |
Aliases: | ifDesc, InstanceID |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies an array of network adapter names.
Type: | String[] |
Aliases: | ifAlias, InterfaceAlias |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
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
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.