I’ve created a new project that combines my two primary technical passions: SharePoint 2010 and PowerShell.

The project “SharePoint PowerShell Timer Jobs” lets you create, modify and delete SharePoint timer jobs that run PowerShell scripts in the context of the SharePoint Timer Service!

It’s on Codeplex – including source code:

• http://sppowershelltimerjob.codeplex.com.
• It’s "BETA" at the moment – version 0.1.0.0.

I hope you will love it! (If so please let me know!) – Please feel free to extend the project. If you do so please share your extensions with the community!!!

PowerShell Timer Jobs could be very useful. I’ll use it for “SharePoint Warmup”. Therefore I create a PowerShell script some months ago. This I will port to a PowerShell Timer Job and post it on my blog…

Now let’s have a look…

Here’s a screenshot of the “System Settings” page of the SharePoint 2010 Central Administration:

Use “Manage PowerShell Jobs” to create, modify or delete PowerShell jobs.

On the admin page you can select an existing timer job or select “<new>” to create a new one.

If you create a new one you have to configure it and name it. Then save the timer job. After that you’ll be able to edit the script.

In this screenshot you see an existing timer job:

Here the “Edit” button is enabled. The script below the “Edit” button is read only!

Click “Edit”… Here is what you will see:

In the Edit dialog you can enter your PowerShell script and save it.

The Edit dialog does not validate your script! It have to be valid. Or you will see errors in the history list.

At the management page you can enable or disable existing jobs using the checkbox. Don’t forget to click the “Update” button after you changed something!

At the “System Settings” page of the Central Administration you see the link “Review PowerShell Job Execution History”. Using this link you will be redirected to the history list. All outputs of all of your PowerShell jobs will be collected here.

The list will not be cleared automatically! – But… You could create a SharePoint PowerShell Timer Job for this purpose 🙂 …

The last thing you should know: All the jobs you create are accessible at common SharePoint Job admin pages  like “Review Job definitions” and “Check job status” (Central Administration -> Monitoring)

Here you see a screenshot of the “Review Job definitions” page of SharePoint 2010:

This is a screenshot of the Job definitions detail page:

At least a screenshot of the “Check job status” page of SharePoint:

Some more details…

The PowerShell script of each timer job will be executed in a dedicated PowerShell runtime environment (“Runspace”).

For the PowerShell runspace I’ve created a PowerShell Host implementation. This implementation does not support any user interaction! Be sure your script does not need to interact with the user, e.g. for delete confirmation.

The script you enter will be surrounded with this code:

Add-PSSnapIn Microsoft.SharePoint.PowerShell -ErrorAction SilentlyContinue | out-null  
$o = Invoke-Command -ScriptBlock 
{ 
<your code> 
} 
$p = $o | out-string 
$p
 

For script development you should use this code frame too! But if you copy the script code from the development tool, e.g. Windows PowerShell ISE, to PowerShell Timer Jobs, be sure only to copy <your code>.

Furthermore you need to enable the execution of unsigned PowerShell scripts in the context of the SharePoint Timer Service. This service normally runs under the Farm account. Have a look into the “Services” management console.

Before you use the tool be sure you know what you do! – PowerShell scripts can damage your farm! BE CAREFULL!!!! – I’m not responsible for any damages.

You shoud test the tool in your own environment. There could be errors in the tool!!! I’ve tested it in my dev environment, but maybe in yours it does not work properly!

Feel free to extend the tool. But if you do so please publish your code to the community.

You must not remove my name or the link to the projects homepage from any file or page of the project. – Please don’t do that. Thanks 🙂

 TO USE THE PROJECT…

…you need to deploy the .WSP file to sharepoint and activate the SharePoint features in the Central Administration. The history list have to resist on the CA!!!

$urls= @("http://sharepoint.local", "http://anothersharepoint.local")

New-EventLog -LogName "Application" -Source "SharePoint Warmup Script" -ErrorAction SilentlyContinue | Out-Null

$urls | % {
    $url = $_
    try {
        $wc = New-Object System.Net.WebClient
        $wc.Credentials = [System.Net.CredentialCache]::DefaultCredentials
        $ret = $wc.DownloadString($url)
        if( $ret.Length -gt 0 ) {
            $s = "Last run successful for url ""$($url)"": $([DateTime]::Now.ToString('yyyy.dd.MM HH:mm:ss'))" 
            $filename=((Split-Path ($MyInvocation.MyCommand.Path))+"lastrunlog.txt")
            if( Test-Path $filename -PathType Leaf ) {
                $c = Get-Content $filename
                $cl = $c -split '`n'
                $s = ((@($s) + $cl) | select -First 200)
            }
            Out-File -InputObject ($s -join "`r`n") -FilePath $filename
        }
    } catch {
          Write-EventLog -Source "SharePoint Warmup Script"  -Category 0 -ComputerName "." -EntryType Error -LogName "Application" `
            -Message "SharePoint Warmup failed for url ""$($url)""." -EventId 1001

        $s = "Last run failed for url ""$($url)"": $([DateTime]::Now.ToString('yyyy.dd.MM HH:mm:ss')) : $($_.Exception.Message)" 
        $filename=((Split-Path ($MyInvocation.MyCommand.Path))+"lastrunlog.txt")
        if( Test-Path $filename -PathType Leaf ) {
          $c = Get-Content $filename
          $cl = $c -split '`n'
          $s = ((@($s) + $cl) | select -First 200)
        }
        Out-File -InputObject ($s -join "`r`n") -FilePath $filename
    }
}

 <?xml version="1.0" encoding="utf-16"?>

 <Task version="1.2" xmlns="http://schemas.microsoft.com/windows/2004/02/mit/task">

   <RegistrationInfo>

     <Date>2011-01-26T00:00:37.2455395</Date>

     <Author>DOMAIN\ikarstein</Author>

   </RegistrationInfo>

   <Triggers>

     <CalendarTrigger>

       <Repetition>

         <Interval>PT5M</Interval>

         <Duration>P1D</Duration>

         <StopAtDurationEnd>false</StopAtDurationEnd>

       </Repetition>

       <StartBoundary>2011-01-26T00:00:37.2455395</StartBoundary>

       <Enabled>true</Enabled>

       <ScheduleByDay>

         <DaysInterval>1</DaysInterval>

       </ScheduleByDay>

     </CalendarTrigger>

   </Triggers>

   <Principals>

     <Principal id="Author">

       <UserId>DOMAIN\spfarm</UserId>

       <LogonType>Password</LogonType>

       <RunLevel>HighestAvailable</RunLevel>

     </Principal>

   </Principals>

   <Settings>

     <MultipleInstancesPolicy>IgnoreNew</MultipleInstancesPolicy>

     <DisallowStartIfOnBatteries>true</DisallowStartIfOnBatteries>

     <StopIfGoingOnBatteries>true</StopIfGoingOnBatteries>

     <AllowHardTerminate>true</AllowHardTerminate>

     <StartWhenAvailable>false</StartWhenAvailable>

     <RunOnlyIfNetworkAvailable>false</RunOnlyIfNetworkAvailable>

     <IdleSettings>

       <StopOnIdleEnd>true</StopOnIdleEnd>

       <RestartOnIdle>false</RestartOnIdle>

     </IdleSettings>

     <AllowStartOnDemand>true</AllowStartOnDemand>

     <Enabled>true</Enabled>

     <Hidden>false</Hidden>

     <RunOnlyIfIdle>false</RunOnlyIfIdle>

     <WakeToRun>false</WakeToRun>

     <ExecutionTimeLimit>P3D</ExecutionTimeLimit>

     <Priority>7</Priority>

   </Settings>

   <Actions Context="Author">

     <Exec>

       <Command>C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe</Command>

       <Arguments>-command ".\SharePointWarmup.ps1"</Arguments>

       <WorkingDirectory>C:\Program Files\SharePoint Warmup</WorkingDirectory>

     </Exec>

   </Actions>

 </Task>