Edit

Get-CMPackageDeployment

  • Reference
Module:
ConfigurationManager

Gets a package deployment from Configuration Manager.

Syntax

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

Description

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

Note

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

Examples

Example 1

PS XYZ:\> 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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CollectionName

Specifies the name of a user collection.

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

-DeploymentId

Specifies the ID of a deployment.

Type:String
Aliases:AdvertisementID, PackageDeploymentID
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

-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

Specifies a package.

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

-Name

Specifies the name of a package.

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

-PackageId

Specifies the ID of a package.

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

-ProgramName

Specifies the name of a program.

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

-Summary

Add this parameter to return the SMS_DeploymentSummary WMI class object.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject[]

IResultObject

IResultObject[]

IResultObject

Notes

For more information on these return objects and their properties, see the following articles: