Name
Start-JobSchedulerJobEditor
SYNOPSIS
Starts the JobScheduler Editor (JOE)
SYNTAX
Start-JobSchedulerJobEditor [[-Id] <String>] [[-InstallPath] <String>] [[-InstallBasePath] <String>] [[-ConfigPath] <String>] [[-ConfigBasePath] <String>] [[-EnvironmentVariablesScript] <String>] [[-EditorEnvironmentVariablesScript] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
JobScheduler Editor can be started from a JobScheduler Master location or from a JobScheduler Editor location:
* The JobScheduler Master Installation includes the JobScheduler Editor
* The JobScheduler Editor is available from a separate installer
PARAMETERS
Id
-Id <String>
Specifies the ID of a JobScheduler Master.
The installation path is assumed from the -InstallBasePath parameter and the JobScheduler ID,
therefore no -InstallPath parameter has to be specified.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
InstallPath
-InstallPath <String>
Specifies the installation path of a JobScheduler Master or JobScheduler Editor.
The installation path is expected to be accessible from the host on which the JobScheduler cmdlets are executed.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
InstallBasePath
-InstallBasePath <String>
Specifies the base path of a JobScheduler Master or JobScheduler Editor installation. This parameter is used in
combination with the -Id parameter to determine the installation path.
Default Value: %ProgramFiles%\sos-berlin.com\jobscheduler
| Required? | false |
| Position? | 3 |
| Default value | "$($env:ProgramFiles)\sos-berlin.com\jobscheduler" |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ConfigPath
-ConfigPath <String>
Specifies the configuration path of a JobScheduler Maser or JobScheduler Dashboard.
The configuration path is expected to be accessible from the host on which the JobScheduler cmdlets are executed.
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ConfigBasePath
-ConfigBasePath <String>
Specifies the base path of a JobScheduler Master or JobScheduler Dashboard configuration. This parameter is used in
combination with the -Id parameter to determine the configuration path.
Default Value: %ProgramData%\sos-berlin.com\jobscheduler
| Required? | false |
| Position? | 5 |
| Default value | "$($env:ProgramData)\sos-berlin.com\jobscheduler" |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
EnvironmentVariablesScript
-EnvironmentVariablesScript <String>
Specifies the name of the script that includes environment variables of a JobScheduler Master installation.
Typically the script is available from the "bin" directory of a JobScheduler Master installation directory.
Default Value: jobscheduler_environment_variables.cmd
| Required? | false |
| Position? | 6 |
| Default value | jobscheduler_environment_variables.cmd |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
EditorEnvironmentVariablesScript
-EditorEnvironmentVariablesScript <String>
Specifies the name of the script that includes environment variables of a JobScheduler Editor installation.
Typically the script is available
from the "user_bin" directory of a JobScheduler Dashboard installation directory.
Default Value: jobeditor_environment_variables.cmd
| Required? | false |
| Position? | 7 |
| Default value | jobeditor_environment_variables.cmd |
| Accept pipeline input? | true (ByPropertyName) |
| 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 > Start-JobSchedulerJobEditor -Id scheduler110
Starts the JobScheduler Editor from a local JobScheduler Master installation with the specified id.
-------------------------- EXAMPLE 2 --------------------------
PS > Start-JobSchedulerJobEditor -InstallPath c:\Program Files\JOE
Starts JOE from the specified installation directory. This is a suitable option if JOE has been installed independently from a JobScheduler Master installation.