Utilitaire client de ligne de commande batchManager

L'utilitaire client de ligne de commande batchManager fournit une interface de ligne de commande pour la gestion des travaux qui s'exécutent sur Liberty.

L'utilitaire client de ligne de commande batchManager interagit avec le gestionnaire par lots sur l'API REST du gestionnaire par lots.   Pour utiliser l'utilitaire client de ligne de commande batchManager, le gestionnaire par lots doit s'exécuter sur votre serveur Liberty. Utilisez la fonction de gestion par lots pour installer et activer le gestionnaire par lots Liberty.

Configuration SSL

L'utilitaire client de ligne de commande batchManager communique avec le gestionnaire par lots sur une connexion SSL. Pour faciliter la communication SSL avec un gestionnaire par lots qui s'exécute sur un serveur Liberty, l'utilitaire doit pouvoir vérifier le certificat SSL du serveur Liberty.

Si le certificat SSL est signé par une autorité de certification connue, l'utilitaire peut vérifier le certificat. Aucune configuration supplémentaire n'est nécessaire.

Si le certificat SSL n'est pas signé par une autorité de certification, vous devez configurer l'utilitaire afin qu'il fasse confiance au certificat SSL du serveur en effectuant l'une des actions ci-après.
  • Indiquez l'option --trustSslCertificates, qui configure l'utilitaire afin qu'il fasse confiance à tous les certificats SSL.
  • Incluez le certificat SSL du serveur dans le magasin de clés de confiance de l'utilitaire.

Si vous choisissez d'indiquer l'option --trustSslCertificates, l'utilitaire fait confiance à tous les certificats SSL qu'il reçoit et aucune configuration supplémentaire n'est nécessaire.

Si vous choisissez l'option d'inclure le certificat SSL du serveur dans le magasin de clés de confiance de l'utilitaire, vous devez aussi configurer l'utilitaire afin qu'il puisse trouver son magasin de clés de confiance. L'utilitaire est un principal Java autonome. Pour configurer SSL, vous devez utiliser des propriétés système telles que javax.net.ssl.truststore.

 Si le gestionnaire par lots s'exécute sur la même machine que l'utilitaire, vous pouvez pointer sur l'utilitaire directement au niveau du magasin de clés du serveur :
   $ export JVM_ARGS="-Djavax.net.ssl.trustStore=/path/to/server/keystore.jks"
   $ batchManager submit ...
Avertissement : Les arguments JVM, comme les propriétés -D, sont transmis à l'utilité client de ligne de commande batchManager par la variable d'environnement JVM-ARGS.
Si vous ne pouvez pas utiliser le magasin de clés du serveur directement, vous devez exporter le certificat serveur depuis le magasin de clés du serveur et l'importer dans le magasin de clés de confiance du client.   Utilisez l'utilitaire de clé JDK pour exporter et importer des certificats.   Dans l'exemple ci-après, le certificat serveur est stocké dans le fichier de clés [server-dir]/resources/security/key.jks sous l'alias default, et le mot de passe est Liberty.
    $ 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
Avertissement : La commande import crée le fichier truststore.jks si celui-ici n'existe pas.
    $ export JVM_ARGS="-Djavax.net.ssl.trustStore=/path/to/truststore.jks"
    $ batchManager submit ...

Commandes et utilisation

L'utilitaire client de ligne de commande batchManager fournit des commandes pour soumettre, arrêter, redémarrer et vérifier l'état des travaux.

Pour une utilisation générale de l'utilitaire :

$ batchManager [command] [options]

Pour afficher la liste des commandes disponibles :

$ batchManager help

Pour afficher la description et les options d'une commande spécifique :

$ batchManager help [command]

L'exemple suivant illustre comment soumettre un travail et attendre son achèvement :

  $ 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 et jobPropertiesFile

Lorsqu'un travail par lots est soumis à l'aide de l'utilitaire client batchManager, jobParametersFile et jobPropertiesFile prennent en charge l'utilisation de plusieurs fichiers séparés par des virgules. Les fichiers apparaissant en bas de la liste sont prioritaires par rapport aux fichiers qui apparaissent en tête de liste. L'exemple suivant illustre comment utiliser correctement la liste séparée par des virgules.
jobParametersFile=filePath1,filePath2,filePath3
jobPropertiesFile=filePath1,filePath2,filePath3
Par exemple, --jobParametersFile=<filepath1> prévaudrait sur --jobParametersFile=<filepath1>,<filepath2> dans le fichier de propriétés de contrôle. Le paramètre résultant serait --jobParametersFile=<filepath1>.
[17.0.0.3 and later]

Propriétés de contrôle et paramètres de travail

Pour générer un ensemble unique de paramètres de travail, le programme commence avec un ensemble vide et charge continuellement des propriétés de différentes sources. Le programme fusionne ensuite les propriétés en un ensemble unique. Après avoir lu et chargé toutes les sources, le programme transmet l'ensemble unique de propriétés à la soumission de travaux en tant que paramètres de travail.

Cet ensemble de propriétés est généré en fusionnant dans cet ordre. Lorsque la même propriété avec la même clé est chargée et définie plusieurs fois, la valeur la plus récente remplace la valeur antérieure. Les dernières étapes de cette séquence ont une priorité plus élevée que les étapes antérieures.

  1. Si le paramètre --jobParametersFile n'est pas inclus en tant que paramètre de ligne de commande, les actions suivantes se produisent par ordre de priorité croissante :
    1. Les contenus des fichiers référencés par la propriété de contrôle --jobParametersFile sont chargés et fusionnés. Cette propriété de contrôle peut apparaître dans un seul fichier de propriétés de contrôle ou dans plusieurs fichiers si la propriété a été remplacée.
    2. Les propriétés de contrôle des paramètres de travail sont chargées et fusionnées. Ces propriétés sont structurées sous la forme --jobParameter=key=value à l'intérieur du fichier de propriétés de contrôle.
    3. Les paramètres de travail de la ligne de commande sont chargés et fusionnés.
  2. Si le paramètre --jobParametersFile n'est pas inclus en tant que paramètre de ligne de commande, les actions suivantes se produisent par ordre de priorité croissante :
    1. Les contenus des fichiers référencés par la propriété de contrôle --jobParametersFile sont chargés et fusionnés. Cette propriété de contrôle peut apparaître dans un seul fichier de propriétés de contrôle ou dans plusieurs fichiers si la propriété a été remplacée.
    2. Les propriétés de contrôle des paramètres de travail sont chargées et fusionnées. Ces propriétés sont structurées sous la forme --jobParameter=key=value à l'intérieur du fichier de propriétés de contrôle.
    3. Les paramètres de travail de la ligne de commande sont chargés et fusionnés.

Cette structure se produit car le paramètre --controlPropertiesFile a une priorité inférieure aux arguments de la ligne de commande. Le niveau avec lequel vous spécifiez le paramètre --jobParametersFile détermine le niveau de priorité de ces fichiers.

Alors qu'il lit et charge chaque fichier dans la séquence, le programme réduit les propriétés --jobParametersFile et --jobPropertiesFile trouvées en une seule propriété. Chaque propriété est un alias de l'autre. Le remplacement d'un argument de ligne de commande ou des propriétés de contrôle par l'un de ces alias remplace une instance de l'un des deux apparaissant dans un fichier de propriétés de contrôle remplacé plus tôt.

Remarque : Consultez le fichier d'informations Javadoc java.util.Properties.load() pour obtenir les spécifications relatives aux commentaires.
For z/OS platforms

Utilitaire client de ligne de commande batchManager sur z/OS avec un fichier de clés SAF

Pour utiliser le fichier de clés SAF (System Authorization Facility) de votre serveur Liberty avec l'utilitaire de ligne de commande batchManager du client, vous devez définir les paramètres d'environnement java.environment et spécifier sur l'appel de cet utilitaire un ID utilisateur autorisé à lire le fichier de clés SAF.

Les commandes ci-après autorisent l'utilisateur à lire le fichier de clés SAF.

Important : ringOwnerId est généralement le même ID que l'ID utilisateur du serveur Liberty.

PermitRingOwnerId.RingName.LST CLASS(RDATALIB)ID(userId)ACCESS(UPDATE)

SETROPTS RACLIST(RDATALIB) GENERIC(RDATALIB) REFRESH

Pour plus d'informations, consultez la référence au langage de commande (CL) WebSphere Application Server z/OS Security Server RACF.

L'exemple ci-après définit la variable d'environnement JVM_ARGS.

export JVM_ARGS="-Djavax.net.ssl.trustStore=safkeyring://ringOwnerId/ringName
-Djavax.net.ssl.trustStoreType=JCERACFKS -Djavax.net.ssl.keyStore=safkeyring://ringOwnerId/ringName
-Djavax.net.ssl.keyStoreType=JCERACFKS -Dcom.ibm.ssl.keyStoreFileBased=false -Dcom.ibm.ssl.trustStoreFileBased=false
-Djava.protocol.handler.pkgs=com.ibm.crypto.provider -Djavax.net.ssl.keyStorePassword=password"
Avertissement : La propriété javax.net.ssl.keyStorePassword est obligatoire et sa valeur doit être password et elle est utilisée pour décoder la copie des informations de clé sur la machine JVM lorsqu'elle existe en mémoire.

Codes retour

L'utilitaire client de ligne de commande batchManager produit les codes retour suivants :
Code Description
0 La tâche s'est terminée normalement.
20 Un argument obligatoire n'a pas été spécifié.
21 Un argument non reconnu a été spécifié.
22 Un argument non valide a été spécifié.
255 Une erreur inattendue est survenue.
Remarque : Si vous indiquez l'argument --wait, l'utilitaire produit les codes retour suivants concernant l'état du travail que vous attendez.
Code Description
33 Le travail s'est arrêté.
34 Le travail n'a pas abouti.
35 Le travail a abouti.
36 Le travail a été abandonné.

Icône indiquant le type de rubrique Rubrique de concept

Nom du fichier : cwlp_jbatch_commandlineutil.html