Versions Compared

Key

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

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.

...

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

Id

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

...

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.

...

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.

...

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.

...

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.

...

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.

...

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 --------------------------

...