Remove-SCLogicalNetwork
Applies To: System Center 2012 - Virtual Machine Manager
Remove-SCLogicalNetwork
Deletes a logical network object.
Syntax
Parameter Set: Default
Remove-SCLogicalNetwork [-LogicalNetwork] <LogicalNetwork> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Remove-SCLogicalNetwork cmdlet deletes a System Center Virtual Machine Manager (VMM) logical network object.
NOTE: If any logical network definition, virtual machine template, or service template object references a specific logical network object, that logical network object will not be deleted.
For more information about Remove-SCLogicalNetwork, type: "Get-Help Remove-SCLogicalNetwork -online".
Parameters
-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 |
-LogicalNetwork<LogicalNetwork>
Specifies a logical network. A logical network is a named grouping of IP subnets and VLANs that is used to organize and simplify network assignments.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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 |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
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.
- LogicalNetwork
Notes
- Requires a VMM logical network object, which can be retrieved by using the Get-SCLogicalNetwork cmdlet.
Examples
1: Delete a logical network
The first command gets the logical network object named LogicalNetwork01 and stores it in the $LogicalNetwork variable.
The second command deletes the logical network object stored in $LogicalNetwork.
PS C:\> $LogicalNetwork = Get-SCLogicalNetwork "LogicalNetwork01"
PS C:\> Remove-SCLogicalNetwork -LogicalNetwork $LogicalNetwork