This document applies to EntireX Brokers under z/OS, BS2000 and z/VSE. It covers the following topics:
See also Monitoring EntireX Mainframe Broker and Monitoring EntireX Mainframe Broker using the Command Central GUI.
Parameter | Value | Description |
---|---|---|
Instance |
instance |
Required. Name of the runtime component, for example "myBroker". |
Transport |
TCP | SSL |
Transport over TCP or SSL. Default is TCP .
|
Host |
name |
Required. EntireX Broker host name or IP address. |
Port |
1025-65535 |
Required. Port number in range from 1025 to 65535. |
SslTrustStore |
filename |
Optional. Specifies the location of the SSL trust store. |
SslVerifyServer |
true | false |
Optional. The RPC server as SSL client checks the identity of the broker as SSL server. Default is true .
|
User |
user |
Optional. The user ID for secured access to the broker. |
Password |
password |
Optional. The password for secured access to the broker. |
Command | Parameter | Description |
---|---|---|
sagcc create configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the broker connection is installed. |
componentid |
Required. Must be EntireXMainframeProxy-Administration .
|
|
instanceid |
Required. Must be EXX-BROKER .
|
|
-i file |
Required. Specifies the file from where you want the input read. |
To create a new instance of "EntireX Mainframe Broker", with the name "MyBroker" in the installation with alias name "local" from the file MyBroker.json in the current working directory:
sagcc create configuration data local EntireXMainframeProxy-Administration EXX-BROKER -i MyBroker.json
MyBroker.json |
---|
{ "Instance": "MyBroker", "Transport": "TCP", "Host": "mainframeHost", "Port": "4713", "SslTrustStore": "", "SslVerifyServer": "false", "User": "", "Password": "" } |
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 broker connection is installed. |
componentid |
Required. The component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
To list EntireX Mainframe Broker Connection components in the installation with alias name "local":
sagcc list inventory components local EntireXMainframeProxy-Broker-*
A list of all EntireX Mainframe Broker Connection components will be displayed. If the component is not valid, you will find more information in the connection.log file.
The following table lists the parameters to include when displaying the state of an EntireX Mainframe Broker 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 broker connection is installed. |
componentid |
Required. The component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
To display state information about the EntireX Mainframe Broker:
sagcc get monitoring state local EntireXMainframeProxy-Broker-MyBroker
Runtime status and runtime state will be displayed.
Runtime status indicates whether a runtime component is running, unknown or down. Examples of a runtime status are
UNRESPONSIVE
, ONLINE
, ERROR
, or STOPPED
. If the EntireX Mainframe Broker is detected as a non-mainframe broker, the status is shown as ERROR
.
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 updating a Broker Connection of an EntireX Mainframe Broker instance,
using the Command Central update configuration
commands.
Parameter | Value | Description |
---|---|---|
Transport |
TCP | SSL |
Transport over TCP or SSL. Default is TCP .
|
Host |
name |
Required. EntireX Broker host name or IP address. |
Port |
1025-65535 |
Required. Port number in range from 1025 to 65535. |
SslTrustStore |
filename |
Optional. Specifies the location of the SSL trust store. |
SslVerifyServer |
true | false |
Optional. The RPC server as SSL client checks the identity of the broker as SSL server. Default is true .
|
User |
user |
Optional. The user ID for secured access to the broker. |
Password |
password |
Optional. The password for secured access to the broker. |
Command | Parameter | Description |
---|---|---|
sagcc update configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the broker connection is installed. |
componentid |
Required. The component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
|
instanceid |
Required. Must be EXX-BROKER .
|
|
-i file |
Required. Specifies the file from where you want the input read. |
To update an instance of "EntireX Mainframe Broker Connection", with the name "MyBroker" in the installation with alias name "local" from the file MyBroker.json in the current working directory:
sagcc update configuration data local EntireXMainframeProxy-Administration EXX-BROKER -i MyBroker.json
MyBroker.json |
---|
{ "Transport": "TCP", "Host": "mainframeHost", "Port": "9999", "SslTrustStore": "", "SslVerifyServer": "false", "User": "", "Password": "" } |
The following table lists the parameters to include when updating the Monitoring KPIs of an EntireX Mainframe Broker instance,
using the Command Central update configuration
commands.
Parameter | Value | Description |
---|---|---|
ClientsMaximum |
1-2147483647 | Required. Maximum number of clients in graph. |
ClientsCriticalPercent |
1-100 | Required. Critical barrier of clients in graph in %. |
ClientsMarginalPercent |
1-100 | Required. Marginal barrier of clients in graph in %. |
ServersMaximum |
1-2147483647 | Required. Maximum number of servers in graph. |
ServersCriticalPercent |
1-100 | Required. Critical barrier of servers in graph in %. |
ServersMarginalPercent |
1-100 | Required. Marginal barrier of servers in graph in %. |
ConversationsMaximum |
1-2147483647 | Required. Maximum number of conversations in graph. |
ConversationsCriticalPercent |
1-100 | Required. Critical barrier of conversations in graph in %. |
ConversationsMarginalPercent |
1-100 | Required. Marginal barrier of conversations in graph in %. |
Command | Parameter | Description |
---|---|---|
sagcc update configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the broker connection is installed. |
componentid |
Required. The component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
|
instanceid |
Required. Must be EXX-MONITORING-KPIS .
|
|
-i file |
Required. Specifies the file from where you want the input read. |
To update an instance of "EntireX Mainframe Broker", with the name "MyBroker" in the installation with alias name "local" from the file MyKpis.json in the current working directory:
sagcc update configuration data local EntireXMainframeProxy-Broker-MyBroker EXX-MONITORING-KPIS -i MyKpis.json
MyKpis.json |
---|
{ "ClientsMaximum": "200", "ClientsCriticalPercent": "95", "ClientsMarginalPercent": "80", "ServersMaximum": "50", "ServersCriticalPercent": "95", "ServersMarginalPercent": "80", "ConversationsMaximum": "1000", "ConversationsCriticalPercent": "95", "ConversationsMarginalPercent": "80" } |
Here you can administer the log files of the EntireX Mainframe Broker Connection instance.
The following table lists the parameters to include when displaying or modifying parameters of the EntireX Mainframe Broker,
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 broker connection is installed. |
componentid |
Required. The component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
To list the log files of EntireX Mainframe Broker Connection instance, in the installation with alias name "local" on stdout:
sagcc list diagnostics logs local EntireXMainframeProxy-Broker-MyBroker
Command | Parameter | Description |
---|---|---|
sagcc get diagnostics logs |
node_alias |
Required. Specifies the alias name of the installation in which the broker connection is installed. |
componentid |
Required. The component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
|
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 EntireXMainframeProxy-Broker-MyBroker connection.log tail
To create a zip file myfile.zip of the logs:
sagcc get diagnostics logs local EntireXMainframeProxy-Broker-MyBroker export -o myfile.zip
Displaying the General Statistics of a Running EntireX Broker
Displaying the UOW (Unit of Work) Statistics of a Running EntireX Broker
Here you can display the current statistics of a running EntireX Broker.
Command | Parameter | Description |
---|---|---|
get administration |
component |
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 component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
|
Statistics |
Required. Specifies what is to be administered. | |
loadStatisticGeneral |
Required. Get the general settings. | |
-f xml|json |
Required. Specifies XML or JSON as output format. | |
-o file |
Optional. Specifies the file where you want the output written. |
To display the current general setting of the running EntireX Broker with the name 'MyBroker' in the installation with alias name 'local'.broker in JSON format on stdout:
sagcc get administration component local EntireXMainframeProxy-Broker-MyBroker Statistics loadStatisticGeneral -f json
To display the current general setting of the running EntireX Broker with the name 'MyBroker' in the installation with alias name 'local' in XML format on stdout:
sagcc get administration component local EntireXMainframeProxy-Broker-MyBroker Statistics loadStatisticGeneral -f xml
Here you can display the current UOW statistics of a running EntireX Broker. The UOW statistics are summarized per service.
Note:
The returned value "UOWStatusFailed" represents the sum of UOW status "backed-out", "cancelled", "timeout" and "discarded".
Command | Parameter | Description |
---|---|---|
get administration |
component |
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 component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
|
Statistics |
Required. Specifies what is to be administered. | |
loadStatisticUow |
Required. Get the statistics of UOW usage. | |
-f xml|json |
Required. Specifies XML or JSON as output format. | |
-o file |
Optional. Specifies the file where you want the output written. |
To display the current UOW statistics of the running EntireX Broker with the name 'MyBroker' in the installation with alias name 'local'.broker in JSON format on stdout:
sagcc get administration component local EntireXMainframeProxy-Broker-MyBroker Statistics loadStatisticUow -f json
To display the current UOW statistics of the running EntireX Broker with the name 'MyBroker' in the installation with alias name 'local' in XML format on stdout:
sagcc get administration component local EntireXMainframeProxy-Broker-MyBroker Statistics loadStatisticUow -f xml
Command | Parameter | Description |
---|---|---|
sagcc list administration |
component |
Specifies that a component will be administered. |
node_alias |
Required. Specifies the alias name of the installation in which the broker connection is installed. | |
componentid |
Required. The component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
|
Services |
Required. Specifies what is to be administered. | |
listServices |
Required. List all services. | |
-f xml|json |
Required. Specifies XML or JSON as output format. |
To display a list of services of the running EntireX Mainfram Broker with the name "MyBroker" in the installation with alias name "local" in JSON format:
sagcc list administration component local EntireXMainframeProxy-Broker-MyBroker Services listServices -f json
To store a list of services of the EntireX Mainframe Broker with the name "MyBroker" in the installation with alias name "local" in JSON format in the file services.json of the current working directory:
sagcc list administration component local EntireXMainframeProxy-Broker-MyBroker Services listServices -o services.json
Command | Parameter | Description |
---|---|---|
sagcc list administration |
component |
Specifies that a component will be administered. |
node_alias |
Required. Specifies the alias name of the installation in which the broker connection is installed. | |
componentid |
Required. The component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
|
Services |
Required. Specifies what is to be administered. | |
listServers |
Required. List all servers. | |
serviceName |
Required. Shows only servers of this service. Format: class/server/service .
|
|
-f xml|json |
Required. Specifies XML or JSON as output format. |
To display a list of servers of the current service of the EntireX Mainframe Broker with the name "MyBroker" in the installation with alias name "local" in XML format:
sagcc list administration component local EntireXMainframeProxy-Broker-MyBroker Services listServers serviceName=RPC/SRV1/CALLNAT -f xml
To store a list of servers in JSON format in the file services.json of the current working directory:
sagcc list administration component local EntireXMainframeProxy-Broker-MyBroker Services listServers serviceName=RPC/SRV1/CALLNAT -o server.json
The following table lists the parameters to include when deleting an EntireX Mainframe Broker Connection instance, using the
Command Central delete configuration
commands.
Command | Parameter | Description |
---|---|---|
sagcc delete configuration data |
node_alias |
Required. Specifies the alias name of the installation in which the broker connection is installed. |
componentid |
Required. The component identifier. The prefix is "EntireXMainframeProxy-Broker- ".
|
To delete an instance of an EntireX Mainframe Broker Connection with the name "MyBroker" in the installation with alias name "local":
sagcc delete configuration data local EntireXMainframeProxy-Administration EntireXMainframeProxy-Broker-MyBroker --force