Edit

Share via

Set-CMApplicationSupersedence

Module:
ConfigurationManager Module

Set deployment type supersedence for an application.

Syntax

SetById 

Set-CMApplicationSupersedence
    [-Id] <Int32>
    [-CurrentDeploymentTypeId <Int32>]
    [-CurrentDeploymentTypeName <String>]
    [-CurrentDeploymentType <IResultObject>]
    [-SupersededApplicationId <Int32>]
    [-SupersededApplicationName <String>]
    [-SupersededApplication <IResultObject>]
    [-OldDeploymentTypeId <Int32>]
    [-OldDeploymentTypeName <String>]
    [-OldDeploymentType <IResultObject>]
    [-IsUninstall <Boolean>]
    [-RemoveSupersedence]
    [-Force]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByName 

Set-CMApplicationSupersedence
    [-Name] <String>
    [-CurrentDeploymentTypeId <Int32>]
    [-CurrentDeploymentTypeName <String>]
    [-CurrentDeploymentType <IResultObject>]
    [-SupersededApplicationId <Int32>]
    [-SupersededApplicationName <String>]
    [-SupersededApplication <IResultObject>]
    [-OldDeploymentTypeId <Int32>]
    [-OldDeploymentTypeName <String>]
    [-OldDeploymentType <IResultObject>]
    [-IsUninstall <Boolean>]
    [-RemoveSupersedence]
    [-Force]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByValue 

Set-CMApplicationSupersedence
    [-InputObject] <IResultObject>
    [-CurrentDeploymentTypeId <Int32>]
    [-CurrentDeploymentTypeName <String>]
    [-CurrentDeploymentType <IResultObject>]
    [-SupersededApplicationId <Int32>]
    [-SupersededApplicationName <String>]
    [-SupersededApplication <IResultObject>]
    [-OldDeploymentTypeId <Int32>]
    [-OldDeploymentTypeName <String>]
    [-OldDeploymentType <IResultObject>]
    [-IsUninstall <Boolean>]
    [-RemoveSupersedence]
    [-Force]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to set deployment type supersedence for the specified application.

For more information, see Supersede applications.

Note

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

Examples

Example 1: Add deployment type supersedence

$AppSupersededName = "Superseded app"
$AppSuperseded = New-CMApplication -Name $AppSupersededName
$OriginalDT = Add-CMScriptDeploymentType -ApplicationName $AppSuperseded -DeploymentTypeName "ScriptDT01" -InstallCommand 'appsetup.exe'

$AppSupersedingName = "Superseding app"
$AppSuperseding = New-CMApplication -Name $AppSupersedingName
$AppSupersedingDT = Add-CMScriptDeploymentType -ApplicationName $AppSuperseding -DeploymentTypeName "ScriptDT02" -InstallCommand 'appsetup2.exe'

Set-CMApplicationSupersedence -ApplicationId ($AppSuperseding.CI_ID) -CurrentDeploymentTypeId ($AppSupersedingDT.CI_ID) -SupersededApplicationId ($AppSuperseded.CI_ID) -OldDeploymentTypeId ($OriginalDT.CI_ID)

Example 2: Remove deployment type supersedence

Set-CMApplicationSupersedence -ApplicationName $AppSupersedingName -CurrentDeploymentTypeName ($AppSupersedingDT.LocalizedDisplayName) -SupersededApplicationName $AppSupersededName -OldDeploymentTypeName ($OriginalDT.LocalizedDisplayName) -RemoveSupersedence -Force

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CurrentDeploymentType

Specify a deployment type object from the superseding application. To get this object, use the Get-CMDeploymentType cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ReplacementDeploymentType, SupersedingDeploymentType

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CurrentDeploymentTypeId

Specify the ID of a deployment type from the superseding application.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CurrentDeploymentTypeCIId, CurrentDeploymentTypeCI_ID, ReplacementDeploymentTypeId, ReplacementDeploymentTypeCIId, ReplacementDeploymentTypeCI_ID, SupersedingDeploymentTypeId, SupersedingDeploymentTypeCIId, SupersedingDeploymentTypeCI_ID

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CurrentDeploymentTypeName

Specify the name of a deployment type from the superseding application.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ReplacementDeploymentTypeName, SupersedingDeploymentTypeName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Add this parameter to run the command without asking for confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specify the ID of the current (superseding) application.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ApplicationId, CurrentApplicationId, CurrentApplicationCIId, CurrentApplicationCI_ID

Parameter sets

SetById
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specify an object for the current (superseding) application. To get this object, use the Get-CMApplication cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Application, CurrentApplication

Parameter sets

SetByValue
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IsUninstall

Set this parameter to $true to uninstall the superseded application before the client installs the superseding application.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specify the localized display name of the current (superseding) application.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ApplicationName, LocalizedDisplayName, CurrentApplicationName, CurrentApplicationLocalizedDisplayName

Parameter sets

SetByName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OldDeploymentType

Specify a deployment type object from the superseded application. To get this object, use the Get-CMDeploymentType cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SupersededDeploymentType

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OldDeploymentTypeId

Specify the ID of a deployment type from the superseded application.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:OldDeploymentTypeCIId, OldDeploymentTypeCI_ID, SupersededDeploymentTypeId, SupersededDeploymentTypeCIId, SupersededDeploymentTypeCI_ID

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OldDeploymentTypeName

Specify the name of a deployment type from the superseded application.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SupersededDeploymentTypeName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveSupersedence

Add this parameter to remove the supersedence relationship.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SupersededApplication

Specify an object for the old (superseded) application. To get this object, use the Get-CMApplication cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SupersededApplicationId

Specify the ID of the old (superseded) application.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SupersededApplicationCIId, SupersededApplicationCI_ID

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SupersededApplicationName

Specify the localized display name of the old (superseded) application.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SupersededApplicationLocalizedDisplayName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object