This document describes how to administer the EntireX RPC Server for IBM® MQ, using the Command Central command-line interface. It covers the following topics:
Administering the RPC Server for IBM MQ using the Command Central GUI is described under Administering the RPC Server for IBM MQ using the Command Central GUI. The core Command Central documentation is provided separately and is also available under Guides for Tools Shared by Software AG Products on the Software AG documentation website.
The following table lists the parameters to include when creating an EntireX RPC instance, using the Command Central instance management commands.
To create a new instance for an installed EntireX of the type "RpcServerIbmMq", with name "MyRpcServer", with server address "RPC/SRV1/CALLNAT", using administration port 5757, with broker host name "localhost", listening on broker port 1971, with bindings mode="yes", in the installation with alias name "local":
sagcc create instances local EntireXCore type=RpcServerIbmMq instance.name=MyRpcServer server.address=RPC/SRV1/CALLNAT server.adminport=5757
broker.host=localhost broker.port=1971 mq.bindingsmode=yes mq.javainstallpath=myMQJavaInstallPath |
Information about the creation job - including the job ID - is displayed.
Here you can administer the parameters of the RPC Server for IBM MQ. Any changes to parameters will be used the next time you start the RPC server.
Here you can administer the parameters used for communication between the RPC Server for IBM MQ and EntireX Broker.
| Parameter | Value | Description |
|---|---|---|
BrokerTransport |
TCP | SSL |
Transport over TCP or SSL. Default is TCP.
|
BrokerHost |
name |
Required. EntireX Broker host name or IP address. |
BrokerPort |
1025-65535 |
Required. Port number in range from 1025 to 65535. |
BrokerUser |
user |
Optional. The user ID for secured access to the broker. |
BrokerPassword |
password |
Optional. The password for secured access to the broker. |
BrokerEncoding |
codepage |
Required. Encoding used for the communication between the RPC server and EntireX Broker. |
BrokerSslTrustStore |
filename |
Optional. Specifies the location of SSL trust store. |
BrokerSslVerifyServer |
true | false |
Optional. The RPC server as SSL client checks the identity of the broker as SSL server. |
TransportTimeout |
n |
Optional. TCP/IP transport timeout in seconds, used by the server to wait for broker requests. Default is 60. |
| Command | Parameter | Description |
|---|---|---|
sagcc get configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "BROKER".
|
|
-o file |
Optional. Specifies the file where you want the output written. |
To display the Broker parameters of the RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local":
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer BROKER |
To store the Broker parameters in the file broker.json in the current working directory:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer BROKER -o broker.json |
Resulting output file in JSON format:
{
"BrokerHost":"localhost",
"BrokerPort":"1971",
"BrokerTransport":"TCP",
"BrokerUser":"testuser",
"BrokerPassword":"",
"BrokerEncoding":"Cp1252",
"BrokerSslTrustStore":"",
"BrokerSslVerifyServer":"true"
}
| Command | Parameter | Description |
|---|---|---|
sagcc update configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "BROKER".
|
|
-i file |
Optional. Specifies the file from where you want the input read. |
To load the Broker parameters of the RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local" from the file broker.json in the current working directory:
sagcc update configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer BROKER -i broker.json |
See Example 2 above for sample input file.
Here you can administer the configuration file of the RPC Server for IBM MQ. Any changes will take effect after the next restart.
| Command | Parameter | Description |
|---|---|---|
sagcc get configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "CONFIGURATION".
|
|
-o file |
Optional. Specifies the file where you want the output written. |
To display the configuration file of the RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local":
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer CONFIGURATION |
To store the contents of the configuration file in the text file configuration.txt in the current working directory:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer CONFIGURATION -o configuration.txt |
| Command | Parameter | Description |
|---|---|---|
sagcc update configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "CONFIGURATION".
|
|
-i file |
Optional. Specifies the file from where you want the input read. |
To load the contents of configuration file configuration.json in the current working directory:
sagcc update configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer CONFIGURATION -i configuration.json |
Here you can modify the MQ-specific parameters. This section covers the following topics:
| Parameter | Description |
|---|---|
IbmMqBindingsMode |
Required. "yes"=bindings mode, "no"=client mode.
|
IbmMqHost |
Required for client mode only. Host name of IP address of the MQ server. |
IbmMqPort |
Required for client mode only. Port of the MQ server. |
IbmMqChannel |
Required for client mode only. Channel name used to connect to the MQ server. |
IbmMqQueueManager |
Optional. Name of the queue manager. If not specified, a connection is made to the default queue manager. |
IbmMqInputQueue |
Optional. Name of input queue that is used for MQ GET operations.
|
IbmMqOutputQueue |
Optional. Name of output queue that is used for MQ PUT operations.
|
IbmMqJavaInstallPath |
Required. MQ Java installation path. If set, take the value of the environment variable MQ_JAVA_INSTALL_PATH from the MQ installation.
|
IbmMqJavaLibPath |
Required for bindings mode only. MQ Java library path. If set, take the value of the environment variable MQ_JAVA_LIB_PATH from the MQ installation.
|
IbmMqCharacterSetId |
Coded Character Set Identification used by the RPC Server for IBM MQ (which acts as an MQ client). Not used in bindings mode. (Numeric value). |
IbmMqWaitTime |
Wait interval for MQGET call in milliseconds.
|
IbmMqPriority |
Message priority for messages sent to MQ. |
IbmMqSsl |
Configuration for SSL connection to MQ server. Not used in bindings mode. |
IbmMqMapping |
Name of XMM (XML Mapping) file if MQ message payload is XML/SOAP. If this is specified, messages to/from MQ will be converted to XML/SOAP. |
IbmMqUser |
Required if MQ server is running with security. |
IbmMqPassword |
Required if MQ server is running with security. |
IbmMqUserExit |
Class name for MQ Server user exit. |
IbmMqUserExitClasspath |
URL of the classpath for user exit. |
| Command | Parameter | Description |
|---|---|---|
sagcc get configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "IBM-MQ".
|
|
-o file |
Optional. Specifies the file where you want the output written. |
To display the MQ-specific parameters of the RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local":
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer IBM-MQ |
To store the MQ-specific parameters in the file mq.json in the current working directory:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer IBM-MQ -o mq.json |
Resulting output file in JSON format:
{"IbmMqBindingsMode":"yes",
"IbmMqHost":"localhost",
"IbmMqPort":"1414",
"IbmMqChannel":"MQ_CHANNEL",
"IbmMqQueueManager":"MQ_QUEUEMANAGER",
"IbmMqInputQueue":"Q2",
"IbmMqOutputQueue":"Q1",
"IbmMqJavaInstallPath":"myMQJavaInstallPath"
"IBMMqJavaLibPath":""
"IbmMqUser":"",
"IbmMqMapping":"example.xmm",
"IbmMqCharacterSetId":"",
"IbmMqMarshalling":"",
"IbmMqUserExit":"",
"IbmMqUserExitClasspath":"",
"IbmMqWaitTime":"10000",
"IbmMqSsl":"",
"IbmMqPriority":""}
| Command | Parameter | Description |
|---|---|---|
sagcc update configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "IBM-MQ".
|
|
-i file |
Optional. Specifies the file from where you want the input read. |
To load the MQ-specific parameters of the RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local" from the file mq.json in the current working directory:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer IBM-MQ -i mq.json |
See Example 2 above for sample output file.
Here you can administer margins of monitored key performance indicators (KPIs) available for the RPC Server for IBM MQ: Active Workers and Busy Workers.
Key performance indicators (KPIs) enable you to monitor the health of your RPC Server for IBM MQ. The following KPIs help you administer, troubleshoot, and resolve performance issues:
| KPI | Setting |
|---|---|
| Absolute number of Active Workers | entirex.generic.kpi.1.max=20 |
| Critical alert relative to maximum | entirex.generic.kpi.1.critical=0.95 |
| Marginal alert relative to maximum | entirex.generic.kpi.1.marginal=0.80 |
| Absolute number of Busy Workers | entirex.generic.kpi.2.max=20 |
| Critical alert relative to maximum | entirex.generic.kpi.2.critical=0.95 |
| Marginal alert relative to maximum | entirex.generic.kpi.2.marginal=0.80 |
Do not change the other properties!
| Command | Parameter | Description |
|---|---|---|
sagcc get configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "MONITORING-KPI".
|
|
-o file |
Optional. Specifies the file where you want the output written. |
To display the monitoring KPI properties of RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local" on stdout:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer MONITORING-KPI |
To store the monitoring KPI properties in the file my.properties in the current working directory:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer MONITORING-KPI -o my.properties |
Resulting output file in text format:
entirex.entirex.spm.version=10.1.0.0.473 entirex.generic.kpi.1.critical=0.95 entirex.generic.kpi.1.id=\#1 entirex.generic.kpi.1.marginal=0.80 entirex.generic.kpi.1.max=20 entirex.generic.kpi.1.name=Active Workers entirex.generic.kpi.1.unit= entirex.generic.kpi.1.value=0 entirex.generic.kpi.2.critical=0.95 entirex.generic.kpi.2.id=\#2 entirex.generic.kpi.2.marginal=0.80 entirex.generic.kpi.2.max=20 entirex.generic.kpi.2.name=Busy Workers entirex.generic.kpi.2.unit= entirex.generic.kpi.2.value=0
| Command | Parameter | Description |
|---|---|---|
sagcc update configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "MONITORING-KPI".
|
|
-i file |
Optional. Specifies the file from where you want the input read. |
To load the contents of file my.properties in the current working directory:
sagcc update configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer MONITORING-KPI -i my.properties |
Here you can administer the parameters defining the registration name, the administration port and the behavior of the RPC Server for IBM MQ.
| Parameter | Value | Description |
|---|---|---|
ServerAddress |
class/server/service |
Required. The case-sensitive RPC server address has the format: CLASS/SERVER/SERVICE.
|
ServerAdminport |
1025-65535 |
Required. The administration port in range from 1025 to 65535. |
ReconnectionAttempts |
n |
Required. Number of reconnection attempts to the broker. When the number of attempts is reached and a connection to the broker is not possible, the RPC Server stops. |
WorkerScalability |
true | false |
You can either have a fixed or dynamic number of workers. Default is dynamic (true). For more information see Worker Models.
|
FixNumber |
1-255 |
Required. Fixed number of workers. Must be a number in range from 1 to 255. |
MinWorkers |
1-255 |
Required. Minimum number of workers. Must be a number in range from 1 to 255. |
MaxWorkers |
1-255 |
Required. Maximum number of workers. Must be a number in range from 1 to 255. |
| Command | Parameter | Description |
|---|---|---|
sagcc get configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "SERVER".
|
|
-o file |
Optional. Specifies the file where you want the output written. |
To display the server parameters of RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local" on stdout:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer SERVER |
To store the server parameters in the file server.json in the current working directory:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer SERVER -o server.json |
Resulting output file in JSON format:
{
"ServerAddress":"RPC/SRV1/CALLNAT",
"ServerAdminport":"4711",
"ReconnectionAttempts":"15",
"WorkerScalability":"true",
"FixNumber":"5",
"MinWorkers":"1",
"MaxWorkers":"10"
}
| Command | Parameter | Description |
|---|---|---|
sagcc update configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "SERVER".
|
|
-i file |
Optional. Specifies the file from where you want the input read. |
To load the server parameters from the file server.json in the current working directory:
sagcc update configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer SERVER -i server.json |
See Example 2 above for sample input file.
Here you can set the trace level of the RPC Server for IBM MQ.
| Parameter | Value | Description |
|---|---|---|
TraceLevel |
0 | 1 | 2 | 3 |
One of the following levels: 0 - None - No trace output (default). 1 - Standard - Minimal trace output. 2 - Advanced - Detailed trace output. 3 - Support - Support diagnostic. Use only when requested by Software AG support. |
| Command | Parameter | Description |
|---|---|---|
sagcc get configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "TRACE".
|
|
-o file |
Optional. Specifies the file where you want the output written. |
To display the trace level of RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local" on stdout:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer TRACE |
To store the trace level in the file trace.json in the current working directory:
sagcc get configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer TRACE -o trace.json |
Resulting output file in JSON format:
{
"TraceLevel":"0"
}
| Command | Parameter | Description |
|---|---|---|
sagcc update configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
instanceid |
Required. Must be "TRACE".
|
|
-i file |
Optional. Specifies the file from where you want the input read. |
To load the trace level parameters from the file trace.json in the current working directory:
sagcc update configuration data local EntireXCore-RpcServerIbmMq-MyRpcServer TRACE -i trace.json |
See Example 2 above for sample input file.
The following table lists the parameters to include, when listing all EntireX instances, using the Command Central list inventory commands.
| Command | Parameter | Description |
|---|---|---|
sagcc list inventory components |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
To list inventory components of instance EntireX in the installation with alias name "local":
sagcc list inventory components local EntireXCore* |
A list of all EntireX RPC Server runtime components will be displayed.
The following table lists the parameters to include when displaying the state of an EntireX component, using the Command Central
get monitoring commands.
| Command | Parameter | Description |
|---|---|---|
sagcc get monitoring state |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
To display state information about the RPC Server for IBM MQ:
sagcc get monitoring state local EntireXCore-RpcServerIbmMq-MyRpcServer |
Runtime status and runtime state will be displayed.
Runtime status indicates whether a runtime component is running or not. Examples of a runtime status are ONLINE or STOPPED.
Runtime state indicates the health of a runtime component by providing key performance indicators (KPIs) for the component. Each KPI provides information about the current use, marginal use, critical use and maximum use.
The following table lists the parameters to include when starting an EntireX RPC Server for IBM® MQ, using the Command Central
exec lifecycle commands.
| Command | Parameter | Description |
|---|---|---|
sagcc exec lifecycle start |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
To start the RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local":
sagcc exec lifecycle start local EntireXCore-RpcServerIbmMq-MyRpcServer |
Information about the job - including the job ID - will be displayed.
The following table lists the parameters to include when stopping an EntireX RPC Server for IBM® MQ, using the Command Central
exec lifecycle commands.
| Command | Parameter | Description |
|---|---|---|
sagcc exec lifecycle stop |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
To stop the RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local":
sagcc exec lifecycle stop local EntireXCore-RpcServerIbmMq-MyRpcServer |
Information about the job - including the job ID - will be displayed.
Here you can administer the log files of the RPC Server for IBM MQ.
The following table lists the parameters to include when displaying or modifying parameters of the RPC server,
using the Command Central list commands.
| Command | Parameter | Description |
|---|---|---|
sagcc list diagnostics logs |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
To list the log files of RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local" on stdout:
sagcc list diagnostics logs local EntireXCore-RpcServerIbmMq-MyRpcServer |
| Command | Parameter | Description |
|---|---|---|
sagcc get diagnostics logs |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
full | tail | head |
Optional. Shows full log file content, or only tail or head. | |
export -o file |
Optional. Creates a zip file of the logs. |
To list the tail of the log file content in the current working directory:
sagcc get diagnostics logs local EntireXCore-RpcServerIbmMq-MyRpcServer server.log tail |
To create a zip file myfile.zip of the logs:
sagcc get diagnostics logs local EntireXCore-RpcServerIbmMq-MyRpcServer export -o myfile.zip |
Here you can temporarily change the trace level of a running RPC server.
The following table lists the parameters to include when displaying or modifying parameters of an EntireX component,
using the Command Central exec administration command.
The change is effective immediately; there is no need to restart the RPC server.
Note:
If you want to set the trace level permanently, see Trace under Configuring an RPC Server Instance.
| Command | Parameter | Description |
|---|---|---|
sagcc exec administration |
component |
Required. Specifies that a component will be administered. |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. | |
Trace |
Required. Specifies what is to be administered. | |
load tracelevel=? |
Required. Get the trace level. | |
-f xml|json |
Required. Specifies XML or JSON as output format. |
To display the current trace level of the RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local" in JSON format on stdout:
sagcc exec administration component local EntireXCore-RpcServerIbmMq-MyRpcServer Trace load tracelevel=? -f json |
To display the current trace level of the RPC Server for IBM MQ "MyRpcServer" in the installation with alias name "local" in XML format on stdout:
sagcc exec administration component local EntireXCore-RpcServerIbmMq-MyRpcServer Trace load tracelevel=? -f xml |
| Command | Parameter | Description |
|---|---|---|
sagcc exec administration |
component |
Required. Specifies that a component will be administered. |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. | |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
|
Trace |
Required. Specifies what is to be administered. | |
update tracelevel |
Required. Update temporarily the trace level of a running RPC server. | |
-f xml|json |
Required. Specifies XML or JSON as output format. |
To change the current trace level of the running RPC Server with the name "MyRpcServer" in the installation with alias name "local":
sagcc exec administration component local EntireXCore-RpcServerIbmMq-MyRpcServer Trace update tracelevel=2 -f json |
The following table lists the parameters to include when deleting an EntireX RPC Server instance, using the Command Central
instance management commands.
| Command | Parameter | Description |
|---|---|---|
sagcc delete instances |
node_alias |
Required. Specifies the alias name of the installation in which the runtime component is installed. |
componentid |
Required. The RPC Server for IBM MQ component identifier. The prefix is "EntireXCore-RpcServerIbmMq-".
|
To delete an instance of an EntireX RPC Server for IBM® MQ with the name "MyRpcServer" in the installation with alias name "local":
sagcc delete instances local EntireXCore-RpcServerIbmMq-MyRpcServer
|
Information about the deletion job - including the job ID - is displayed.