Windows Service - Stop | Octopus Integrations

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

Stops a Windows Service if it is running.

Parameters

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

Service Name

ServiceName

Name of the Windows Service (this is not always the display name).

Script body

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

$serviceName = $OctopusParameters['ServiceName']

Write-Output "Stopping $serviceName..."

$serviceInstance = Get-Service $serviceName -ErrorAction SilentlyContinue
if ($serviceInstance -ne $null) {
    Stop-Service $serviceName -Force
    $serviceInstance.WaitForStatus('Stopped', '00:01:00')
    Write-Output "Service $serviceName stopped."
} else {
    Write-Output "The $serviceName service could not be located."
}

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": "ab3eb4cf-5fc1-4168-be8d-02246d919ca8",
  "Name": "Windows Service - Stop",
  "Description": "Stops a Windows Service if it is running.",
  "Version": 2,
  "ExportedAt": "2014-05-05T04:13:42.618+00:00",
  "ActionType": "Octopus.Script",
  "Author": "bobjwalker",
  "Parameters": [
    {
      "Name": "ServiceName",
      "Label": "Service Name",
      "HelpText": "Name of the Windows Service (this is not always the display name).",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptBody": "$serviceName = $OctopusParameters['ServiceName']\r\rWrite-Output \"Stopping $serviceName...\"\r\r$serviceInstance = Get-Service $serviceName -ErrorAction SilentlyContinue\rif ($serviceInstance -ne $null) {\r    Stop-Service $serviceName -Force\r    $serviceInstance.WaitForStatus('Stopped', '00:01:00')\r    Write-Output \"Service $serviceName stopped.\"\r} else {\r    Write-Output \"The $serviceName service could not be located.\"\r}\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-service-stop.json",
  "Website": "/step-templates/ab3eb4cf-5fc1-4168-be8d-02246d919ca8",
  "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 5, 2014