New-Service

Module:
Microsoft.PowerShell.Management
Creates a new Windows service.

Syntax 

New-Service
   [-Name] <String>
   [-BinaryPathName] <String>
   [-DisplayName <String>]
   [-Description <String>]
   [-StartupType <ServiceStartMode>]
   [-Credential <PSCredential>]
   [-DependsOn <String[]>]
   [-WhatIf]
   [-Confirm]
   [<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 runs during the service.

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

Examples

Example 1: Create a service 

PS C:\> New-Service -Name "TestService" -BinaryPathName "C:\WINDOWS\System32\svchost.exe -k netsvcs"

This command creates a service named TestService.

Example 2: Create a service that includes description, startup type, and display name 

PS C:\> 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."

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

Example 3: View the new service 

PS C:\> Get-WmiObject win32_service -Filter "name='testservice'"

ExitCode  : 0

Name      : testservice

ProcessId : 0

StartMode : Auto

State     : Stopped

Status    : OK

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

Required Parameters

-BinaryPathName

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

Type: String
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

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

Type: String
Aliases: ServiceName
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Credential

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 generated by the Get-Credential cmdlet. If you type a user name, this cmdlet prompts you for a password.

Type: PSCredential
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DependsOn

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

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description

Specifies a description of the service.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisplayName

Specifies a display name for the service.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StartupType

Sets the startup type of the service. The acceptable values for this parameter are:

  • Manual. The service is started only manually, by a user, using the Service Control Manager, or by an application.
  • 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.

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

    The default value is Automatic.

Type: ServiceStartMode
Parameter Sets: Automatic, Manual, Disabled
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

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

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

System.ServiceProcess.ServiceController

This cmdlet returns an object that represents the new service.

Notes

  • To run this cmdlet on Windows Vista and later versions of the Windows operating system, start Windows PowerShell by using the Run as administrator option.