Get-CMTaskSequenceDeployment

SYNOPSIS

Gets a task sequence deployment in Configuration Manager.

SYNTAX

SearchByName (Default)

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

SearchById

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

SearchByDeploymentId

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

SearchByValue

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

DESCRIPTION

The Get-CMTaskSequenceDeployment cmdlet gets a task sequence deployment. A task sequence deployment assigns a task sequence to a collection of computers.

EXAMPLES

Example 1

PS C:\> Get-CMTaskSequenceDeployment -Name "Task Sequence 1333" 

This command gets a task sequence deployment by name.

PARAMETERS

-Collection

Specifies a collection object.

Type: IResultObject
Parameter Sets: (All)
Aliases: 

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

-CollectionId

Specifies a collection ID.

Type: String
Parameter Sets: (All)
Aliases: 

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

-CollectionName

Specifies a name of a collection designated to receive a task sequence deployment. A collection is a group of client computers.

Type: String
Parameter Sets: (All)
Aliases: 

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

-DeploymentId

Specifies a deployment ID.

Type: String
Parameter Sets: SearchByDeploymentId
Aliases: AdvertisementID, TaskSequenceDeploymentID

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

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

-InputObject

Specifies a task sequence deployment object. To obtain a task sequence object, use the Get-CMTaskSequenceDeployment cmdlet.

Type: IResultObject
Parameter Sets: SearchByValue
Aliases: TaskSequence

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of a task sequence.

Type: String
Parameter Sets: SearchByName
Aliases: TaskSequenceName

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

-Summary

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-TaskSequenceId

Specifies the ID of a task sequence

Type: String
Parameter Sets: SearchById
Aliases: SmsObjectId, TaskSequencePackageID

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

OUTPUTS

IResultObject[]#SMS_DeploymentSummary

  • IResultObject#SMS_DeploymentSummary
  • IResultObject[]#SMS_Advertisement
  • IResultObject#SMS_Advertisement

New-CMTaskSequenceDeployment Set-CMTaskSequenceDeployment Start-CMTaskSequenceDeployment Remove-CMTaskSequenceDeployment