Edit

Share via

Suspend-CMApplication

  • Reference
Module:
ConfigurationManager

Suspends an application.

Syntax

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

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.

Note

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

Examples

Example 1: Suspend an application by its name

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

This command suspends the application named Application01.

Example 2: Get an application and suspend it

PS XYZ:\> 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.

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

-Id

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

Type:Int32
Aliases:CIId, CI_ID
Position:0
Default value:None
Required:True
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
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the application.

Type:String
Aliases:LocalizedDisplayName, ApplicationName
Position:0
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

System.Object