Page History

...

Install-JS7Agent.ps1 [-HomeDir] <String> [[-Data] <String>] [[-Config] <String>] [[-Logs] <String>] [[-Work] <String>] [[-User] <String>] [[-Release] <String>] [[-Tarball] <String>] [[-Patch] <String>] [[-Jar] <String>] [[-InstanceScript] <String>] [[-BackupDir] <String>] [[-LogDir] <String>] [[-ExecStart] <String>] [[-ExecStop] <String>] [[-ReturnValues] <String>] [[-DeployDir] <String[]>] [[-AgentConf] <String>] [[-PrivateConf] <String>] [[-ControllerId] <String>] [[-HttpPort] <String>] [[-HttpsPort] <String>] [[-PidFileDir] <String>] [[-PidFileName] <String>] [[-ControllerPrimaryCert] <String>] [[-ControllerSecondaryCert] <String>] [[-Keystore] <String>] [[-KeystorePassword] <SecureString>] [[-KeyAlias] <String>] [[-Truststore] <String>] [[-TruststorePassword] <SecureString>] [[-JavaHome] <String>] [[-JavaOptions] <String>] [[-StopTimeout] <Int32>] [[-ServiceDir] <String>] [[-ServiceFile] <String>] [[-ServiceName] <String>] [[-ServiceCredentials] <PSCredential>] [[-ServiceStartMode] <String>] [[-ServiceDisplayName] <String>] [-NoYade] [-NoInstall] [-UseInstall] [-Uninstall] [-UninstallHome] [-UninstallData] [-ShowLogs] [-MakeDirs] [-MakeService] [-MoveLibs] [-RemoveJournal] [-Restart] [-Abort] [-Kill] [-WhatIf] [-Confirm] [<CommonParameters>]

...

-Patch <String>
A patch is identified by an issue key and a specific release in the SOS Change Management System.

For example the -Patch JS-1984 -Release 2.2.3 parameters will download an (empty) sample patch from the SOS web site
for the respective operating system that the the cmdlet is operated for:

* For Unix the download file is https://download.sos-berlin.com/JobScheduler.2.2/js7_agent_unix.2.2.3.JS-1984.tar.gz
* For windows the downloaded file is https://download.sos-berlin.com/JobScheduler.2.2/js7_agent_windows.2.2.3.JS-1984.zip

Patches can be individually downloaded and can be made available from the -Tarball parameter.

For example the -Patch JS-1984 -Tarball /tmp/js7_agent_windows.2.2.3.JS-1984.zip parameters will apply the patch from the downloaded file.

Patches are added to the Agent's <home>/lib/patches directory.
Note that patches will be removed when updating the Agent installation later on.

To apply patches the Agent has to be restarted. The -Restart or -ExecStart, -ExecStop parameters can be used for automated restart.

Jar

-Jar <String>
Opetionally specifies the path to a .jar file that holds a patch.

The patch .jar file is copied to the Agent's <home>/lib/patches directory.

...

-InstanceScript <String>
Specifies the path to an Instance Start Script that acts as a template and that is copied to the 'bin' directory.

Users are free to choose any name for the Instance Start Script template. In the target directory the file name agent_<http-port>.sh|.cmd will be used.

The script has to be executable for the Agent daemon or Windows Service, see -User parameter.
Permissions of the script are not changed by the Installation Script.
The Installation Script will perform replacements in the Instance Start Script template for known placeholders such as <JS7_AGENT_USER>,
for details see ./bin/agent_instance.sh-example and .\bin\agent_instance.cmd-example.

...

-BackupDir <String>
If a backup directory is specified then an Agent's existing installation directory will be added to a backup file in this directory.
The backup file type will be .tar.gz for Unix and .zip for Windows.

File names are created according to the pattern: backup_js7_agent.<hostname>.<release>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz|.zip
For example: backup_js7_agent.centostest_primary.2.3.1.2022-03-19T20-50-45.tar.gz

...

-LogDir <String>
If a log directory is specified then the Installation Script will log information about processing steps to a log file in this directory.
File names are created according to the pattern: install_js7_agent.<hostname>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
For example: install_js7_agent.centostest_primary.2022-03-19T20-50-45.log

...

-ExecStart <String>
This parameter can be used should the Agent be started after installation.
For example, when using systemd for Unix or using Windows Services then the -ExecStart "StartService" parameter value
will start the Agent service provided that the underlying service has been created manually or by use of the -MakeService switch.

For Unix users can specify individual commands, for example -ExecStart "sudo systemctl start js7_agent_4445".

For Unix systemd service files see the 'JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems' article.
This parameter is an alternative to use of the -Restart switch which will start the Agent from its Instance Start Script.
If specified this parameter overrules the -Restart switch.

...

-ExecStop <String>
This parameter can be used should the Agent be stopped before installation.
For example, when using Unix systemd or Windows Services then
the -ExecStop "StopService" parameter value will stop the Agent service provided
that the underlying service has been created manually or by use of the -MakeService switch.

For Unix users can specify individual commands, for example -ExecStop "sudo systemctl stop js7_agent_4445".
This parameter is an alternative to use of the -Restart switch which stops the Agent from its Instance Start Script.
If specified this parameter overrules the -Restart switch.

...

-ReturnValues <String>
Optionally specifies the path to a file to which return values will be added in the format <name>=<key>. For example:

log_file=install_js7_agent.centostest_primary.2022-03-20T04-54-31.log
backup_file=backup_js7_agent.centostest_primary.2.3.1.2022-03-20T04-54-31.tar.gz

An existing file will be overwritten. It is recommended to use a unique file name such as /tmp/return.$PID.properties.
A value from the file can be retrieved like this:

* Unix
** backup=$(cat /tmp/return.$$.properties | grep "backup_file" | cut -d'=' -f2)
* Windows
** $backup = ( Get-Content /tmp/return.$PID.properties | Select-String "^backup_file[ ]*=[ ]*(.*)" ).Matches.Groups[1].value

...

-DeployDir <String[]>
Specifies the path to a deployment directory that holds configuration files and sub-directories that will be copied to the <config> directory.
A deployment directory allows to manage central copies of configuration files such as agent.conf, private.conf, log4j2.xml etc.

Use of a deployment directory has lower precedence as files can be overwritten by individual parameters such as -AgentConf, -PrivateConf etc.

...

-AgentConf <String>
Specifies the path to a configuration file for global Agent configuration items. The file will be copied to the <config>/agent.conf file.

Any path to a file can be used as a value of this parameter, however, the target file name agent.conf will be used.

...

-PrivateConf <String>
Specifies the path to a configuration file for private Agent configuration items. The file will be copied to the <config>/private/private.conf file.

Any path to a file can be used as a value of this parameter, however, the target file name private.conf will be used.

...

-ControllerId <String>
Specifies the Controller ID, a unique identifier of the Controller installation. Agents will be dedicated to the Controller with the given Controller ID.
The Controller ID is used in the Agent's private.conf file to specify which Controller can access a given Agent.

...

-HttpPort <String>
Specifies the HTTP port that the Agent is operated for. The default value is 4445.
The Agent by default makes use of a configuration directory ./var_<http-port> that will be excluded from a backup taken with the -BackupDir parameter.

In addition the HTTP port is used to identify the Agent Instance Start Script typically available from the ./bin/agent_<http-port>.sh|.cmd script
and to specify the value of the JS7_AGENT_HTTP_PORT environment variable in the script.

The port can be prefixed by the network interface, for example localhost:4445.
When used with the -Restart switch the HTTP port is used to identify if the Agent is running.

...

-HttpsPort <String>
Specifies the HTTPS port that the Agent is operated for. The HTTPS port is specified in the Agent Instance Start Script typically available
from the ./bin/agent_<http-port>.sh|.cmd script with the environment variable JS7_AGENT_HTTPS_PORT.

Use of HTTPS requires a keystore and truststore to be present, see -Keystore and -Truststore parameters.
The port can be prefixed by the network interface, for example batch.example.com:4445.

...

-PidFileDir <String>
Specifies the directory to which the Agent stores its PID file. By default the <data>/logs directory is used.
When using SELinux then it is recommended to specify the /var/run directory, see the 'JS7 - How to install for SELinux' article.

...

-PidFileName <String>
Specifies the name of the PID file in Unix environments. By default the file name agent.pid is used.
The PID file is created in the directory specified by the -PidFileDir parameter.

...

-ControllerPrimaryCert <String>
Specifies the path to the SSL/TLS certificate of the Primary Controller Instance.
The Installation Script extracts the distinguished name from the given certificate and adds it to the Agent's private.conf file
to allow HTTPS connections from the given Controller using mutual authentication without the need for passwords.

...

-ControllerSecondaryCert <String>
Corresponds to the -ControllerPrimaryCert parameter and is used for the Secondary Controller Instance.

...

-Keystore <String>
Specifies the path to a PKCS12 keystore file that holds the private key and certificate for HTTPS connections to the Agent.
Users are free to specify any file name, typically the name https-keystore.p12 is used. The keystore file will be copied to the <config>/private directory.

If a keystore file is made available then the Agent's <config>/private/private.conf file has to hold a reference to the keystore location and optionally the keystore password.
It is therefore recommended to use the -PrivateConf parameter to deploy an individual private.conf file that holds settings related to a keystore.
For automating the creation of keystores see the 'JS7 - How to add SSL TLS Certificates to Keystore and Truststore' article.

...

-KeystorePassword <SecureString>
Specifies the password for access to the keystore from a secure string. Use of a keystore password is required.

The are a number of ways how to specify secure strings, for example:

-KeystorePassword ( 'secret' | ConvertTo-SecureString -AsPlainText -Force )

...

-KeyAlias <String>
If a keystore holds more than one private key, for example if separate pairs of private keys/certificates for server authentication and client authentication exist, then it is not determined which private key/certificate will be used.

The alias name of a given private key/certificate is specified when the entry is added to the keystore. The alias name allows to indicate a specific private key/certificate to be used.

...

-Truststore <String>
Specifies the path to a PKCS12 truststore file that holds the certificate(s) for HTTPS connections to the Agent using mutual authentication .
Users are free to specify any file name, typically the name https-truststore.p12 is used. The truststore file will be copied to the <config>/private directory.

If a truststore file is made available then the Agent's <config>/private/private.conf file has to hold a reference to the truststore location and optionally the truststore password.
It is therefore recommended to use the -PrivateConf parameter to deploy an individual private.conf file that holds settings related to a truststore.
For automating the creation of truststores see the 'JS7 - How to add SSL TLS Certificates to Keystore and Truststore' article.

...

-TruststorePassword <SecureString>
Specifies the password for access to the truststore from a secure string.
Use of a password is recommended: it is not primarily intended to protect access to the truststore, but to ensure integrity.
The password is intended to allow verification that truststore entries have been added using the same password.

The are a number of ways how to specify secure strings, for example:

-TruststorePassword ( 'secret' | ConvertTo-SecureString -AsPlainText -Force )

...

-JavaHome <String>
Specifies the Java home directory that will be made available to the Agent from the JAVA_HOME environment variable
specified with the Agent Instance Start Script typically available from the ./bin/agent_<http-port>.sh|.cmd script.

...

-JavaOptions <String>
Specifies the Java options that will be made available to the Agent from the JAVA_OPTIONS environment variable specified with the Agent Instance Start Script typically available from the ./bin/agent_<http-port>.sh|.cmd script.

Java options can be used for example to specify Java heap space settings for the Agent.
If more than one Java option is used then the value has to be quoted, for example -JavaOptions "-Xms256m -Xmx512m".

...

-StopTimeout <Int32>
Specifies the timeout in seconds for which the Installation Script will wait for the Agent to terminates, for example if jobs are running.
If this timeout is exceeded then the Agent will be killed. A timeout is not applicable when used with the -Abort or -Kill parameters.

...

-ServiceDir <String>
For Unix environments specifies the systemd service directory to which the Agent's service file will be copied if the -MakeService switch is used.
By default the /usr/lib/systemd/system directory will be used. Users can specify an alternative location.

...

-ServiceFile <String>
For Unix environments specifies the path to a systemd service file that acts as a template and that will be copied to the Agent's <home>/bin directory.
Users are free to choose any file name as a template for the service file. The resulting service file name will be agent_<http-port>.service.
The Installation Script will perform replacements in the service file to update paths and the port to be used, for details see ./bin/agent.service-example.

...

-ServiceName <String>
For Unix environments specifies the name of the systemd service that will be created if the -MakeService switch is used.
By default the service name js7_agent_<http-port> will be used.

For Windows the service name is not specified, instead the service name js7_agent_<http-port> will be used.

...

-ServiceCredentials <PSCredential>
In Windows environments the credentials for the Windows service account can be specified for which the Agent should be operated.

A credentials object can be created in a number of ways, for example:

$cred = ( New-Object -typename System.Management.Automation.PSCredential -ArgumentList '.\sos', ( 'secret' | ConvertTo-SecureString -AsPlainText -Force) )

The first argument '.\sos' specifies the user account, the second argument 'secret' specifies the password of the Windows Service account.
Consider that the user account is specified from a local account using the .\ prefix or from a domain account using account@domain.

...

-ServiceStartMode <String>
For Windows environemnts one of the following start modes can be set when used with the -ServiceCredentials parameter:

* System
* Automatic
* Manual
* Disabled

By default automatic start is used.

...

-ServiceDisplayName <String>
For Windows environments allows to specify the display name of the Agent's Windows Service.

...