Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Start-JobSchedulerMaster

SYNOPSIS

Starts the JobScheduler Master from a local Windows installation.

SYNTAX

Start-JobSchedulerMaster [-Service] [[-Cluster] <String>] [-Backup] [-Pause] [-PauseAfterFailure] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

JobScheduler can be started in service mode and in dialog mode:

* Service Mode: the Windows service of the JobScheduler Master is started.
* Dialog Mode: the JobScheduler Master is started in the context of the current user account.

PARAMETERS

Service

-Service <SwitchParameter>
Starts the JobScheduler Windows service.

Without this parameter being specified JobScheduler will be started in dialog mode.

Required?false
Position?named
Default valueFalse
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 valueFalse
Accept pipeline input?false
Accept wildcard characters?false

Pause

-Pause <SwitchParameter>
Specifies that the JobScheduler is paused after start-up.

When used with -Service then 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 valueFalse
Accept pipeline input?false
Accept wildcard characters?false

PauseAfterFailure

-PauseAfterFailure <SwitchParameter>
Specifies that the JobScheduler Master will pause on start-up if it has previously been terminated with an error.

When used with -Service then this behavior will apply to each start of the Windows service,
e.g. by use of the Windows service panel.

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

about_JobScheduler

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Start-JobSchedulerMaster

Starts the JobScheduler Master in dialog mode.

-------------------------- EXAMPLE 2 --------------------------

PS > Start-JobSchedulerMaster -Service

Starts the JobScheduler Master Windows service.