Date: Fri, 29 Mar 2024 07:31:32 +0000 (UTC) Message-ID: <227739652.12545.1711697492455@change.sos-berlin.com> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_12544_1265098212.1711697492454" ------=_Part_12544_1265098212.1711697492454 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Use-JobSchedulerMaster
This cmdlet has to be used as the first operation with JobScheduler Mast= er cmdlets and identifies the JobScheduler Master that should be used. Opti= onally applies settings from a JobScheduler Master location. A Master is id= entified by its JobScheduler ID and URL for which it is operated.
Use-JobSchedulerMaster [[-Url] <Uri>] [[-Id] <String>=
] [[-InstallPath] <String>] [[-BasePath] <String>] [[-Environme=
ntVariablesScript] <String>] [[-Credentials] <PSCredential>] [[=
-ProxyUrl] <Uri>] [[-ProxyCredentials] <PSCredential>] [-NoCach=
e] [<CommonParameters>]
During installation of a JobScheduler Master a number of settings are sp=
ecified.
Such settings are imported for use with subsequent cmdlets.
* For a local Master that is installed on the local computer the cmdlet rea=
ds
settings from the installation path.
* For a remote Master operations for management of the
Windows service are not available.
-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 p=
ort that JobScheduler Master listens to, e.g. http://localhost:4444
If JobScheduler Master is operated for the Jetty web server then the URLs f=
or the JOC GUI and the command interface differ:
* JOC GUI: https://localhost:40444/jobscheduler/operations_gui/
* XML Command Interface: http://localhost:40444/jobscheduler/engine/command=
/
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 Com=
mand Interface path.
Required? | false |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-Id <String>
Specifies the ID of a JobScheduler Master.
The installation path is assumed from the -BasePath parameter and the JobSc=
heduler ID,
therefore no -InstallPath parameter has to be specified.
Required? | false |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-InstallPath <String>
Specifies the installation path of a JobScheduler Master.
The installation path is expected to be accessible from the host on which t=
he JobScheduler cmdlets are executed.
Required? | false |
Position? | 3 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-BasePath <String>
Specifies the base path of a JobScheduler Master installation. This parame=
ter is used in
combination with the -Id parameter to determine the installation path.
<=
br>
Default Value: C:\Program Files\sos-berlin.com\jobscheduler
Required? | false |
Position? | 4 |
Default value | "$($env:ProgramFiles)\sos-berlin.com\jobschedule= r" |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-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 t=
he script is available
from the "bin" subdirectory and optionally "user_bin" subdirectory of a Job=
Scheduler installation directory.
Default Value: jobscheduler_environment_variables.cmd
Required? | false |
Position? | 5 |
Default value | jobscheduler_environment_variables.cmd |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-Credentials <PSCredential>
Specifies a credentials object that is used for authentication with JobSch=
eduler.
A credentials object can be created e.g. with:
$account =3D 'John'
$password =3D ( 'Doe' | ConvertTo-SecureString -AsPlainText -Force)
$credentials =3D New-Object -typename System.Management.Automation.PSCrede=
ntial -Argumentlist $account, $password
An existing credentials object can be retrieved from the Windows Credential=
Manager e.g. with:
$systemCredentials =3D Get-JobSchedulerSystemCredentials -TargetName 'loca=
lhost'
$credentials =3D ( New-Object -typename System.Management.Automation.PSCre=
dential -Argumentlist $systemCredentials.UserName, $systemCredentials.Passw=
ord )
Required? | false |
Position? | 6 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-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://localhost:3128
Required? | false |
Position? | 7 |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | false |
-ProxyCredentials <PSCredential>
Specifies a credentials object that is used for authentication with a prox=
y. See parameter -Credentials how to create a credentials object.
Required? | false |
Position? | 8 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-NoCache <SwitchParameter>
Specifies that the cache for JobScheduler objects is ignored.
This results in the fact that for each Get-JobScheduler* cmdlet execution t=
he response is
retrieved directly from the JobScheduler Master and is not resolved from th=
e cache.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | false |
Accept wildcard characters? | false |
-------------------------- EXAMPLE 1 --------------------------
PS > Use-JobSchedulerMaster http://somehost:4444
Allows to manage a JobScheduler Master that is operated on the same or o= n a remote host. This includes to manage Master instances that are running = e.g. in a Linux box.
-------------------------- EXAMPLE 2 --------------------------
PS > Use-JobSchedulerMaster http://localhost:4444 scheduler110 =
Use-JobSchedulerMaster -Url http://localhost:4444 -Id scheduler110
=
p>
Specifies the URL for a local master and imports settings from the the J= obScheduler Master with ID *scheduler110*. The installation path is determi= ned from the default value of the -BasePath parameter. Cmdlets that require= a local Master can be used, e.g. Install-JobSchedulerService, Remove-JobSc= hedulerService, Start-JobSchedulerMaster.
-------------------------- EXAMPLE 3 --------------------------
PS > Use-JobSchedulerMaster -InstallPath "C:\Program Files\sos-=
berlin.com\jobscheduler\scheduler110"
Imports settings from the specified installation path.
-------------------------- EXAMPLE 4 --------------------------
PS > Use-JobSchedulerMaster -InstallPath $env:SCHEDULER_HOME
Imports settings from the installation path that is specified from the S= CHEDULER_HOME environment variable.