Remove-SCVMConfiguration
Applies To: System Center 2012 - Virtual Machine Manager
Remove-SCVMConfiguration
Removes a virtual machine configuration object from VMM.
Syntax
Parameter Set: Default
Remove-SCVMConfiguration [-VMConfiguration] <BaseVMConfiguration> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Remove-SCVMConfiguration cmdlet removes a virtual machine configuration object from System Center Virtual Machine Manager (VMM).
For more information about Remove-SCVMConfiguration, type: "Get-Help Remove-SCVMConfiguration -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 |
-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 |
-VMConfiguration<BaseVMConfiguration>
Specifies a virtual machine configuration 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.
Notes
- Requires a VMM virtual machine configuration object, which can be objtained by using the Get-SCVMConfiguration cmdlet.
Examples
1: Remove a virtual machine configuration.
The first command gets all virtual machine configuration objects, selects the object named VMConfig01 and then stores that virtual machine configuration object in the $VMConfig variable.
The second command removes the virtual machine configuration in $VMConfig (VMConfig01).
PS C:\> $VMConfig = Get-SCVMConfiguration -All | where {$_.Name -eq "VMConfig01"}
PS C:\> Remove-SCVMConfiguration -VMConfiguration $VMConfig