Remove-SCVirtualNetworkAdapter

Remove-SCVirtualNetworkAdapter

Removes a virtual network adapter object from VMM.

Syntax

Parameter Set: SlotIdSpecified
Remove-SCVirtualNetworkAdapter -JobGroup <Guid]> -SlotID <Int32]> [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VirtualNicSpecified
Remove-SCVirtualNetworkAdapter [-VirtualNetworkAdapter] <VirtualNetworkAdapter> [-JobGroup <Guid]> ] [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-SCVirtualNetworkAdapter cmdlet removes one or more virtual network adapter objects from a virtual machine, virtual machine template, or hardware profile used in a Virtual Machine Manager (VMM) environment.

This cmdlet returns the object upon success, with the property MarkedForDeletion set to TRUE, or returns an error message upon failure.

Parameters

-JobGroup<Guid]>

Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

-OnBehalfOfUser<System.String>

-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

-SlotID<Int32]>

Specifies a numerical ID used to identify a device.

-VirtualNetworkAdapter<VirtualNetworkAdapter>

Specifies a virtual network adapter object for a virtual machine. The number of virtual adapters for each type of host are:

-- Hyper-V: Up to four emulated adapters per virtual machine, and up to eight synthetic adapters per virtual machine. No driver is available for an emulated network adapter on a Windows Server 2003 x64 guest.
-- VMware ESX: Up to four emulated adapters per virtual machine.
-- Citrix XenServer: Up to seven emulated adapters per virtual machine.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Notes

• This cmdlet requires a VMM virtual network adapter object, which can be retrieved by using the Get-SCVirtualNetworkAdapter cmdlet.

Examples

Example 1: Remove a virtual network adapter with the specified MAC address from a virtual machine

The first command gets the virtual machine object named VM01, and then stores the object in the $VM variable.

The second command gets the virtual network adapter object on VM01 that has the specified MAC address, and then stores the object in the $Adapter variable.

The last command removes the virtual network adapter stored in $Adapter from VM01.

PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $Adapter = Get-SCVirtualNetworkAdapter -VM $VM | where { $_.PhysicalAddress -eq "00:16:D3:CC:00:1B" }
PS C:\> Remove-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter

Example 2: Remove a virtual network adapter connected to a specific virtual network from a virtual machine

The first command gets the virtual machine object named VM02, and then stores the object in the $VM variable.

The second command gets the virtual network adapter object on VM02 that is connected to the specified virtual network, and then stores the object in the $Adapter variable.

The last command removes the virtual network adapter object stored in $Adapter from VM02.

PS C:\> $VM = Get-SCVirtualMachine -Name "VM02"
PS C:\> $Adapter = Get-SCVirtualNetworkAdapter -VM $VM | where { $_.VirtualNetwork -eq "ExternalVirtualNetwork01" }
PS C:\> Remove-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter

Example 3: Remove the only virtual network adapter from a virtual machine

The first command gets the virtual machine object named VM03, and then stores the object in the $VM variable.

The second command gets the virtual network adapter object on VM03, and then stores the object in the $Adapter variable. This example assumes that VM03 has only one virtual network adapter.

The last command removes the virtual network adapter object stored in $Adapter from VM03.

PS C:\> $VM = Get-SCVirtualMachine -Name "VM03"
PS C:\> $Adapter = Get-SCVirtualNetworkAdapter -VM $VM
PS C:\> Remove-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter

Example 4: Remove all virtual network adapters from a virtual machine

The first command gets the virtual machine object named VM04, and then stores the object in the $VM variable.

The second command gets all virtual network adapter objects on VM04, and then stores the objects in the $Adapters object array.

The last command passes each object stored in $Adapters to Remove-SCVirtualNetworkAdapter. That cmdlet removes each virtual network adapter object from VM04.

PS C:\> $VM = Get-SCVirtualMachine -Name "VM04"
PS C:\> $Adapters = Get-SCVirtualNetworkAdapter -VM $VM
PS C:\> $Adapters | Remove-SCVirtualNetworkAdapter

Example Example 5: Remove the second virtual network adapter from a virtual machine that has three virtual network adapters.

The first command gets the virtual machine object named VM05, and then stores the object in the $VM variable.

The second command gets all virtual network adapter objects on VM05, and then stores the objects in the $Adapters object array. This example assumes that VM05 has three virtual network adapters.

The last command passes the second virtual network adapter object, $Adapters [1], to the Remove-SCVirtualNetworkAdapter cmdlet by using the pipeline operator. That cmdlet removes this virtual network adapter object from VM05.

PS C:\> $VM = Get-SCVirtualMachine -Name "VM05"
PS C:\> $Adapters = Get-SCVirtualNetworkAdapter -VM $VM
PS C:\> $Adapters[1] | Remove-SCVirtualNetworkAdapter

Related topics

Get-SCVirtualNetworkAdapter

New-SCVirtualNetworkAdapter

Set-SCVirtualNetworkAdapter

Get-SCVirtualMachine