Set-JobTrigger

Set-JobTrigger
    [-InputObject] <ScheduledJobTrigger[]>
    [-DaysInterval <Int32>]
    [-WeeksInterval <Int32>]
    [-RandomDelay <TimeSpan>]
    [-At <DateTime>]
    [-User <String>]
    [-DaysOfWeek <DayOfWeek[]>]
    [-AtStartup]
    [-AtLogOn]
    [-Once]
    [-RepetitionInterval <TimeSpan>]
    [-RepetitionDuration <TimeSpan>]
    [-RepeatIndefinitely]
    [-Daily]
    [-Weekly]
    [-PassThru]
    [<CommonParameters>]

Set-JobTrigger コマンドレットは、スケジュールされたジョブのジョブ トリガーのプロパティを変更します。 このコマンドレットを使用すると、ジョブを開始する時間や頻度を変更することや、時間ベースのスケジュールから、ログオンまたは起動によってトリガーされるスケジュールに変更することができます。

ジョブ トリガーは、スケジュールされたジョブを開始するための定期的なスケジュールまたは条件を定義します。 ジョブ トリガーはディスクに保存されませんが、スケジュールされたジョブのジョブ トリガーを変更することはできます。スケジュールされたジョブは、ディスクに保存されます。

スケジュールされたジョブのジョブ トリガーを変更するには、まず Get-JobTrigger コマンドレットを使用して、スケジュールされたジョブのジョブ トリガーを取得します。 次に、トリガーを Set-JobTrigger にパイプ処理するか、トリガーを変数に保存し、Set-JobTrigger コマンドレットの InputObject パラメーターを使用してトリガーを識別します。 Set-JobTrigger の残りのパラメーターを使用して、ジョブ トリガーを変更します。

ジョブ トリガーの種類 (毎日または毎週のトリガーから AtLogon トリガーに変更するなど) を変更すると、元のトリガー プロパティが削除されます。 ただし、週単位のトリガーの曜日の変更など、トリガーの種類ではなく、値を変更した場合は、指定したプロパティのみが変更されます。 元のジョブ トリガーの他のすべてのプロパティは保持されます。

Set-JobTrigger は、Windows PowerShell に含まれる PSScheduledJob モジュール内のジョブ スケジューリング コマンドレットのコレクションの 1 つです。

スケジュールされたジョブの詳細については、PSScheduledJob モジュールの About トピックを参照してください。 PSScheduledJob モジュールをインポートし、「Get-Help about_Scheduled*」と入力するか、about_Scheduled_Jobsを参照してください。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

PS C:\> Get-JobTrigger -Name "DeployPackage"
Id         Frequency       Time                   DaysOfWeek              Enabled
--         ---------       ----                   ----------              -------
1          Weekly          9/29/2011 12:00:00 AM  {Wednesday, Saturday}   True

The second command uses the Get-JobTrigger cmdlet to get the job trigger of the DeployPackage scheduled job. A pipeline operator (|) sends the trigger to the **Set-JobTrigger** cmdlet, which changes the job trigger so that it starts the DeployPackage job on Wednesdays and Sundays. The command uses the *Passthru* parameter to return the trigger after the change.
PS C:\> Get-JobTrigger -Name "DeployPackage" | Set-JobTrigger -DaysOfWeek "Wednesday", "Sunday" -Passthru
Id         Frequency       Time                   DaysOfWeek              Enabled
--         ---------       ----                   ----------              -------
1          Weekly          9/29/2011 12:00:00 AM  {Wednesday, Sunday}     True

この例では、週単位のジョブ トリガーの曜日を変更する方法を示します。

最初のコマンドでは、Get-JobTrigger コマンドレットを使用して、スケジュールされた DeployPackage ジョブのジョブ トリガーを取得します。 出力には、トリガーによって毎週水曜日と土曜日の午前 0 時にジョブが開始されることが示されています。

このコマンドは必須ではありません。トリガーの変更の結果を表示するためにのみ含まれています。

PS C:\> Get-JobTrigger -Name "Inventory"
Id         Frequency       Time                   DaysOfWeek              Enabled
--         ---------       ----                   ----------              -------
1          Daily           9/27/2011 11:00:00 PM                          True
2          AtStartup                                                      True

The second command uses the **Get-JobTrigger** cmdlet to get the *AtStartup* job trigger of the Inventory job. The command uses the *TriggerID* parameter to identify the job trigger. A pipeline operator (|) sends the job trigger to the **Set-JobTrigger** cmdlet, which changes it to a weekly job trigger that runs every four weeks on Monday at midnight. The command uses the *Passthru* parameter to return the trigger after the change.
PS C:\> Get-JobTrigger -Name "Inventory" -TriggerID 2 | Set-JobTrigger -Weekly -WeeksInterval 4 -DaysOfWeek Monday -At "12:00 AM"
Id         Frequency       Time                   DaysOfWeek              Enabled
--         ---------       ----                   ----------              -------
1          Daily           9/27/2011 11:00:00 PM                          True
2          Weekly          10/31/2011 12:00:00 AM {Monday}                True

この例では、ジョブを開始するジョブ トリガーの種類を変更する方法を示します。 この例のコマンドは、AtStartup ジョブ・トリガーを週次トリガーに置き換えます。

最初のコマンドでは、Get-JobTrigger コマンドレットを使用して、Inventory スケジュールされたジョブのジョブ トリガーを取得します。 出力には、ジョブに 1 日あたりのトリガーと AtStartup トリガーが 2 つあることが示されています。

このコマンドは必須ではありません。トリガーの変更の結果を表示するためにのみ含まれています。

PS C:\> Invoke-Command -ComputerName "Server01" -ScriptBlock {Get-ScheduledJob | Get-JobTrigger | Where-Object {$_.User} | Set-JobTrigger -User "Domain01/Admin02"}

このコマンドは、Server01 コンピューター上のスケジュールされたジョブのすべての AtLogon ジョブ トリガーのユーザーを変更します。

このコマンドでは、Invoke-Command コマンドレットを使用して Server01 コンピューターでコマンドを実行します。

remote コマンドは、コンピューター上のすべてのスケジュールされたジョブを取得する Get-ScheduledJob コマンドで始まります。 スケジュールされたジョブは Get-JobTrigger コマンドレットにパイプ処理され、スケジュールされたジョブのジョブ トリガーが取得されます。 各ジョブ トリガーには、スケジュールされたジョブを含む JobDefinition プロパティが含まれているため、トリガーは変更された場合でもスケジュールされたジョブに関連付けられたままになります。

ジョブ トリガーは Where-Object コマンドレットにパイプ処理され、User プロパティを持つジョブ トリガーが取得されます。 選択したジョブ トリガーは Set-JobTrigger コマンドレットにパイプ処理され、ユーザーは Domain01\Admin02 に変更されます。

PS C:\> Get-JobTrigger -Name "SecurityCheck"
Id         Frequency       Time                   DaysOfWeek              Enabled
--         ---------       ----                   ----------              -------
1          Daily           4/24/2013 3:00:00 AM                           True
2          Weekly          4/24/2013 4:00:00 PM   {Sunday}                True
3          Once            4/24/2013 4:00:00 PM                           True

The second command uses the **TriggerID** parameter of the **Get-JobTrigger** cmdlet to get the *Once* trigger of the SecurityCheck scheduled job. The command pipes the trigger to the Format-List cmdlet, which displays all of the properties of the *Once* job trigger.The output shows that the trigger starts the job once every hour (RepetitionInterval = 1 hour) for one day (RepetitionDuration = 1 day).
PS C:\> Get-JobTrigger -Name "SecurityCheck" -TriggerID 3 | Format-List -Property *
At                 : 4/24/2012 4:00:00 PM
DaysOfWeek         :
Interval           : 1
Frequency          : Once
RandomDelay        : 00:00:00
RepetitionInterval : 01:00:00
RepetitionDuration : 1.00:00:00
User               :
Id                 : 3
Enabled            : True
JobDefinition      : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

The third command changes the repetition interval of the job trigger from one hour to 90 minutes. The command does not return any output.
PS C:\> Get-JobTrigger -Name "SecurityCheck" -TriggerId 3 | Set-JobTrigger -RepetitionInterval (New-TimeSpan -Minutes 90)

The fourth command displays the effect of the change.The output shows that the trigger starts the job once every 90 minutes (RepetitionInterval = 1 hour, 30 minutes) for one day (RepetitionDuration = 1 day).
PS C:\> Get-JobTrigger -Name "SecurityCheck" -TriggerID 3 | Format-List -Property *
At                 : 4/24/2012 4:00:00 PM
DaysOfWeek         :
Interval           : 1
Frequency          : Once
RandomDelay        : 00:00:00
RepetitionInterval : 01:30:00
RepetitionDuration : 1.00:00:00
User               :
Id                 : 3
Enabled            : True
JobDefinition      : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

この例のコマンドは、SecurityCheck スケジュール済みジョブの Once ジョブ・トリガーの繰り返し間隔を 60 分ごとから 90 分ごとに変更します。 SecurityCheck スケジュールされたジョブには 3 つのジョブ トリガーがあるため、コマンドは Get-JobTrigger コマンドレットの TriggerId パラメーターを使用して、変更されるジョブ トリガーを識別します。

最初のコマンドでは、 Get-JobTrigger コマンドレットを使用して、SecurityCheck スケジュールされたジョブのすべてのジョブ トリガーを取得します。 ジョブ トリガーの ID を表示する出力は、 Once ジョブ トリガーの ID が 3 であることを示しています。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

複数のジョブ トリガーを Set-JobTrigger にパイプ処理できます。

Passthru パラメーターを使用すると、Set-JobTrigger は変更されたジョブ トリガーを返します。 それ以外の場合、このコマンドレットは出力を生成しません。

• ジョブ トリガーには、スケジュールされたジョブに関連付ける JobDefintion プロパティがあります。 スケジュールされたジョブのジョブ トリガーを変更すると、ジョブが変更されます。 変更されたトリガーをスケジュールされたジョブに適用するために、Set-ScheduledJob コマンドを使用する必要はありません。