Versions Compared


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


Install-JS7Agent.ps1 [-HomeDir] <String> [[-Data] <String>] [[-Config] <String>] [[-Logs] <String>] [[-Work] <String>] [[-User] <String>] [[-Release] <String>] [[-Tarball] <String>] [[-Patch] <String>] [[-JarPatchJar] <String>] [[-LicenseKey] <String>] [[-LicenseBin] <String>] [[-InstanceScript] <String>] [[-BackupDir] <String>] [[-LogDir] <String>] [[-ExecStart] <String>] [[-ExecStop] <String>] [[-ReturnValues] <String>] [[-DeployDir] <String[]>] [[-AgentConf] <String>] [[-PrivateConf] <String>] [[-ControllerId] <String>] [[-AgentClusterId] <String>] [[-HttpPort] <String>] [[-HttpsPort] <String>] [[-PidFileDir] <String>] [[-PidFileName] <String>] [[-ControllerPrimaryCert] <String>] [[-ControllerSecondaryCert] <String>] [[-DirectorPrimaryCert] <String>] [[-DirectorSecondaryCert] <String>] [[-Keystore] <String>] [[-KeystorePassword] <SecureString>] [[-KeyAlias] <String>] [[-ClientKeystore] <String>] [[-ClientKeystorePassword] <SecureString>] [[-ClientKeyAlias] <String>] [[-Truststore] <String>] [[-TruststorePassword] <SecureString>] [[-JavaHome] <String>] [[-JavaOptions] <String>] [[-StopTimeout] <Int32>] [[-ServiceDir] <String>] [[-ServiceFile] <String>] [[-ServiceName] <String>] [[-ServiceCredentials] <PSCredential>] [[-ServiceStartMode] <String>] [[-ServiceDisplayName] <String>] [-Active] [-Standby] [-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 and Windows the download file is
* For windows the downloaded file is

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

For example the -Patch JS-1984 -Tarball /tmp/ gz 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.

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



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

The patch .jar file is has to be downloaded individually and will be copied to the Agent's <home>/lib/patches directory.


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

File names are created according to the pattern:

* backup_js7_agent.<hostname>.<release>.home.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz|.tar.gz
* backup_js7_agent.<hostname>.<release>.data.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz|.ziptar.gz

For example: backup_js7_agent.centostest_primary.2.3.1.home.2022-03-19T20-50-45.tar.gz


-------------------------- EXAMPLE BEISPIEL 1 --------------------------

PS C:\> Install-JS7Agent.ps1 -HomeDir "C:\Program Files\\js7\agent" -Data "C:\ProgramData\\js7\agent_4445" -Release 2.5.1 -HttpPort 4445 -MakeDirs


-------------------------- EXAMPLE BEISPIEL 2 --------------------------

PS C:\> Install-JS7Agent.ps1 -HomeDir "C:\Program Files\\js7\agent" -Data "C:\ProgramData\\js7\agent_4445" -Tarball /tmp/ -BackupDir /tmp/backups -LogDir /tmp/logs -HttpPort 4445 -MakeDirs


-------------------------- EXAMPLE BEISPIEL 3 --------------------------

PS C:\> Install-JS7Agent.ps1 -HomeDir "C:\Program Files\\js7\agent" -Data "C:\ProgramData\\js7\agent_4445" -Tarball /tmp/ -HttpPort localhost:4445 -HttpsPort apmacwin:4445 -JavaHome "C:\Program Files\Java\jdk-11.0.12+7-jre" -JavaOptions "-Xms100m -Xmx256m" -MakeDirs