Stop-Service
Additional Resources for Stop-Service |
Stopping a Running Service http://www.microsoft.com/technet/scriptcenter/topics/msh/cmdlets/stop-service.mspx
|
SYNOPSIS
Stops one or more running services.
SYNTAX
Stop-Service [-name] <string[]> [-include <string[]>] [-exclude <string[]>] [-force] [-passthru] [-whatIf] [-confirm] [<CommonParameters>]
Stop-Service -displayName <string[]> [-include <string[]>] [-exclude <string[]>] [-force] [-passthru] [-whatIf] [-confirm] [<CommonParameters>]
Stop-Service [-inputObject <ServiceController[]>] [-include <string[]>] [-exclude <string[]>] [-force] [-passthru] [-whatIf] [-confirm] [<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 representing the services that you want to stop.
PARAMETERS
-name <string[]>
Specifies the service names of the services to be stopped. Wildcards are permitted.
The parameter name is optional. You can use "-Name" or its alias, "-ServiceName", or you can omit the parameter name.
Required? |
true |
Position? |
1 |
Default value |
|
Accept pipeline input? |
true (ByValue, ByPropertyName) |
Accept wildcard characters? |
true |
-include <string[]>
Stops only the specified services. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as "s*". Wildcards are permitted.
Required? |
false |
Position? |
named |
Default value |
|
Accept pipeline input? |
false |
Accept wildcard characters? |
true |
-exclude <string[]>
Omits the specified services. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as "s*". Wildcards are permitted.
Required? |
false |
Position? |
named |
Default value |
|
Accept pipeline input? |
false |
Accept wildcard characters? |
true |
-force <SwitchParameter>
Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. For example, Force will stop a service that has dependent services.
Required? |
false |
Position? |
named |
Default value |
False |
Accept pipeline input? |
false |
Accept wildcard characters? |
false |
-passthru <SwitchParameter>
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
Required? |
false |
Position? |
named |
Default value |
False |
Accept pipeline input? |
false |
Accept wildcard characters? |
false |
-displayName <string[]>
Specifies the display names of the services to be stopped. Wildcards are permitted.
Required? |
true |
Position? |
named |
Default value |
|
Accept pipeline input? |
false |
Accept wildcard characters? |
true |
-inputObject <ServiceController[]>
Stops the services represented by the specified ServiceController objects. Enter a variable that contains the objects or type a command or expression that gets the objects.
Required? |
false |
Position? |
named |
Default value |
|
Accept pipeline input? |
true (ByValue) |
Accept wildcard characters? |
false |
-whatIf
Describes what would happen if you executed the command without actually executing the command.
Required? |
false |
Position? |
named |
Default value |
|
Accept pipeline input? |
false |
Accept wildcard characters? |
false |
-confirm
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default value |
|
Accept pipeline input? |
false |
Accept wildcard characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".
INPUT TYPE
Object
NOTES
For more information, type "Get-Help Stop-Service -detailed". For technical information, type "Get-Help Stop-Service -full".
When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".
You can also refer to Stop-Service by its built-in alias, "spsv". For more information, see About_Alias.
Stop-Service can control services only when the current user has permission to do so. 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.
EXAMPLE 1
stop-service sysmonlog
This command stops the Performance Logs and Alerts (SysmonLog) service on the local computer.
EXAMPLE 2
get-service -displayname telnet | stop-service
This command stops the Telnet service on the local computer. The command uses the Get-Servicecmdlet to get an object representing the Telnet service. The pipeline operator pipes the object to the Stop-Service cmdlet, which stops the service.
EXAMPLE 3
get-service iisadmin | format-list -property name, dependentservices
C:PS>stop-service iisadmin -force -confirm
The Stop-Service command 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 the Stop-Service command 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 the Get-Servicecmdlet to get an object representing 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 stopping each service.
RELATED LINKS