Remove-SCVMHostNetworkAdapter
Applies To: System Center 2012 - Virtual Machine Manager
Remove-SCVMHostNetworkAdapter
Removes a physical host network adapter object from a virtual network that is configured on a host managed by VMM.
Syntax
Parameter Set: Default
Remove-SCVMHostNetworkAdapter [-VirtualNetwork] <VirtualNetwork> -VMHostNetworkAdapter <HostNetworkAdapter> [-JobGroup <Guid> ] [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Remove-SCVMHostNetworkAdapter removes one or more physical host network adapter objects from a virtual network that is configured on a host managed by System Center Virtual Machine Manager (VMM).
For more information about Remove-SCVMHostNetworkAdapter, type: "Get-Help Remove-SCVMHostNetworkAdapter -online".
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualNetwork<VirtualNetwork>
Specifies a virtual network object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-VMHostNetworkAdapter<HostNetworkAdapter>
Specifies a physical network adapter object on a host to which virtual machines deployed on that host can connect.
Example format: -VMHostNetworkAdapter $VMHostNIC
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
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.
Examples
1: Remove the physical host network adapter from a specific virtual network.
The first command gets the host object named VMHost01 and stores the object in the $VMHost variable.
The second command gets the host network adapter object named HostAdapter01 and stores the object in the $HostAdapter variable.
The third command gets the virtual network object named ExternalVirtualNetwork01 from VMHost01 and stores the object in the $VirtualNetwork variable.
The last command removes the host network adapter stored in $HostAdapter from the virtual network stored in $VirtualNetwork. The Confirm parameter prompts you to confirm whether you want to delete the adapter from VMM.
PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01.Contoso.com"
PS C:\> $HostAdapter = Get-SCVMHostNetworkAdapter -VMHost $VMHost -Name "HostAdapter01"
PS C:\> $VirtualNetwork = Get-SCVirtualNetwork -VMHost $VMHost -Name "ExternalVirtualNetwork01"
PS C:\> Remove-SCVMHostNetworkAdapter -VMHostNetworkAdapter $HostAdapter -VirtualNetwork $VirtualNetwork -Confirm