commands

^

Stop-DbaService

Author Kirill Kravtsov (@nvarscar)
Availability Windows, Linux, macOS

 

Want to see the source code for this command? Check out Stop-DbaService on GitHub.
Want to see the Bill Of Health for this command? Check out Stop-DbaService.

Synopsis

Stops SQL Server services on a computer.

Description

Stops the SQL Server related services on one or more computers. Will follow SQL Server service dependencies.

Requires Local Admin rights on destination computer(s).

Syntax

Stop-DbaService
    [[-ComputerName] <DbaInstanceParameter[]>]
    [-InstanceName <String[]>]
    [-SqlInstance <DbaInstanceParameter[]>]
    [-Type <String[]>]
    [-Timeout <Int32>]
    [-Credential <PSCredential>]
    [-Force]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-DbaService
    [-InstanceName <String[]>]
    [-Type <String[]>]
    -InputObject <Object[]>
    [-Timeout <Int32>]
    [-Credential <PSCredential>]
    [-Force]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Stop-DbaService -ComputerName sqlserver2014a

Stops the SQL Server related services on computer sqlserver2014a.

Example: 2
PS C:\> 'sql1','sql2','sql3'| Get-DbaService | Stop-DbaService

Gets the SQL Server related services on computers sql1, sql2 and sql3 and stops them.

Example: 3
PS C:\> Stop-DbaService -ComputerName sql1,sql2 -Instance MSSQLSERVER

Stops the SQL Server services related to the default instance MSSQLSERVER on computers sql1 and sql2.

Example: 4
PS C:\> Stop-DbaService -ComputerName $MyServers -Type SSRS

Stops the SQL Server related services of type "SSRS" (Reporting Services) on computers in the variable MyServers.

Example: 5
PS C:\> Stop-DbaService -ComputerName sql1 -Type Engine -Force

Stops SQL Server database engine services on sql1 forcing dependent SQL Server Agent services to stop as well.

Required Parameters

-InputObject

A collection of services from Get-DbaService

Alias ServiceCollection
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-ComputerName

The target SQL Server instance or instances.

Alias cn,host,Server
Required False
Pipeline false
Default Value $env:COMPUTERNAME
-InstanceName

Only affects services that belong to the specific instances.

Alias Instance
Required False
Pipeline false
Default Value
-SqlInstance

Use a combination of computername and instancename to get the SQL Server related services for specific instances on specific computers.
Parameters ComputerName and InstanceName will be ignored if SqlInstance is used.

Alias
Required False
Pipeline false
Default Value
-Type

Use -Type to collect only services of the desired SqlServiceType.
Can be one of the following: "Agent","Browser","Engine","FullText","SSAS","SSIS","SSRS"

Alias
Required False
Pipeline false
Default Value
Accepted Values Agent,Browser,Engine,FullText,SSAS,SSIS,SSRS
-Timeout

How long to wait for the start/stop request completion before moving on. Specify 0 to wait indefinitely.

Alias
Required False
Pipeline false
Default Value 60
-Credential

Credential object used to connect to the computer as a different user.

Alias
Required False
Pipeline false
Default Value
-Force

Use this switch to stop dependent services before proceeding with the specified service

Alias
Required False
Pipeline false
Default Value False
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before running the cmdlet.

Alias cf
Required False
Pipeline false
Default Value