Remove-SCGuestOSProfile

Removes a guest operating system profile object from VMM.

Description

The Remove-SCGuestOSProfile cmdlet removes one or more guest operating system profile objects from the System Center 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.

For more information about Remove-SCGuestOSProfile, type: "Get-Help Remove-SCGuestOSProfile -online".

Parameters

GuestOSProfile

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0 
Specifies a guest operating system profile object.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

Force

Required? false
Accept Pipeline Input? false
Position? named 
Forces the operation to complete. 

For example:
- Remove-SCSCVMHost -Force
  Forces the removal of a host object from the VMM database.

- Stop-SCVirtualMachine -Force
  Stops a virtual machine.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

Requires a VMM guest operating system profile object, which can be retrieved by using the Get-SCGuestOSProfile cmdlet.

Examples

1: Remove a specific guest operating system profile from the library. 
PS C:\> $OSProfile = Get-SCGuestOSProfile -Name "NewOSProfile01"
PS C:\> Remove-SCGuestOSProfile -GuestOSProfile $OSProfile -Confirm

The first command gets the guest OS profile object named NewOSProfile01 and stores the object in the $OSProfile variable.

The second command removes the guest OS profile stored in $OSProfile, prompting for confirmation before completing the operation.
2: Remove all operating system profiles without being prompted to confirm each deletion. 
PS C:\> $OSProfiles = Get-SCGuestOSProfile -VMMServer "VMMServer01.Contoso.com"
PS C:\> $OSProfiles | Remove-SCGuestOSProfile

The first command gets all operating system profile objects from VMMServer01 and stores the objects in the $OSProfiles object array.

The second command passes each object in $OSProfiles to the Remove-OSProfile cmdlet, which removes each of the guest OS profile objects from the VMM library.

See Also