Add-JobTrigger
スケジュールされたジョブにジョブ トリガーを追加します。
構文
Add-JobTrigger
[-Trigger] <ScheduledJobTrigger[]>
[-InputObject] <ScheduledJobDefinition[]>
[<CommonParameters>]
Add-JobTrigger
[-Trigger] <ScheduledJobTrigger[]>
[-Id] <Int32[]>
[<CommonParameters>]
Add-JobTrigger
[-Trigger] <ScheduledJobTrigger[]>
[-Name] <String[]>
[<CommonParameters>]
説明
Add-JobTrigger
コマンドレットは、スケジュールされたジョブにジョブ トリガーを追加します。 このコマンドレットを使用すると、スケジュールされた複数のジョブに複数のトリガーを追加できます。
ジョブ トリガーは、1 回限りまたは定期的なスケジュールで、またはイベントが発生したときに、スケジュールされたジョブを開始します。
Add-JobTrigger
の Trigger パラメーターを使用して、追加するジョブ トリガーを識別します。 トリガーが追加されるスケジュールされたジョブを識別するには、Add-JobTrigger
の Name、ID、または InputObject パラメーターを使用します。
Trigger パラメーターの値のジョブ トリガーを作成するには、New-JobTrigger
コマンドレットを使用するか、ハッシュ テーブルを使用してジョブ トリガーを指定します。
Add-JobTrigger
は、Windows PowerShell に含まれる PSScheduledJob モジュールのジョブ スケジューリング コマンドレットのコレクションの 1 つです。
スケジュールされたジョブの詳細については、PSScheduledJob モジュールの概要トピックを参照してください。 PSScheduledJob モジュールをインポートし、「 Get-Help about_Scheduled*
」と入力するか、 about_Scheduled_Jobsを参照してください。
このコマンドレットは、Windows PowerShell 3.0 で導入されました。
例
例 1: スケジュールされたジョブにジョブ トリガーを追加する
$Daily = New-JobTrigger -Daily -At 3AMPS
Add-JobTrigger -Trigger $Daily -Name "TestJob"
これらのコマンドは、スケジュールされたジョブ TestJob に日単位のジョブ トリガーを追加します。
最初のコマンドでは、 New-JobTrigger
コマンドレットを使用して、毎日午前 3 時にスケジュールされたジョブを開始するジョブ トリガーを作成します。このコマンドは、ジョブ トリガーを $Daily
変数に保存します。
2 番目のコマンドでは、 Add-JobTrigger
コマンドレットを使用して、$Startup変数のジョブ トリガーを TestJob スケジュールされたジョブに追加します。
例 2: スケジュールされた複数のジョブにジョブ トリガーを追加する
Get-ScheduledJob | Add-JobTrigger -Trigger (New-JobTrigger -AtStartup)
このコマンドは、ローカル コンピューター上のスケジュールされたすべてのジョブに AtStartup ジョブ トリガーを追加します。 Get-ScheduledJob
を使用して、コンピューター上のすべてのスケジュールされたジョブを取得します。 パイプライン演算子 (|
) を使用してジョブを Add-JobTrigger
コマンドレットに送信し、スケジュールされた各ジョブにジョブ トリガーを追加します。 Trigger パラメーターの値は、AtStartup ジョブ トリガーを作成するNew-JobTrigger
コマンドです。
例 3: ジョブ トリガーをコピーする
$T = Get-JobTrigger -Name "BackupArchives"
Add-JobTrigger -Name "TestBackup,BackupLogs" -Trigger $T
これらのコマンドは、スケジュールされたジョブ BackupArchives のジョブ トリガーをコピーして、スケジュールされたジョブ TestBackup と BackupLogs に追加します。
最初のコマンドでは、 Get-JobTrigger
コマンドレットを使用して、BackupArchives のスケジュールされたジョブのジョブ トリガーを取得します。 このコマンドは、トリガーを $t 変数に保存します。
2 番目のコマンドでは、 Add-JobTrigger
コマンドレットを使用して、$tのジョブ トリガーを TestBackup および BackupLogs のスケジュールされたジョブに追加します。
パラメーター
-Id
スケジュールされたジョブの識別番号を指定します。 Add-JobTrigger
は、指定されたスケジュールされたジョブにジョブ トリガーを追加します。
ローカル コンピューターまたはリモート コンピューターでスケジュールされたジョブの識別番号を取得するには、 Get-ScheduledJob
コマンドレットを使用します。
型: | Int32[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InputObject
スケジュールされたジョブを指定します。 ScheduledJob オブジェクトを含む変数を入力するか、Get-ScheduledJob
コマンドなどのScheduledJob オブジェクトを取得するコマンドまたは式を入力します。
パイプ ScheduledJob オブジェクトを Add-JobTrigger
することもできます。
型: | ScheduledJobDefinition[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
スケジュールされたジョブの名前を指定します。 Add-JobTrigger
は、指定されたスケジュールされたジョブにジョブ トリガーを追加します。 ワイルドカードを利用できます。
ローカル コンピューターまたはリモート コンピューターでスケジュールされたジョブの名前を取得するには、 Get-ScheduledJob
コマンドレットを使用します。
型: | String[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Trigger
追加するジョブ トリガーを指定します。 ジョブ トリガーを指定するハッシュ テーブル、または ScheduledJobTrigger オブジェクトを含む変数を入力するか、Get-JobTrigger
コマンドなどのScheduledJobTrigger オブジェクトを取得するコマンドまたは式を入力します。 ScheduledJobTrigger オブジェクトをパイプ処理してAdd-JobTrigger
することもできます。
型: | ScheduledJobTrigger[] |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
ジョブ トリガーをこのコマンドレットにパイプできます。
スケジュールされたジョブをこのコマンドレットにパイプできます。
出力
None
このコマンドレットは、出力を返しません。
関連リンク
- 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
PowerShell