Add-JobTrigger
スケジュールされたジョブにジョブ トリガーを追加します。
構文
Add-JobTrigger
[-Trigger] <ScheduledJobTrigger[]>
[-InputObject] <ScheduledJobDefinition[]>
[<CommonParameters>]
Add-JobTrigger
[-Trigger] <ScheduledJobTrigger[]>
[-Name] <String[]>
[<CommonParameters>]
Add-JobTrigger
[-Trigger] <ScheduledJobTrigger[]>
[-Id] <Int32[]>
[<CommonParameters>]
説明
Add-JobTrigger コマンドレットは、スケジュールされたジョブにジョブ トリガーを追加します。 これを使用して、複数のスケジュールされたジョブに複数のトリガーを追加できます。
ジョブ トリガーは、1 回限りまたは定期的なスケジュールで、またはイベントが発生したときに、スケジュールされたジョブを開始します。
Add-JobTrigger の Trigger パラメーターを使用して、追加するジョブ トリガーを識別します。 Add-JobTrigger の Name、ID、または InputObject パラメーターを使用して、トリガーが追加されるスケジュールされたジョブを識別します。
Trigger パラメーターの値のジョブ トリガーを作成するには、New-JobTrigger コマンドレットを使用するか、ハッシュ テーブルを使用してジョブ トリガーを指定します。
Add-JobTrigger は、Windows PowerShell に含まれる PSScheduledJob モジュール内のジョブ スケジューリング コマンドレットのコレクションの 1 つです。
スケジュールされたジョブの詳細については、PSScheduledJob モジュールの About トピックを参照してください。
PSScheduledJob モジュールをインポートし、「 Get-Help about_Scheduled*
」と入力するか、「about_Scheduled_Jobs」と入力します。
このコマンドレットは、Windows PowerShell 3.0 で導入されました。
例
例 1: スケジュールされたジョブにジョブ トリガーを追加する
PS C:\> $Daily = New-JobTrigger -Daily -At 3AMPS
PS C:\> Add-JobTrigger -Trigger $Daily -Name "TestJob"
これらのコマンドは、日次ジョブ トリガーを TestJob スケジュールされたジョブに追加します。
最初のコマンドでは、New-JobTrigger コマンドレットを使用して、スケジュールされたジョブを毎日午前 3:00 に開始するジョブ トリガーを作成します。このコマンドは、ジョブ・トリガーを $Daily 変数に保存します。
2 番目のコマンドでは、 Add-JobTrigger コマンドレットを使用して、$Startup 変数のジョブ トリガーを TestJob スケジュールされたジョブに追加します。
例 2: スケジュールされた複数のジョブにジョブ トリガーを追加する
PS C:\> Get-ScheduledJob | Add-JobTrigger -Trigger (New-JobTrigger -AtStartup)
このコマンドは、ローカル コンピューター上のすべてのスケジュールされたジョブに AtStartup ジョブ トリガーを追加します。 Get-ScheduledJob を使用して、コンピューター上のスケジュールされたすべてのジョブを取得します。 パイプライン演算子 (|) を使用してジョブを Add-JobTrigger コマンドレットに送信し、スケジュールされた各ジョブにジョブ トリガーを追加します。 Trigger パラメーターの値は、AtStartup ジョブ トリガーを作成する New-JobTrigger コマンドです。
例 3: ジョブ トリガーをコピーする
PS C:\> $T = Get-JobTrigger -Name "BackupArchives"
PS C:\> 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 |
入力
Microsoft.PowerShell.ScheduledJob.ScheduledJobTrigger, Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition
ジョブ トリガーまたはスケジュールされたジョブを Add-JobTrigger にパイプできます。
出力
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