Option de commande serveur

La commande server prend en charge le démarrage, l'arrêt, la création, le conditionnement et le cliché d'un serveur Liberty. Cette rubrique décrit toutes les options disponibles ainsi que les codes de sortie que vous pouvez utiliser avec la commande server et le fichier JAR exécutable équivalent ws-server.jar.

Syntaxe

La syntaxe de la commande est la suivante :

server action serverName [options]

La valeur de action représente l'opération que vous pouvez effectuer sur un serveur Liberty. Reportez-vous aux opérations d'administration disponibles pour Liberty depuis une invite de commande.

Remarque : Si aucun serveur n'est spécifié sur la ligne de commande, l'action est effectuée pour l'instance de serveur par défaut (defaultServer), si elle existe.

Options

Les options suivantes sont disponibles pour la commande server :
--archive="chemin_fichier_archive_cible"

Spécifie un fichier cible pour l'opération package ou dump. Ce chemin peut être relatif au répertoire racine d'installation de Liberty ou absolu. La cible par défaut est un fichier compressé, portant le même nom que le serveur et placé dans le répertoire racine d'installation. Utilisez des guillemets si la valeur contient des espaces. Vous pouvez utiliser cette option pour les opérations package et dump.

--clean
Efface toutes les informations mises en cache persistantes liées à l'instance de serveur spécifiée, notamment les métadonnées du programme de résolution OSGi et les données de bundle OSGi persistantes. Si vous utilisez cette option, le serveur devra recalculer les données mises en cache au démarrage suivant, qui prendra alors plus de temps qu'un redémarrage pouvant réutiliser les données mises en cache.
Remarque : Cette option n'est pas requise dans le cadre d'un fonctionnement normal. Le service IBM® peut vous demander de l'utiliser pour un correctif temporaire ou s'il soupçonne un problème lié aux données mises en cache. Cette option peut également être requise si vous développez une extension de produit et que vous mettez à jour des manifestes OSGi ou planifiez d'effacer des données de bundle OSGi persistantes.
--include=option_package
Spécifie les fichiers à conditionner, où option_package peut prendre l'une des valeurs suivantes :
  • all indique que tous les fichiers qui se trouvent dans le répertoire d'installation de Liberty doivent être conditionnés. Si les variables ${WLP_USER_DIR} et ${WLP_OUTPUT_DIR} sont définies dans le fichier server.env, les fichiers qu'ils contiennent sont conditionnés. Cette valeur est valable pour l'opération package seulement.
  • usr indique que les fichiers qui se trouvent dans le répertoire ${WLP_USER_DIR} doivent être conditionnés. Cette valeur est valable pour l'opération package seulement.
  • minify conditionne uniquement les composants de l'environnement d'exécution et les fichiers qui se trouvent dans le répertoire ${WLP_USER_DIR} nécessaires à l'exécution du serveur et réduit ainsi la taille de l'archive générée. Cette valeur est valable pour l'opération package seulement.
--include=option_diagnostic,option_diagnostic,...
Indique le type d'informations de diagnostic à capturer. La valeur de --include est une liste dont les éléments sont séparés par une virgule et qui peut contenir les valeurs suivantes :
  • heap permet de diagnostiquer la consommation de mémoire excessive ainsi que les fuites de mémoire, et affiche les objets actifs dans la mémoire et les références entre eux. Sur les machines virtuelles IBM J9, le fichier généré s'appelle heapdump.date.heure.IDprocessus.numéroSéquence.phd. Sur les machines virtuelles HotSpot, le fichier généré s'appelle java.date.heure.IDprocessus.numéroSéquence.hprof. Cette valeur est valable pour les opérations dump et javadump.
  • system permet de diagnostiquer la consommation de mémoire excessive et les fuites de mémoire, mais est également utile pour rechercher des incidents sur la machine virtuelle. Ces clichés sont pris en charge uniquement sur les machines virtuelles IBM J9. Le fichier résultant est nommé core.date.time.processID.sequenceNumber.dmp. Cette valeur est valable pour les opérations dump et javadump.
  • thread permet de diagnostiquer les unités d'exécution bloquées et les interblocages et peut parfois être utilisé pour diagnostiquer les problèmes d'utilisation excessive de l'unité centrale. Ces clichés sont toujours créés avec la commande server javadump. Sur les machines virtuelles IBM J9, le fichier généré s'appelle javacore.date.heure.IDprocessus.numéroSéquence.txt. Sur les machines virtuelles HotSpot, le fichier généré s'appelle javadump.date.heure.IDprocessus.numéroSéquence.txt. Cette valeur est aussi valable pour l'opération dump.
    Remarque : Le type de cliché d'unité d'exécution est pris en charge uniquement lorsque le serveur est démarré sur le SDK Java™. Si le serveur est démarré avec un environnement d'exécution Java (JRE), une erreur indique que le serveur ne prend pas en charge le type de cliché. Cette restriction concerne les machines virtuelles HotSpot ; le type de cliché Java d'unité d'exécution est pris en charge sur toutes les machines virtuelles Java IBM (JRE ou SDK).
--os=valeur_se,valeur_se,...
Spécifie les systèmes d'exploitation que le serveur conditionné doit prendre en charge. Fournissez une liste dont les éléments sont séparés par une virgule. La valeur par défaut est any et indique que le serveur doit pouvoir être déployé sur tout système d'exploitation pris en charge par la source.

Pour indiquer qu'un système d'exploitation ne doit pas être pris en charge, ajoutez-lui le préfixe moins (-). Pour obtenir une liste des valeurs du système d'exploitation, veuillez vous reporter au site Web d'OSGi Alliance à l'adresse URL suivante : https://www.osgi.org/developer/specifications/reference/#os.

Cette option est valable uniquement pour l'opération package et ne peut être utilisée qu'avec l'option --include=minify. Si vous excluez un système d'exploitation, vous ne pouvez pas l'inclure ultérieurement si vous répétez l'opération minify pour l'archive.

[17.0.0.1 and later]--target=composant_pouvant_être_mis_en_pause,composant_pouvant_être_mis_en_pause,...
[17.0.0.1 and later]Spécifie une liste délimitée par des virgules de composants pouvant être mis en pause. Si vous spécifiez l'option target (cible), seuls les composants répertoriés sont mis en pause ou remis en activité. Pour une liste d'exemples de valeurs cibles, voir Pause et reprise d'un serveur Liberty depuis la ligne de commande.

Processus serveur

Le processus serveur est créé à l'aide des variables d'environnement qui sont spécifiées dans le fichier server.env. Les options de machine virtuelle Java sont ajoutées par défaut :
  • L'option -javaagent:wlp/bin/tools/ws-javaagent.jar est requise pour la trace, la surveillance, la publication incrémentielle d'applications, et d'autres capacités serveur.
  • L'option -Xshareclasses et les options liées activent le cache de classe partagée sur les machines virtuelles IBM J9 prises en charge. Le répertoire cache est WLP_OUTPUT_DIR/.classCache.
  • L'option -XX:MaxPermSize augmente la taille de la génération permanente des machines virtuelles HotSpot antérieures à Java 8. Vous pouvez définir la variable d'environnement WLP_SKIP_MAXPERMSIZE sur true pour éviter cette option par défaut, qui évite les avertissements comme :
    Java HotSpot(TM) Client VM warning: ignoring option MaxPermSize=256m; support was removed in 8.0
  • L'option -Djava.awt.headless=true évite l'exception java.awt.HeadlessException sur toutes les plateformes et les problèmes de mainmise sur le focus sur Mac OS X.

Vous pouvez utiliser le fichier jvm.options pour remplacer ces options de machine virtuelle Java (JVM) par défaut ou ajouter d'autres options JVM. Pour plus d'informations sur les fichiers server.env et jvm.options, voir Personnalisation de l'environnement Liberty.

Par défaut, la commande server définit la valeur umask de manière à rejeter toutes les autorisations aux utilisateurs Other avant que la commande n'exécute l'action. Vous pouvez définir la variable d'environnement WLP_SKIP_UMASK sur true dans le fichier server.env pour éviter que la commande de serveur ne modifie la valeur umask. Si vous définissez la variable d'environnement WLP_SKIP_UMASK, le serveur utilise la valeur umask du processus sous-jacent de l'opération. Sur z/OS, vous pouvez spécifier la propriété WLP_SKIP_UMASK de l'une des manières suivantes :
  • Utilisez le fichier server.env.
  • Si vous démarrez le serveur avec une procédure z/OS, vous pouvez également spécifier la propriété avec l'entrée STDENDV DD.

Le répertoire de travail en cours du processus serveur est le répertoire de sortie du serveur.

La commande server crée un fichier PID (ID de processus) au démarrage du serveur et supprime ce fichier PID à l'arrêt du serveur. Par défaut, le fichier PID est défini sur WLP_OUTPUT_DIR/.pid/serverName.pid. Le chemin d'accès absolu du fichier PID peut être modifié en définissant la variable d'environnement PID_FILE, ou le chemin d'accès absolu du répertoire PID peut être modifié en définissant la variable d'environnement PID_DIR.

Les erreurs et la sortie standard du processus serveur sont envoyées à la console en avant-plan si vous utilisez les actions run et debug et sont redirigées vers le fichier WLP_OUTPUT_DIR/serverName/logs/console.log par défaut si vous utilisez l'action start. Le nom du journal peut être modifié à l'aide de la variable d'environnement LOG_FILE et le répertoire du journal peut être modifié à l'aide de la variable d'environnement LOG_DIR. Pour plus d'informations sur la configuration de la journalisation, voir Journalisation et Trace.

L'action stop empêche les nouvelles demandes d'application d'entrer sur le serveur, ce qui donne plus de temps aux demandes existantes pour s'exécuter. Après cela, les composants de serveur restants sont arrêtés et le processus serveur s'arrête. Les demandes d'application qui ne se terminent pas dans le délai imparti échouent, mais leur comportement exact dépend de leur activité lorsque les composants serveur sont arrêtés.

Codes de sortie

Les codes de sortie suivants sont disponibles pour la commande server et le fichier JAR exécutable équivalent ws-server.jar :
0
OK. 0 indique que l'opération demandée a abouti. Pour le statut du serveur, 0 indique que le serveur est démarré.
1
Pour le statut du serveur, 1 indique que le serveur est arrêté. Pour les autres opérations, 1 indique l'appel d'une opération redondante, comme le démarrage d'un serveur démarré ou l'arrêt d'un serveur arrêté. Ce code peut aussi être renvoyé par la machine virtuelle Java si des options Java non valides sont utilisées.
2
Le serveur n'existe pas.
3
Une action non prise en charge a été appelée sur un serveur démarré. Par exemple, le serveur est en cours d'exécution lorsque l'action de conditionnement est appelée.
4
Une action non prise en charge a été appelée sur un serveur arrêté. Par exemple, le serveur n'est pas en cours d'exécution lorsque l'action de vidage est appelée.
5
Statut du serveur inconnu. Par exemple, le répertoire workarea manque, ou l'API Attach ne fonctionne pas.
>=20
Les codes retour supérieurs ou égaux à 20 indiquent qu'une erreur est survenue lors de l'exécution de la demande. Des messages qui contiennent des informations détaillées sur l'erreur sont affichés et capturés dans des fichiers journaux.

Syntaxe

Les exemples suivants illustrent la syntaxe correcte :

server run
server start myserver --clean
server package myserver --archive="archivefile.zip" --include=all
server dump myserver --archive="c:\mybackup\myserver.zip" --include=thread
server javadump myserver
server javadump myserver --include=thread,system

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

Nom du fichier : rwlp_command_server.html