Get-CMPackageDeployment

Gets a package deployment from Configuration Manager.

Syntax

Get-CMPackageDeployment
   [-Name <String>]
   [-ProgramName <String>]
   [-Summary]
   [-CollectionName <String>]
   [-CollectionId <String>]
   [-Collection <IResultObject>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMPackageDeployment
   [-ProgramName <String>]
   [-PackageId <String>]
   [-Summary]
   [-CollectionName <String>]
   [-CollectionId <String>]
   [-Collection <IResultObject>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMPackageDeployment
   [-ProgramName <String>]
   [-DeploymentId <String>]
   [-Summary]
   [-CollectionName <String>]
   [-CollectionId <String>]
   [-Collection <IResultObject>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMPackageDeployment
   [-ProgramName <String>]
   [-InputObject <IResultObject>]
   [-Summary]
   [-CollectionName <String>]
   [-CollectionId <String>]
   [-Collection <IResultObject>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

The Get-CMPackageDeployment cmdlet starts deployment of a specified software package to computers that belong to a Microsoft System Center Configuration Manager collection.

Examples

Example 1

PS C:\> Get-CMPackageDeployment -PackageId $thisPackage.packageid

This command gets a package deployment by the package id.

Parameters

-Collection

Specifies the user collection.

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

Specifies the ID of a device or user collection.

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

Specifies the name of a user collection.

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

Specifies the ID of a deployment.

Type:String
Aliases:AdvertisementID, PackageDeploymentID
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

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

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

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

Specifies a package.

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

Specifies the name of a package.

Type:String
Aliases:PackageName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PackageId

Specifies the ID of a package.

Type:String
Aliases:SmsObjectId
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProgramName

Specifies the name of a program.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Summary
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject[]#SMS_DeploymentSummary

IResultObject#SMS_DeploymentSummary IResultObject[]#SMS_Advertisement IResultObject#SMS_Advertisement