stop-service cmdlet timeout possible?

larryq picture larryq · Sep 21, 2012 · Viewed 13.2k times · Source

We're using the stop-service cmdlet to kill a few services on our boxes. Most of the time it works great, however we have one or two services (who doesn't?) that occasionally don't play nice.

In this instance one of the services in question will remain in the stopping state, and the cmdlet puts this out to the console over and over:

[08:49:21]WARNING: Waiting for service 'MisbehavingService (MisbehavingService)' to finish 
[08:49:21]stopping...
[08:49:23]WARNING: Waiting for service 'MisbehavingService (MisbehavingService)' to finish 
[08:49:23]stopping... 
[08:49:25]WARNING: Waiting for service 'MisbehavingService (MisbehavingService)' to finish 
[08:49:25]stopping...

Eventually we have to kill the service in the task manager, and our script then continues.

Is there a way to have the stop-service cmdlet give up or timeout after a certain point? I figure we can check afterward and if the service is still running, use the kill-process cmdlet to provide a final chop.

Answer

JamesQMurphy picture JamesQMurphy · Mar 8, 2016

Although Stop-Service does not have a timeout parameter, the WaitForStatus method on the System.ServiceController class does have an overload that takes a timeout parameter (documented here). Fortunately, this is exactly the type of object that the Get-Service command returns.

Here is a simple function that takes a service name and a timeout in seconds. It returns $true if the service stops before the timeout is reached, and $false if the call times out (or if the service isn't present).

function Stop-ServiceWithTimeout ([string] $name, [int] $timeoutSeconds) {
    $timespan = New-Object -TypeName System.Timespan -ArgumentList 0,0,$timeoutSeconds
    $svc = Get-Service -Name $name
    if ($svc -eq $null) { return $false }
    if ($svc.Status -eq [ServiceProcess.ServiceControllerStatus]::Stopped) { return $true }
    $svc.Stop()
    try {
        $svc.WaitForStatus([ServiceProcess.ServiceControllerStatus]::Stopped, $timespan)
    }
    catch [ServiceProcess.TimeoutException] {
        Write-Verbose "Timeout stopping service $($svc.Name)"
        return $false
    }
    return $true
}