Commande installUtility

Utilisez la commande installUtility pour rechercher et obtenir des informations sur des actifs hébergés dans un référentiel basé sur un répertoire, une instance du service Liberty Asset Repository ou le Référentiel Liberty et les installer.

Sources d'actifs

La commande installUtility peut accéder aux actifs dans les référentiels suivants :
  • Le Référentiel Liberty, référentiel public hébergé par IBM®, est accessible via Internet. Pour plus d'informations, voir Référentiel Liberty.
  • Le Service du référentiel d'actifs Liberty est un service open source que vous pouvez utiliser pour créer un référentiel sur site accessible à distance derrière le pare-feu d'une entreprise. Pour plus d'informations, voir l'article WASdev/tool.lars project on GitHub.
  • Les référentiels locaux à base de répertoires que vous créez à l'aide de l'action installUtility download ou en téléchargeant le fichier wlp-featureRepo-<version>.zip, qui contiennent toutes les fonctions et tous les modules complémentaires applicables. Pour plus d'informations, voir Téléchargement d'actifs avec la commande installUtility.

Vous pouvez utiliser la commande installUtility pour travailler avec les actifs d'un référentiel basé sur un répertoire directement à partir des référentiels compressés, par exemple wlp-featureRepo-<version>.zip, sans extraire les archives. Pour en savoir plus sur le fichier wlp-featureRepo-<version>.zip, voir Téléchargement d'actifs avec la commande installUtility.

Syntaxe

La syntaxe de la commande est la suivante :

installUtility action [options]
La variable action peut prendre l'une des valeurs suivantes :
download
Télécharge les actifs depuis les référentiels.
find
Recherche des actifs dans les référentiels qui s'appliquent à votre configuration, pou afficher des informations détaillées sur les actifs.
install
Installe les actifs ou un fichier ESA dans l'environnement d'exécution, ou déploie un package serveur et installe les fonctions requises de ce package.
testConnection
Teste la connexion à un référentiel.
uninstall
Désinstalle des fonctions en indiquant le nom abrégé ou le nom symbolique de la fonction. Vous pouvez spécifier plusieurs fonctions en les séparant par un espace.
Remarque : Assurez-vous que tous les processus serveur sont arrêtés avant de désinstaller une fonction.
viewSettings
Affiche un modèle pour configuration de référentiels ou de proxy, ou affiche et valide les paramètres des référentiels configurés ou du proxy.
help
Afficher les informations d'aide pour l'action spécifiée.

Options

Les options suivantes sont disponibles pour la commande installUtility download :
--acceptLicense
Accepter le contrat de licence.
--viewLicenseAgreement
Afficher le contrat de licence.
--viewLicenseInfo
Afficher le contrat de licence.
--location=directoryPath
Indiquer le répertoire de destination pour les actifs reçus par téléchargement. Cette option est obligatoire.
--overwrite
Cette option permet de remplacer les fichiers existants lors du téléchargement sur le répertoire local. Le comportement par défaut sans l'option est d'ignorer tous les fichiers existants.
--verbose
Cette option permet d'afficher des informations supplémentaires pendant le téléchargement.
name
Indiquez les ID d'actif pour télécharger un ou plusieurs des actifs suivants, en séparant plusieurs ID d'actif par un espace :
  • Fonctions
  • Modules complémentaires
  • Intégrations Open source
  • Exemples

Les options suivantes sont disponibles pour la commande installUtility find :
--from
Indiquez un seul référentiel basé sur un répertoire comme source des actifs pour la commande installUtility.

Le référentiel basé répertoires peut être un dossier décompressé ou un fichier archive compressé.

Pour rechercher des actifs dans plusieurs référentiels basés sur un répertoire, vous devez configurer les référentiels dans le fichier repositories.properties. Pour plus d'informations, voir Configuration de référentiels et de paramètres de proxy pour la commande installUtility.

--showDescriptions
Affiche la description de chacune des fonctions détectées par la recherche.
--type=[feature|sample|opensource|addon|all*]
Recherche les types d'actifs spécifiés.
--name
Recherche le nom d'actif pour l'élément searchString spécifié.
--verbose
Utilisez cette option pour afficher des informations supplémentaires disponibles pendant l'exécution de l'action.
searchString
Recherche des actifs qui sont applicables à votre configuration. Si vous ne spécifiez pas de chaîne de recherche, la commande recherche tous les actifs applicables.

Les options suivantes sont disponibles pour la commande installUtility install :
--to=option_install
L'option install_option peut prendre l'une des valeurs suivantes :
  • usr: La fonction est installée en tant que fonction utilisateur. Cette valeur est la valeur par défaut.
  • extension : Emplacement d'installation de la fonction. Vous pouvez installer la fonction dans n'importe quel emplacement d'extension de produit.
--from
Indiquez un seul référentiel basé sur un répertoire comme source des actifs pour la commande installUtility.

Le référentiel basé répertoires peut être un dossier décompressé ou un fichier archive compressé.

Pour installer des actifs de plusieurs référentiels basés sur un répertoire, vous devez configurer les référentiels dans le fichier repositories.properties. Pour plus d'informations, voir Configuration de référentiels et de paramètres de proxy pour la commande installUtility.

--acceptLicense
Accepter les dispositions du contrat de licence.
--viewLicenseAgreement
Afficher le contrat de licence.
--viewLicenseInfo
Afficher les informations sur la licence.
--verbose
Utilisez cette option pour afficher des informations supplémentaires disponibles pendant l'exécution de l'action.
name
Indiquez un ou plusieurs actifs à installer. Vous pouvez indiquer les actifs de plusieurs manières :
ID d'actif
Vous pouvez indiquer des ID d'actif pour l'installation d'un ou de plusieurs des actifs suivants, en séparant plusieurs ID d'actif par un espace :
  • Fonctions
  • Modules complémentaires
  • Intégrations Open source
  • Exemples
Nom du serveur
Vous pouvez installer des fonctions depuis un serveur existant dans le même environnement Liberty en spécifiant le nom du serveur. La commande installe toutes les fonctions applicables qui sont définies dans le fichier server.xml de ce serveur et qui ne sont pas déjà installées dans l'environnement Liberty.
Package serveur
Vous pouvez spécifier un package serveur que vous avez créé à l'aide de la commande server package --include=usr. Le package serveur se déploie, et les fonctions requises, qui sont définies dans le fichier server.xml, sont installées depuis les référentiels.
Fichier server.xml
Pour installer des fonctions basées sur un fichier de configuration du serveur, vous pouvez indiquer un chemin d'accès un fichier server.xml local, comme C:\localDir\server.xml. La commande installe toutes les fonctions applicables qui sont définies dans le fichier server.xml et qui ne sont pas déjà installées dans l'environnement Liberty.
Fichier .esa
Installer une fonction depuis un fichier .esa sur votre système de fichiers local. Cette action utilise le fichier manifeste OSGI-INF/SUBSYTEM.MF depuis le fichier .esa comme nouveau manifeste de fonction. Le fichier manifeste indique le nom, le contenu et les dépendances d'une fonction. Si vous spécifiez l'option --to, installUtility copie le fichier manifeste dans le répertoire ${wlp.user.dir}/extensions/lib/features ou le répertoire d'extensions du produit. Tous les bundles du sous-système sont extraits dans le répertoire ${wlp.user.dir}/extensions/lib et renommés $ {nom symbolique bundle}_{version bundle}.jar. Les fichiers de licence, de total de contrôle, de localisation et les autres contenus du sous-système sont extraits vers l'emplacement défini dans le manifeste du sous-système.

L'option suivante est disponible pour la commande installUtility testConnection :
repoName
Indique le nom du référentiel à tester. S'il n'est pas indiqué, tous les référentiels spécifiés dans le fichier repositories.properties sont testés.

L'option suivante est disponible pour la commande installUtility uninstall :
--force
Désinstaller la fonction spécifiée même si d'autres fonctions installées ont des dépendances de celle-ci.
Remarque : La désinstallation d'une fonction requise par d'autres fonctions installées peut entraîner l'arrêt de ces fonctions et empêcher un fonctionnement correct des serveurs.
--noPrompts
Désinstalle la fonction sans invites. La valeur par défaut est false.
--verbose
Cette option permet d'afficher des informations supplémentaires pendant la désinstallation.
name
Indiquez une ou plusieurs fonctions à désinstaller, en séparant plusieurs noms par un espace. Vous pouvez définir les options suivantes :
  • Le nom abrégé de l'archive de sous-système (fichier ESA), par exemple adminCenter-1.0.
  • Le nom symbolique de l'archive de sous-système (fichier ESA), par exemple com.ibm.websphere.appserver.adminCenter-1.0.

Vous pouvez désinstaller des fonctions utilisateur et des extensions produit en préfixant le nom de fonction par l'extension suivie d'un deux points, comme usr:webCacheMonitor-1.0.


L'option suivante est disponible pour la commande installUtility viewSettings :
--viewValidationMessages
Cette option vous permet d'afficher les messages détaillés de la validation du fichier repositories.properties configuré. Chaque message contient un code d'erreur, le numéro de ligne où l'erreur a été détectée et la cause de l'erreur.

Exemples d'utilisation

Utilisez l'exemple suivant pour afficher les informations d'aide relatives à l'action install :
installUtility help install
Utilisez l'exemple suivant pour installer une fonction utilisateur :
installUtility install my_feature --to=usr
Utilisez l'exemple suivant pour installer une fonction utilisateur dans l'emplacement d'extension de produit my_extension :
installUtility install my_feature --to=my_extension
Utilisez l'exemple suivant pour installer plusieurs fonctions :
installUtility install feature1 feature2 feature3
Utilisez l'exemple suivant pour installer un exemple de fonction :
installUtility install mongoDBSample
Utilisez l'exemple suivant pour installer un module complémentaire de bundle de fonctions à partir d'un référentiel basé sur un répertoire local unique :
installUtility install ndMemberBundlelibertyCoreBundle --from=c:\download\wlp-featureRepo-16.0.0.2
Utilisez l'exemple suivant pour installer un module complémentaire de bundle de fonctions depuis un seul fichier archive compressé de référentiel basé répertoires :
installUtility install ndMemberBundlelibertyCoreBundle --from=c:\download\wlp-featureRepo-16.0.0.2.zip
Utilisez l'exemple suivant pour installer un serveur :
installUtility install myServer
Utilisez l'exemple suivant pour installer un fichier .jar compressé de package serveur :
installUtility install c:\temp\myServer.jar
Utilisez l'exemple suivant pour installer un fichier .esa local :
installUtility install c:\temp\myFeature.esa 
Utilisez l'exemple suivant pour installer un fichier compressé de package serveur :
installUtility install c:\temp\myServer.zip
Utilisez l'exemple suivant pour rechercher des actifs qui s'appliquent à votre configuration :
installUtility find searchString
Utilisez l'exemple suivant pour rechercher des exemples qui s'appliquent à votre configuration :
installUtility find searchString --type=sample
Utilisez l'exemple suivant pour rechercher une fonction particulière qui s'applique à votre configuration :
installUtility find webCacheMonitor-1.0 --name --type=feature
Utilisez l'exemple suivant pour afficher des informations détaillées :
installUtility find searchstring --showDescriptions
Utilisez l'exemple suivant pour télécharger les dépendances requises des référentiels vers un répertoire local :
installUtility download feature_shortName --location=c:\temp\download --acceptLicense
Utilisez l'exemple suivant pour tester la connexion au Référentiel Liberty:
installUtility testConnection default
Utilisez l'exemple suivant pour désinstaller une fonction :
installUtility uninstall adminCenter-1.0
Utilisez l'exemple suivant pour désinstaller une fonction ou une extension de produit :
installUtility uninstall usr:webCacheMonitor-1.0
Utilisez l'exemple suivant pour désinstaller plusieurs fonctions :
installUtility uninstall feature1 feature2 feature3
Utilisez l'exemple suivant pour désinstaller plusieurs fonctions sans invites :
installUtility uninstall --noPrompts feature1 feature2 feature3

Codes retour

Tableau 1. Codes retour et explications
Code retour Explication
0 La commande a exécuté l'opération demandée.
20 Un ou plusieurs arguments sont incorrects.
21 Une exception d'exécution est survenue en raison d'une ou de plusieurs des conditions suivantes :
  • Une exception d'exécution est survenue lors de l'installation du fichier archive de sous-système .esa.
  • Une licence n'a pas été acceptée ou reconnue.
  • Le fichier archive de sous-système .esa n'a pas été extrait correctement.
22 La fonction à installer existe.
23 La définition de la fonction n'est pas valide pour une ou plusieurs raisons :
  • La fonction ne possède pas de fichier manifeste valide.
  • La version de la fonction n'est pas prise en charge dans cet environnement Liberty.
  • Le fichier .zip ou .jar qui contient les fichiers de la fonction n'existe pas.
24 Du contenu manque dans le fichier archive de sous-système .esa.
25 Un fichier à installer existe.
26 Le produit n'est pas un produit de base et les fichiers d'extension de produit sont introuvables.
27 Le produit n'est pas un produit de base et l'extension de produit n'est pas définie dans le fichier ${wlp.install.dir}/etc/extensions/nom_extension.properties.
28 Les fichiers manifeste pour la fonction dans l'extension de produit sont introuvables.
29 La fonction n'est pas valide pour le produit courant.
30 La validation du fichier repositories.properties a échoué.
33 La connexion au référentiel a échoué.
34 Le nom de référentiel est introuvable. Le nom de référentiel fourni n'existe pas dans le fichier de configuration.
35 L'action a été annulée par l'utilisateur.
[17.0.0.3 and later]36 [17.0.0.3 and later]L'installation d'une fonction d'utilisateur n'est pas valide pour l'extension spécifiée : --to=core .

Icône indiquant le type de rubrique Rubrique de référence

Nom du fichier : rwlp_command_installutility.html