This document covers the following topics:
EntireX provides a set of command-line scripts as a solution to the following scenarios:
"I want a quick overview of my standard broker and a list of active external services that are running." 
More info
"I want to monitor an EntireX component (broker, service, client) over time." More info
"I want to monitor my environment and check that all components (broker, RPC servers) are up and running." More info
You can select the scripts from the EntireX Command-line Scripts Menu or call the individual scripts from the command-line.
Note:
You can use these scripts with local or remote brokers. The scripts were introduced with version 9.7, but can be used with
brokers of any supported version.
To call the command-line script menu
Choose .
Or:
Enter command Menu_Of_EntireX_Command_Line_Scripts.bat in the EntireX bin directory.
The following screen appears:
List of EntireX Command-line Scripts Current Broker: localhost:1971 1 : Show Broker and registered Services The following scripts write to CSV file: 2 : Monitor Broker 3 : Monitor Services 4 : Monitor Clients 5 : Change current Broker (this session only) 6 : Edit Broker and other defaults (persistent) 7 : Define your Environment 8 : Monitor your Environment 9 : Open new command window (in script directory) 0 : Exit Enter the number to be executed or ? for help
The screen shows the current broker to which the administration tasks apply. You can change this for the duration of the session or persistently in the defaults. See Using the Broker ID in Applications in the ACI Programming documentation for possible formats.
Enter a number to perform the respective task. The options are described in the table below, together with the corresponding script if you prefer to call the script directly.
| Option | Description | Corresponding Script | Note | |
|---|---|---|---|---|
| 1 | Show Broker and registered Services. Displays information on the current broker and its registered services. | More info |
entirex_overview.bat |
|
| 2 | Monitor Broker. Monitors the current broker. | More info |
monitor_broker_to_csv.bat |
Output for these three monitoring scripts is written to a CSV file (comma-separated values), which you can view, for example, with a spreadsheet tool. |
| 3 | Monitor Services. Monitors services registered to the current broker. | More info |
monitor_service_to_csv.bat |
|
| 4 | Monitor Clients. Monitors clients registered to the current broker. | More info |
monitor_client_to_csv.bat |
|
| 5 | Change Current Broker. Changes the broker used in the various scripts for this session only. | When the session is restarted, this value reverts to the default. | ||
| 6 | Edit Broker and other Defaults. You can modify defaults for Broker ID, timeout values and output files. | More info |
edit_user_specific_monitor_defaults.bat |
|
| 7 | Define your Environment. You can define the environment (list of broker and registered services) you want to monitor. | More info |
edit_user_specific_environment_definition.bat |
|
| 8 | Monitor your Environment (defined with option 7). | More info |
monitor_environment.bat |
|
| 9 | Open New Command Window (in command-line script directory). | This enables you to start the scripts with your parameters. | ||
| 0 | Exit. | Exits the menu. If you changed the current broker with Option 5, this will revert to the default value. Monitoring scripts that write to CSV files running in a separate command window continue to run. | ||
To change the current broker for your current session
Choose option 5 from the EntireX Command-line Script Menu, "Change current Broker (this session only)". This changes the current broker ID used for executing the command-line scripts in this session.
If you restart the script, the broker ID will be (re)set to the default value.
To change the current broker permanently
Choose option 6 from the EntireX Command-line Script Menu, "Edit Broker and other Defaults (persistent)".
Or:
Run command
edit_user_specific_monitor_defaults.bat in the EntireX bin directory.
See Default Handling.