Skip to main content

Create a Scheduled Job that Deletes Itself

In last week’s PowerShell class, we had a question about not only running a scheduled job, but how to unregister it after it finishes.  Good question.  The answer is actually very simple.
The code below is a very simple job.  The problem with it is that after it executes, it will stay in memory until you unregister it.

$Trigger = New-ScheduledTaskTrigger -Once -At (Get-Date).AddMinutes(1)

Register-ScheduledJob -Trigger $Trigger `
                      -Name "Test1" `
                      -ScriptBlock {Get-CimInstance -ClassName Win32_Bios}


In the Task Scheduler, we can see that the job completed, but it still in memory.


The cmdlet Unregister-ScheduledJob must be run to remove this object from memory.

PS C:\> Unregister-ScheduledJob -Name Test1

Now we will re-code the script to automatically remove the job after it completes.

$Trigger = New-ScheduledTaskTrigger -Once -At (Get-Date).AddMinutes(1)

Register-ScheduledJob -Trigger $Trigger `
                      -Name "Test1" `
                      -ScriptBlock {
                        Get-CimInstance -ClassName Win32_Bios
                        Unregister-ScheduledJob -Name "Test1"
                        }

Notice that the final cmdlet in the script block is Unregister-ScheduledJob.  This removal will take effect immediately in the Task Scheduler once the job completes.  If you are still in the same PowerShell session as the one you used to create the job, you will see the following error for a few minutes after the job is unregistered.

PS C:\> Get-ScheduledJob
Get-ScheduledJob : Cannot get the Test1 scheduled job because it is corrupted or in an irresolvable state. Because it cannot run,
Windows PowerShell has deleted Test1 and its results from the computer. To recreate the scheduled job, use the Register-ScheduledJob
cmdlet. For more information about corrupted scheduled jobs, see about_Scheduled_Jobs_Troubleshooting.
At line:1 char:1
+ Get-ScheduledJob
+ ~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [Get-ScheduledJob], RuntimeException
    + FullyQualifiedErrorId : CantLoadScheduledJobDefinitionFromStore,Microsoft.PowerShell.ScheduledJob.GetScheduledJobCommand

Again this error will correct itself shortly.

This method is only appropriate if you do not intent on recovering data from the script later on.  One of the benefits of a scheduled job is that the objects returned are serialized and written to disk for you to consume later.  If you un-register the job, that stored data is removed from this.  For this reason, you should ether explicitly commit the objects to disk before the Unregister-Scheduled job cmdlet is executed or only use this procedure for scripts that perform actions.  In any case, I would consider a little extra code to at least email you to let you know if the task was successful or not.



Comments

Popular posts from this blog

Adding a Comment to a GPO with PowerShell

As I'm writing this article, I'm also writing a customization for a PowerShell course I'm teaching next week in Phoenix.  This customization deals with Group Policy and PowerShell.  For those of you who attend my classes may already know this, but I sit their and try to ask the questions to myself that others may ask as I present the material.  I finished up my customization a few hours ago and then I realized that I did not add in how to put a comment on a GPO.  This is a feature that many Group Policy Administrators may not be aware of. This past summer I attended a presentation at TechEd on Group Policy.  One organization in the crowd had over 5,000 Group Policies.  In an environment like that, the comment section can be priceless.  I always like to write in the comment section why I created the policy so I know its purpose next week after I've completed 50 other tasks and can't remember what I did 5 minutes ago. In the Group Policy module for PowerShell V3, th

Return duplicate values from a collection with PowerShell

If you have a collection of objects and you want to remove any duplicate items, it is fairly simple. # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   # Remove the duplicate values. $Set1 | Select-Object -Unique 1 2 3 4 5 6 7 What if you want only the duplicate values and nothing else? # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   #Create a second collection with duplicate values removed. $Set2 = $Set1 | Select-Object -Unique   # Return only the duplicate values. ( Compare-Object -ReferenceObject $Set2 -DifferenceObject $Set1 ) . InputObject | Select-Object – Unique 1 2 This works with objects as well as numbers.  The first command creates a collection with 2 duplicates of both 1 and 2.   The second command creates another collection with the duplicates filtered out.  The Compare-Object cmdlet will first find items that are diffe

How to list all the AD LDS instances on a server

AD LDS allows you to provide directory services to applications that are free of the confines of Active Directory.  To list all the AD LDS instances on a server, follow this procedure: Log into the server in question Open a command prompt. Type dsdbutil and press Enter Type List Instances and press Enter . You will receive a list of the instance name, both the LDAP and SSL port numbers, the location of the database, and its status.