Remove-SCVirtualNetwork

Removes a virtual network from a host managed by VMM.

Description

The Remove-SCVirtualNetwork cmdlet removes one or more virtual network objects from System Center Virtual Machine Manager (VMM). 

This cmdlet returns the object upon success (with the property MarkedForDeletion set to True) or returns an error message upon failure.

For more information about Remove-SCVirtualNetwork, type: "Get-Help Remove-SCVirtualNetwork -online".

Parameters

ClusterVirtualNetwork

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0 
Specifies a cluster virtual network object.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

JobGroup

Required? false
Accept Pipeline Input? false
Position? named 
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

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

VirtualNetwork

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0 
Specifies a virtual network object.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

JobGroup

Required? false
Accept Pipeline Input? false
Position? named 
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

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Examples

1: Remove a specific virtual network from a host. 
PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01.Contoso.com" 
PS C:\> $Network = Get-SCVirtualNetwork -VMHost $VMHost -Name "InternalVNet01"
PS C:\> Remove-SCVirtualNetwork -VirtualNetwork $Network -Confirm

The first command gets the host object named VMHost01 and stores the object in the $VMHost variable.

The second command gets the virtual network object named InternalVNet01 configured on VMHost01 and stores the object in the $Network variable. 

The last command removes InternalVNet01 from VMHost01, prompting you for confirmation before continuing the action.

See Also