Versions Compared

Key

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

...

Code Block
languagetext
titleUsage for UnixWindows
Usage: controller.cmd command [options]
  command:
    start           [options]
    stop            [options]
    abort           [options]
    restart         [options]
    status          [options]
    kill            [options]
    install-service [options]
    remove-service  [options]
    start-service   [options]
  options:
    --id=<JS7 Controller ID>                                    | default: controller
    --http-port=<[hostname or ip address:]number>               | default: 7444
    --https-port=<[hostname or ip address:]number>              | default:
    --data-directory=<location of data directory>               | default: C:\ProgramData\sos-berlin.com\js7\controller\controller
    --config-directory=<location of config directory>           | default: C:\ProgramData\sos-berlin.com\js7\controller\controller\config
    --java-options=<java options>                               | default: -Dfile.encoding=UTF-8  -Xmx500m -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector -Dlog4j2.asyncLoggerWaitStrategy=Block; see also https://kb.sos-berlin.com/x/aIC9
see also https://kb.sos-berlin.com/x/CKrAAw for more information.

...

  • --id=<JS7 Controller ID>
    • is a unique identifier for a Controller within a network
  • --http-port=<[hostname or ip address:]number>
    • specifies the HTTP port that the Controller is listening to in order to receive requests from JOC Cockpit.
      • controller.cmd|sh command --http-port=####

      • where #### is the numeric port.
      • This option can be also used to indicate which network interface the JS7 Controller should listen to if in addition you specify a hostname or IP address for example with --http-port=myhost:4444.
    • Without this option being used the port defaults to 4444 and the Controller listens to all available network interfaces.
    • Should you want to specify a port then the following precedence applies:
      • First precedence: command line option
      • Second precedence: environment variable JS7_CONTROLLER_HTTP_PORT (see below)
      • Third precedence: use of default value
  • --https-port=<[hostname or ip address:]number>
    • specifies the HTTPS port that the Controller is listening to in order to receive requests from a Controller:
      • agent.cmd|sh command -https-port=####
      • where #### is the numeric port.
      • This option can be also used to indicate which network interface the Controller should listen to if in addition you specify a hostname or IP address for example with --https-port=myhost:4444.
    • Should you want to specify a port then the following precedence applies:
      • First precedence: command line option
      • Second precedence: environment variable JS7_CONTROLLER_HTTPS_PORT (see below)
      • Third precedence: use of default value
  • --data-directory=<location of data directory>
    • specifies the location of the data directory.
    • This location has to be unique over all JS7 Controller instances
    • Should you want to specify a data directory then the following precedence applies:
      • First precedence: command line option
      • Second precedence: environment variable JS7_CONTROLLER_DATA (see below)
      • Third precedence: use of default value (JS7_CONTROLLER_HOME\var)
  • --config-directory=<location of config directory>
    • specifies the location of the config directory.
    • This location has to be unique for any Controller instances
    • Should you want to specify a config directory then the following precedence applies:
      • First precedence: command line option
      • Second precedence: environment variable JS7_CONTROLLER_CONFIG_DIR (see below)
      • Third precedence: use of default value (=JS7_CONTROLLER_DATA/config)
  • --java-options=<java options>
    • With Java 1.8 the initial memory allocation has changed, for details see How to manage the Java heap space.

    • This option can be used to apply Java options for the Controller, e.g. for memory settings.

    • Without this option being used the Java options default to '-Xms500m'.

    • Should you want to specify the Java options then the following precedence applies:

      • First precedence: command line option
      • Second precedence: environment variable JAVA_OPTIONS (see below)
      • Third precedence: use of default value

...