.png)
Restart-Service
Published: February 29, 2012
Updated: December 5, 2012
Applies To: Windows PowerShell 2.0, Windows PowerShell 3.0
Restart-Service
Syntax
Parameter Set: InputObject Restart-Service [-InputObject] <ServiceController[]> [-Exclude <String[]> ] [-Force] [-Include <String[]> ] [-PassThru] [ <CommonParameters>] Parameter Set: Default Restart-Service [-Name] <String[]> [-Exclude <String[]> ] [-Force] [-Include <String[]> ] [-PassThru] [ <CommonParameters>] Parameter Set: DisplayName Restart-Service -DisplayName <String[]> [-Exclude <String[]> ] [-Force] [-Include <String[]> ] [-PassThru] [ <CommonParameters>]
Detailed Description
The Restart-Service cmdlet sends a stop message and then a start message to the Windows Service Controller for a specified service. If a service was already stopped, it is started without notifying you of an error. You can specify the services by their service names or display names, or you can use the InputObject parameter to pass an object that represents each service that you want to restart.
Parameters
-DisplayName<String[]>
Specifies the display names of services to be restarted. Wildcards are permitted.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
named |
|
Default Value |
none |
|
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.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
true |
-Force
Restarts a service that has dependent services.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
False |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Include<String[]>
Restarts 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.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
true |
-InputObject<ServiceController[]>
Specifies ServiceController objects that represent the services to be restarted. 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 be restarted.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByPropertyName, ByValue) |
|
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 |
False |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).
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 a service name to Restart-Service.
Outputs
The output type is the type of the objects that the cmdlet emits.
-
None or System.ServiceProcess.ServiceController
When you use the PassThru parameter, Restart-Service generates a System.ServiceProcess.ServiceController object that represents the restarted service. Otherwise, this cmdlet does not generate any output.
Notes
-
Restart-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 appears in the Name column, and the display names appear in the DisplayName column.
Examples
-------------------------- EXAMPLE 1 --------------------------
This command restarts the Windows Management Instrumentation service (WinMgmt) on the local computer.
PS C:\> Restart-Service winmgmt
-------------------------- EXAMPLE 2 --------------------------
This command restarts the services that have a display name that begins with "Net", except for the "Net Logon" service.
PS C:\> Restart-Service -DisplayName net* -Exclude "net logon"
-------------------------- EXAMPLE 3 --------------------------
This command starts all of the stopped network services on the computer.
It uses the Get-Service cmdlet to get objects representing the services whose service name begins with "net". (The optional Name parameter name is omitted.) The pipeline operator (|) sends the services object to the Where-Object cmdlet, which selects only the services with a status of "stopped." Another pipeline operator sends the selected services to Restart-Service. In practice, you would use the WhatIf parameter to see the effect of the command before using it.
PS C:\> Get-Service net* | Where-Object {$_.Status -eq "Stopped"} | Restart-Service
Related topics
