Stop-Service

Updated: August 9, 2015

Stop-Service

Stops one or more running services.

Aliases

The following abbreviations are aliases for this cmdlet: 

  • spsv

Syntax

Parameter Set: InputObject
Stop-Service [-InputObject] <ServiceController[]> [-Exclude <String[]> ] [-Force] [-Include <String[]> ] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Default
Stop-Service [-Name] <String[]> [-Exclude <String[]> ] [-Force] [-Include <String[]> ] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: DisplayName
Stop-Service -DisplayName <String[]> [-Exclude <String[]> ] [-Force] [-Include <String[]> ] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Stop-Service cmdlet sends a stop message to the Windows Service Controller for each of the specified services. You can specify the services by their service names or display names, or you can use the InputObject parameter to pass a service object that represents the service that you want to stop.

Parameters

-DisplayName<String[]>

Specifies the display names of the services to stop. Wildcard characters are permitted.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Exclude<String[]>

Specifies services that this cmdlet omits. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as s*. Wildcard characters are permitted.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Forces the cmdlet to stop a service even if that service has dependent services.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Include<String[]>

Specifies services that this cmdlet stops. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as s*. Wildcard characters are permitted.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<ServiceController[]>

Specifies ServiceController objects that represent the services to stop. Enter a variable that contains the objects, or type a command or expression that gets the objects.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies the service names of the services to stop. Wildcard characters are permitted.


Aliases

ServiceName

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByValue,ByPropertyName)

Accept Wildcard Characters?

false

-NoWait

Indicates that this cmdlet uses the no wait option.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Returns an object that represents the service. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.ServiceProcess.ServiceController, System.String

    You can pipe a service object or a string that contains the name of a service to this cmdlet.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None, System.ServiceProcess.ServiceController

    This cmdlet generates a System.ServiceProcess.ServiceController object that represents the service, if you use the PassThru parameter. Otherwise, this cmdlet does not generate any output.


Notes

  • You can also refer to Stop-Service by its built-in alias, spsv. For more information, see about_Aliases.

    Stop-Service can control services only when the current user has permission to do this. If a command does not work correctly, you might not have the required permissions.

    To find the service names and display names of the services on your system, type Get-Service. The service names appear in the Name column and the display names appear in the DisplayName column.

Examples

Example 1: Stop a service on the local computer

This command stops the Performance Logs and Alerts (SysmonLog) service on the local computer.


PS C:\> Stop-Service -Name "sysmonlog"

Example 2: Stop a service by using the display name

This command stops the Telnet service on the local computer. The command uses Get-Service to get an object that represents the Telnet service. The pipeline operator (|) pipes the object to Stop-Service, which stops the service.


PS C:\> Get-Service -DisplayName "telnet" | Stop-Service

Example 3: Stop a service that has dependent services

This example stops the IISAdmin service on the local computer. Because stopping this service also stops the services that depend on the IISAdmin service, it is best to precede Stop-Service with a command that lists the services that depend on the IISAdmin service.

The first command lists the services that depend on IISAdmin. It uses Get-Service to get an object that represents the IISAdmin service. The pipeline operator (|) passes the result to the Format-List cmdlet. The command uses the Property parameter of Format-List to list only the Name and DependentServices properties of the service.

The second command stops the IISAdmin service. The Force parameter is required to stop a service that has dependent services. The command uses the Confirm parameter to request confirmation from the user before it stops each service.


PS C:\> Get-Service -Name "iisadmin" | Format-List -Property Name, DependentServices
PS C:\> Stop-Service -Name "iisadmin" -Force -Confirm

Related topics

Community Additions

ADD
Show: