Get-CMTaskSequenceDeployment

Get a task sequence deployment.

Syntax

Get-CMTaskSequenceDeployment
   [-Fast]
   [-Name <String>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMTaskSequenceDeployment
   [-Fast]
   [-DeploymentId <String>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMTaskSequenceDeployment
   [-Fast]
   [-InputObject <IResultObject>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMTaskSequenceDeployment
   [-Fast]
   [-TaskSequenceId <String>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

Use this cmdlet to get a task sequence deployment. A task sequence deployment assigns a task sequence to a collection of computers. For more information, see Deploy a task sequence in Configuration Manager.

Note

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

Examples

Example 1: Get all deployments for a task sequence by name

This command gets the deployments for the task sequence named Upgrade to Windows 10 latest.

Get-CMTaskSequenceDeployment -Name "Upgrade to Windows 10 latest"

Example 2: Get all task sequence deployments to a specific collection

This command gets all task sequence deployments to the collection with ID XYZ00112

Get-CMTaskSequenceDeployment -Fast -CollectionId "XYZ00112"

Parameters

-Collection

Specify a collection object to which a task sequence is deployed. To get this object, use the Get-CMCollection cmdlet.

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

-CollectionId

Specify a collection ID to which a task sequence is deployed. This value is a standard collection ID, for example, XYZ00581.

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

-CollectionName

Specify a collection name to which a task sequence is deployed.

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

-DeploymentId

Specify the ID for the deployment. This value is a standard ID, for example, XYZ20174. It's the same value as the Deployment ID property in the console, and the AdvertisementID attribute of the SMS_Advertisement WMI class that this cmdlet returns.

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

-Fast

Add this parameter to not automatically refresh lazy properties. Lazy properties contain values that are relatively inefficient to retrieve. Getting these properties can cause additional network traffic and decrease cmdlet performance.

If you don't use this parameter, the cmdlet displays a warning. To disable this warning, set $CMPSSuppressFastNotUsedCheck = $true.

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

Specify a task sequence object to get its deployments. To get this object, use the Get-CMTaskSequence cmdlet.

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

-Name

Specify the name of a task sequence to get its deployments.

Type:String
Aliases:TaskSequenceName
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

-TaskSequenceId

Specify the ID of a task sequence to get its deployments. This value is a standard ID, for example, XYZ00279.

Type:String
Aliases:SmsObjectId, TaskSequencePackageID
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: