powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-Service



NAME
New-Service

SYNOPSIS
Creates a new Windows service.

SYNTAX
New-Service [-Name] [-BinaryPathName] [-Credential ] [-DependsOn ] [-Desc
ription ] [-DisplayName ] [-StartupType {Automatic | Manual | Disabled}] [-Confirm] [-WhatIf] [ monParameters>]


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 serv
ice.


PARAMETERS
-BinaryPathName
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
Specifies a user account that has permission to perform this action. Type a user name, such as "User01" or "Dom
ain01\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
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
Specifies a description of the service.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DisplayName
Specifies a display name for the service.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Name
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
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 a
pplication.

-- Automatic: The service is to be started (or was started) by the operating system, at system start-up. If a
n automatically started service depends on a manually started service, the manually started service is also sta
rted 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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

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 ad
ministrator" option.


-------------------------- 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 -path "C:\WINDOWS\System32\svchost.exe -k netsvcs" -dependson NetLogon -display
Name "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.

To specify the BinaryPathName parameter, the command uses the Path parameter alias. You can also use "-bpn".





-------------------------- 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 include
s the start mode and the service description.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113359
Get-Service
Start-Service
Stop-Service
Restart-Service
Resume-Service
Set-Service
Suspend-Service