Disable-JobTrigger

禁用计划作业的作业触发器。

语法

Default (默认值)

Disable-JobTrigger
    [-InputObject] <ScheduledJobTrigger[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

Disable-JobTrigger cmdlet 暂时禁用计划作业的作业触发器。 禁用会保留所有作业触发器属性,但会阻止作业触发器启动计划作业。

若要使用此 cmdlet,请使用 Get-JobTrigger cmdlet 获取作业触发器。 然后通过管道将作业触发器传递给 Disable-JobTrigger 或使用其 InputObject 参数。

若要禁用作业触发器,Disable-JobTrigger cmdlet 将作业触发器的 Enabled 属性设置为 $false。 若要重新启用作业触发器,请使用 Enable-JobTrigger cmdlet,该 cmdlet 将作业触发器的 Enabled 属性设置为$true。 禁用作业触发器不会禁用计划作业,例如由 Disable-ScheduledJob cmdlet 完成,但如果禁用所有作业触发器,效果与禁用计划作业的效果相同。

如果禁用计划作业或禁用计划作业的所有作业触发器,仍可使用 Start-Job cmdlet 启动作业,或使用禁用的计划作业作为模板。

Disable-ScheduledJob 是 Windows PowerShell 中包含的 PSScheduledJob 模块中的作业计划 cmdlet 集合之一。

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

此 cmdlet 已在 Windows PowerShell 3.0 中引入。

示例

示例 1:禁用作业触发器

此示例禁用本地计算机上的第一个触发计划作业。

PS C:\> Get-JobTrigger -Name "Backup-Archives" -TriggerId 1 | Disable-JobTrigger

该命令使用 Get-JobTrigger cmdlet 来获取作业触发器。 管道运算符(|)将作业触发器发送到禁用它的 Disable-JobTrigger cmdlet。

示例 2:禁用所有作业触发器

Get-ScheduledJob -Name "Backup-Archives,Inventory" | Get-JobTrigger | Disable-JobTrigger
Get-ScheduledJob -Name "Backup-Archives,Inventory" |
    Get-JobTrigger |
    Format-Table -Property Id, Frequency, At, DaysOfWeek, Enabled,
    @{Label="JobName";Expression={$_.JobDefinition.Name}} -AutoSize
Id Frequency At                     DaysOfWeek Enabled JobName
-- --------- --                     ---------- ------- -------
1  Weekly    9/28/2011 3:00:00 AM   {Monday}   False   Backup-Archive
2  Daily     9/29/2011 1:00:00 AM              False   Backup-Archive
1  Weekly    10/20/2011 11:00:00 PM {Friday}   False   Inventory
1  Weekly    11/2/2011 2:00:00 PM   {Monday}   False   Inventory

第一个命令使用 Get-ScheduledJob cmdlet 获取 Backup-Archives 和清单计划作业。 管道运算符(|)将计划作业发送到 Get-JobTrigger cmdlet,该 cmdlet 可获取计划作业的所有作业触发器。 另一个管道运算符将作业触发器发送到 Disable-JobTrigger cmdlet,这会禁用它们。第一个命令使用 Get-ScheduledJob cmdlet 获取作业,因为它 Name 参数采用多个名称。

第二个命令显示结果。 该命令重复 Get-ScheduledJobGet-JobTrigger 命令。 管道运算符将作业触发器发送到 Format-Table cmdlet,该 cmdlet 在表中显示作业触发器。 Format-Table 命令添加一个 JobName 属性,该属性在作业触发器对象的 JobDefinition 属性中显示计划作业的 Name 属性的值。

这些命令在两个计划作业上禁用所有作业触发器,并显示结果。

示例 3:禁用远程计算机上的计划作业的作业触发器

此示例禁用远程计算机上的计划作业的每日作业触发器

Invoke-Command -ComputerName Server01 {
    Get-JobTrigger -Name DeployPackage |
    Where-Object {$_.Frequency -eq "Daily"} |
    Disable-JobTrigger
}

该命令使用 Invoke-Command cmdlet 在 Server01 计算机上运行命令。 远程命令使用 Get-JobTrigger cmdlet 来获取 DeployPackage 计划作业的作业触发器。 管道运算符将作业触发器发送到 Where-Object cmdlet,该 cmdlet 仅返回每日作业触发器。 管道运算符将每日作业触发器发送到 Disable-JobTrigger cmdlet,这会禁用它们。

参数

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InputObject

指定要禁用的作业触发器。 输入一个变量,其中包含 ScheduledJobTrigger 对象或键入 ScheduledJobTrigger 对象(如 Get-JobTrigger 命令)的命令或表达式。 还可以通过管道将 ScheduledJobTrigger 对象传递给 Disable-JobTrigger

参数属性

类型:

ScheduledJobTrigger[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:0
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PassThru

返回一个对象,该对象表示你正在处理的项目。 默认情况下,此 cmdlet 不生成任何输出。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

ScheduledJobTrigger

可以通过管道将作业触发器传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。

备注

  • 如果禁用已禁用的作业触发器,Disable-JobTrigger 不会生成错误或警告。