Skip to content

Latest commit

 

History

History
178 lines (127 loc) · 4.45 KB

Get-CMTSStepInstallUpdate.md

File metadata and controls

178 lines (127 loc) · 4.45 KB
Raw
external help file Module Name ms.date schema title
AdminUI.PS.psm1-help.xml
ConfigurationManager
08/13/2021
2.0.0
Get-CMTSStepInstallUpdate

Get-CMTSStepInstallUpdate

SYNOPSIS

Get the Install Software Updates step from a specific task sequence.

SYNTAX

ByValue (Default)

Get-CMTSStepInstallUpdate [-InputObject] <IResultObject> [-StepName <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ById

Get-CMTSStepInstallUpdate [-TaskSequenceId] <String> [-StepName <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ByName

Get-CMTSStepInstallUpdate [-TaskSequenceName] <String> [-StepName <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Use this cmdlet to get a task sequence step object for one or more instances of the Install Software Updates step. You can use this object to:

For more information on this step, see About task sequence steps: Install Software Updates.

Note

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

EXAMPLES

Example 1

This example first gets a task sequence object in the $tsOsd variable. It then passes that variable as the input object to get the Install Software Updates step.

$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast

$tsStepNameInstallUpd = "Install Software Updates"
$tsStepInstallUpd = Get-CMTSStepInstallUpdate -InputObject $tsOsd -StepName $tsStepNameInstallUpd

PARAMETERS

-InputObject

Specify a task sequence object from which to get the Install Software Updates step. To get this object, use the Get-CMTaskSequence cmdlet.

Type: IResultObject
Parameter Sets: ByValue
Aliases: TaskSequence

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

-StepName

Specify the name of the Install Software Updates step to get from the task sequence.

Type: String
Parameter Sets: (All)
Aliases:

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

-TaskSequenceId

Specify the package ID of the task sequence from which to get the Install Software Updates step. This value is a standard package ID, for example XYZ00858.

Type: String
Parameter Sets: ById
Aliases: Id, TaskSequencePackageId

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

-TaskSequenceName

Specify the name of the task sequence from which to get the Install Software Updates step.

Type: String
Parameter Sets: ByName
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

System.Object

NOTES

RELATED LINKS

New-CMTSStepInstallUpdate Remove-CMTSStepInstallUpdate Set-CMTSStepInstallUpdate

About task sequence steps: Install Software Updates