Register-ScheduledJob

Register-ScheduledJob
    [-ScriptBlock] <ScriptBlock>
    [-Name] <String>
    [-Trigger <ScheduledJobTrigger[]>]
    [-InitializationScript <ScriptBlock>]
    [-RunAs32]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-ScheduledJobOption <ScheduledJobOptions>]
    [-ArgumentList <Object[]>]
    [-MaxResultCount <Int32>]
    [-RunNow]
    [-RunEvery <TimeSpan>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Register-ScheduledJob
    [-FilePath] <String>
    [-Name] <String>
    [-Trigger <ScheduledJobTrigger[]>]
    [-InitializationScript <ScriptBlock>]
    [-RunAs32]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-ScheduledJobOption <ScheduledJobOptions>]
    [-ArgumentList <Object[]>]
    [-MaxResultCount <Int32>]
    [-RunNow]
    [-RunEvery <TimeSpan>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Register-ScheduledJob cmdlet 在本地计算机上创建计划作业。

计划作业是 Windows PowerShell 后台作业，可按一次性或定期计划自动启动。 计划作业存储在磁盘上并在任务计划程序中注册，因此可以在任务计划程序中或使用 Windows PowerShell 中的计划作业 cmdlet 进行管理。

计划作业启动时，它会创建计划作业的实例。 计划作业实例与 Windows PowerShell 后台作业相同，只是结果保存在磁盘上。 使用作业 cmdlet（如 Start-Job、Get-Job 和 Receive-Job）启动、查看和获取作业实例的结果。

使用 Register-ScheduledJob 创建新的计划作业。 若要指定计划作业运行的命令，请使用 ScriptBlock 参数;若要指定作业运行的脚本，请使用 FilePath 参数。

Windows PowerShell 计划的作业使用相同的作业触发器和任务计划程序用于计划任务的作业选项。

Register-ScheduledJobTrigger 参数添加一个或多个启动作业的作业触发器。 触发器 参数是可选的，因此可以在创建计划作业时添加触发器，稍后添加作业触发器，添加 RunNow 参数以立即启动作业，使用 Start-Job cmdlet 随时启动作业，或将未触发的计划作业保存为其他作业的模板。

Options 参数允许自定义计划作业的选项设置。 Options 参数也是可选的，因此可以在创建计划作业或更改作业时设置作业选项。 由于作业选项设置可以阻止计划作业运行，因此请查看作业选项并仔细设置它们。

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

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

此 cmdlet 已在 Windows PowerShell 3.0 中引入。

PS C:\> Register-ScheduledJob -Name "Archive-Scripts" -ScriptBlock { dir $home\*.ps1 -Recurse | Copy-Item -Destination "\\Server\Share\PSScriptArchive" }

此命令将创建 Archive-Scripts 计划作业。 ScriptBlock 参数值包含一个命令，该命令以递归方式搜索$home目录以获取 .ps1 文件，并将其复制到文件共享中的目录。

由于计划作业不包含触发器，因此它不会自动启动。 稍后可以使用添加作业触发器，使用 Start-Job cmdlet 按需启动作业，或使用计划作业作为其他计划作业的模板。

The first command uses the New-ScheduledJobOption cmdlet to create a job option object, which it saves in the $O parameter. The options start the scheduled job even if the computer is not idle, wake the computer to run the job, if necessary, and allows multiple instances of the job to run in a series.
PS C:\> $O = New-ScheduledJobOption -WakeToRun -StartIfNotIdle -MultipleInstancesPolicy Queue


The second command uses the New-JobTrigger cmdlet to create job trigger that starts a job every other Monday at 9:00 PM.
PS C:\> $T = New-JobTrigger -Weekly -At "9:00 PM" -DaysOfWeek Monday -WeeksInterval 2

This command creates the UpdateVersion scheduled job, which runs the UpdateVersion.ps1 script every Monday at 9:00 p.m. The command uses the *FilePath* parameter to specify the script that the job runs. It uses the *Trigger* parameter to specify the job triggers in the $T variable and the *ScheduledJobOption* parameter to specify the option object in the $O variable.
PS C:\> Register-ScheduledJob -Name "UpdateVersion" -FilePath "\\Srv01\Scripts\UpdateVersion.ps1" -Trigger $T -ScheduledJobOption $O

此示例演示如何创建具有作业触发器和自定义作业选项的计划作业。

PS C:\> Register-ScheduledJob -FilePath "\\Srv01\Scripts\Update-Version.ps1" -Trigger @{Frequency=Weekly; At="9:00PM"; DaysOfWeek="Monday"; Interval=2} -ScheduledJobOption @{WakeToRun; StartIfNotIdle; MultipleInstancesPolicy="Queue"}

此命令与示例 2 中的命令的效果相同。 它创建计划作业，但它使用哈希表来指定 触发器 和 ScheduledJobOption 参数的值。

PS C:\> Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {Register-ScheduledJob -Name "Get-EnergyData" -FilePath "\\Srv01\Scripts\Get-EnergyData.ps1" -ScheduledJobOption $O -Trigger $T } -Credential $Cred

此命令在多个远程计算机上创建 EnergyData 计划作业。 计划作业运行一个脚本，该脚本收集原始数据并将其保存在正在运行的日志中。 计划作业是在远程计算机上创建的，在远程计算机上运行，并将其结果存储在远程计算机上。

该命令使用 Invoke-Command cmdlet 在 Servers.txt 文件中的计算机上运行 Register-ScheduledJob 命令。 Invoke-Command 命令使用 Credential 参数提供有权在 Servers.txt 文件中的计算机上创建计划作业的用户的凭据。

Register-ScheduledJob 命令在远程计算机上创建计划作业，该作业在$T变量中由作业触发器指定的计划上运行 EnergyData.ps1 脚本。 该脚本位于可供所有参与的计算机使用的文件服务器上。

PS C:\> Register-ScheduledJob -Name "CollectEnergyData" -Trigger $T -MaxResultCount 99 -ScriptBlock { Invoke-Command -AsJob -ComputerName (Servers.txt) -FilePath "\\Srv01\Scripts\Get-EnergyData.ps1" -Credential $Admin -Authentication CredSSP }

此命令使用 Register-ScheduledJob cmdlet 在本地计算机上创建 CollectEnergyData 计划作业。 该命令使用 Trigger 参数指定作业计划和 MaxResultCount 参数，将保存的结果数增加到 99。

CollectEnergyData 作业使用 Invoke-Command cmdlet 在 Servers.txt 文件中列出的计算机上以后台形式运行 EnergyData.ps1 脚本。 Invoke-Command 命令使用 AsJob 参数在本地计算机上创建后台作业对象，即使 Energydata.ps1 脚本在远程计算机上运行也是如此。 该命令使用 Credential 参数指定有权在远程计算机上运行脚本的用户帐户，并使用值为 CredSSP 的 Authentication 参数来允许委派凭据。

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

不能通过管道将输入传递给此 cmdlet。

• 每个计划作业都保存在本地计算机上的 $home\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs 目录的子目录中。 子目录为计划作业命名，并包含计划作业的 XML 文件及其执行历史记录的记录。 有关磁盘上计划作业的详细信息，请参阅about_Scheduled_Jobs_Advanced。

• 在 Windows PowerShell 中创建的计划作业显示在任务计划程序库\Microsoft\Windows\PowerShell\ScheduledJobs 文件夹中的任务计划程序中。 可以使用任务计划程序查看和编辑计划作业。

• 可以使用任务计划程序、SchTasks.exe 命令行工具和任务计划程序 cmdlet 来管理使用计划作业 cmdlet 创建的计划作业。 但是，不能使用计划作业 cmdlet 来管理在任务计划程序中创建的任务。

• 如果计划的作业命令失败，Windows PowerShell 将返回错误消息。 但是，如果任务计划程序尝试运行作业时作业失败，则错误不适用于 Windows PowerShell。

  如果计划作业未运行，请使用以下方法查找原因。

• 验证作业触发器是否已正确设置。 -- 验证作业选项中设置的条件是否满足。
• 验证运行作业的用户帐户是否有权在作业中运行命令或脚本。
• 检查任务计划程序历史记录中是否存在错误
• 检查任务计划程序事件日志中是否存在错误。

有关详细信息，请参阅about_Scheduled_Jobs_Troubleshooting。