Remove-SCHardwareProfile
Remove-SCHardwareProfile
Removes a hardware profile object from the VMM library.
Syntax
Parameter Set: Default
Remove-SCHardwareProfile [-HardwareProfile] <HardwareProfile> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-SCHardwareProfile cmdlet removes one or more hardware profile objects from the Virtual Machine Manager (VMM) library.
This cmdlet returns the object upon success, with the property MarkedForDeletion set to TRUE, or returns an error message upon failure.
Parameters
-HardwareProfile<HardwareProfile>
Specifies a hardware profile object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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
- This cmdlet requires a VMM hardware profile object, which can be retrieved by using the Get-SCHardwareProfile cmdlet.
Examples
Example 1: Remove a specific hardware profile from the library
The first command gets the hardware profile object named NewHWProfile01 from the VMM library, and then stores the object in the $HWProfile variable.
The second command deletes NewHWProfle01 from the library, prompting you for confirmation before completing the operation.
PS C:\> $HWProfile = Get-SCHardwareProfile | where { $_.Name -eq "NewHWProfile01"}
PS C:\> Remove-SCHardwareProfile -HardwareProfile $HWProfile -Confirm
Example 2: Remove all hardware profiles without being prompted to confirm each deletion
This command gets all hardware profile objects in the library, and then passes each profile object to the Remove-SCHardwareProfile cmdlet by using the pipeline operator. That cmdlet removes each hardware profile. This command does not specify the Confirm parameter. The cmdlet does not confirm whether you want to delete these hardware profile objects.
PS C:\> Get-SCHardwareProfile | Remove-SCHardwareProfile