Share via

Remove-JobTrigger

  • リファレンス
モジュール:
PSScheduledJob

スケジュールされたジョブからジョブ トリガーを削除します。

構文

Remove-JobTrigger
      [-TriggerId <Int32[]>]
      [-InputObject] <ScheduledJobDefinition[]>
      [<CommonParameters>]
Remove-JobTrigger
      [-TriggerId <Int32[]>]
      [-Name] <String[]>
      [<CommonParameters>]
Remove-JobTrigger
      [-TriggerId <Int32[]>]
      [-Id] <Int32[]>
      [<CommonParameters>]

説明

Remove-JobTrigger コマンドレットは、スケジュールされたジョブからジョブ トリガーを削除します。

ジョブ トリガーは、スケジュールされたジョブを開始するための定期的なスケジュールまたは条件を定義します。 ジョブ トリガーを管理するには、New-JobTrigger、Add-JobTrigger、Set-JobTrigger、および Set-ScheduledJob コマンドレットを使用します。

トリガーを削除するスケジュールされたジョブを特定するには、Remove-JobTrigger の Name、ID、または InputObject パラメーターを使用します。 TriggerID パラメーターを使用して、削除するジョブ トリガーを識別します。 既定では、Remove-JobTrigger は、スケジュールされたジョブのすべてのジョブ トリガーを削除します。

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

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

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

例

例 1: すべてのジョブ トリガーを削除する

PS C:\> Remove-JobTrigger -Name "Test*"

このコマンドは、Test で始まる名前を持つスケジュールされたジョブからすべてのジョブ トリガーを削除します。

例 2: 選択したジョブ トリガーを削除する

PS C:\> Remove-JobTrigger -Name "BackupArchive" -TriggerID 3

このコマンドは、スケジュールされたジョブ BackupArchive から 3 番目のトリガー (ID = 3) のみを削除します。

例 3: すべてのスケジュールされたジョブから AtStartup ジョブ トリガーを削除する

PS C:\> function Delete-AtStartup
{
    Get-ScheduledJob | Get-JobTrigger | Where-Object {$_.Frequency -eq "AtStartup"} | ForEach-Object { Remove-JobTrigger -InputObject $_.JobDefinition -TriggerID $_.ID}
}

この関数は、ローカル コンピューター上のすべてのジョブからすべての AtStartup ジョブ トリガーを削除します。 関数を使用するには、セッションで 関数を実行し、「」と入力 Delete-AtStartupします。

Delete-AtStartup 関数には、1 つのコマンドが含まれています。 コマンドは、Get-ScheduledJob コマンドレットを使用して、ローカル コンピューターでスケジュールされたジョブを取得します。 パイプライン演算子 (|) は、スケジュールされたジョブを Get-JobTrigger コマンドレットに送信します。これにより、スケジュールされた各ジョブからすべてのジョブ トリガーが取得されます。 パイプライン演算子は、ジョブ トリガーを Where-Object コマンドレットに送信します。このコマンドレットでは、ジョブ トリガーの Frequency プロパティの値が AtStartup と等しいジョブ トリガーを選択します。

JobTrigger オブジェクトには、トリガーするスケジュールされたジョブを含む JobDefinition プロパティがあります。 このコマンドの残りの部分では、その便利な機能を使用しています。

パイプライン演算子は、atStartup ジョブ トリガーを ForEach-Object コマンドレットに送信します。このコマンドレットでは、各 AtStartup トリガーで Remove-JobTrigger コマンドが実行されます。 Remove-JobTrigger の InputObject パラメーターの値は、ジョブ トリガーの JobDefinition プロパティに格納されているスケジュールされたジョブです。 TriggerID パラメーターの値は、ジョブ トリガーの ID プロパティに格納されている ID です。

例 4: リモート のスケジュールされたジョブからジョブ トリガーを削除する

PS C:\> Invoke-Command -ComputerName "Server01" { Remove-JobTrigger -ID 38 -TriggerID 1 }

このコマンドは、Server01 コンピューター上の Inventory ジョブから最初のジョブ トリガーを削除します。

コマンドは 、Invoke-Command コマンドレットを使用して、Server01 コンピューターで Remove-JobTrigger コマンドレットを実行します。 Remove-JobTrigger コマンドレットは、ID パラメーターを使用して Inventory scheduled ジョブを識別し、TriggerID パラメーターを使用して最初のトリガーを指定します。 ID パラメーターは、複数のスケジュールされたジョブの名前が同じまたは類似している場合に特に便利です。

パラメーター

-Id

スケジュールされたジョブの識別番号を指定します。 Remove-JobTrigger は、指定されたスケジュールされたジョブからジョブ トリガーを削除します。

ローカル コンピューターまたはリモート コンピューターでスケジュールされたジョブの識別番号を取得するには、Get-ScheduledJob コマンドレットを使用します。

Type:Int32[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

スケジュールされたジョブを指定します。 ScheduledJob オブジェクトを含む変数を入力するか、または ScheduledJob オブジェクトを取得するコマンドまたは式 (Get-ScheduledJob コマンドなど) を入力します。 ScheduledJob オブジェクトを Remove-JobTrigger にパイプすることもできます。

Type:ScheduledJobDefinition[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

スケジュールされたジョブの名前を指定します。 Remove-JobTrigger は、指定されたスケジュールされたジョブからジョブ トリガーを削除します。 ワイルドカードを利用できます。

ローカル コンピューターまたはリモート コンピューターでスケジュールされたジョブの名前を取得するには、Get-ScheduledJob コマンドレットを使用します。

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TriggerId

指定されたジョブ トリガーのみを削除します。 既定では、Remove-JobTrigger は、スケジュールされたジョブからすべてのトリガーを削除します。 スケジュールされたジョブに複数のジョブ トリガーが設定されている場合に、このパラメーターを使用します。

スケジュールされたジョブの 1 つまたは複数のジョブ トリガーの ID を入力します。 複数のスケジュールされたジョブを指定した場合、 Remove-JobTrigger は、指定された ID を持つジョブ トリガーをすべてのスケジュールされたジョブから削除します。

Type:Int32[]
Position:Named
Default value:All triggers
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

ScheduledJobDefinition

パイプを使用して、スケジュールされたジョブを Remove-JobTrigger コマンドレットに渡すことができます。

出力

None

このコマンドレットは出力を生成しません。