Name
Install-JobSchedulerService
SYNOPSIS
Install the JobScheduler Windows service. This operation requires elevated privileges of a Windows administrator.
SYNTAX
Install-JobSchedulerService [-Start] [[-Cluster] <String>] [-Backup] [-Pause] [-PauseAfterFailure] [-UseCredentials] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
JobScheduler is commonly operated as a Windows service.
The cmdlet installs the service and optionally assigns an account to the service.
PARAMETERS
Start
-Start <SwitchParameter>
Optionally specifies that the Windows service is started after installation.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Cluster
-Cluster <String>
Specifies that the JobScheduler instance is a cluster member.
* An active cluster operates a number of instances for shared job execution
* A passive cluster operates a single instance as a primary JobScheduler and any number of additional instances as backup JobSchedulers.
When using -Cluster "passive" then the -Backup parameter can be used to specify that the instance to be installed is a backup JobScheduler.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Backup
-Backup <SwitchParameter>
Specifies that the JobScheduler instance is a backup instance in a passive cluster.
Backup instances use the same JobScheduler ID and database connection as the primary instance.
This parameter can only be used with -Cluster "passive".
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Pause
-Pause <SwitchParameter>
Specifies that the JobScheduler is paused after start-up.
The pause is applied to the initial start-up only, it is not applied
to further starts, e.g. carried out by the Windows service panel.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
PauseAfterFailure
-PauseAfterFailure <SwitchParameter>
Specifies that the JobScheduler instance will pause on start-up if it has previously been terminated with an error.
This behavior will applies to each start of the Windows service,
e.g. by use of the Windows service panel.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
UseCredentials
-UseCredentials <SwitchParameter>
Optionally specifies that credentials are entered for the Windows service.
Without credentials being specified the JobScheduler Windows service is operated for the system account.
Credentials include to enter the user account and password when being prompted:
* Accounts should include the domain such as in domain\account. For a local account "john" this could be ".\john"
* Passwords are prompted as secure strings.
Alternatively to using this switch the account can be assigned with the Windows service panel.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
WhatIf
-WhatIf <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Confirm
-Confirm <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Install-JobSchedulerService
Removes an existing Windows service and installs the new service.
-------------------------- EXAMPLE 2 --------------------------
PS > Install-JobSchedulerService -Start
Installs and starts the Windows service.
-------------------------- EXAMPLE 3 --------------------------
PS > Install-JobSchedulerService -Start -Pause
Installs and starts the Windows service. After start-up the Windows service is paused.
-------------------------- EXAMPLE 4 --------------------------
PS > Install-JobSchedulerService -Backup
Installs the Windows service for a JobScheduler backup instance in a passive cluster.