Edit

Remove-CMProgram

  • Reference
Module:
ConfigurationManager

Remove a program from a package.

Syntax

Remove-CMProgram
      [-Force]
      -InputObject <IResultObject>
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMProgram
      [-Force]
      -PackageId <String>
      -ProgramName <String>
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Use this cmdlet to remove a program from a package. When you remove a program from a package, Configuration Manager removes all of the deployments for this program. If Configuration Manager has already run the deployed program on clients, Configuration Manager doesn't remove the software.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Remove a program by using a name and an ID

This command removes the program named ProgramD02 from the package with ID XYZ0000F.

Remove-CMProgram -PackageId "XYZ0000F" -ProgramName "ProgramD02"

Example 2: Remove a program by using an object variable

The first command uses the Get-CMProgram cmdlet to get the program named ProgramD02 in the package with ID XYZ0000F. It stores the results in the $Prog variable.

The second command removes the program.

$Prog = Get-CMProgram -Name "ProgramD02" -PackageId "XYZ0000F"
Remove-CMProgram -InputObject $Prog -Force

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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specify a program object to remove. To get this object, use the Get-CMProgram cmdlet.

Type:IResultObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PackageId

Specify the ID of the package with the program to remove.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ProgramName

Specify the name of the package with the program to remove.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object