Share via


Remove-SCGuestOSProfile

Removes a guest operating system profile object from VMM.

Syntax

Default (Default)

Remove-SCGuestOSProfile
    [-GuestOSProfile] <GuestOSProfile>
    [-Force]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-SCGuestOSProfile cmdlet removes one or more guest operating system profile objects from the VMM library.

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 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 operating system profile object named NewOSProfile01 and stores the object in the $OSProfile variable.

The second command removes the guest operating system profile stored in $OSProfile, prompting for confirmation before completing the operation.

Example 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 operating system profile objects from the VMM library.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GuestOSProfile

Specifies a guest operating system profile object.

Parameter properties

Type:GuestOSProfile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

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