batchManager command-line client utility

SSL configuration

The batchManager command-line client utility communicates with the batch manager over an SSL connection. To facilitate SSL communication with a batch manager that is running on a Liberty server, the utility must be able to verify the SSL certificate of the Liberty server.

If the SSL certificate is signed by a well-known certificate authority (CA), the utility can verify the certificate by the CA. No further configuration is necessary.

If you choose to specify the option --trustSslCertificates, the utility trusts all SSL certificates that it receives and no further configuration is necessary.

If you choose the option to include the server's SSL certificate in the utility's truststore, then you must also configure the utility so that it can find its truststore. The utility is a stand-alone Java main. You configure SSL by using system properties such as javax.net.ssl.truststore.

   $ export JVM_ARGS="-Djavax.net.ssl.trustStore=/path/to/server/keystore.jks"
   $ batchManager submit ...

    $ keytool -export -alias default -file server.crt -keystore [server-dir]/resources/security/key.jks -storepass Liberty
    $ keytool -import -alias server_crt -file server.crt -keystore /path/to/truststore.jks -storepass passw0rd

    $ export JVM_ARGS="-Djavax.net.ssl.trustStore=/path/to/truststore.jks"
    $ batchManager submit ...

Commands and usage

The batchManager command-line client utility provides commands for submitting, stopping, restarting, and checking the status of jobs.

To generally use the utility:

$ batchManager [command] [options]

To see a list of available commands:

$ batchManager help

To see the description and options for a specific command:

$ batchManager help [command]

The following example illustrates how to submit a job and wait for its completion:

  $ batchManager submit \
        --batchManager=<host>:<port>
        --user=[credentials for logging into the batch manager]
        --password=[credentials for logging into the batch manager]
        --applicationName=[application name used when packaging the batch app]
        --jobXMLName=[job XML file basename in the app's batch-jobs dir]
        --wait

jobParametersFile and jobPropertiesFile

jobParametersFile=filePath1,filePath2,filePath3
jobPropertiesFile=filePath1,filePath2,filePath3

Control properties and job parameters

To build a single set of job parameters, the program starts with an empty set and continually loads properties from various sources. The program then merges the properties into a single set. After the program reads and loads all the sources, the program passes the single set of properties to the job submission as the job parameters.

This set of properties is built by merging in this order. When the same property with the same key is loaded and set more than once, the later value overrides the earlier value. The later steps in this sequence have a higher precedence than the earlier steps.

1. If the --jobParametersFile parameter is not included as a command line parameter, the following actions occur in order of ascending precedence:
   1. The contents of the files that are referenced by the --jobParametersFile control property are loaded and merged. This control property might appear in only one control property file, or it might appear in more than one file if the property was overridden.
   2. Job parameter control properties are loaded and merged. These properties are structured as --jobParameter=key=value inside of the control properties file.
   3. Command line job parameters are loaded and merged.
2. If the --jobParametersFile parameter is not included as a command line parameter, the following actions occur in order of ascending precedence:
   1. The contents of the files that are referenced by the --jobParametersFile control property are loaded and merged. This control property might appear in only one control property file, or it might appear in more than one file if the property was overridden.
   2. Job parameter control properties are loaded and merged. These properties are structured as --jobParameter=key=value inside of the control properties file.
   3. Command line job parameters are loaded and merged.

This structure occurs because the --controlPropertiesFile parameter has less precedence than the command line arguments. The level at which you specify the --jobParametersFile parameter determines the level of precedence of those files.

As the program reads and loads each file in the sequence, the program collapses the --jobParametersFile and --jobPropertiesFile properties that are found into a single property. Each property is an alias of the other. A command line argument or control properties override with one of these aliases supersedes an instance of either of the two that appears in an earlier overridden control properties file.

Return codes