Suspend-CMApplication

Suspends an application.

Syntax

Suspend-CMApplication
       [-Id] <Int32>
       [-Confirm]
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [<CommonParameters>]
Suspend-CMApplication [-InputObject]  [-Confirm] [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-WhatIf] []
Suspend-CMApplication [-Name]  [-Confirm] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
 []

Description

The Suspend-CMApplication cmdlet suspends an application. Until the application is resumed, users cannot modify or deploy the application. This action does not affect existing deployments. When you suspend an application, its status shows as "Retired" in the Configuration Manager console. To resume an application, use the Resume-CMApplication cmdlet.

Examples

Example 1: Suspend an application by its name

PS C:\> Suspend-CMApplication -Name "Application01"

This command suspends the application named Application01.

Example 2: Get an application and suspend it

PS C:\> Get-CMApplication -Name "Application01" | Suspend-CMApplication

This command gets the application object named Application01 and uses the pipeline operator to pass the object to Suspend-CMApplication, which suspends the application.

Required Parameters

-Id

Specifies the CI_ID and ModelID properties (the same value) of an application.

Type:Int32
Aliases:CIId, CI_ID
Required:True
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Specifies an application object. To obtain an application object, use the Get-CMApplication cmdlet.

Type:IResultObject
Aliases:Application
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies the name of the application.

Type:String
Aliases:LocalizedDisplayName, ApplicationName
Required:True
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

Indicates that wildcard handling is disabled.

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

Indicates that wildcard handling is enabled.

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

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

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