Edit

Share via

Remove-CMContentDistribution

Module:
ConfigurationManager Module

Remove packages from a distribution point.

Syntax

SearchByValueMandatory_Application (Default) 

Remove-CMContentDistribution
    [-Force]
    [-CollectionName <String[]>]
    [-DisableContentDependencyDetection]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory_Application 

Remove-CMContentDistribution
    -ApplicationId <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DisableContentDependencyDetection]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory_Application 

Remove-CMContentDistribution
    -ApplicationName <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DisableContentDependencyDetection]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory_BootImage 

Remove-CMContentDistribution
    -BootImageId <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory_BootImage 

Remove-CMContentDistribution
    -BootImageName <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory_DeploymentPackage 

Remove-CMContentDistribution
    -DeploymentPackageId <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory_DeploymentPackage 

Remove-CMContentDistribution
    -DeploymentPackageName <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory_DriverPackage 

Remove-CMContentDistribution
    -DriverPackageId <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory_DriverPackage 

Remove-CMContentDistribution
    -DriverPackageName <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByValueMandatory 

Remove-CMContentDistribution
    -InputObject <IResultObject>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByValueMandatory_OperatingSystemImage 

Remove-CMContentDistribution
    -OperatingSystemImage <IResultObject>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory_OperatingSystemImage 

Remove-CMContentDistribution
    -OperatingSystemImageId <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory_OperatingSystemImage 

Remove-CMContentDistribution
    -OperatingSystemImageName <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory_OperatingSystemInstaller 

Remove-CMContentDistribution
    -OperatingSystemInstallerId <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory_OperatingSystemInstaller 

Remove-CMContentDistribution
    -OperatingSystemInstallerName <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory_Package 

Remove-CMContentDistribution
    -PackageId <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory_Package 

Remove-CMContentDistribution
    -PackageName <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory_TaskSequence 

Remove-CMContentDistribution
    -TaskSequenceId <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory_TaskSequence 

Remove-CMContentDistribution
    -TaskSequenceName <String[]>
    [-Force]
    [-CollectionName <String[]>]
    [-DistributionPointGroupName <String[]>]
    [-DistributionPointName <String[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to remove one or more packages from a distribution point.

Note

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

Examples

Example 1: Remove a driver package from a distribution point

This command removes the driver package PCO00019 from the distribution point distribution-server.contoso.com.

Remove-CMContentDistribution -DriverPackageID "PCP00019" -DistributionPointName "distribution-server.contoso.com"

Parameters

-ApplicationId

Specify an array of application IDs to remove. These IDs are GUIDs as strings.

By default, Configuration Manager also removes the content for dependent applications. To disable this behavior, use the DisableContentDependencyDetection parameter.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SearchByIdMandatory_Application
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ApplicationName

Specify an array of application names to remove.

By default, Configuration Manager also removes the content for dependent applications. To disable this behavior, use the DisableContentDependencyDetection parameter.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SearchByNameMandatory_Application
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BootImageId

Specify an array of boot image IDs to remove. For example, "XYZ00015".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:BootImageIds

Parameter sets

SearchByIdMandatory_BootImage
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BootImageName

Specify an array of boot image names to remove.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:BootImageNames

Parameter sets

SearchByNameMandatory_BootImage
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CollectionName

Specify an array of Configuration Manager collection names. Use this collection to target the distribution points from which to remove the content.

Parameter properties

Type:

String[]

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
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

-DeploymentPackageId

Specify an array of software update deployment package IDs to remove. For example, "XYZ00016".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:DeploymentPackageIds, SoftwareUpdatesPackageId, SoftwareUpdatesPackageIds

Parameter sets

SearchByIdMandatory_DeploymentPackage
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeploymentPackageName

Specify an array of software update deployment package names to remove.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:DeploymentPackageNames, SoftwareUpdatesPackageName, SoftwareUpdatesPackageNames

Parameter sets

SearchByNameMandatory_DeploymentPackage
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableContentDependencyDetection

Add this parameter to not automatically remove content for dependent apps.

Parameter properties

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

Parameter sets

SearchByValueMandatory_Application
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SearchByIdMandatory_Application
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SearchByNameMandatory_Application
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

-DistributionPointGroupName

Specify an array of distribution point group names from which to remove the content.

Parameter properties

Type:

String[]

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

-DistributionPointName

Specify an array of distribution point names from which to remove the content.

Parameter properties

Type:

String[]

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

-DriverPackageId

Specify an array of driver package IDs to remove. For example, "XYZ00017".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:DriverPackageIds

Parameter sets

SearchByIdMandatory_DriverPackage
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DriverPackageName

Specify an array of driver package names to remove.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:DriverPackageNames

Parameter sets

SearchByNameMandatory_DriverPackage
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

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

-InputObject

Specify an object type to remove. To get these objects, use one of the following cmdlets:

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Application, Package, BootImage, DeploymentPackage, SoftwareUpdatePackage, DriverPackage, ImagePackage, OperatingSystemInstaller, TaskSequence

Parameter sets

SearchByValueMandatory
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-OperatingSystemImage

Specify an OS image object to remove. To get this object, use the Get-CMOperatingSystemImage cmdlet.

Parameter properties

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

Parameter sets

SearchByValueMandatory_OperatingSystemImage
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OperatingSystemImageId

Specify an array of OS image IDs to remove. For example, "XYZ00018".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:OperatingSystemImageIds

Parameter sets

SearchByIdMandatory_OperatingSystemImage
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OperatingSystemImageName

Specify an array of OS image names to remove.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:OperatingSystemImageNames

Parameter sets

SearchByNameMandatory_OperatingSystemImage
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OperatingSystemInstallerId

Specify an array of OS upgrade package IDs to remove. For example, "XYZ00019".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:OperatingSystemInstallerIds

Parameter sets

SearchByIdMandatory_OperatingSystemInstaller
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OperatingSystemInstallerName

Specify an array of OS upgrade package names to remove.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:OperatingSystemImageInstallerNames

Parameter sets

SearchByNameMandatory_OperatingSystemInstaller
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PackageId

Specify an array of legacy package IDs to remove. For example, "XYZ00020".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:PackageIds

Parameter sets

SearchByIdMandatory_Package
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PackageName

Specify an array of legacy package names to remove.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:PackageNames

Parameter sets

SearchByNameMandatory_Package
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TaskSequenceId

Specify an array of task sequence IDs to remove referenced content. For example, "XYZ00021".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:TaskSequenceIds

Parameter sets

SearchByIdMandatory_TaskSequence
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TaskSequenceName

Specify an array of task sequence names to remove referenced content.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:TaskSequenceNames

Parameter sets

SearchByNameMandatory_TaskSequence
Position:Named
Mandatory:True
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:False
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