Edit

Disable-CMProgram

  • Reference
Module:
ConfigurationManager

Disable a program in a package.

Syntax

Disable-CMProgram
       -InputObject <IResultObject>
       [-PassThru]
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-CMProgram
       -PackageId <String>
       [-PassThru]
       -ProgramName <String>
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-CMProgram
       -PackageName <String>
       [-PassThru]
       -ProgramName <String>
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Use this cmdlet to disable a program in a package.

Disable a program to prevent Configuration Manager clients from running it. When you disable a program, Configuration Manager still distributes the package content to distribution points and sends the program deployment to clients. The client doesn't display or run the program on the client. This behavior is the same when you disable the program deployment.

Note

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

Examples

Example 1: Disable a program

This command disables the program named ProgramD02 in the package that has the ID XYZ00007.

Disable-CMProgram -PackageId "XYZ00007" -ProgramName "ProgramD02"

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

-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 disable. To get this object, use the Get-CMProgram cmdlet.

Type:IResultObject
Aliases:Program
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 disable.

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

-PackageName

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

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

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

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

-ProgramName

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

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

-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

IResultObject

Notes

For more information on this return object and its properties, see SMS_Program server WMI class.