Windows Scheduled Task - Enable

Octopus.Script exported 2014-05-14 by maohde belongs to ‘Windows’ category.

Enables a Windows Scheduled Task for both 2008 and 2012.

Parameters

When steps based on the template are included in a project’s deployment process, the parameters below can be set.

Task Name

TaskName

Name of the Windows Scheduled Task.

Script body

Steps based on this template will execute the following PowerShell script.

$taskName = $OctopusParameters['TaskName']

Write-Output "Enabling $taskName..."

#Check if 2008 Server
if ((Get-WmiObject Win32_OperatingSystem).Name.Contains("2008"))
{
    schtasks /Change /Enable /TN $taskName
}
else
{
    Enable-ScheduledTask $taskName;
}

Provided under the Apache License version 2.0.

Report an issue

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "c5b985a0-14ed-4364-a1c1-6a1dc65500ed",
  "Name": "Windows Scheduled Task - Enable",
  "Description": "Enables a Windows Scheduled Task for both 2008 and 2012.",
  "Version": 2,
  "ExportedAt": "2014-05-14T19:46:43.760+00:00",
  "ActionType": "Octopus.Script",
  "Author": "maohde",
  "Parameters": [
    {
      "Name": "TaskName",
      "Label": "Task Name",
      "HelpText": "Name of the Windows Scheduled Task.",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "DefaultValue": null
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptBody": "$taskName = $OctopusParameters['TaskName']\r\rWrite-Output \"Enabling $taskName...\"\r\r#Check if 2008 Server\rif ((Get-WmiObject Win32_OperatingSystem).Name.Contains(\"2008\"))\r{\r    schtasks /Change /Enable /TN $taskName\r}\relse\r{\r    Enable-ScheduledTask $taskName;\r}",
    "Octopus.Action.Script.Syntax": "PowerShell"
  },
  "Category": "Windows",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/windows-scheduled-task-enable.json",
  "Website": "/step-templates/c5b985a0-14ed-4364-a1c1-6a1dc65500ed",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAADNQTFRF////Da3qSsLvhtb0wur6O7zuWcfxldv2aMzyK7ftpOD3s+X48Pr+0fD7d9HzHLLr4fX8xD/OcwAAAaNJREFUeNrs3cFygjAUQFECWott1f//2sJoW6kIKEzNs+euXOmcmSSGDa8oJEmSJEmSJGmsj1W1K9cpsGD1Vr2WdToVEPC+2lYvZfpVrEW0qZpF1F+MRdRugzoNlvkiarfBPk0pT8GhWUSX2yASpDlLr2+DEJBmEY1ug6whx7N0n2b30G1QlmmxHsRYp6X76yvF9vg5RYQczq8UVURI35UiFmTgShED0p6lI1eKzCHTrxS5Qk6PZ9PLDtJ9PIsJmXWlyAky6/dAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQMJCyjltF/iO3gpJUpD8s4OAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgID8T8itwwKyhbTdMr4ha8hXUwZqhICcOgyNOIkE+V5wo4MSgr1u/fp7poO+AL8K/gL8yw0UeyRB34m9iQ/pVD8L5JYTO3NI58R+AsiEEzsW5OfE3sUe/zRwYkeGnG2g2CPS7rhjF4GKP0ZwyoldxK37kFqEL/7wU0mSJEmSJOmJ+xRgAHxZTCXGdZkfAAAAAElFTkSuQmCC",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History

Page updated on Wednesday, May 14, 2014