...
Code Block |
---|
language | text |
---|
title | Usage for Unix |
---|
|
Usage: agent.sh command [options] [switches]
command:
start [options]
start-container [options]
stop [options]
abortrestart [options]
restartstatus [options]
statuscancel [options]
switch-over cancel | kill [options]
cert [cert-options] | see https://kb.sos-berlin.com/x/jLbAAw
options:
--http-port=<[interface:]port> | http network interface and port, default: 4445
--https-port=<[interface:]port> | https network interface and port, default:
--data-directory=<directory> | default: /var/sos-berlin.com/js7/agent/var_4445
--config-directory=<directory> | default: /var/sos-berlin.com/js7/agent/var_4445/config
--sigkill-delay=<seconds> | send | send SIGTERM SIGTERM and delayed SIGKILL signal, default: 3
--timeout=<seconds> | timeout for terminating jobs on Agent stop
--killjava-scriptoptions=<path><java options> | default: -Xms100m -Dfile.encoding=UTF-8; see https://kb.sos-berlin.com/x/uYo7B
switches:
-c | --curl | user kill script on Agent start (deprecated)
--java-options=<java options> | use curl instead of Java | default: -Xms100m -Dfile.encoding=UTF-8; http client
see https://kb.sos-berlin.com/x/aIC9
ZqrAAw for switches:
-c | --curlmore information. |
Code Block |
---|
language | text |
---|
title | Usage for Windows |
---|
|
Usage: agent.cmd command [options] [switches]
command:
start [options]
stop [options]
restart | use curl instead of[options]
Java http client
status -f | --force | --sigkill [options]
cancel [options]
switch-over [options]
| forcestart-service termination of jobs[options]
on Agent stop and restart
see https://kb.sos-berlin.com/x/fAmGAw for more information. |
Code Block |
---|
language | text |
---|
title | Usage for Windows |
---|
|
Usage: agent.cmd commandinstall-service [options]
remove-service [options]
command:
cert start [cert-options]
start-container [options]
stop | see https://kb.sos-berlin.com/x/jLbAAw
options:
[options]
--http-port=<[interface:]port> abort | http network interface and port, default: [options]4445
restart [options]
--https-port=<[interface:]port> status | https network interface and [options]port, default:
cancel | kill--data-directory=<directory> [options]
cert | default: /var/sos-berlin.com/js7/agent/var_4445
[cert-options] --config-directory=<directory> | seedefault: https:/var/kb.sos-berlin.com/x/jLbAAw
options:/js7/agent/var_4445/config
--http-port=<[interface:]port>timeout=<seconds> | httptimeout networkfor interfaceterminating andjobs port,on default:Agent 4445stop
--httpsjava-port=<[interface:]port> options=<java options> | default: -Xms100m | https network interface and port, default-Dfile.encoding=UTF-8; see https://kb.sos-berlin.com/x/uYo7B
switches:
-c | -data-directory=<directory>curl | default: /var/sos-berlin.com/js7/agent/var_4445
--config-directory=<directory> | default: /var/| use curl instead of Java http client
see https://kb.sos-berlin.com/js7/agent/var_4445/config
--timeout=<seconds> | timeout for terminating jobs on Agent stop
--kill-script=<path> | user kill script on Agent start (deprecated)
--java-options=<java options> | default: -Xms100m -Dfile.encoding=UTF-8; see https://kb.sos-berlin.com/x/aIC9
switches:
-f | --force | force termination of jobs on Agent stop and restart
see https://kb.sos-berlin.com/x/fAmGAw for more information. |
Command Line Options
x/ZqrAAw for more information. |
Command Line Options
--http-port
--http-port=<[hostname or ip address:]number>
- Specifies the HTTP port that the Agent is listening to in order to receive requests from a JS7 Controller. This option can be used to indicate which network interface the JS7 Agent should listen to if a hostname or IP address is specified, for example with
--http-port=myhost:4445
. - Without this option being used the port defaults to
4445
and the Agent listens to all available network interfaces. - If a port is specified then the following order of precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_AGENT_HTTP_PORT
(see below) - Third precedence: use of default value
--https-port=<[hostname or ip address:]number>
- Specifies the HTTPS port that the Agent is listening to in order to receive requests from a Controller. This option can be used to indicate which network interface the Agent should listen to if a hostname or IP address is specified, for example, with
--https-port=myhost:4445
. - When using the HTTPS protocol for connections from a Controller instance consider additionally allowing the HTTP protocol for local connections as with
--http-port=localhost:4445
. As the Agent Start Script makes use of an HTTP connection this the protocol has to be in place to allow the Agent to be started, stopped, etc. by its Start Script. - Without this option being used the port defaults to
4445
and the Agent listens to all available network interfaces. - If a port is specified then the following order of precedence applies:
- First precedence: command line option
- Second precedence: environment variable
SJS7_AGENT_HTTPS_PORT
(see below) - Third precedence: use of default value
--data-directory=<location of data directory>
- Specifies the location of the data directory that usually includes the
config
, logs, tmp
and state
sub-directories. - This location has to be unique for any Agent instance.
- If a data directory is specified then the following order of precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_AGENT_DATA
(see below) - Third precedence: use of default value
JS7_AGENT_HOME/var_<JS7_AGENT_PORT>
--config-directory=<location of config directory>
- Specifies the location of the
config
directory for configuration data. - This location has to be unique for any Agent instance.
- Should a configuration directory be specified then the following order of precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_AGENT_CONFIG_DIR
(see below) - Third precedence: use of default value
JS7_AGENT_HOME/var_<JS7_AGENT_PORT>
--sigkill-delay
- Specifies the delay for terminating job processes on Unix in case the Agent is terminated. A value
--sigkill-delay=5
will specify 5 seconds. Default: 3
. - When the Agent is crashed or is terminated using the
--force
switch, the Agent's Watchdog Script will terminate When the Agent is crashed or is stopped then remaining job processes and child processes will be forcibly terminated by the JS7 - Agent Watchdog.- if the
--sigkill-delay
option specifies a positive, non-zero value- send all processes and child processes created by the Agent the SIGTERM signal,
- wait for the period specified with the
--sigkill-delay
option,
- send remaining job processes and child processes the SIGKILL signalsignal.
- When using JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems users should consider that
--timeout
and --sigkill-delay
values will count towards the systemd service file's TimeoutStopSec
setting. Users must ensure that the Agent is terminated when the systemd timeout is exceeded. - The option is available for Agents running on Unix starting from release 2.7.2, see
Jira |
---|
server | SOS JIRA |
---|
columnIds | issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
---|
key | JS-2148 |
---|
|
--timeout
--kill-script=<path>
The kill script provides the functionality to kill tasks and any child processes of jobs.
- Kill scripts are by default provided from the following locations:
This option The option can be used to specify the location of an individual kill script if required.
Should an individual kill script be specified then the following order of precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_AGENT_KILL_SCRIPT
(see below) - Third precedence: use of default value
- Starting from release 2.7.2 this the option is ignored, see see
Jira |
---|
server | SOS JIRA |
---|
columnIds | issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
---|
key | JS-2148 |
---|
|
--java-options=<java options>
This option can be used to apply Java options for the Agent, e.g. for memory settings, see JS7 - FAQ - Which Java Options are recommended.
Without this option being used the Java options default to -Xms100m
.
- In order to specify a number of Java options quotes have to be used like this:
--java-options="-Xms100m -Xmx1g"
When specifying Java options then the following order of precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JAVA_OPTIONS
(see below) - Third precedence: use of default value
...
-c , --curl
- Specifies that the
curl
utility should be used instead of the built-in HTTP client when sending commands to the Agent.
-f, --forcesigkill
Watchdog Script agent_watchdog.sh, agent_watchdog.cmd
...
When used for Container operation using Unix OS then the following command is used:
Code Block |
---|
|
agent_4445.sh|.cmd start-container [options] |
This The command is used to start the JS7 Agent in a container:
- The command will keep the start script running as PID 1 in order to receive later SIGTERM, SIGKILL signals from the container management software.
- The command
start-docker
is an alias for start-container
. Jira |
---|
server | SOS JIRA |
---|
columnIds | issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
---|
key | SET-223 |
---|
|
...
resolution | serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
---|
key | SET-223 |
---|
|
Stopping the Agent
Code Block |
---|
|
# terminate jobs and stop Agent
agent_4445.sh|.cmd stop [options]
# terminate jobs on Unix by sending SIGKILL with a delay of 10s and stop Agent
agent_4445.sh stop --sigkill-delay=10
# wait for jobs to terminate within 60s and stop Agent
agent_4445.sh|.cmd stop --timeout=60
# wait for jobs to terminate and stop Agent
|
...
Code Block |
---|
|
agent_4445.sh|.cmd stop [options]--timeout=never |
This command will safely terminate the Agent (recommended).
...
Agent
...
.
- Unix
- Using the
--force
switch will terminate any running job Job processes and child processes will terminate be terminated and the Agent normallywill terminate with exit code 0.- collect PIDs of job processes,if the
--sigkill-delay
option is usedof job processes, - send SIGTERM signal to remaining job processes and child processes for which PIDs have been collected,
- wait for the indicated delay grace timeout specified with the job or for stdout/stderr to be released by processes whichever is shorterearlier,
- send SIGKILL signal to job processes and child processes,
- terminate the Agent with exit code 0.
- Windows
- Using the
--force
switch will forcibly terminate job Job processes and child processes will be forcibly terminated and the Agent will terminate with exit code 0.
- Using the
--timeout
command line option will wait for the indicated timeout that the Agent terminates. If the timeout is exceeded and if the Agent is still running, then then Agent and runing jobs will be focibly terminated:. The option accepts a number of seconds or the never
value that indicates that the Agent will wait endlessly until job processes and child processes will terminate.
- Agent
- collect PIDs of job processes,
- terminate the Agent with exit code 143 for Unix143 for Unix and 99 for Windows.
- Watchdog
- Unix
- if the
--sigkill-delay
option is used- send SIGTERM signal to remaining job processes and child processes for which PIDs have been collected,
- wait for the indicated delay or for stdout/stderr to be released by processes whichever is shorterearlier,
- send SIGKILL signal to remaining job processes and child processes.
- Windows
- forcibly terminates terminate job processes and child processes.
Only one of the --force
and --timeout
options can be used
Code Block |
---|
|
agent_4445.sh|.cmd abort [options] |
The Agent process will terminate.
Starting from release 2.7.2 the command is deprecated and is replaced by the stop
command, optionally for Unix using the --sigkill-delay=0
option.
Code Block |
---|
|
agent_4445.sh|.cmd abort.sh|.cmd cancel | kill [options] |
The Agent process will be terminated.The command is deprecated and is replaced by the stop
command using the --force
or --timeout
options.is forcibly terminated.
- The
kill
command can be used as an alias to cancel
. - The command corresponds to sending a SIGKILL signal with a
kill -9
OS command (Unix) or taskkill
command (Windows) to the Agent. - Should jobs be running then they will be terminated by the JS7 - Agent Watchdog similar to crash of the Agent.
Anchor |
---|
| #restart_agent |
---|
| #restart_agent |
---|
|
Restarting the Agent Code Block |
---|
|
# terminate jobs and restart Agent
agent_4445.sh|.cmd cancel |restart kill [options] |
The Agent process is forcibly terminated.
- The
kill
command can be used alternatively to cancel
. - This corresponds to sending a SIGKILL signal with a
kill -9
command (Unix) or taskkill
command (Windows). - Should jobs be running then they will be terminated by the JS7 - Agent Watchdog similar to crash of the Agent.
...
Code Block |
---|
|
[options]
# terminate jobs on Unix by sending SIGKILL with a delay of 10s and restart Agent
agent_4445.sh restart --sigkill-delay=10
# wait for jobs to terminate and restart Agent
agent_4445.sh|.cmd restart [options]--timeout=never |
The command will safely restart the Agent (recommended).
- Job processes and child processes will be terminated and the Agent will terminate as explained in chapter Stopping the Agent.
- The Agent is started similar to use of the
start
command using the same options as for initial start. - The
--timeout
option for Unix/Windows and the --sigkill-delay
option for Unix can - The Agent waits for running processes of any jobs to be completed.
- Using the
--force
switch will terminate any running job processes and will terminate the Agent as explained in chapter Stopping the Agent. - The Agent terminates with exit code 97 on Unix and exit code 98 on Windows.
- The
--timeout
option cannot be used.
Anchor |
---|
| #status_agent |
---|
| #status_agent |
---|
|
Checking the Agent Status
Code Block |
---|
|
agent_4445.sh|.cmd status [options] |
...
|
agent_4445.sh|.cmd status [options] |
If the Agent is up and running then this command results in output such as:
Code Block |
---|
|
version: 2.0.0-alpha.20210722.2 (2021-07-22)
buildId: QQqWYNiJRbqcYqx4iiFWww
startedAt: 1626981330629
isTerminating: false
system:
hostname: agent-2-0-primary
distribution: Alpine Linux v3.13
cpuModel: Intel(R) Xeon(R) CPU E5-2630 v4 @ 2.20GHz
mxBeans:
operatingSystem:
availableProcessors: 8
systemLoadAverage: 0.0107421875
java:
version: 1.8.0_292
memory:
maximum: 954728448
total: 289931264
free: 87118936
systemProperties:
java.vendor: IcedTea
os.arch: amd64
java.runtime.name: OpenJDK Runtime Environment
java.runtimeos.version: 3.10.0-957.1.3.el7.x86_64
os.name: Linux
java.vm.name: OpenJDK 64-Bit RuntimeServer EnvironmentVM
osjava.version: 31.108.0-957.1.3.el7.x86_64
os.name: Linux
java.vm.name: OpenJDK 64-Bit Server VM
java.version: 1.8.0_292_292 |
Switching-over the Active Director Agent Instance
Code Block |
---|
|
agent_4445.sh|.cmd switch-over [options] |
If an Agent Cluster is operated then the command will switch the active role from the Active Director Agent instance to the Standby Director Agent instance. The command can be executed for the Active Director Agent .
After switch-over the Agent instance is restarted.
Performing Certificate Rollout
...
- For general information see JS7 - Log Levels and Debug Options.
- The log level can be increased by using the Agent's Apache ProcRun Daemon Service Manager daemon/service. On Windows systems this is installed in the Agent's
service
directory with a name such as js7_agent_<port>w.exe
where <port>
is the Agent's HTTP port. - Users can start the ProcRun Manager, select the Logging tab in the user interface and set the log level to Debug.
- For the location of log files see JS7 - Log Files and Locations.
- Users should consider reverting the debug log level to its original value once they are finished with debugging.
Resources