Page History

...

• --home
  • Specifies the directory in which the Agent should be installed.
• --data
  • Specifies the directory in which Agent data such as configuration files should be stored.
  • By default the <home>/var_<http-port> directory is used, see options --home and --http-port.
• --config
  • Specifies the directory from which the Agent reads configuration files.
  • By default the <data>/config directory is used, see option --data.
• --logs
  • Specifies the directory to which the Agent stores log files.
  • By default the <data>/logs directory is used, see option --data.
• --work
  • Specifies the working directory of the Agent.
  • By default the <data> directory is used, see option --data.
• --user
  • Specifies the user account for the Agent daemon.
  • By default the account of the user running the Agent Installer Script is used.
• --release
  • Specifies a release number such as 2.3.1 for download from the SOS web site if the --tarball option is not used.
• --tarball
  • Optionally specifies the path to a .tar.gz file that holds the Agent installation files. If this option is not used the installer tarball will be downloaded from the SOS web site for the release indicated with the --release option.
  • Download is performed with curl that considers http_proxy and https_proxy environment variables and respective settings from a .curlrc file.
• --patch
  • A patch is identified by an issue key in the Change Management System, for example JS-1984.
  • Patches are downloaded from the SOS web site if the --tarball option is not used.
  • Patches are added to the Agent's <home>/lib/patches directory. Note that the patches sub-directory will be emptied when updating a Controller an Agent installation later on.
  • If a backup directory is specified then an Agent's existing installation directory will be added in a .tar.gz file in this directory.
• --instance-script
  • Specifies the path to an Instance Start Script that acts as a template and that is copied to the bin directory. Typically the name agent_<http-port>.sh. is used. Users are free to choose any name for the Instance Start Script. The script has to be executable for the Agent daemon, see --user option. Permissions of the script are not changed by the Agent Installer Script.
  • The Agent Installer 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.
• --backup-dir
  • If a backup directory is specified then an Agent's existing installation directory will be added to a .tar.gz file in this directory.
  • File names are created according to the pattern: backup_js7_agent.<hostname>.<release>.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.tar.gz
  • For example: backup_js7_agent.centostest_primary.2.3.1.2022-03-19T20-50-45.tar.gz
• --log-dir
  • If a log directory is specified then the installer script will log information about processing steps in 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
• --exec-start
  • This option can be used should the Agent be started after installation. For example, when using systemd then the option --exec-start="StartService" will start the Agent service provided that the related systemd service has been created manually or by use of the --make-service switch. Alternatively users can specify individual commands, for example --exec-start="sudo systemctl start js7_agent_4445".
  • For systemd service files see the JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems article.
  • This option is an alternative to the use of the --restart switch which will start the Agent from its Instance Start Script. If specified this option overrules the --restart switch.
• --exec-stop
  • This option can be used should the Agent be stopped before installation. For example, when using systemd then the option --exec-stop="StopService" will stop the Agent service provided that the related systemd service has been created manually or by use of the --make-service switch. Alternatively users can specify individual commands, for example --exec-stop="sudo systemctl stop js7_agent_4445".
  • For systemd service files see the JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems article.
  • This option is an alternative to the use of the --restart switch which stops the Agent from its Instance Start Script. If specified this option overrules the --restart switch.
• --return-values
  • 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.$$.$RANDOM.properties.
  • A value from the file can be retrieved like this:
    • backup=$(cat /tmp/return.$$.$RANDOM.properties | grep "backup_file" | cut -d'=' -f2)

...