Set-Service
Starts, stops, and suspends a service, and changes its properties.
Syntax
Name (Default)
Set-Service
[-Name] <String>
[-DisplayName <String>]
[-Credential <PSCredential>]
[-Description <String>]
[-StartupType <ServiceStartupType>]
[-Status <String>]
[-SecurityDescriptorSddl <String>]
[-Force]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObject
Set-Service
[-InputObject] <ServiceController>
[-DisplayName <String>]
[-Credential <PSCredential>]
[-Description <String>]
[-StartupType <ServiceStartupType>]
[-SecurityDescriptorSddl <String>]
[-Status <String>]
[-Force]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
This cmdlet is only available on the Windows platform.
The Set-Service cmdlet changes the properties of a service such as the Status,
Description, DisplayName, and StartupType. Set-Service can start, stop, suspend, or
pause a service. To identify a service, enter its service name or submit a service object. Or, send
a service name or service object down the pipeline to Set-Service.
Examples
Example 1: Change a display name
In this example, a service's display name is changed. To view the original display name, use
Get-Service.
Set-Service -Name LanmanWorkstation -DisplayName "LanMan Workstation"
Set-Service uses the Name parameter to specify the service's name, LanmanWorkstation. The
DisplayName parameter specifies the new display name, LanMan Workstation.
Example 2: Change the startup type of services
This example shows how to change a service's startup type.
Set-Service -Name BITS -StartupType Automatic
Get-Service BITS | Select-Object -Property Name, StartType, Status
Name StartType Status
---- --------- ------
BITS Automatic Running
Set-Service uses the Name parameter to specify the service's name, BITS. The
StartupType parameter sets the service to Automatic.
Get-Service uses the Name parameter to specify the BITS service and sends the object down
the pipeline. Select-Object uses the Property parameter to display the BITS service's
status.
Example 3: Change the description of a service
This example changes the BITS service's description and displays the result.
The Get-CimInstance cmdlet is used because it returns a Win32_Service object that includes the
service's Description.
Get-CimInstance Win32_Service -Filter 'Name = "BITS"' | Format-List Name, Description
Name : BITS
Description : Transfers files in the background using idle network bandwidth. If the service is
disabled, then any applications that depend on BITS, such as Windows Update or MSN
Explorer, will be unable to automatically download programs and other information.
Set-Service -Name BITS -Description "Transfers files in the background using idle network bandwidth."
Get-CimInstance Win32_Service -Filter 'Name = "BITS"' | Format-List Name, Description
Name : BITS
Description : Transfers files in the background using idle network bandwidth.
Get-CimInstance sends the object down the pipeline to Format-List and displays the service's
name and description. For comparison purposes, the command is run before and after the description
is updated.
Set-Service uses the Name parameter to specify the BITS service. The Description
parameter specifies the updated text for the services' description.
Example 4: Start a service
In this example, a service is started.
Set-Service -Name WinRM -Status Running -PassThru
Status Name DisplayName
------ ---- -----------
Running WinRM Windows Remote Management (WS-Manag...
Set-Service uses the Name parameter to specify the service, WinRM. The Status
parameter uses the value Running to start the service. The PassThru parameter outputs a
ServiceController object that displays the results.
Example 5: Suspend a service
This example uses the pipeline to pause to service.
Get-Service -Name Schedule | Set-Service -Status Paused
Get-Service uses the Name parameter to specify the Schedule service, and sends the object
down the pipeline. Set-Service uses the Status parameter to set the service to Paused.
Example 6: Stop a service
This example uses a variable to stop a service.
$S = Get-Service -Name Schedule
Set-Service -InputObject $S -Status Stopped
Get-Service uses the Name parameter to specify the service, Schedule. The object is stored
in the variable, $S. Set-Service uses the InputObject parameter and specifies the object
stored $S. The Status parameter sets the service to Stopped.
Example 7: Stop a service on a remote system
This example stops a service on a remote computer. For more information, see Invoke-Command.
$Cred = Get-Credential
$S = Get-Service -Name Schedule
Invoke-Command -ComputerName server01.contoso.com -Credential $Cred -ScriptBlock {
Set-Service -InputObject $S -Status Stopped
}
Get-Credential prompts for a username and password, and stores the credentials in the $Cred
variable. Get-Service uses the Name parameter to specify the Schedule service. The object
is stored in the variable, $S.
Invoke-Command uses the ComputerName parameter to specify a remote computer. The
Credential parameter uses the $Cred variable to sign on to the computer. The ScriptBlock
calls Set-Service. The InputObject parameter specifies the service object stored $S. The
Status parameter sets the service to Stopped.
Example 8: Change credential of a service
This example changes the credentials that are used to manage a service.
$credential = Get-Credential
Set-Service -Name Schedule -Credential $credential
Get-Credential prompts for a username and password, and stores the credentials in the
$credential variable. Set-Service uses the Name parameter to specify the Schedule
service. The Credential parameter uses the $credential variable and updates the Schedule
service.
Example 9: Change the SecurityDescriptor of a service
This example changes a service's SecurityDescriptor.
$SDDL = "D:(A;;CCLCSWRPWPDTLOCRRC;;;SY)(A;;CCDCLCSWRPWPDTLOCRSDRCWDWO;;;BA)(A;;CCLCSWLOCRRC;;;SU)"
Set-Service -Name "BITS" -SecurityDescriptorSddl $SDDL
The SecurityDescriptor is stored in the $SDDL variable. Set-Service uses the Name
parameter to specify the BITS service. The SecurityDescriptorSddl parameter uses
$SDDL to change the SecurityDescriptor for the BITS service.
Example 10: Set the startup type for multiple services
The Set-Service cmdlet only accepts one service name at a time. However, you can pipe multiple
services to Set-Service to change the configuration of multiple services.
Get-Service SQLWriter,spooler |
Set-Service -StartupType Automatic -PassThru |
Select-Object Name, StartType
Name StartType
---- ---------
spooler Automatic
SQLWriter Automatic
Parameters
-Confirm
Prompts you for confirmation before running Set-Service.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies the account used by the service as the Service Logon Account.
Type a user name, such as User01 or Domain01\User01, or enter a PSCredential object,
such as one generated by the Get-Credential cmdlet. If you type a user name, this cmdlet prompts
you for a password.
Credentials are stored in a PSCredential object and the password is stored as a SecureString.
Note
For more information about SecureString data protection, see How secure is SecureString?.
This parameter was introduced in PowerShell 6.0.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Description
Specifies a new description for the service.
The service description appears in Computer Management, Services. The Description isn't a
property of the Get-Service ServiceController object. To see the service description, use
Get-CimInstance that returns a Win32_Service object that represents the service.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisplayName
Specifies a new display name for the service.
Note
Typically, Set-Service only operates on Windows services and not drivers. However, if you
specify the name of a driver, Set-Service can target the driver.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DN |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Specifies the Stop mode of the service. This parameter only works when -Status Stopped is used. If
enabled, Set-Service stops the dependent services before the target service is stopped. By
default, exceptions are raised when other running services depend on the target service.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies a ServiceController object that represents the service to change. Enter a variable
that contains the object, or type a command or expression that gets the object, such as a
Get-Service command. You can use the pipeline to send a service object to Set-Service.
Parameter properties
| Type: | ServiceController |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the service name of the service to be changed. Wildcard characters aren't permitted. You
can use the pipeline to send a service name to Set-Service.
Note
Typically, Set-Service only operates on Windows services and not drivers. However, if you
specify the name of a driver, Set-Service can target the driver.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ServiceName, SN |
Parameter sets
Name
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-PassThru
Returns a ServiceController object that represents the services that were changed. By default,
Set-Service doesn't generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SecurityDescriptorSddl
Specifies the SecurityDescriptor for the service in Sddl format. The account calling
Set-Service with this parameter must have the WRITE_DAC and WRITE_OWNER permissions. For more
information, see
Service security and access rights.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | sd |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StartupType
Specifies the start mode of the service.
The acceptable values for this parameter are as follows:
- Automatic - The service is started or was started by the operating system, at system start-up. If an automatically started service depends on a manually started service, the manually started service is also started automatically at system startup.
- AutomaticDelayedStart - Starts shortly after the system boots.
- Disabled - The service is disabled and cannot be started by a user or application.
- InvalidValue - Has no effect. The cmdlet does not return an error but the StartupType of the service is not changed.
- Manual - The service is started only manually, by a user, using the Service Control Manager, or by an application.
Parameter properties
| Type: | ServiceStartupType |
| Default value: | None |
| Accepted values: | Automatic, AutomaticDelayedStart, Disabled, InvalidValue, Manual |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | StartMode, SM, ST, StartType |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Status
Specifies the status for the service.
The acceptable values for this parameter are as follows:
- Paused. Suspends the service.
- Running. Starts the service.
- Stopped. Stops the service.
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | Paused, Running, Stopped |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if Set-Service runs. The cmdlet isn't run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
ServiceController
You can pipe a service object to this cmdlet.
String
You can pipe a string that contains a service name to this cmdlet.
Outputs
None
By default, this cmdlet returns no output.
ServiceController
When you use the PassThru parameter, this cmdlet returns a ServiceController object.
Notes
This cmdlet is only available on Windows platforms.
Set-Service requires elevated permissions. Use the Run as administrator option.
Set-Service can only control services when the current user has permissions to manage services. If
a command doesn't work correctly, you might not have the required permissions.
To find a service's service name or display name, use Get-Service. The service names are in the
Name column and the display names are in the DisplayName column.