Disconnect-VMNetwork Adapter

Module:
hyper-v
Disconnects a virtual network adapter from a virtual switch or Ethernet resource pool.

Syntax 

Disconnect-VMNetworkAdapter
          [-VMName] <String[]>
          [[-Name] <String[]>]
          [-CimSession <CimSession[]>]
          [-ComputerName <String[]>]
          [-Credential <PSCredential[]>]
          [-Passthru]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Disconnect-VMNetworkAdapter
          [-VMNetworkAdapter] <VMNetworkAdapter[]>
          [-Passthru]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Description

The Disconnect-VMNetworkAdapter cmdlet disconnects a virtual network adapter from a virtual switch or Ethernet resource pool.

Examples

Example 1 

PS C:\> Disconnect-VMNetworkAdapter -VMNetworkAdapter Test1

Disconnects virtual network adapter Test1.

Example 2 

PS C:\> Get-VMNetworkAdapter -VMName * | Where-Object {$_.SwitchName -eq 'InternetAccess'} | Disconnect-VMNetworkAdapter

Disconnects all virtual network adapters whose SwitchName is InternetAccess in all virtual machines on the local server that runs Hyper-V.

Required Parameters

-VMName

Specifies the name of the virtual machine in which the virtual network adapter is to be disconnected.

Type: String[]
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VMNetworkAdapter

Specifies the virtual network adapter to be disconnected.

Type: VMNetworkAdapter[]
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional Parameters

-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[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName

Specifies one or more Hyper-V hosts on which a virtual network adapter is to be disconnected. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Type: String[]
Position: Named
Default value: None
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
Accept pipeline input: False
Accept wildcard characters: False
-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type: PSCredential[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies the name of the virtual network adapter to be disconnected.

Type: String[]
Aliases: VMNetworkAdapterName
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Passthru

Specifies that a Microsoft.HyperV.PowerShell.VMNetworkAdapter object is to be passed through to the pipeline representing the virtual network adapter to be disconnected.

Type: SwitchParameter
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
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Outputs

None by default; Microsoft.HyperV.PowerShell.VMNetworkAdapter if PassThru is specified.