How to Use the mlcmd Utility
You can use the mlcmd command-line utility to :
- Query the status of hosts, applications, or solutions.
- Start, stop, and gracefully stop applications and solutions.
- Send a custom command to an application.
Installing the Utility
If you installed Solution Control Server 18.104.22.168 and earlier, the mlcmd utility is already installed, and is located in the same folder in which Solution Control Server was installed.
Staring with SCS 22.214.171.124 release, the mlcmd utility is not installed by default with Solution Control Server. You can install it separately by following the instructions in the section "Solution Control Server Utilities' of the Framework Deployment Guide. After the utilities are installed, the mlcmd utility is stored in the location you specified during the installation.
Starting in 8.1.2, you can install the Solution Control Server utilities without installing Solution Control Server itself.
Using the Utility
All mlcmd command parameters are made in a single command. The general syntax is as follows:
mlcmd <mandatory parameters> <optional parameters> <command parameter>
You must provide all the mandatory parameters and one operation parameter. The parameters are listed in the following table. Starting in release 8.1, you must authenticate yourself with mlcmd by logging in to the utility. If authentication is successful, you can use the utility as part of operations. The parameters are listed in the following table.
For all parameters, the utility returns a numeric code when it has finished, regardless of whether execution was successful. This code can then be used in downstream processing as necessary. See Return Codes for a full list of return codes.
If any errors occur when processing this utility, a log message is generated and sent to stderr. Output is never sent to stdout unless the -help or -custom-print-response parameters are specified.
The parameter get-app-performance enables you to output CPU Usage data in an XML file. See XML Data Output for Information Query.
A zero-value (0) or a positive two-digit return code indicates that processing was completed successfully. If the command included one of the parameters used to retrieve the status of a host, application, or solution, the return code indicates the status. A negative return code (or on UNIX, a positive value in the range of 247 to 255) indicates that processing did not complete successfully. Success and failure return codes are given in the following tables.
XML Data Output for Information Query
When you use the get-app-performance command, the results are stored in an XML file named as follows:
- Default: <application name>_Performance_<timestamp>.xml
- User specifies name in command: <User-specified name>.xml
The format of the record in the XML file is as follows: