Windows PowerShell command on Get-command Disable-NetAdapter

NAME

Disable-NetAdapter

SYNOPSIS

Disables a network adapter.

SYNTAX

Disable-NetAdapter [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-PassThru]

[-ThrottleLimit ] [-Confirm] [-WhatIf] []

Disable-NetAdapter [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] -InputObject

[-Confirm] [-WhatIf] []

Disable-NetAdapter [-AsJob] [-CimSession ] [-IncludeHidden] [-PassThru] [-ThrottleLimit ]

-InterfaceDescription [-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. 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.

PARAMETERS

-AsJob []

ps_cimcommon_asjob Required? false Position? named Default value 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. Required? false Position? named Default value 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. Required? false 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. Required? true Position? named Default value Accept pipeline input? true (ByValue) 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. Required? true Position? named Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? true

-Name

Specifies an array of network adapter names. Required? true Position? 1 Default value 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. Required? false Position? named Default value 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 PowerShellr 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. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-Confirm []

Prompts you for confirmation before running the cmdlet.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.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 This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

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.

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 Get-Help -Name about_Preference_Variables cmdlet.

PS C:\>Disable-NetAdapter -Name "MyAdapter" -Confirm:$False

This command disables the network adapter named MyAdapter.