OESERVER is an extension to the TCMAN utility for starting and stopping a PAS for OpenEdge instance. OESERVER can be used with either TCMAN or PASMAN. PASMAN supports additional parameters which makes it the preferred utility. OESERVER is an evolution of PASOESTART for starting and stopping servers. For more information on PASOESTART, see PASOESTART.

Note: You cannot use OESERVER to start an instance configured as a Windows service.

Syntax

[oe-install-dir/bin/pasman | 
oe-install-dir/bin/tcman{.sh|.bat}}] oeserver -I instance-name
action [action_options]

Parameters

The following table lists the parameters used in the OESERVER utility:

Action option Description
-I instance-name The name of the instance to start.
Note: This parameter is required when you execute OESERVER with PASMAN. This parameter is not necessary when you execute OESERVER with TCMAN from the instance's instance-name/bin directory.
-ablapp appname

Optional ABLApp name for -status and -close actions.

-archive Archives existing log files. This option executes the tcman clean -A command.
-array Use with -json to output PID information as an array.
-close

Terminates any active client sessions.
-container Modifies instance startup to not return until the instance is stopped. Used in container startup.
-force Forcibly terminate a running instance.
-g Displays verbose execution information to the console that is much more than the output displayed when using -vv.
-halt

Stops a running instance. Same as -stop added for legacy support of PASOESTART.
-h[elp]

Provides usage information for OESERVER. Use of OESERVER without any parameters returns the same help.
-json

Returns the instance state information as a json object.
-nostop Turns off the default stop action, which automatically occurs after a time-out, or when OESERVER detects errors in an instance's log files.
-query

Prints or displays the current state of the instance. Use -status to collect additional details about the agents and sessions.

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

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

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

Prints the current run-time agent/session status.
-stop

Stops a running instance.
-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.
-vv Displays detailed execution information to the console.

Start an instance

Start and restart an instance with PASMAN:

oe-install-dir/bin/pasman oeserver -I instance-name -start [-json | -array] [-timeout seconds] [-archive] [-nostop] [-g] [-v] [-vv] [-silent]

Restart an instance

Restart an instance with PASMAN:

oe-install-dir/bin/pasman oeserver -I instance-name -restart [-timeout seconds] [-archive] [-nostop] [-close [-ablapp appname]] [-g] [-v] [-vv] [-silent]

Stop an instance

Stop an instance with PASMAN:

oe-install-dir/bin/pasman oeserver -I instance-name -stop [-force | -abort] [-timeout seconds] [-close [-ablapp appname]][-g] [-v] [-vv] [-silent]
Note: For backwards compatibility, the -halt parameter is supported. The -stop parameter is recommended.

Close connections

Close connections with PASMAN:

oe-install-dir/bin/pasman oeserver -I instance-name -close [-ablapp appname] [-g] [-v] [-vv] [-silent]

Get summary state information

Query the current state of an instance, executing from PASMAN:

oe-install-dir/bin/pasman oeserver -I instance-name -query [-json | -array] [-g] [-v] [-vv] [-silent]

Get detailed state information

Provides more details than query about the current status of an instance, executing from PASMAN:

oe-install-dir/bin/pasman oeserver -I instance-name -status [-ablapp appname] [-g] [-v] [-vv] [-silent]

Status Codes

OESERVER 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 OESERVER 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 Code Description
0 The instance started or restarted without errors and is usable in a running state.
1 The core (Tomcat) server process failed to start and the instance is left in the stopped state.
2 The instance started, but encountered errors that make some or all of it unusable, and is left in the stopped state for troubleshooting and problem resolution.
3 The instance is already in the running state, was not restarted, and is left in a running state that may, or may not, be usable.
4 The instance was started from a state, but timed out before it reached a running state. The instance is left in the stopped state for troubleshooting and problem resolution.
5 The instance is hung in the starting state, was not restarted, and is left in the hung starting state.
6 The instance is hung in the stoppingstate, was not restarted, and is left in the hung stopping state.
10 Command-line line option errors prevented the execution of OESERVER.
11 OESERVER was used to start a Windows service, and no startup process was attempted.
12 Missing OS process environment variables prevented OESERVER from running, and no startup process was attempted.
20 An unspecified internal programming error was encountered. Contact OpenEdge technical support for more information.

Status Information

OESERVER 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:

Field name Description
Start action The type of startup process executed: { start | restart | status }.
Initial state

The initial state of the PAS for OpenEdge instance at execution time:

{ stopped | starting | stopping | running }.
Initial processes

A space-separated list of the OS process IDs for the PAS for OpenEdge instance found at execution time:

A single 0 value indicates that there are no OS processes (stopped).

A single non-zero value indicates that the PAS for OpenEdge server is running but there are no multi-session agents (starting or stopping).

Multiple non-zero values indicate that the PAS for OpenEdge server and at least one multi-session agent is running; however, there may be errors that prevent the instance from serving clients.
Exit state The state of the PAS for OpenEdge instance when the OESERVER command completes. See the Initial state field name entry for state names.
Exit description
Exit statusA text description of the command completion status. A single numerical value of the OESERVER command’s completion status. See the list of OESERVER exit statuses.
A text description of the command completionExit errors

A brief list of error or fatal log file entries found in the PAS for OpenEdge log files. This provides hints about why the PAS for OpenEdge instance startup failed and provides references for where the administrator or developer can find the full error output.

The Exit errors information may be blank or empty for some types of completion statuses.

Server state transitions

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

Initial state Exit state Description
stopped started OESERVER succesfully started Tomcat, the OpenEdge application, the multi-session agent, and startup event procedures
stopped stopped

Startup failed and the instance was stopped due to a OESERVER time-out or errors.
stopped starting A startup time-out was detected, and the server is hung in the starting state after a failed attempt to stop the instance.

Try the OESERVER restart command once, and then manually stop the instance if the restart is not successful.
started started The instance is already running. The state of the instance is not changed. The server may, or may not, be usable.
started started After a OESERVER restart, a running instance was stopped, and then Tomcat, the OpenEdge application, the multi-session agent, and startup event procedures were restarted successfully.
started stopped

After a OESERVER restart, a running instance was stopped, and failed while restarting due to a time-out or errors.

Try the OESERVER restart command once more, then manually stop the instance if restart is not successful.
started starting

After a OESERVER restart, a running instance was stopped, and timed out in thestarting state.

The instance is not in a usable condition. Retry the OESERVER restart command once. If it is not successful, manually stop the instance.
starting starting After a OESERVER restart, an instance is hung in the startingstate and no restart was performed.

The instance is not in a usable condition. Retry the OESERVER restart command once. If it is not successful, manually stop the instance.
starting starting The PASOE instance is hung in the starting state and no restart was performed. The instance is not in a usable condition. Manually stop the instance or run a OESERVER restart.
starting stopping After attempting to stop an instance hung in the starting state, the instance hangs in the stopping state.

The instance is not in a usable condition. Try the OESERVER restart command once. If it is not successful, manually stop the instance.
starting stopped

After a OESERVER restart, an instance hung in the starting state, was stopped, and failed to restart due to a time-out our errors.

Retry the OESERVER restart command once.
starting started After a OESERVER restart, an instance hung in the starting state was stopped and then Tomcat, the OpenEdge application, the Agent, and startup event procedures were restarted successfully.
stopping stopping The instance is hung in the stopping state and no restart was performed. The instance is not in a usable condition. Manually stop the instance or run a OESERVER restart.
stopping stopping

After a OESERVER restart, an instance hung in the stopping state , was stopped, restarted, and then hung in the stopping state because of a time-out or errors.

The instance is not in a usable condition. Manually stop the instance.
stopping stopped

After a OESERVER restart, an instance hung in the stopping state , was stopped, restarted, and stopped a second time because of a time-out or errors.

The instance is not in a usable condition.

stopping started After a OESERVER restart, an instance hung in the stopping state, was stopped, and then successfully restarted and then Tomcat, the OpenEdge application, the Agent, and startup event procedures were restarted successfully.