Disable-NetAdapter

Disables a network adapter.

Syntax

Disable-NetAdapter
       [-Name] <String[]>
       [-AsJob]
       [-CimSession <CimSession[]>]
       [-IncludeHidden]
       [-PassThru]
       [-ThrottleLimit <Int32>]
       [-Confirm]
       [-WhatIf]
Disable-NetAdapter
       [-AsJob]
       [-CimSession <CimSession[]>]
       [-PassThru]
       [-ThrottleLimit <Int32>]
       -InputObject <CimInstance[]>
       [-Confirm]
       [-WhatIf]
Disable-NetAdapter
       [-AsJob]
       [-CimSession <CimSession[]>]
       [-IncludeHidden]
       [-PassThru]
       [-ThrottleLimit <Int32>]
       -InterfaceDescription <String[]>
       [-Confirm]
       [-WhatIf]

Description

The Disable-NetAdapter cmdlet disables a network adapter. A network adapter must be enabled to connect to a network. This cmdlet causes loss of network connectivity of the specified network adapter. Note: Do not disable the network adapter being used to manage a remote computer. By default the user will be prompted to confirm the network adapter should be disabled

Examples

EXAMPLE 1

PS C:\>Disable-NetAdapter -Name "Ethernet 2"


A version of the cmdlet that uses position.
PS C:\>Disable-NetAdapter "Ethernet 2"


A version of the cmdlet that uses position and wildcard characters.
PS C:\>Disable-NetAdapter E*2

This example disables a network adapter named Ethernet Connection 2.

EXAMPLE 2

PS C:\>Disable-NetAdapter -Name VMGuestTrafficAdapter -CimSession HyperVServer4

This example disables the network adapter named VMGuestTrafficAdapter on the remote computer named HyperVServer4.

EXAMPLE 3

PS C:\>Disable-NetAdapter -Name *

This example disables all network adapters. Note: If remotely managing a computer, then all network connectivity will be lost and cannot be remotely restored.

EXAMPLE 4

PS C:\>Disable-NetAdapter -Name MyAdapter
Confirm 
Are you sure you want to perform this action? 
Disable-NetAdapter ŕ×îMyAdapter' 


[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"):Y


A version of the cmdlet that overrides the default confirmation prompt when disabling the network adapter named MyAdapter. For more information about changing the default confirmation prompt, see the [CODE_Snippit]$ConfirmPreference[CODE_Snippit] variable by running the [CODE_Snippit]Get-Help -Name about_Preference_Variables[CODE_Snippit] cmdlet.
PS C:\>Disable-NetAdapter -Name MyAdapter -Confirm:$false

This example disables the network adapter named MyAdapter.

Parameters

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

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
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: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
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:False
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.

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[]

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

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.