New-Service

Article
04/20/2010

Applies To: Windows PowerShell 2.0

Creates a new Windows service.

Syntax

New-Service [-Name] <string> [-BinaryPathName] <string> [-Credential <PSCredential>] [-DependsOn <string[]>] [-Description <string>] [-DisplayName <string>] [-StartupType {<Automatic> | <Manual> | <Disabled>}] [-Confirm] [-WhatIf] [<CommonParameters>]

Description

The New-Service cmdlet creates a new entry for a Windows service in the registry and in the service database. A new service requires an executable file that executes during the service.

The parameters of this cmdlet let you set the display name, description, startup type, and dependencies of the service.

Parameters

-BinaryPathName <string>

Specifies the path to the executable file for the service. This parameter is required.

Required?	true
Position?	2
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Credential <PSCredential>

Specifies a user account that has permission to perform this action. Type a user name, such as "User01" or "Domain01\User01". Or, enter a PSCredential object, such as one from the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.

Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DependsOn <string[]>

Specifies the names of other services upon which the new service depends. To enter multiple service names, use a comma to separate the names.

Required?	false
Position?	named
Default Value	None
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Description <string>

Specifies a description of the service.

Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DisplayName <string>

Specifies a display name for the service.

Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name <string>

Specifies the name of the service. This parameter is required.

Required?	true
Position?	1
Default Value
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-StartupType <ServiceStartMode>

Sets the startup type of the service. "Automatic" is the default.

Valid values are:

-- Manual: The service is started only manually, by a user (using the Service Control Manager) or by an application.

-- Automatic: The service is to be 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.

-- Disabled: The service is disabled and cannot be started by a user or application.

Required?	false
Position?	named
Default Value	Automatic
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

-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

<CommonParameters>

This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.

Inputs and Outputs

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

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

System.ServiceProcess.ServiceController

New-Service returns an object that represents the new service.

Notes

To run this cmdlet on Windows Vista and later versions of Windows, start Windows PowerShell with the "Run as administrator" option.

To delete a service, use Sc.exe, or use the Get-WmiObject cmdlet to get the Win32_Service object that represents the service and then use the Delete method to delete the service. (The object that Get-Service returns does not have a delete method.) For an example, see the Examples section.

Example 1

C:\PS>new-service -name TestService -binaryPathName "C:\WINDOWS\System32\svchost.exe -k netsvcs"

Description
-----------
This command creates a new service named "TestService".

Example 2

C:\PS>new-service -name TestService -binaryPathName "C:\WINDOWS\System32\svchost.exe -k netsvcs" -dependson NetLogon -displayName "Test Service" -StartupType Manual -Description "This is a test service."

Description
-----------
This command creates a new service named "TestService". It uses the parameters of the New-Service cmdlet to specify a description, startup type, and display name for the new service.

Example 3

C:\PS>get-wmiobject win32_service -filter "name='testservice'"

ExitCode  : 0
Name      : testservice
ProcessId : 0
StartMode : Auto
State     : Stopped
Status    : OK

Description
-----------
This command uses the Get-WmiObject cmdlet to get the Win32_Service object for the new service. This object includes the start mode and the service description.

Example 4

C:\PS>sc.exe delete TestService

- or -

C:\PS> (get-wmiobject win32_service -filter "name='TestService'").delete()

Description
-----------
This example shows two ways to delete the TestService service. The first command uses the delete option of Sc.exe. The second command uses the Delete method of the Win32_Service objects that the Get-WmiObject cmdlet returns.

Share via