Versions Compared

Key

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

...

Install-JS7Joc.ps1 [[-HomeDir] <String>] [[-Data] <String>] [[-ClusterId] <String>] [[-InstanceId] <Int32>] [[-Release] <String>] [[-Tarball] <String>] [[-Patch] <String>] [[-User] <String>] [[-SetupDir] <String>] [[-ResponseDir] <String>] [[-LicenseKey] <String>] [[-LicenseBin] <String>] [[-BackupDir] <String>] [[-LogDir] <String>] [[-ExecStart] <String>] [[-ExecStop] <String>] [[-ReturnValues] <String>] [[-DeployDir] <String[]>] [[-Ini] <String[]>] [[-Properties] <String>] [[-Title] <String>] [[-SecurityLevel] <String>] [[-DBMSConfig] <String[]>] [[-DBMSDriver] <String[]>] [[-DBMSInit] <String[]>] [[-HttpPort] <String>] [[-HttpsPort] <String>] [[-Keystore] <String>] [[-KeystorePassword] <SecureString>] [[-KeyAlias] <String>] [[-Truststore] <String>] [[-TruststorePassword] <SecureString>] [[-JavaHome] <String>] [[-JavaOptions] <String>] [[-ServiceDir] <String>] [[-ServiceFile] <String>] [[-ServiceName] <String>] [[-ServiceNameSuffix] <String>] [[-ServiceCredentials] <PSCredential>] [[-ServiceStartMode] <String>] [-AsUser] [-PreserveEnv] [-NoInstall] [-NoJetty] [-Uninstall] [-ShowLogs] [-MakeDirs] [-MakeService] [-Restart] [-Kill] [-WhatIf] [-Confirm] [<CommonParameters>]

...

Required?false
Position?4
Default value10
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-ExecStart <String>
This parameter can be used should the JOC Cockpit be started after installation. For example, when using systemd for Unix or using a Windows Service then the
-ExecStart "StartService" parameter value will start the JOC Cockpit service provided that the related systemd underlying service has been created manually or by use of the -MakeService switch.
When using Windows then the -ExecStart "StartService" parameter value will start the Windows Service.
Alternatively
For Unix users can specify individual commands, for example -ExecStart "sudo systemctl start js7_joc_joc-1".

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 the use of the -Restart switch which will start the JOC Cockpit from its Instance Start Script.
If specified this parameter overrules the -Restart switch.

...

-ExecStop <String>
This parameter can be used should the JOC Cockpit be stopped before installation. For example, when using Unix systemd or Windows Services then
the -ExecStop "StopService" parameter value will stop the JOC Cockpit service provided that the related systemd underlying service has been created manually or by use of the -MakeService switch.
When using Windows then the -ExecStop "StopService" parameter value will stop the Windows Service.
Alternatively users can specify individual commands, for example -ExecStop "sudo systemctl stop js7_joc_joc#1
For Unix users can specify individual commands, for example -ExecStop "sudo systemctl stop js7_joc".
This parameter is an alternative to the use of the -Restart switch which stops the JOC Cockpit from its Instance Start Script.
If specified this parameter overrules the -Restart switch.

...

-ServiceName <String>
For Unix environments specifies the name of the systemd service that will be created if the -MakeService switch is used.
Similarly for Windows a service with the given name will be created.
By default By default the service name js7_joc will be used.

For Windows the service name is not specified, instead the service name js7_joc will be used.
Optionally a suffix to the service name can be added with the -ServiceNameSuffix parameter.

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

ServiceNameSuffix

-ServiceNameSuffix <String>
For Windows environments the Windows service name is not specified. Instead the service name js7_joc _<joc-id> will be used.

The parameter optionally specifies a suffix that is appended the Windows service name.

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

...

-ServiceCredentials <PSCredential>
In Windows environments the credentials for the Windows service account can be specified for which the JOC Cockpit 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.

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

...

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

Required?false
Position?3940
Default valueAutomatic
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...