Remove-SCVMXComputerConfiguration
Removes a VMX computer configuration object from VMM.
Syntax
Remove-SCVMXComputerConfiguration
[-VMXComputerConfiguration] <VmxMachineConfiguration>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Remove-SCVMXComputerConfiguration cmdlet removes one or more VMX computer configuration objects from the Virtual Machine Manager (VMM) database.
This cmdlet returns the object upon success (with the property MarkedForDeletion set to True) or returns an error message upon failure.
Examples
Example 1: Remove all VMX computer configurations without being prompted to confirm each deletion
PS C:\> $VMXComputerConfigs = Get-SCVMXComputerConfiguration -VMMServer "VMMServer01.Contoso.com"
PS C:\> $VMXComputerConfigs | Remove-SCVMXComputerConfigurationThe first command retrieves all VMX computer configuration objects from the VMM database on VMMServer01 and stores these objects in the $VMXComputerConfigs object array.
The second command passes each object in $VMXComputerConfigs to Remove-VMXComputerConfiguration, which removes each VMX computer configuration object.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobVariable
Specifies that job progress is tracked and stored in the variable named by this parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMXComputerConfiguration
Specifies a VMX computer configuration object.
| Type: | VmxMachineConfiguration |
| Aliases: | MachineConfig, VMXMachineConfig |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Notes
- Requires a VMM VMX computer configuration object, which can be retrieved by using the Get-SCVMXComputerConfiguration cmdlet.