Remove-SCVirtualNetwork
Applies To: System Center 2012 - Virtual Machine Manager
Remove-SCVirtualNetwork
Removes a virtual network from a host managed by VMM.
Syntax
Parameter Set: Host
Remove-SCVirtualNetwork [-VirtualNetwork] <VirtualNetwork> [-JobGroup <Guid> ] [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]
Parameter Set: Cluster
Remove-SCVirtualNetwork [-ClusterVirtualNetwork] <ClusterVirtualNetwork> [-JobGroup <Guid> ] [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed 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<ClusterVirtualNetwork>
Specifies a cluster virtual network object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-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 |
<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 a specific virtual network from a host.
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.
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