Skip to end of metadata
Go to start of metadata

NAME

Use-JobSchedulerMaster

SYNOPSIS

This cmdlet has to be used as the first operation with JobScheduler Master cmdlets
and identifies the JobScheduler Master that should be used.

Optionally applies settings from a JobScheduler Master location. A Master is identified
by its JobScheduler ID and URL for which it is operated.

SYNTAX

Use-JobSchedulerMaster [-Url <Uri>] [-Id <String>] [-InstallPath <String>] [-BasePath <String>] [[-EnvironmentV
ariablesScript] <String>] [-Credentials <PSCredential>] [-ProxyUrl <Uri>] [-ProxyCredentials <PSCredential>] [-No
Cache] <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 operations for management of the
    Windows service are not available.

PARAMETERS

Url

-Url <Uri>
Specifies the URL for which a JobScheduler Master is available.

The URL includes one of the protocols HTTP or HTTPS, the hostname and the port that JobScheduler Master listens to,
e.g. http://localhost:4444

If JobScheduler Master is operated for the Jetty web server then the URLs for the JOC GUI and the command interface
differ:

For use with Jetty specify the URL for the XML Command Interface.
The cmdlet will convert the above JOC GUI path automatically to the XML Command Interface path.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Id

-Id <String>
Specifies the ID of a JobScheduler Master.

The installation path is assumed from the -BasePath parameter and the JobScheduler ID,
therefore no -InstallPath parameter has to be specified.

Required? false
Position? 2
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? 3
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? 4
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" subdirectory and optionally "user_bin" subdirectory of a JobScheduler installation directory.

Default Value: jobscheduler_environment_variables.cmd

Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Credentials

-Credentials <PSCredential>
Specifies a credentials object that is used for authentication with JobScheduler.

A credentials object can be created e.g. with:

$account = 'John'
$password = ( 'Doe' | ConvertTo-SecureString -AsPlainText -Force)
$credentials = New-Object -typename System.Management.Automation.PSCredential -Argumentlist $account, $password

An existing credentials object can be retrieved from the Windows Credential Manager e.g. with:

$systemCredentials = Get-JobSchedulerSystemCredentials -TargetName 'localhost'
$credentials = ( New-Object -typename System.Management.Automation.PSCredential -Argumentlist $systemCredential
s.UserName, $systemCredentials.Password )

Required? false
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

ProxyUrl

-ProxyUrl <Uri>
Specifies the URL of a proxy that is used to access a JobScheduler Master.

The URL includes one of the protocols HTTP or HTTPS and optionally the port that proxy listens to, e.g. http://loca
lhost:3128

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

ProxyCredentials

-ProxyCredentials <PSCredential>
Specifies a credentials object that is used for authentication with a proxy. See parameter -Credentials how to crea
te a credentials object.

Required? false
Position? 8
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

NoCache

-NoCache <SwitchParameter>
Specifies that the cache for JobScheduler objects is ignored.
This results in the fact that for each Get-JobScheduler* cmdlet execution the response is
retrieved directly from the JobScheduler Master and is not resolved from the cache.

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

about_jobscheduler

EXAMPLES

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

C:\PS>Use-JobSchedulerMaster http://somehost:4444

Allows to manage a JobScheduler Master that is operated on the same or on a remote host.
This includes to manage Master instances that are running e.g. in a Linux box.

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

C:\PS>Use-JobSchedulerMaster http://localhost:4444 scheduler110

Use-JobSchedulerMaster -Url http://localhost:4444 -Id scheduler110

Specifies the URL for a local master and imports settings from the the JobScheduler Master with ID scheduler110.
The installation path is determined from the default value of the -BasePath parameter.

Cmdlets that require a local Master can be used, e.g. Install-JobSchedulerService, Remove-JobSchedulerService, Start-Jo
bSchedulerMaster.

-------------------------- EXAMPLE 3 --------------------------

C:\PS>Use-JobSchedulerMaster -InstallPath "C:\Program Files\sos-berlin.com\jobscheduler\scheduler110"

Imports settings from the specified installation path.

-------------------------- EXAMPLE 4 --------------------------

C:\PS>Use-JobSchedulerMaster -InstallPath $env:SCHEDULER_HOME

Imports settings from the installation path that is specified from the SCHEDULER_HOME environment variable.

  • No labels
Write a comment…