Get-CMPackageDeployment
Gets a package deployment from Configuration Manager.
Syntax
SearchByName (Default)
Get-CMPackageDeployment
[-Name <String>]
[-ProgramName <String>]
[-Summary]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
SearchByDeploymentId
Get-CMPackageDeployment
[-DeploymentId <String>]
[-ProgramName <String>]
[-Summary]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
SearchByValue
Get-CMPackageDeployment
[-InputObject <IResultObject>]
[-ProgramName <String>]
[-Summary]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
SearchById
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.
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
-CollectionId
Specifies the ID of a device or user collection.
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
-CollectionName
Specifies the name of a user collection.
Parameter properties
Type: String
Default value: None
Supports wildcards: True
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
-DeploymentId
Specifies the ID of a deployment.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Aliases: AdvertisementID, PackageDeploymentID
Parameter sets
SearchByDeploymentId
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
-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
Specifies a package.
Type: IResultObject
Default value: None
Supports wildcards: False
DontShow: False
Aliases: Package
SearchByValue
Position: Named
Mandatory: False
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
-Name
Specifies the name of a package.
Parameter properties
Type: String
Default value: None
Supports wildcards: True
DontShow: False
Aliases: PackageName
Parameter sets
SearchByName
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-PackageId
Specifies the ID of a package.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Aliases: SmsObjectId
Parameter sets
SearchById
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ProgramName
Specifies the name of a program.
Parameter properties
Type: String
Default value: None
Supports wildcards: True
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
-Summary
Add this parameter to return the SMS_DeploymentSummary WMI class object.
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
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 .
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
IResultObject
IResultObject
IResultObject
IResultObject
Notes
For more information on these return objects and their properties, see the following articles: