Set-ScheduledJobOption

模块:

PSScheduledJob

更改计划作业的作业选项。

语法

Set-ScheduledJobOption
   [-InputObject] <ScheduledJobOptions>
   [-PassThru]
   [-RunElevated]
   [-HideInTaskScheduler]
   [-RestartOnIdleResume]
   [-MultipleInstancePolicy <TaskMultipleInstancePolicy>]
   [-DoNotAllowDemandStart]
   [-RequireNetwork]
   [-StopIfGoingOffIdle]
   [-WakeToRun]
   [-ContinueIfGoingOnBattery]
   [-StartIfOnBattery]
   [-IdleTimeout <TimeSpan>]
   [-IdleDuration <TimeSpan>]
   [-StartIfIdle]
   [<CommonParameters>]

说明

Set-ScheduledJobOptions cmdlet 更改计划作业的作业选项。

若要更改计划作业的选项，应首先使用 Get-ScheduledJobOption cmdlet 来获取计划作业的作业选项。 然后，通过管道将选项传递给 Set-ScheduledJobOption 或将其保存在某个变量中，并且使用 Set-ScheduledJobOption cmdlet 的 InputObject 参数来标识选项。 使用 Set-ScheduledJobOption 的其余参数来更改作业选项。

若要启用作业选项，请使用设置该选项的参数。 若要禁用某个选项，请依次键入参数名、冒号 (:) 和 $false。 例如，若要禁用 RunElevated 选项，请键入 -RunElevated:$false。

每个作业选项对象都包括 JobDefinition 属性，该属性包含计划作业，以便在作业选项发生更改后保留计划作业的关联内容。

计划作业选项确定作业在由任务计划程序启动后的运行方式。 当你使用 Start-Job cmdlet 启动计划作业时，这些选项不适用。

Set-ScheduledJobOption 是 PSScheduledJob 模块（包含在 Windows PowerShell 中）中的一系列作业计划 cmdlet 之一。

有关计划作业的详细信息，请参阅 PSScheduledJob 模块中的“关于”主题。 导入 PSScheduledJob 模块，然后键入 Get-Help about_Scheduled*，或参阅 about_Scheduled_Jobs。

此 cmdlet 是在 Windows PowerShell 3.0 中引入的。

示例

示例 1：更改作业选项

Get-ScheduledJobOption -Name "DeployPackage"

StartIfOnBatteries     : False
StopIfGoingOnBatteries : True
WakeToRun              : False
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : False
DoNotAllowDemandStart  : False
MultipleInstancePolicy : IgnoreNew
JobDefinition          :

Get-ScheduledJobOption -Name "DeployPackage" |
    Set-ScheduledJobOption -WakeToRun -RequireNetwork:$false -PassThru

StartIfOnBatteries     : False
StopIfGoingOnBatteries : True
WakeToRun              : True
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : True
DoNotAllowDemandStart  : False
MultipleInstancePolicy : IgnoreNewJobDefinition          :

此示例显示了如何更改本地计算机上的计划作业选项。

第一个命令使用 Get-ScheduledJobOption cmdlet 来获取 DeployPackage 计划作业的作业选项。 该输出显示 WakeToRun 和 RunElevated 属性都设置为 $false。

第二个命令使用 Set-ScheduledJobOpton cmdlet 更改作业选项，因此 WakeToRun 和 RunWithoutNetwork 属性值都为 $True。 该命令使用 PassThru 参数在更改后返回触发器。

此命令不是必需的；包含它只是为了显示选项更改的效果。

示例 2：更改所有远程计划作业上的某个选项

Invoke-Command -Computer "Server01" -ScriptBlock {
    Get-ScheduledJob |
        Get-ScheduledJobOption |
        Set-ScheduledJobOption -IdleTimeout 2:00:00
}

此命令将 Server01 计算机上所有计划作业的 IdleTimeout 值从一个小时（默认值）更改为两个小时。

该命令使用 Invoke-Command cmdlet 在 Server01 计算机上运行命令。

远程命令以 Get-ScheduledJob 命令开始，该命令可获取计算机上的所有计划作业。 计划作业通过管道传递给 Get-ScheduledJobOption cmdlet，此 cmdlet 将获取这些计划作业的作业选项。 每个作业选项对象都包含 JobDefinition 属性，该属性包括计划作业，因此选项对象与计划作业保持关联，即使该作业出现更改也是如此。

作业触发器通过管道传递给 Set-ScheduledJobOption cmdlet，此 cmdlet 将 IdleTimeout 选项的值更改为两个小时 (2:00:00)。

参数

-ContinueIfGoingOnBattery

如果计算机在正在运行计划作业时切换到电池电源（断开交流电源），请不要停止运行该作业。 默认情况下，计划作业在计算机断开交流电源时将停止运行。

ContinueIfGoingOnBattery 参数将计划作业的 StopIfGoingOnBatteries 属性的值设置为 $true。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-DoNotAllowDemandStart

仅在触发作业时它才启动。 用户无法手动启动作业，例如通过使用任务计划程序中的 Run 功能。

此参数仅影响任务计划程序。 它不会阻止用户使用 Start-Job cmdlet 来启动作业。

DoNotAllowDemandStart 参数将计划作业的 DoNotAllowDemandStart 属性的值设置为 $true。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-HideInTaskScheduler

不会在任务计划程序中显示作业。 此值仅影响运行该作业的计算机。 默认情况下，计划任务将显示在任务计划程序中。

即使任务处于隐藏状态，用户也可通过选择任务计划程序中的“显示隐藏任务”视图选项来显示该任务。

HideInTaskScheduler 参数将计划作业的 ShowInTaskScheduler 属性的值设置为 $false。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IdleDuration

指定在启动作业之前计算机必须处于空闲状态的时长。 默认值为 10 分钟。 如果在 IdleTimeout 的值过期前，计算机在指定的持续时间内不处于空闲状态，则在下一个计划时间（如果有）之前计划作业不会启动。

输入一个时间跨度对象（例如 New-TimeSpan cmdlet 生成的对象），或输入采用 <hours>:<minutes>:<seconds> 格式的值（会自动转换为时间跨度对象）。

若要启用此值，请使用 StartIfIdle 参数。 默认情况下，计划作业的 StartIfNotIdle 属性设置为 $true，并且 Windows PowerShell 会忽略 IdleDuration 和 IdleTimeout 值。

类型:	TimeSpan
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IdleTimeout

指定在启动作业之前计算机必须处于空闲状态的时长。 默认值为 10 分钟。 如果在 IdleTimeout 的值过期前，计算机在指定的持续时间内不处于空闲状态，则在下一个计划时间（如果有）之前计划作业不会启动。

输入一个时间跨度对象（例如 New-TimeSpan cmdlet 生成的对象），或输入采用 <hours>:<minutes>:<seconds> 格式的值（会自动转换为时间跨度对象）。

若要启用此值，请使用 StartIfIdle 参数。 默认情况下，计划作业的 StartIfNotIdle 属性设置为 $True，并且 Windows PowerShell 会忽略 IdleDuration 和 IdleTimeout 值。

类型:	TimeSpan
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-InputObject

指定作业选项。 输入包含 ScheduledJobOptions 对象的变量，或者键入可获取 ScheduledJobOptions 对象的命令或表达式，例如 Get-ScheduledJobOption 命令。 还可以通过管道将 ScheduledJobOptions 对象传递给 Set-ScheduledJobOption。

类型:	ScheduledJobOptions
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-MultipleInstancePolicy

确定系统如何在计划作业的某个实例正在运行时响应启动该作业的其他实例。 此参数的可接受值为：

• IgnoreNew - 忽略新的作业实例。 这是默认值。
• Parallel - 立即启动新的作业实例。
• Queue - 在当前实例完成后立即启动新的作业实例。
• StopExisting - 停止当前的作业实例，并启动新的实例。

若要运行该作业，必须满足作业计划的所有条件。 例如，如果不满足由 RequireNetwork、IdleDuration 和 IdleTimeout 参数设置的条件，则无论此参数的值如何，都不会启动作业实例。

类型:	TaskMultipleInstancePolicy
接受的值:	None, IgnoreNew, Parallel, Queue, StopExisting
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PassThru

返回一个代表你所处理的项目的对象。 默认情况下，此 cmdlet 将不产生任何输出。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-RequireNetwork

仅在网络连接可用时才运行计划作业。

如果指定了此参数，但网络在计划开始时间不可用，则在下一个计划开始时间（如果有）之前该作业不会运行。

RequireNetwork 参数将计划作业的 RunWithoutNetwork 属性的值设置为 $false。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-RestartOnIdleResume

在计算机处于空闲状态后重新启动计划作业。 此参数可与 StopIfGoingOffIdle 参数配合使用，后者会在计算机变为活动状态（退出空闲状态）时暂停正在运行的计划作业。

RestartOnIdleResume 参数将计划作业的 RestartOnIdleResume 属性的值设置为 $true。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-RunElevated

使用运行计划作业的计算机上 Administrators 组成员权限来运行该作业。

若要使计划作业能够使用管理员权限运行，请使用 Register-ScheduledJob 的 Credential 参数为作业提供显式凭据。

RunElevated 参数将计划作业的 RunElevated 属性的值设置为 $true。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-StartIfIdle

如果在 IdleDuration 参数指定的时间到期之前，计算机在 IdleTimeout 参数指定的时间内已处于空闲状态，则启动计划作业。

默认情况下，系统会忽略 IdleDuration 和 IdleTimeout 参数，作业会在计划的开始时间启动，即使计算机处于繁忙状态。

如果指定了此参数，但计算机在计划开始时间处于繁忙状态（不空闲），则在下一个计划开始时间（如果有）之前该作业不会运行。

StartIfIdle 参数将计划作业的 StartIfNotIdle 属性的值设置为 $false。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-StartIfOnBattery

在计划开始时间启动计划作业，即使计算机使用电池电源运行也是如此。 默认值为 $false。

StartIfOnBattery 参数将计划作业的 StartIfOnBatteries 属性的值设置为 $true。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-StopIfGoingOffIdle

如果计算机在计划作业正在运行时处于活动状态（不空闲），则挂起运行的作业。

默认情况下，计划作业将在计算机处于活动状态时挂起，而在计算机再次处于空闲状态时恢复运行。 若要更改此默认行为，请使用 RestartOnIdleResume 参数。

StopIfGoingOffIdle 参数将计划作业的 StopIfGoingOffIdle 属性的值设置为 $true。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-WakeToRun

在计划开始时间，将计算机从休眠或睡眠状态唤醒，以便它可以运行该作业。 默认情况下，如果计算机在计划开始时间处于休眠或睡眠状态，则不会运行该作业。

WakeToRun 参数将计划作业的 WakeToRun 属性的值设置为 $true。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

ScheduledJobOptions

你可以通过管道将计划作业选项对象传递给此 cmdlet。

输出

None

默认情况下，此 cmdlet 不返回任何输出。

ScheduledJobOptions

当使用 PassThru 参数时，此 cmdlet 返回已更改的作业选项。

相关链接

• Add-JobTrigger
• Disable-JobTrigger
• Disable-ScheduledJob
• Enable-JobTrigger
• Enable-ScheduledJob
• Get-JobTrigger
• Get-ScheduledJob
• Get-ScheduledJobOption
• New-JobTrigger
• New-ScheduledJobOption
• Register-ScheduledJob
• Remove-JobTrigger
• Set-JobTrigger
• Set-ScheduledJob
• Set-ScheduledJobOption
• Unregister-ScheduledJob