Disable-NetAdapter

  • Reference
Module:
NetAdapter

Disables a network adapter.

Syntax

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

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. Do not disable the network adapter being used to manage a remote computer. By default the user is prompted to confirm that the network adapter should be disabled.

Examples

Example 1: Disable a network adapter by name

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 command disables a network adapter named Ethernet Connection 2.

Example 2: Disable a network adapter on a remote computer

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

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

Example 3: Disable all network adapters

PS C:\> Disable-NetAdapter -Name "*"

This command disables all network adapters. If you are remotely managing a computer, then all network connectivity is lost and cannot be remotely restored.

Example 4: Disable a network adapter

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 $ConfirmPreference variable by running the [CODE_Snippit]Get-Help -Name about_Preference_Variables[CODE_Snippit] cmdlet.
PS C:\> Disable-NetAdapter -Name "MyAdapter" -Confirm:$False

This command disables the network adapter named MyAdapter.

Parameters

-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

-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

-IncludeHidden

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.

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

CimInstance[]

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

CimInstance

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.