Windows Service - Remove | Octopus Integrations

Octopus.Script exported 2014-05-19 by bobjwalker belongs to ‘Windows’ category.

Removes a Windows service.

Parameters

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

Service name to remove.

ServiceName

Name of the service to remove. Example: OctopusDeploy Tentacle

Script body

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

$TheService = Get-Service $ServiceName -ErrorAction SilentlyContinue
if ($TheService)
{
    Write-Host "Windows Service ""$ServiceName"" found, removing service."
    if ($TheService.Status -eq "Running")
    {
        Write-Host "Stopping $ServiceName ..."
        $TheService.Stop()
    }
    sc.exe delete $TheService
    Write-Host "Service ""$ServiceName"" removed."
}
else
{
    Write-Host "Windows Service ""$ServiceName"" not found."
}

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": "c5e85c9f-0408-4b38-b85f-6a225fd3e9d6",
  "Name": "Windows Service - Remove",
  "Description": "Removes a Windows service.",
  "Version": 1,
  "ExportedAt": "2014-05-19T21:05:57.107+00:00",
  "ActionType": "Octopus.Script",
  "Author": "bobjwalker",
  "Parameters": [
    {
      "Name": "ServiceName",
      "Label": "Service name to remove.",
      "HelpText": "Name of the service to remove. Example: _OctopusDeploy Tentacle_",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptBody": "$TheService = Get-Service $ServiceName -ErrorAction SilentlyContinue\nif ($TheService)\n{\n    Write-Host \"Windows Service \"\"$ServiceName\"\" found, removing service.\"\n    if ($TheService.Status -eq \"Running\")\n    {\n        Write-Host \"Stopping $ServiceName ...\"\n        $TheService.Stop()\n    }\n    sc.exe delete $TheService\n    Write-Host \"Service \"\"$ServiceName\"\" removed.\"\n}\nelse\n{\n    Write-Host \"Windows Service \"\"$ServiceName\"\" not found.\"\n}\n",
    "Octopus.Action.Script.Syntax": "PowerShell"
  },
  "Category": "Windows",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/windows-service-remove.json",
  "Website": "/step-templates/c5e85c9f-0408-4b38-b85f-6a225fd3e9d6",
  "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 Monday, May 19, 2014