NAME
Use-JobSchedulerMaster
SYNOPSIS
This cmdlet is required to be used as the first operation with JobScheduler cmdlets.
Applies settings from a JobScheduler Master location. A Master is identified
by its JobScheduler ID, the host and port for which it is operated.
For a local Master settings are imported from its installation directory.
For a remote Master settings are specified by parameters.
SYNTAX
Use-JobSchedulerMaster [-Id <String>] [-Hostname <String>] [-Port <String>] -Remote [-InstallPath <String>] [
-BasePath <String>] [-EnvironmentVariablesScript <String>] <CommonParameters>
DESCRIPTION
During installation of a JobScheduler Master a number of settings are specified.
Such settings are imported for use with subsequent cmdlets.
- For a local Master that is installed on the local computer the cmdlet reads
settings from the installation path. - For a remote Master the parameter -Remote has to be used with the -Id, -Hostname and -Port
parameters to specify the instance.
PARAMETERS
Id
-Id <String>
Specifies the ID of a JobScheduler Master.
The installation path is determined from the -BasePath parameter and the JobScheduler ID,
therefore no -InstallPath parameter has to be specified.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters?
Hostname
-Hostname <String>
Specifies the hostname of a JobScheduler Master.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Port
-Port <String>
Specifies the port of a JobScheduler Master.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Remote
-Remote <SwitchParameter>
Specifies if the JobScheduler Master to be used is a remote instance.
By default a local instance is assumed with the Master being installed on the local computer.
Use this switch in addition to the parameters -Id, -Hostname and -Port to use a remote Master.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
InstallPath
-InstallPath <String>
Specifies the installation path of a JobScheduler Master.
The installation 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?
BasePath
-BasePath <String>
Specifies the base path of a JobScheduler Master installation. This parameter is used in
combination with the -Id parameter to determine the installation path.
Default Value: C:\Program Files\sos-berlin.com\jobscheduler
Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
EnvironmentVariablesScript
-EnvironmentVariablesScript <String>
Specifies the name of the script that includes environment variables of a JobScheduler Master installation.
Typically the script name is "jobscheduler_environment_variables.cmd" and the script is available
from the "bin" directory and optionally "user_bin" directory of a JobScheduler installation directory.
Default Value: jobscheduler_environment_variables.cmd
Required? false
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
RELATED LINKS
about_jobscheduler
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Use-Master scheduler110
Imports settings from the the JobScheduler Master with ID "scheduler110".
The installation path is determined from the default value of the -BasePath parameter.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>Use-Master -InstallPath "C:\Program Files\sos-berlin.com\jobscheduler\scheduler110"
Imports settings from the specified installation path.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>Use-Master -InstallPath $env:SCHEDULER_HOME
Imports settings from the installation path that is specified from the SCHEDULER_HOME environment variable.
-------------------------- EXAMPLE 4 --------------------------
C:\PS>Use-Master -Remote -Id scheduler110 -Hostname gollum.sos -Port 4454
Uses the specified JobScheduler Master as the base for cmdlets of this module.
Cmdlets that require a local Master cannot be used, e.g. Install-Service, Remove-Service, Start-Master.