Edit

Share via

Set-CMTaskSequenceDeployment

Module:
ConfigurationManager Module

Configure a task sequence deployment.

Syntax

SetTaskSequenceDeploymentByValueMandatory (Default) 

Set-CMTaskSequenceDeployment
    -InputObject <IResultObject>
    [-AlertDateTime <DateTime>]
    [-AllowFallback <Boolean>]
    [-AllowSharedContent <Boolean>]
    [-AllowUsersRunIndependently <Boolean>]
    [-Comment <String>]
    [-CreateAlertOnFailure <Boolean>]
    [-CreateAlertOnSuccess <Boolean>]
    [-DeploymentAvailableDateTime <DateTime>]
    [-DeploymentExpireDateTime <DateTime>]
    [-DeploymentOption <DeploymentOptionType>]
    [-InternetOption <Boolean>]
    [-MakeAvailableTo <MakeAvailableToType>]
    [-PercentFailure <Int32>]
    [-PercentSuccess <Int32>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-RerunBehavior <RerunBehaviorType>]
    [-ClearSchedule]
    [-RemoveSchedule <IResultObject[]>]
    [-AddSchedule <IResultObject[]>]
    [-Schedule <IResultObject[]>]
    [-ClearScheduleEvent]
    [-RemoveScheduleEvent <ScheduleEventType[]>]
    [-AddScheduleEvent <ScheduleEventType[]>]
    [-ScheduleEvent <ScheduleEventType[]>]
    [-SendWakeupPacket <Boolean>]
    [-ShowTaskSequenceProgress <Boolean>]
    [-SoftwareInstallation <Boolean>]
    [-SystemRestart <Boolean>]
    [-UseMeteredNetwork <Boolean>]
    [-UseUtcForAvailableSchedule <Boolean>]
    [-UseUtcForExpireSchedule <Boolean>]
    [-PassThru]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetTaskSequenceDeploymentByDeploymentIdMandatory 

Set-CMTaskSequenceDeployment
    -TaskSequenceDeploymentId <String>
    [-AlertDateTime <DateTime>]
    [-AllowFallback <Boolean>]
    [-AllowSharedContent <Boolean>]
    [-AllowUsersRunIndependently <Boolean>]
    [-Comment <String>]
    [-CreateAlertOnFailure <Boolean>]
    [-CreateAlertOnSuccess <Boolean>]
    [-DeploymentAvailableDateTime <DateTime>]
    [-DeploymentExpireDateTime <DateTime>]
    [-DeploymentOption <DeploymentOptionType>]
    [-InternetOption <Boolean>]
    [-MakeAvailableTo <MakeAvailableToType>]
    [-PercentFailure <Int32>]
    [-PercentSuccess <Int32>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-RerunBehavior <RerunBehaviorType>]
    [-ClearSchedule]
    [-RemoveSchedule <IResultObject[]>]
    [-AddSchedule <IResultObject[]>]
    [-Schedule <IResultObject[]>]
    [-ClearScheduleEvent]
    [-RemoveScheduleEvent <ScheduleEventType[]>]
    [-AddScheduleEvent <ScheduleEventType[]>]
    [-ScheduleEvent <ScheduleEventType[]>]
    [-SendWakeupPacket <Boolean>]
    [-ShowTaskSequenceProgress <Boolean>]
    [-SoftwareInstallation <Boolean>]
    [-SystemRestart <Boolean>]
    [-UseMeteredNetwork <Boolean>]
    [-UseUtcForAvailableSchedule <Boolean>]
    [-UseUtcForExpireSchedule <Boolean>]
    [-PassThru]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetTaskSequenceDeploymentByNameMandatory 

Set-CMTaskSequenceDeployment
    -TaskSequenceName <String>
    [-AlertDateTime <DateTime>]
    [-AllowFallback <Boolean>]
    [-AllowSharedContent <Boolean>]
    [-AllowUsersRunIndependently <Boolean>]
    [-Comment <String>]
    [-CreateAlertOnFailure <Boolean>]
    [-CreateAlertOnSuccess <Boolean>]
    [-DeploymentAvailableDateTime <DateTime>]
    [-DeploymentExpireDateTime <DateTime>]
    [-DeploymentOption <DeploymentOptionType>]
    [-InternetOption <Boolean>]
    [-MakeAvailableTo <MakeAvailableToType>]
    [-PercentFailure <Int32>]
    [-PercentSuccess <Int32>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-RerunBehavior <RerunBehaviorType>]
    [-ClearSchedule]
    [-RemoveSchedule <IResultObject[]>]
    [-AddSchedule <IResultObject[]>]
    [-Schedule <IResultObject[]>]
    [-ClearScheduleEvent]
    [-RemoveScheduleEvent <ScheduleEventType[]>]
    [-AddScheduleEvent <ScheduleEventType[]>]
    [-ScheduleEvent <ScheduleEventType[]>]
    [-SendWakeupPacket <Boolean>]
    [-ShowTaskSequenceProgress <Boolean>]
    [-SoftwareInstallation <Boolean>]
    [-SystemRestart <Boolean>]
    [-UseMeteredNetwork <Boolean>]
    [-UseUtcForAvailableSchedule <Boolean>]
    [-UseUtcForExpireSchedule <Boolean>]
    [-PassThru]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetTaskSequenceDeploymentByIdMandatory 

Set-CMTaskSequenceDeployment
    -TaskSequencePackageId <String>
    [-AlertDateTime <DateTime>]
    [-AllowFallback <Boolean>]
    [-AllowSharedContent <Boolean>]
    [-AllowUsersRunIndependently <Boolean>]
    [-Comment <String>]
    [-CreateAlertOnFailure <Boolean>]
    [-CreateAlertOnSuccess <Boolean>]
    [-DeploymentAvailableDateTime <DateTime>]
    [-DeploymentExpireDateTime <DateTime>]
    [-DeploymentOption <DeploymentOptionType>]
    [-InternetOption <Boolean>]
    [-MakeAvailableTo <MakeAvailableToType>]
    [-PercentFailure <Int32>]
    [-PercentSuccess <Int32>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-RerunBehavior <RerunBehaviorType>]
    [-ClearSchedule]
    [-RemoveSchedule <IResultObject[]>]
    [-AddSchedule <IResultObject[]>]
    [-Schedule <IResultObject[]>]
    [-ClearScheduleEvent]
    [-RemoveScheduleEvent <ScheduleEventType[]>]
    [-AddScheduleEvent <ScheduleEventType[]>]
    [-ScheduleEvent <ScheduleEventType[]>]
    [-SendWakeupPacket <Boolean>]
    [-ShowTaskSequenceProgress <Boolean>]
    [-SoftwareInstallation <Boolean>]
    [-SystemRestart <Boolean>]
    [-UseMeteredNetwork <Boolean>]
    [-UseUtcForAvailableSchedule <Boolean>]
    [-UseUtcForExpireSchedule <Boolean>]
    [-PassThru]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-CMTaskSequenceDeployment cmdlet configures a task sequence deployment. A task sequence deployment assigns a task sequence to a collection of computers.

Note

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

Examples

Example 1: Configure a deployment to show progress

This command configures the task sequence deployment by using the task sequence name and collection name. It sets the comment and enables the client to show task sequence progress.

Set-CMTaskSequenceDeployment -TaskSequenceName "Task Sequence 1333" -CollectionName "All Systems" -Comment "Task sequence test" -ShowTaskSequenceProgress $True

Example 2: Reconfigure a task sequence deployment

This command reconfigures most of the settings for a task sequence deployment.

Set-CMTaskSequenceDeployment -TaskSequenceName "Task Sequence 1333" -CollectionName "All Desktop and Server Clients" -Comment "Task sequence test" -SendWakeupPacket $True -UseMeteredNetwork $True -DeploymentExpireDateTime $(Get-Date) -ScheduleEvent LogOff -RerunBehavior NeverRerunDeployedProgram -AllowUsersRunIndependently $True -ShowTaskSequenceProgress $False -SoftwareInstallation $True -SystemRestart $True -PersistOnWriteFilterDevice $False -InternetOption $True -DeploymentOption DownloadAllContentLocallyBeforeStartingTaskSequence -AllowFallback $True -AllowSharedContent $True

Parameters

-AddSchedule

Specify a schedule token object to add to the deployment. To create a schedule object, use the New-CMSchedule cmdlet.

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

-AddScheduleEvent

Specify one of the accepted schedule events to add to the deployment.

Parameter properties

Type:

ScheduleEventType[]

Default value:None
Accepted values:AsSoonAsPossible, LogOn, LogOff
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

-AlertDateTime

Specifies an alert date time.

Parameter properties

Type:DateTime
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

-AllowFallback

Indicates whether to allow clients to use a fallback source location for content.

Parameter properties

Type:Boolean
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

-AllowSharedContent

Indicates whether to allow shared content.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AllowUseRemoteDistributionPoint

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowUsersRunIndependently

Indicates whether to allow users to independently run the program, regardless of its assignment status.

Parameter properties

Type:Boolean
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

-ClearSchedule

Add this parameter to remove all schedules from the deployment.

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

-ClearScheduleEvent

Add this parameter to remove all schedule events from the deployment.

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

-Collection

Specifies a collection object as the target of the deployment.

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 collection as the target of the deployment.

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 a name of a collection designated to receive a task sequence deployment.

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

-Comment

Specifies a optional comment for the task sequence deployment to help describe it.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreateAlertOnFailure

Indicates whether to create an alert on failure.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CreateAlertBaseOnPercentFailure

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreateAlertOnSuccess

Indicates whether to create an alert on success.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CreateAlertBaseOnPercentSuccess

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeploymentAvailableDateTime

Specifies deployment available date time.

Parameter properties

Type:DateTime
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

-DeploymentExpireDateTime

Specifies deployment expire date time.

Parameter properties

Type:DateTime
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

-DeploymentOption

Specifies if clients download all content before starting the task sequence, or download content as needed by the running task sequence.

Parameter properties

Type:DeploymentOptionType
Default value:None
Accepted values:DownloadContentLocallyWhenNeededByRunningTaskSequence, DownloadAllContentLocallyBeforeStartingTaskSequence, RunFromDistributionPoint
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

-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

-InputObject

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

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Deployment, DeploymentSummary, TaskSequence, Advertisement

Parameter sets

SetTaskSequenceDeploymentByValueMandatory
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-InternetOption

Indicates whether the task sequence runs on clients connecting over the internet.

Parameter properties

Type:Boolean
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

-MakeAvailableTo

Specifies whether to make this task sequence available to Configuration Manager clients, and whether to make it available when you deploy an OS by using boot media, prestaged media, or PXE.

Parameter properties

Type:MakeAvailableToType
Default value:None
Accepted values:Clients, ClientsMediaAndPxe, MediaAndPxe, MediaAndPxeHidden
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

-PassThru

Returns the current working object. By default, this cmdlet doesn't generate any output.

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

-PercentFailure

Specifies a threshold percentage for failed task sequence deployment.

Parameter properties

Type:Int32
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

-PercentSuccess

Specifies a threshold percentage for successful task sequence deployment.

Parameter properties

Type:Int32
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

-PersistOnWriteFilterDevice

Indicates whether to install a task sequence on the temporary overlay and commit changes later, or commit the changes at an installation deadline or a maintenance window. This setting applies to devices running an embedded edition of Windows with a write filter.

Parameter properties

Type:Boolean
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

-RemoveSchedule

Specify a schedule token object to remove from the deployment. To create a schedule object, use the New-CMSchedule cmdlet.

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

-RemoveScheduleEvent

Specify one of the accepted schedule events to remove from the deployment.

Parameter properties

Type:

ScheduleEventType[]

Default value:None
Accepted values:AsSoonAsPossible, LogOn, LogOff
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

-RerunBehavior

Specifies whether the task sequence will rerun on a computer if it previously ran before the scheduled mandatory time. By default, the task sequence always reruns.

Parameter properties

Type:RerunBehaviorType
Default value:None
Accepted values:NeverRerunDeployedProgram, AlwaysRerunProgram, RerunIfFailedPreviousAttempt, RerunIfSucceededOnPreviousAttempt
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

-Schedule

Specifies an array of CMSchedule objects. A CMSchedule object defines the mandatory assignment schedule for a deployment. To create a CMSchedule object, use the New-CMSchedule cmdlet.

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

-ScheduleEvent

Specifies an array of events that determine when the task sequence deployment runs.

Parameter properties

Type:

ScheduleEventType[]

Default value:None
Accepted values:AsSoonAsPossible, LogOn, LogOff
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

-SendWakeupPacket

Indicates whether to send a wake-up packet to computers before the deployment begins. If this value is $True, Configuration Manager wakes a computer from sleep. If this value is $False, it doesn't wake computers from sleep. For computers to wake, first configure Wake On LAN.

Parameter properties

Type:Boolean
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

-ShowTaskSequenceProgress

Indicates whether to show a process dialog for a task sequence.

Parameter properties

Type:Boolean
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

-SoftwareInstallation

Indicates whether to allow the application to install, even if the installation occurs outside of a maintenance window.

Parameter properties

Type:Boolean
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

-SystemRestart

Indicates whether to allow an advertised program to restart the system, even if the restart occurs outside of a maintenance window.

Parameter properties

Type:Boolean
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

-TaskSequenceDeploymentId

Specifies an ID for a task sequence deployment to configure.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetTaskSequenceDeploymentByDeploymentIdMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TaskSequenceName

Specifies a name for the task sequence to deploy.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetTaskSequenceDeploymentByNameMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TaskSequencePackageId

Specifies an ID for a task sequence to deploy.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetTaskSequenceDeploymentByIdMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseMeteredNetwork

Indicates whether to allow clients on a metered internet connection to download content after the installation deadline, which might incur additional costs.

Parameter properties

Type:Boolean
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

-UseUtcForAvailableSchedule

Indicates whether client computers use UTC time to determine the availability of a program. UTC time makes the task sequence available at the same time for all computers.

Parameter properties

Type:Boolean
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

-UseUtcForExpireSchedule

Indicates whether client computers use UTC time to determine the expiration of a program. UTC time makes the task sequence available at the same time for all computers.

Parameter properties

Type:Boolean
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

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

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.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject