Remove-JobTrigger PowerShell Get-Help Output

This is the built-in help made by Microsoft for the command 'Remove-JobTrigger', in PowerShell version 3 - as retrieved from Windows version 'Microsoft Windows Server 2012 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

SYNTAX

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

Search powershellhelp.space

DESCRIPTION

The Remove-JobTrigger cmdlet deletes job triggers from scheduled jobs.

A "job trigger" defines a recurring schedule or conditions for starting a scheduled job. To manage job triggers, use the New-JobTrigger,
Add-JobTrigger, Set-JobTrigger, and Set-ScheduledJob cmdlets.

Use the Name, ID, or InputObject parameters of Remove-JobTrigger to identify the scheduled jobs from which the triggers are removed. Use the
TriggerID parameter of Remove-JobTrigger to identify the job triggers to delete. By default, Remove-JobTrigger deletes all job triggers of a
scheduled job.

Remove-JobTrigger is one of a collection of job scheduling cmdlets in the PSScheduledJob module that is included in Windows PowerShell.

For more information about Scheduled Jobs, see the About topics in the PSScheduledJob module. Import the PSScheduledJob module and then type:
Get-Help about_Scheduled* or see about_Scheduled_Jobs.

This cmdlet is introduced in Windows PowerShell 3.0.

RELATED LINKS

REMARKS

Examples

Example 1: Delete all job triggers

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

This command deletes all job triggers from scheduled job that have names that begin with "Test".

Example 2: Delete selected job triggers

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

This command deletes only the third trigger (ID = 3) from the BackupArchive scheduled job.

Example 3: Delete AtStartup job triggers from all scheduled jobs

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

This function deletes all AtStartup job triggers from all jobs on the local computer. To use the function, run the function in your session
and then type "Delete-AtStartup"

The Delete-AtStartup function contains a single command. The command uses the Get-ScheduledJob cmdlet to get the scheduled jobs on the local
computer. A pipeline operator (|) sends the scheduled jobs to the Get-JobTrigger cmdlet, which gets all of the job triggers from each of the
scheduled jobs. A pipeline operator sends the job triggers to the Where-Object cmdlet, which selects job triggers where the value of the
Frequency property of the job trigger equals "AtStartup."

Job trigger objects have a JobDefinition property that contains the scheduled job that they trigger. The remainder of the command uses that
valuable feature.

A pipeline operator sends the AtStartup job triggers to the ForEach-Object cmdlet, which runs a Remove-JobTrigger command on each AtStartup
trigger. The value of the InputObject parameter of Remove-JobTrigger is the scheduled job in the JobDefinition property of the job trigger.
The value of the TriggerID parameter is the identifier in the ID property of the job trigger.

Example 4: Delete a job trigger from a remote scheduled job

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

This command deletes the first job trigger from the Inventory job on the Server01 computer.

The command uses the Invoke-Command cmdlet to run a Remove-JobTrigger command on the Server01 computer. The Remove-JobTrigger command uses the
ID parameter to identify the Inventory scheduled job and the TriggerID parameter to specify the first trigger. The ID parameter is especially
useful when multiple scheduled jobs have the same or similar names.