The SYSRPC utility provides the server execution commands ping and terminate. They are used to control active servers that have been defined in the service directory. The ping command sends an internal message to the server to verify a server connection. Terminate either sends an internal message to the server requesting termination of a single server task, or issues a command to EntireX Broker requesting termination of all server tasks associated with an EntireX Broker service.
The server execution commands reference the service
directory in the library that is defined with the profile parameter RPCSDIR
(see the Parameter Reference documentation). If
RPCSDIR is not set (this is the default), the library
where you are currently logged on is used. The name of the library is indicated
in the upper right corner of the
Server Command
Execution screen shown in the following section.
This section covers the following topics:
Using Server Command Execution
To use Server Command Execution
-
In the Code field of the Client Maintenance menu, enter the following command:
XC
-
The standard view of the Server Command Execution screen appears similar to the following example:
15:16:30 ***** NATURAL SYSRPC UTILITY ***** 2016-07-18 - Server Command Execution - Library SAGTRPC2 Cmd Node Server Message 1 ETB045 2 __ NRPC001 Natural 3 __ NRPC002 Command ===> Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help ERR Exit -H +H -P +P TOP BOT < CancThe standard view displays the columns Node, Server and Message. The fields under the column Message are truncated and display a maximum of 8 characters.
-
If you choose PF11 or enter the less than (<) sign in the command line at the bottom of the screen, the extended message view of the Server Command Execution screen is displayed similar to the following example:
16:36:39 ***** NATURAL SYSRPC UTILITY ***** 2016-07-18 - Server Command Execution - Library SAGTRPC2 Cmd Server Message 1 2 __ NRPC001 Natural RPC Server 8.3.7 on WNT-x86 3 __ NRPC002 Command ===> Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help ERR Exit -H +H -P +P TOP BOT > CancThe extended view allows you to display a maximum of 50 characters of message text in the Message column. This view does not display the Node column and the fields under the Server column are truncated and display a maximum of 16 characters (the standard view shows 30 characters).
If you choose PF11 once more or enter the greater than (>) sign in the command line, the standard view of the Server Command Execution screen is displayed again as shown in Example of a Standard View.
This section covers the following topics:
Line Commands: Server Command Execution
The line commands available on the Server Command Execution screen depend on whether they are executed on an EntireX Broker node or an RPC server node. In the following table, an X indicates whether a command is available for a node.
| Line Command | Description | Broker | Server |
|---|---|---|---|
PI |
Broker node: Pings all
servers defined for the selected EntireX Broker.
Server node: Pings the selected RPC server. See also the |
X | X |
TE |
Terminates the selected RPC server. | X | |
TS |
Terminates the selected EntireX Broker service. | X | |
LS |
List servers registered on the selected EntireX
Broker.
See also the |
X | X |
IV |
Lists the versions of the selected EntireX Broker and its Command and Information Services (CIS) and the version of the EntireX Broker stub. | X | X |
Pinging an RPC Server
You can ping an RPC server from the standard or extended message view of
the Server Command Execution screen or by using the
SYSRPC PING direct
command.
For information on pinging anl RPC server by using the Application Programming Interface USR2073N, see the appropriate Natural RPC (Remote Procedure Call) documentation.
The following instructions for pinging an RPC server from the standard view of the Server Command Execution screen.
To ping an RPC server from the Server Command
Execution screen
-
In the Cmd column next to the server(s) to be pinged, enter the following line command:
PI
as shown in the example of a Server Command Execution screen below:
16:41:32 ***** NATURAL SYSRPC UTILITY ***** 2016-07-18 - Server Command Execution - Library SAGTRPC2 Cmd Node Server Message 1 __ ETB045 2 PI NRPC001 3 PI NRPC002 Command ===> Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help ERR Exit -H +H -P +P TOP BOT > Canc -
Choose ENTER. The server(s) return the message:
Server version on operating system
where
Server denotes the type of server; version denotes the version operating system denotes on which operating system the server runs.
Example message:
Natural RPC Server 8.3.7.0 on WNT-x86
If pinging the server fails and an error occurs instead, you can choose PF2 (ERR) to display RPC-related Natural and EntireX Broker messages as described in Using the RPCERR Program (Monitoring the Status of an RPC Session, Natural RPC (Remote Procedure Call) documentation).
-
To display more of the message text which appears truncated in the standard view of the Server Command Execution screen (see also Example of a Standard View) proceed as follows:
Choose PF11.
Or:
In the command line, enter the less than (<) sign.
This section covers the following topic:
Using the SYSRPC PING Direct Command
You can ping an RPC server by using the SYSRPC PING direct
command in online or batch mode.
The following command syntax applies:
SYSRPC PING
server-name
ON broker-name
[[PORT]
port-number][TRANSPORT
{TCP|SSL|NET}] |
The symbols used in the syntax diagram are explained in the section Syntax Symbols in the Statements documentation.
The syntax elements are explained in the following table:
Terminating a Server
The SYSRPC utility provides two commands to terminate a server:
TE (Terminate RPC Server) and
TS (Terminate EntireX Broker Service).
TE terminates a single RPC server task by
sending an internal message to the RPC server. If an RPC server is associated
with multiple RPC server tasks (including replicas on mainframe platforms), you
can either terminate each RPC server task separately by using
TE, or terminate all RPC server tasks in one go by
using the TS command.
TS terminates all server tasks associated
with an EntireX Broker service by calling EntireX Broker's Command and
Information Services (ETBCIS; for details, see the EntireX documentation). The
term service here summarizes all server tasks that run with the
same server name on the same or on different platforms.
You can terminate server tasks from the standard or extended message view of the Server Command Execution screen.
The following section provides instructions for terminating a single RPC server task or an EntireX Broker service from the standard view.
For alternative methods of terminating servers, see Terminating a Natural RPC Server described in the Natural RPC (Remote Procedure Call) documentation.
To terminate a single RPC server task
-
In the Code field of the Client Maintenance menu, enter the following command:
XC
The standard view of the Server Command Execution screen is displayed.
-
In the Cmd column next to the server(s) to be terminated, enter the following line command:
TE
(This is similar to entering the command
PIas show in the example of pinging a server.) -
Choose ENTER.
The server returns the message:
Terminating Server version on operating system
where
Server denotes the type of server; version denotes the four or five-digit product number; operating system denotes the operating system the server runs.
Example message:
Terminating Natural RPC Server 6.3.1.0 on WNT-x86
If terminating the server fails and an error occurs instead, you can choose PF2 (ERR) to display RPC-related Natural and EntireX Broker messages as described in Using the RPCERR Program (Monitoring the Status of an RPC Session, Natural RPC (Remote Procedure Call) documentation).
To display more of the message text which appears truncated in the standard view of the Server Command Execution screen:
Choose PF11.
Or:
In the command line, enter the less than (<) sign. -
If the Logon option is set in the service directory, logon data (user ID, password and library name) is sent to the server with the
TEcommand, as is usual for remoteCALLNATexecution. The Security Token Data window pops up and requests input of user ID and password if no Natural Security is installed on the client side and no logon data is set with the Application Programming Interface USR1071N for the current Natural session. See also USR1071N described in Using Security, Using Natural RPC with Natural Security, in the Natural RPC (Remote Procedure Call) documentation.If
LOGONRQ=ON(see also Using Security in the Natural RPC (Remote Procedure Call) documentation) has been set on the server side, logon data must be sent from the client with theTEcommand.If Natural Security is installed on the server, the logon data transferred must enable a logon to the Natural system library SYSRPC.
To terminate an EntireX Broker service
-
In the Code field of the Client Maintenance menu, enter the following command:
XC
The standard view of the Server Command Execution screen is displayed.
-
In the empty column between sequence number and Node column, in the line which belong to the server to be terminated, enter the following command:
TS
(This is similar to entering the command
PIas show in the example of pinging a server.) -
Choose ENTER.
The SYSRPC - Terminating EntireX Broker Service window appears.
-
If required for the logon, enter the appropriate user ID and password for EntireX Broker.
If you want to terminate server tasks that are involved in a conversation, in the Terminate immediately field, enter a
Yto request immediate termination. If you enter anN(this is the default setting), all server tasks involved in a conversation remain operational.If you do not want this window to appear repeatedly during the current SYSRPC session, choose Do not show this window again.
-
Choose ENTER to terminate the EntireX Broker service.