PASOESTART

PASOESTART is an OpenEdge extension to the TCMAN utility that encapsulates a number of separate startup actions into a single command.

Starting a PAS for OpenEdge instance usually involves manually performing the following individual actions:

1. Executing tcman clean -A to clean and archive log files.
2. Running tcman start to launch the instance.
3. Executing tcman env to check if the instance is running.
4. Polling the core server to report that the instance startup process has completed.
5. Scanning the core server and web application context logs for severe conditions that render the server unusable.
6. Verifying that at least of one child OS process, in the form of an ABL multi-session agent, is running.
7. Scanning the multi-session agent log file for startup errors that render the agent unusable.

The PASOESTART command produces a more stable and predictable startup process by performing the TCMAN actions described in the first three steps, and then by performing the error checking and process validation described in the final four steps. The PASOESTART command executes until the instance starts without any fatal errors, or until a time-out limit is reached and the startup process is terminated.

The core Apache Tomcat server in PAS for OpenEdge was designed to start even when severe network connection failures or invalid web application contexts render the server unusable by clients. Using PASOESTART helps to ensure that the instance is stable and usable after startup.

Output from the PASOESTART action includes all the status and error messages generated during the various steps in the startup process.

Syntax

Executing PASOESTART from PASMAN:

oe-install-dir/bin/pasman pasoestart -I instance-name 
-timeout seconds [-v] [-silent] [-json] [-restart] [-archive] [-container] [-nostop] [-start] [-halt] 
[-query] [-help]

Executing PASOESTART from TCMAN:

instance-dir/bin/tcman{.sh|.bat} pasoestart
-timeout seconds [-v] [-silent] [-json] [-restart] [-archive] [-container] [-nostop] [-start] [-halt] 
[-query] [-help]

Parameters

-I instance-name

The name of the instance to start.

Note: This parameter is required when you execute PASOESTART with PASMAN. This parameter is not necessary when you execute PASOESTART with TCMAN from the instance's instance-name/bin directory.

-timeout seconds

The number of seconds to wait for the PAS for OpenEdge instance to start. If the instance does not start fully within the time-out interval, it is considered hung and is stopped.

If the time-out interval is not specified, the it is set to a default of 30 seconds on UNIX servers and 120 seconds on Windows servers. If the interval is set to 0, only the current state of the specified instance is displayed. Negative values are not allowed and generate a command-line option error if used.

Note: The -timeout option is not required if you specify the -v option or the -restart option.

-v

Displays verbose execution information to the console.

-silent

Sends execution information to a log file (instance-name/logs/pasoestart.log).

Note: Status information is still sent to the console when you use -silent. See Status Information.

-json

Formats completion status information as a JSON object and sends it to the console. The default format is multi-line TEXT output to the console.

The following shows the format of the JSON output:

{
"start-action":"startup-action",
"initial-state":"pasoe-state",
"initial-processes":"os-process-list",
"exit-state":"pasoe-state",
"exit-description":"execution-status",
"exit-processes":"os-process-list",
"exit-status":"exit-status",
"exit-errors":
 [ “line-of-error-text”
             .
             .
             .           
   “line-of-error-text” ]
}

-restart

Stops the instance and performs a full startup if the instance is already running or is in a hung state.. If the instance is in the stopped state, then this option has no effect.

-start

If the instance is not running, execute this parameter to start the instance.

-halt

This parameter stops a running instance.

-query

This parameter prints or displays the current state of the instance.

-help

This provides the information about the usage of pasoestart command.

-archive

Archives existing log files. This option executes the tcman clean -A command.

-container

Modifies instance startup to not return until a terminate or interrupt signal is received.

-nostop

Turns off the default stop action, which automatically occurs after a time-out, or when PASOESTART detects errors in an instance's log files.

Note: The -nostop parameter can start an instance that is hung or in an unstable state. The primary purpose of this parameter is to force a problematic instance to start in order to debug issues. Do not use it for standard startups.

Status Codes

PASOESTART is a blocking operation. Control is not returned to the shell until operations are complete and the PAS for OpenEdge instance is in a known state. For more information about known state, see Status Information. After PASOESTART completes, the instance’s startup completion status is in the OS error variable (%errorlevel% for Windows, and $? for UNIX). The following table lists and describes the status codes:

Status Information

PASOESTART sends status information to the console, even when you use the -silent option. A full status report includes the following information fields, which are available either as human-readable text or as a JSON object:

Server state transitions

PASOESTART may transition the state of a PAS for OpenEdge instance zero or more times during its execution. The following table shows the different initial and exit state transitions an instance may go through.