Edit

Remove-CMApplicationDeployment

  • Reference
Module:
ConfigurationManager

Remove an application deployment.

Syntax

Remove-CMApplicationDeployment
      -InputObject <IResultObject>
      [-Force]
      [-Collection <IResultObject>]
      [-CollectionId <String>]
      [-CollectionName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMApplicationDeployment
      [-DeploymentId <String>]
      [-Force]
      [-Collection <IResultObject>]
      [-CollectionId <String>]
      [-CollectionName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMApplicationDeployment
      [-Name <String>]
      [-Force]
      [-Collection <IResultObject>]
      [-CollectionId <String>]
      [-CollectionName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMApplicationDeployment
      [-SmsObjectId <Int32>]
      [-Force]
      [-Collection <IResultObject>]
      [-CollectionId <String>]
      [-CollectionName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Use this cmdlet to remove an application 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

This example removes the deployment of the Central app to the All HR devices collection.

Remove-CMApplicationDeployment -Name 'Central app' -CollectionName 'All HR devices'

Parameters

-Collection

Specify a collection object to which the application is deployed. To get this object, use the Get-CMCollection cmdlet.

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

-CollectionId

Specify the ID of the collection to which the application is deployed. This value is a standard collection ID, for example, XYZ00034.

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

-CollectionName

Specify the name of the collection to which the collection is deployed.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DeploymentId

Specify the deployment ID to remove. This value is a GUID. It's the Deployment ID value in the console and the AssignmentUniqueID property of the SMS_ApplicationAssignment WMI class.

Type:String
Aliases:AssignmentUniqueID, ApplicationDeploymentID
Position:Named
Default value:None
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

Run the command without asking for 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 an application deployment object to remove. To get this object, use the Get-CMApplicationDeployment cmdlet.

Type:IResultObject
Aliases:Assignment, ApplicationDeployment, Application
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specify the name of the application that's deployed.

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

-SmsObjectId

Specify the CI_ID of the application that's deployed. This value is the CI Unique ID in the console, the AssignedCI_UniqueID property of the SMS_ApplicationAssignment WMI class, and the CI_UniqueID property of the SMS_Application WMI class. For example, the format is like ScopeId_0D7D8B60-F2F9-484A-B9F3-4A8B68D14D59/Application_70659c7c-694b-4563-965f-d82537a1de1b/2.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object