Server Command Execution

#### Search Results

Search

# Server Command Execution

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 `RPCSDIR` profile parameter (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 root node of the service directory tree view.

Note
In this chapter RPC server means Natural RPC server. Any reference to an EntireX RPC server is explicitly called out.

This section covers the following topics:

- Get or Set the Trace Level for an RPC Server

- Message Display Window

- Pinging an RPC Server

- Terminating an RPC Server

## Get or Set the Trace Level for an RPC Server

In the Service Directory tree view, select a server or a node and choose Get/Set Trace Level for RPC Server from the context menu, and from the context sub-menu choose the appropriate command. The commands in the sub-menu are:

- Trace Information: Get the trace level enabled on the server or servers. This command applies for nodes or for servers.

- The following commands apply to servers only:

- Disable tracing (Trace level 0): Disable the RPC server trace.

- Trace Level value: Enable the RPC server trace with level value, where value =1-9 or value =1E-9E, which sets the flag to trace in the event of an error only.

  Example: Trace level 1E enables the RPC server trace with level 1 and sets the flag to trace in the event of an error only.

## Message Display Window

The ping and terminate commands invoke the Message Display window. This window provides the columns Message, Node and Server that display the message returned from the server and the name of the node and the server selected as indicated in the following section.

## Pinging an RPC Server

You can ping an RPC server from the SYSRPC dialog using different methods or by using the `SYSRPC PING` direct command.

For information on pinging an RPC server by using the Application Programming Interface USR2073N, see the appropriate Natural RPC (Remote Procedure Call) documentation.

The following section provides instructions for pinging an RPC server by using menu functions.

To ping a server

- In the Service Directory tree view, select a server or a node and choose Ping from the context menu.

  Or:
  Choose CTRL+F9.

  Or:
  Choose the following toolbar button:

  Selecting an EntireX Broker node will ping all servers that belong to this node.

  The Message Display window appears and displays the physical names of the node(s) and server(s) and the message returned from the server(s).

  If the pinged server(s) are active, the server(s) return the message:

      Server version on operating system

  where Server denotes the type of server;
  version denotes the version of the server;
  operating system denotes on which operating system the server runs.

  Example message: `Natural RPC Server 8.3.7.0 on WNT-x86.`

This section covers the following topic:

- Using the SYSRPC PING Direct Command

### 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}]` `ALL` |

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:

Syntax Element | Format/Length | Description
--- | --- | ---
`server-name` | A32 | Name of an RPC server or a range of names An asterisk (`*`) selects all names, asterisk notation selects all names that start with the specified value.
`broker-name` | A32 | Name of the EntireX Broker or a range of names An asterisk (`*`) selects all names, asterisk notation selects all names that start with the specified value.
`port-number` | N5 | Port number of the network address used for the server connection Valid values: `0` to `65535`
`TRANSPORT` | A3 | Transport method used by EntireX Broker:
`TCP` | TCP/IP protocol
`SSL` | SSL or TLS
`NET` | Entire Net-Work (not supported on Linux or Windows)
`ALL` | n/a | Pings all RPC servers defined in the service directory of the current library.

## Terminating an RPC Server

The SYSRPC utility provides the following commands to terminate an RPC server or EntireX Broker service:

Terminate Server: | 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 replica on z/OS platforms), you can either terminate each RPC server task separately by using Terminate Server, or terminate all RPC server tasks in one go by using the Terminate EntireX Broker Service command.
Terminate Server with Sequence Number: | Lists the sequence number(s) for an RPC server registered on an EntireX Broker. Each server task is identified by start date/time, host name, application name and IP address, and can be selected and terminated from this list.
Terminate EntireX Broker Service: | 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.

The following section provides instructions for terminating a single server task or an EntireX Broker service by using menu functions.

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 server task

1. In the Service Directory tree view, select a server node and choose Terminate Server from the context menu.

   The Message Display window appears with the name of the node and the server, and the message returned from the server.

   If a server is terminated, the server returns the following message:

       Terminating Server version on operating system

   where Server denotes the type of server;
   version denotes the version of the server;
   operating system denotes on which operating system the server runs.

   Example message: `Terminating Natural RPC Server 8.3.7.0 on WNT-x86.`

2. 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 terminate command, as is usual for the `CALLNAT`. The Security Token Data window pops up and requests 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.

   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 the terminate command.

   If Natural Security is installed on the server, the logon data transferred must enable a logon to the Natural system library SYSRPC.

To terminate a single server task with sequence number

1. In the Service Directory tree view, select a server node and choose Terminate Server with Sequence Number from the context menu.

   If required for the logon, a Terminating EntireX Broker Service dialog opens.

2. Enter a valid EntireX Broker user ID and password.

   Select the Terminate immediately check box if you want to immediately terminate all server tasks that are involved in a conversation. If not selected (this is the default setting), all server tasks involved in a conversation remain operational.

   Select the Do not show this dialog again check box (not selected by default) if you do not want the Terminating EntireX Broker Service dialog box to appear repeatedly during the current SYSRPC utilty session.

3. Choose OK.

   A SYSRPC Terminate - Information window opens with a list of server tasks. It provides the following information:

   Column | Description
   --- | ---
   Terminate | Check box to be selected for the terminating the corresponding server task.
   Sequence No. | The number assigned to the server task in the sequence in which they are loaded by the EntireX Broker.
   Date / Time | The date and time (UTC) when the server was started.
   Status | The status of the server. Possible status values are: `idle`, `busy` or `term` (for terminated).
   Host Name | The node where the server is hosted.
   Application Name | The application name depends on the environment where the server runs. It can be the name of a Natural image (on Linux), an LPAR (on z/OS) or a CICS started task, for example.
   IP Address | The IPv4 or IPv6 address of the node.

   You can open a context menu to hide or show additional columns, resize the window, or mark the check boxes of all servers you want to terminate.

4. Select the Terminate check box next to the sequence number of each server task to be terminated.

   Or:
   Choose Mark all servers from the context menu to select all server tasks listed in the window.

5. Choose OK.

   A Message Display window opens displaying the name of the nodes, servers and sequence numbers of the terminated server tasks.

To terminate an EntireX Broker service

1. In the Service Directory tree view, select a server node and choose Terminate EntireX Broker Service from the context menu.

   Or:
   Choose the following toolbar button:

   The SYSRPC - Terminating EntireX Broker Service dialog box appears.

2. 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, select the Terminate immediately check box to request immediate termination. If this check box is not selected (this is the default setting), all server tasks involved in a conversation remain operational.

   If you do not want this dialog box to appear repeatedly during the current SYSRPC session, choose Do not show this dialog again.

3. Choose OK to terminate the EntireX Broker service.

   The Message Display window appears, which displays the name of the node and the server and the number of server tasks terminated.

### On this page

- Get or Set the Trace Level for an RPC Server
- Message Display Window
- Pinging an RPC Server
- Terminating an RPC Server