Remove-SCVirtualNetworkAdapter
Removes a virtual network adapter object from VMM.
Syntax
VirtualNicSpecified
Remove-SCVirtualNetworkAdapter
[-VirtualNetworkAdapter] <VirtualNetworkAdapter>
[-JobGroup <Guid>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-WhatIf]
[-Confirm]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
SlotIdSpecified
Remove-SCVirtualNetworkAdapter
-SlotID <Int32>
-JobGroup <Guid>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-WhatIf]
[-Confirm]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
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.
Examples
Example 1: Remove a virtual network adapter with the specified MAC address from a virtual machine
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
The first command gets the virtual machine object named VM01 and 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 stores the object in the $Adapter variable.
The last command removes the virtual network adapter stored in $Adapter from VM01.
Example 2: Remove a virtual network adapter connected to a specific virtual network from a virtual machine
PS C:\> $VM = Get-SCVirtualMachine -Name "VM02"
PS C:\> $Adapter = Get-SCVirtualNetworkAdapter -VM $VM | where { $_.VirtualNetwork -eq "ExternalVirtualNetwork01" }
PS C:\> Remove-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter
The first command gets the virtual machine object named VM02 and 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 stores the object in the $Adapter variable.
The last command removes the virtual network adapter object stored in $Adapter from VM02.
Example 3: Remove the only virtual network adapter from a virtual machine
PS C:\> $VM = Get-SCVirtualMachine -Name "VM03"
PS C:\> $Adapter = Get-SCVirtualNetworkAdapter -VM $VM
PS C:\> Remove-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter
The first command gets the virtual machine object named VM03 and stores the object in the $VM variable.
The second command gets the virtual network adapter object on VM03 and 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.
Example 4: Remove all virtual network adapters from a virtual machine
PS C:\> $VM = Get-SCVirtualMachine -Name "VM04"
PS C:\> $Adapters = Get-SCVirtualNetworkAdapter -VM $VM
PS C:\> $Adapters | Remove-SCVirtualNetworkAdapter
The first command gets the virtual machine object named VM04 and stores the object in the $VM variable.
The second command gets all virtual network adapter objects on VM04 and stores the objects in the $Adapters object array.
The last command passes each object stored in $Adapters to Remove-SCVirtualNetworkAdapter, which removes each virtual network adapter object from VM04.
Example 5: Remove the second virtual network adapter from a virtual machine that has three virtual network adapters
PS C:\> $VM = Get-SCVirtualMachine -Name "VM05"
PS C:\> $Adapters = Get-SCVirtualNetworkAdapter -VM $VM
PS C:\> $Adapters[1] | Remove-SCVirtualNetworkAdapter
The first command gets the virtual machine object named VM05 and stores the object in the $VM variable.
The second command gets all virtual network adapter objects on VM05 and 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, which removes this virtual network adapter object from VM05.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-JobGroup
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.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VirtualNicSpecified
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-JobVariable
Specifies that job progress is tracked and stored in the variable named by this parameter.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OnBehalfOfUser
Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OnBehalfOfUserRole
Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.
Parameter properties
| Type: | UserRole |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SlotID
Specifies a numerical ID used to identify a device.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SlotIdSpecified
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VirtualNetworkAdapter
Specifies a virtual network adapter object for a virtual machine.
Types of hosts support the following number of virtual network adapters:
- Hyper-V. Up to four emulated adapters per virtual machine. There is no driver available for an emulated network adapter on a Windows Server 2003 x64 guest operating system.
- Hyper-V. Up to eight synthetic adapters per virtual machine.
- VMware ESX. Up to four emulated adapters per virtual machine.
- Citrix XenServer. Up to seven emulated adapters per virtual machine.
Parameter properties
| Type: | VirtualNetworkAdapter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VirtualNicSpecified
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Notes
- Requires a VMM virtual network adapter object, which can be retrieved by using the Get-SCVirtualNetworkAdapter cmdlet.