Outil de scriptage wsadmin
L'outil wsadmin exécute des scripts. Vous pouvez utiliser l'outil wsadmin pour gérer les opérations de serveur d'applications ainsi que celles de configuration, de déploiement d'applications et d'exécution de serveur.
Vous pouvez exécuter les commandes wsadmin à partir de WebSphere
Application Server sur une plateforme distribuée et utiliser la commande distribuée pour administrer WebSphere
Application Server sur un système d'exploitation z/OS.
Utilisez des profils spécifiques pour des droits utilisateurs distincts.
Utilisez une installation distincte pour des droits utilisateurs distincts.
- Le même utilisateur doit exécuter toutes les commandes d'un profil.
- Vérifiez que tous les utilisateurs d'un profil spécifique appartiennent au même groupe. En outre, faites en sorte que chaque utilisateur d'un groupe dispose des droits de lecture et d'écriture sur les fichiers qui sont créés par d'autres membres du même profil.

- Vous devez entrer les commandes wsadmin dans l'interpréteur de commandes interactif wsadmin sur une ligne. En d'autres termes, entrez la commande en continu et ne fractionnez pas la commande en plusieurs lignes. Le fractionnement d'une commande wsadmin longue en plusieurs lignes n'est pas pris en charge. Une tentative d'exécution de commandes wsadmin fractionnées sur plusieurs lignes dans l'interpréteur de commandes interactif wsadmin entraîne une erreur de syntaxe.
- L'outil wsadmin supprime tous les espaces de début et de fin, notamment \n, \r, \t, \f et les espaces lors de l'analyse d'une chaîne, afin d'éviter les erreurs d'utilisateur. Par exemple, il peut arriver d'appuyer par mégarde sur la barre d'espacement ou la touche de tabulation et d'ajouter un espace à la chaîne de commandes. Cet espace risque de faire échouer la commande ou le script. Si vous avez besoin d'ajouter un espace dans une commande, utilisez la syntaxe de liste au lieu de la syntaxe de chaîne, ou placez la chaîne contenant l'espace entre crochets ([ ]).
La syntaxe pour appeler la ligne de commande du client de scriptage wsadmin est la suivante :
![[AIX Solaris HP-UX Linux Windows]](../images/dist.gif)
![[IBM i]](../images/iseries.gif)
wsadmin [-h(help)]
![[z/OS]](../images/ngzos.gif)
wsadmin.sh [-h(help)]
[-?]
[-c command]
[-p properties_file_name]
[-profile profile_script_name]
[-profileName profile_name]
[-f script_file_name]
[-javaoption java_option]
[-lang language]
[-wsadmin_classpath classpath]
[-conntype SOAP [-host host_name] [-port port_number] [-user userid] [-password password]
[-conntype RMI [-host host_name] [-port port_number] [-user userid] [-password password]
[-conntype JSR160RMI [-host host_name] [-port port_number] [-user userid] [-password password]
[-conntype IPC [-ipchost host_name] [-port port_number] [-user userid] [-password password]
[-jobid jobid_string]
[-tracefile trace_file]
[-appendtrace true/false]
[script parameters]
L'élément script parameters représente tout argument différent de ceux répertoriés précédemment. La variable argc contient le nombre d'arguments et la variable argv contient une liste des arguments dans l'ordre où ils ont été codés.
Options
- -c
- Indique l'exécution d'une seule commande. L'option -c doit être suivie d'une commande. La ligne de commande peut contenir plusieurs options -c, qui
s'exécutent dans l'ordre indiqué.
Si vous appelez l'outil wsadmin avec l'option -c, toutes les modifications que vous apportez à la configuration sont automatiquement enregistrées. Si vous effectuez des modifications de configuration sans l'option -c, vous devez utiliser la commande enregistrer de l'objet AdminConfig pour les enregistrer. Pour plus d'information, lire Enregistrement des modifications de configuration avec l'outil wsadmin.
- -Dwsadmin.script.libraries=rép1;rép2;...
- Indique le chemin de recherche des scripts Jython qui utilisent des packages. rép1 et rép2 représentent les chemins de recherche de répertoire des bibliothèques contenant les packages Jython.
- -f
- Indique un script à exécuter. L'option -f doit être suivie d'un nom de fichier.
La ligne de commande ne peut contenir qu'une option -f.
Vous pouvez utiliser l'option -f pour exécuter les scripts contenant des scripts Jython imbriqués. Dans l'exemple suivant, le script test2 importe le script test1 :#test1.py def listServer(): print AdminConfig.list("Server")
#test2.py import test1 test1.listServer()
Pour exécuter le script appelant, exécutez la commande suivante à partir du répertoire racine_serveur_app/bin :wsadmin -lang jython -f test2.py
Après l'exécution des scripts, le système renvoie l'exemple de résultat de la commande suivant :server1(cells/myCell/nodes/myNode/servers/myServer|server.xml#Server_1183122130078)
- -javaoption
- Indique une option standard Java ou non valide. La ligne de commande peut contenir plusieurs options -javaoption.
wsadmin -javaoption java_option -javaoption java_option
wsadmin.sh -javaoption java_option -javaoption java_option
Pour raccourcir la longueur de la commande, vous pouvez la saisir de la manière suivante :
wsadmin -javaoption "java_option java_option"
wsadmin.sh -javaoption "java_option java_option"
transition : Vous ne pouvez pas utiliser la commande abrégée wsadmin -javaoption "option_java option_java". Vous devez utiliser le format wsadmin.sh -javaoption option_java -javaoption option_java le plus long. Contrairement aux versions précédentes, le produit version 8 ne prend pas en charge les options Java multiples en une option unique -javaoption sur les systèmes d'exploitation Windows.
Sur les systèmes d'exploitation Windows, si l'option contient un signe égal (=) ou un point-virgule (;), vous devez placer les marques de guillemets (") de part et d'autre de l'option ; par exemple :
Les systèmes d'exploitation Windows traitent le signe égal (=) ou le point-virgule (;) dans les arguments de ligne de commande comme un espace. L'outil wsadmin requiert des arguments comprenant un espace entre des guillemets.wsadmin -javaoption "-Da.b.c=3"
Pour les utilisateurs en transition: Pour WebSphere Application Server version 8.5, les options %javaoption% dans wsadmin.bat et $javaOption dans wsadmin.sh se trouvent à la fin des arguments JAVA_EXE. Cela vous permet de remplacer les propriétés système Java, telles que CLIENTSOAP et CLIENTSAS.trns
- -lang
- Indique le langage du fichier de script,
de commande ou d'un shell interactif. Les langages admis incluent : Jacl et Jython.
Ces options de langage sont exprimées par jacl et jython.
Cette option supplante les déterminations de langage basées sur un nom de fichier de script, un nom de fichier de script de profil ou la propriété com.ibm.ws.scripting.defaultLang. L'argument -lang ne possède pas de valeur par défaut. Si la langue spécifiée avec l'argument -lang ne correspond pas à la langue déterminée par l'argument -f nom_fichier_script, l'outil wsadmin détermine la langue en fonction du nom du fichier script.
Si vous n'indiquez pas l'argument -lang mais que l'argument -f nom_fichier_script est défini, alors l'outil wsadmin détermine le langage en fonction d'un nom de fichier de script cible. Si vous n'indiquez pas l'argument -lang et l'argument -f, l'outil wsadmin détermine le langage en fonction d'un nom de fichier de script de profil si l'argument -profile nom_script_profil est précisé. Si la ligne de commande ou la propriété n'indique pas le langage du script et que l'outil wsadmin n'arrive pas à le déterminer, un message d'erreur est généré.
- -p
- Désigne un fichier de propriétés. L'option -p doit être suivie d'un nom de fichier.Le fichier indiqué après -p correspond à un fichier de propriétés Java que le processus de scriptage lit. Trois niveaux de fichiers de propriétés par défaut sont chargés avant le fichier de propriétés indiqué sur la ligne de commande :
- Le premier niveau est le fichier par défaut de l'installation, wsadmin.properties, qui se trouve dans le répertoire des propriétés du produit.
- Le deuxième est le fichier par défaut de l'utilisateur, wsadmin.properties, qui se trouve dans votre répertoire principal.
- Le troisième est le fichier de propriétés désigné par la variable d'environnement WSADMIN_PROPERTIES.
La ligne de commande peut contenir plusieurs options -p, qui sont traitées dans l'ordre où vous les avez entrées.
Vous pouvez également utiliser la propriété personnalisée com.ibm.ws.scripting.noechoParamNo avec cette option. Utilisez cette propriété personnalisée pour indiquer les paramètres de script que vous ne souhaitez pas afficher dans un fichier de trace ou une sortie standard. Pour activer cette propriété personnalisée, créez un fichier texte, par exemple nommé noecho.prop. Dans ce fichier texte, indiquez les positions dans la commande wsadmin qui contiennent des données sensibles, par exemple des mots de passe, que vous voulez exclure du fichier de trace et de la sortie standard. Le fichier texte peut indiquer un paramètre, ou plusieurs paramètres séparés par une virgule. Par exemple, ce fichier texte peut contenir les informations suivantes :
Quand vous référencez ce fichier texte dans votre commande wsadmin, la troisième et la cinquième valeurs de paramètre sont exclues des fichiers de trace et des sorties standard. Pour utiliser la propriété personnalisée, exécutez la commande wsadmin et ajoutez-lui le fichier texte avec l'option -p. Par exemple :com.ibm.ws.scripting.noechoParamNo=3,5
Avec Jacl :wsadmin -f script_file script_arguments -p text_file
Avec Jython :wsadmin -lang jython -f script_file script_arguments -p text_file
Par exemple :
wsadmin -f text.py server1 dbuser dbpassword user1 userpassword -p noecho.prop
wsadmin -f c:/text.py server1 dbuser dbpassword user1 userpassword -p c:/noecho.prop
wsadmin.sh -f text.py server1 dbuser dbpassword user1 userpassword -p noecho.prop
dbpassword et userpassword sont le troisième et le cinquième paramètres qui n'apparaissent pas dans un fichier de trace ou la sortie standard.
- -profile
- Désigne un script de profil.
Le script de profil s'exécute avant les autres commandes ou scripts. Si vous indiquez -c, le script du profil s'exécute avant l'appel de cette commande. Si vous spécifiez -f, le script du profil s'exécute avant l'exécution du script. En mode interactif, vous pouvez utiliser le script du profil pour effectuer toute initialisation standard souhaitée. Vous pouvez spécifier plusieurs options -profile sur la ligne de commande et elles sont appelées dans l'ordre où vous les entrez.
- -profileName
- Indique le profil à partir duquel l'outil wsadmin est exécuté. Définissez cette option dans l'un des cas suivants :
- Vous exécutez l'outil wsadmin à partir du répertoire racine_serveur_app/bin, et vous n'avez pas de profil par défaut ou vous voulez l'exécuter dans un profil autre que celui par défaut.
- Vous êtes actuellement dans le répertoire bin d'un profil, mais vous voulez exécuter l'outil wsadmin à partir d'un autre profil.
Important : WebSphere Application Server exécuté sur des systèmes d'exploitation z/OS ne prend pas en charge les profils créés par l'utilisateur, seul le profil par défaut est utilisé.
- -?
- Affiche de l'aide sur la syntaxe.
- -help
- Affiche de l'aide sur la syntaxe.
- -conntype
- Indique le type de connexion à
utiliser.
Cet argument se compose d'une chaîne qui détermine le type, par exemple, SOAP, et les options spécifiques à ce type de connexion. Les types possibles sont les suivants : SOAP, RMI, JSR160RMI, IPC et NONE. Pour chaque type de connexion, vous pouvez définir des attributs supplémentaires à propos de la connexion.
Pour le type de connexion SOAP, vous pouvez définir les attributs suivants :Tableau 1. Description des attributs du type de connexion SOAP de -conntype. Cet attribut permet d'indiquer un type de connexion SOAP. Attribut Description [-host nom_hôte] Définit le nom d'hôte pour la connexion. La valeur par défaut est l'hôte local. [-port numéro_port] Définit le numéro de port pour la connexion. [-user ID_utilisateur] Définit l'ID utilisateur à utiliser pour établir la connexion. [-password mot de passe] Définit le mot de passe à utiliser pour établir la connexion. Pour le type de connexion RMI, vous pouvez définir les attributs suivants :Tableau 2. Description des attributs du type de connexion RMI de -conntype. Cet attribut permet d'indiquer un type de connexion RMI. Attribut Description [-host nom_hôte] Définit le nom d'hôte pour la connexion. La valeur par défaut est l'hôte local. [-port numéro_port] Définit le numéro de port pour la connexion. [-user ID_utilisateur] Définit l'ID utilisateur à utiliser pour établir la connexion. [-password mot de passe] Définit le mot de passe à utiliser pour établir la connexion. Pour le type de connexion JSR160RMI, vous pouvez définir les attributs suivants :Tableau 3. Description des attributs du type de connexion JSR160RMI de -conntype. Cet attribut permet d'indiquer un type de connexion JSR160RMI. Attribut Description [-host nom_hôte] Définit le nom d'hôte pour la connexion. [-port numéro_port] Définit le numéro de port pour la connexion. [-user ID_utilisateur] Définit l'ID utilisateur à utiliser pour établir la connexion. [-password mot de passe] Définit le mot de passe à utiliser pour établir la connexion. Pour le type de connexion IPC, vous pouvez définir les attributs suivants :Tableau 4. Description des attributs du type de connexion IPC de -conntype. Cet attribut permet d'indiquer un type de connexion IPC. Attribut Description [-ipchost nom_hôte] Définit le nom d'hôte pour la connexion. Cet attribut écrase le nom d'hôte défini pour la propriété com.ibm.ws.scripting.ipchost dans le fichier de propriétés wsadmin.properties. [-port numéro_port] Définit le numéro de port pour la connexion. [-user ID_utilisateur] Définit l'ID utilisateur à utiliser pour établir la connexion. [-password mot de passe] Définit le mot de passe à utiliser pour établir la connexion. Pour une exécution en mode local, utilisez l'option -conntype NONE. Avec cette option le client de scriptage n'est pas connecté à un serveur actif. Vous pouvez gérer la configuration de serveur ainsi que l'installation et la désinstallation des applications sans exécuter le serveur d'applications.
Remarque : Vous devrez peut-être utiliser le connecteur JSR160RMI à la place du connecteur Remote Method Invocation (RMI) car le support de ce dernier est obsolète. - -wsadmin_classpath
- Cette option met des classes supplémentaires
à la disposition du processus de scriptage.
Avec une chaîne de chemin d'accès, utilisez l'option suivante :
/MyDir/Myjar.jar;/yourdir/yourdir.jar
/home/MyDir/Myjar.jar;/yourdir/yourdir.jar
c:/MyDir/Myjar.jar;d:/yourdir/yourdir.jar
Le chemin d'accès aux classes est alors ajouté dans le chargeur de classes pour le processus de scriptage.
Vous pouvez également indiquer cette option dans un fichier de propriétés qu'utilise l'outil wsadmin. La propriété concernée est com.ibm.ws.scripting.classpath. Si vous entrez -wsadmin_classpath sur la ligne de commande, la valeur de cette propriété se substitue à toute valeur indiquée dans un fichier de propriétés. La propriété du chemin d'accès aux classes et les options de la ligne de commande ne sont pas concaténées.
- -host
- Définissez un nom d'hôte auquel wsadmin tente de se connecter. Le fichier wsadmin.properties situé dans le répertoire des propriétés de chaque profil fournit localhost comme valeur pour la propriété hôte, si cette option n'est pas définie.
- -password
- Indique le mot de passe utilisé par le connecteur pour se connecter au serveur, si la sécurité est activée pour celui-ci.Avertissement : Sous UNIX, l'utilisation de l'option -password peut entraîner des risques pour la sécurité. En effet, les informations de mot de passe sont affichées dans le programme d'état du système. Par exemple, ces informations peuvent être exposées si vous utilisez la commande ps qui peut être appelée par un autre utilisateur pour afficher tous les processus d'exécution. N'utilisez pas cette option si ce genre d'exposition pose un problème. Pour parer à ce risque, vous pouvez :
- Définir les informations d'utilisateur et de mot de passe dans le fichier soap.client.props pour le connecteur SOAP, dans le fichier sas.client.props pour le connecteur JSR160RMI ou le connecteur RMI ou dans le fichier ipc.client.props pour le connecteur Inter-Process Communications (IPC). Les fichiers soap.client.props, sas.client.props et ipc.client.props se trouvent dans le répertoire des propriétés de votre profil du serveur d'applications.
- Attendez que l'outil wsadmin demande les informations de connexion à l'utilisateur plutôt que de les fournir dans un fichier de propriétés.
- -user ou -username
- Indique un nom d'utilisateur que le connecteur doit utiliser pour se connecter au serveur si la sécurité est activée pour celui-ci.
- -port
- Indique un port que le connecteur doit utiliser. Le fichier wsadmin.properties situé dans le répertoire des propriétés de chaque profil du serveur d'applications fournit une valeur permettant de se connecter au serveur local.
- -jobid
- Spécifie une chaîne d'ID travail pour vous permettre d'assurer le suivi de chaque appel de l'outil wsadmin à des fins de contrôle. La chaîne jobID (jobID=xxxx) est affichée au début du fichier journal wsadmin.
- -tracefile
- Spécifie le nom du fichier journal et l'emplacement dans lequel le fichier journal est enregistré. Cette option écrase la propriété com.ibm.ws.scripting.traceFile dans le fichier wsadmin.properties.
- -appendtrace
- Détermine si une trace s'ajoute à la fin du fichier journal existant ou si elle écrase celui-ci. Spécifiez true pour ajouter la trace à la fin d'un fichier journal ou spécifiez false pour écraser le fichier journal de chaque appel wsadmin. La valeur par défaut est false.
L'exemple suivant spécifie l'option d'ID travail, l'emplacement du fichier journal et ajoute la trace au fichier journal.
wsadmin -jobid wsadmin_test_1 -tracefile /temp/wsadmin_test_1.log -appendtrace true
wsadmin -jobid wsadmin_test_1 -tracefile c:/temp/wsadmin_test_1.log -appendtrace true
wsadmin.sh -jobid wsadmin_test_1 -tracefile /temp/wsadmin_test_1.log -appendtrace true
Dans les exemples de syntaxe suivants, mymachine est le nom de l'hôte du fichier wsadmin.properties indiqué par la propriété com.ibm.ws.scripting.port :
- Connexion SOAP à l'hôte local
- Utilisez les options définies dans le fichier wsadmin.properties.
- Connexion SOAP à l'hôte mamachine
- A l'aide de Jacl, entrez le code d'exemple suivant :
wsadmin -f test1.jacl -profile setup.jacl -conntype SOAP -port mymachine_soap_portnumber -host mymachine
wsadmin.sh -f test1.jacl -profile setup.jacl -conntype SOAP -port mymachine_soap_portnumber -host mymachine
Avec Jython :
wsadmin -lang jython -f test1.py -profile setup.py -conntype SOAP -port mymachine_soap_portnumber -host mymachine
wsadmin.sh -lang jython -f test1.py -profile setup.py -conntype SOAP -port mymachine_soap_portnumber -host mymachine
- Modifiez la taille de segment Java initiale et maximum.
Avec Jacl :
wsadmin -javaoption -Xms128m -javaoption -Xmx256m -f test.jacl
Indiquez plusieurs options Java conjointement ou séparément :
ouwsadmin -javaoption "-Xms128m -Xmx256m" -f test.jacl
wsadmin -javaoption -Xms128m -javaoption -Xmx256m -f test.jacl
wsadmin.sh -javaoption "-Xms128m -Xmx256m" -f test.jacl
Avec Jython :
wsadmin -lang jython -javaoption -Xms128m -javaoption -Xmx256m -f test.py
Indiquez plusieurs options Java conjointement ou séparément :
ouwsadmin -lang jython -javaoption "-Xms128m -Xmx256m" -f test.py
wsadmin -lang jython -javaoption -Xms128m -javaoption -Xmx256m -f test.py
wsadmin.sh -lang jython -javaoption "-Xms128m -Xmx256m" -f test.py
- Modification de la valeur de propriété système
- A l'aide de Jacl :
wsadmin -javaoption "-Dcom.ibm.websphere.management.application.client.jspReloadEnabled=true"
wsadmin.sh -javaoption "-Dcom.ibm.websphere.management.application.client.jspReloadEnabled=true"
Avec Jython :
wsadmin -lang jython -javaoption "-Dcom.ibm.websphere.management.application.client.jspReloadEnabled=true"
wsadmin.sh -lang jython -javaoption "-Dcom.ibm.websphere.management.application.client.jspReloadEnabled=true"
Placez la propriété système Java entre guillemets ("").
Placez les options Java multiples entre guillemets (""), par exemple :
wsadmin -javaoption "-Dcom.ibm.websphere.management.application.client.jspReloadEnabled=true -Dcom.ibm.websphere.management.application.enableDistribution=true"
- Connexion JSR160RMI avec sécurité
- A l'aide de Jacl :
wsadmin -conntype JSR160RMI -port JSR160rmiportnumber -user userid -password password
wsadmin.sh -conntype JSR160RMI -port JSR160rmiportnumber -user userid -password password
Avec Jython :
wsadmin -lang jython -conntype JSR160RMI -port JSR160portnumber -user userid -password password
wsadmin.sh -lang jython -conntype JSR160 -port JSR160rmiportnumber -user userid -password password
L'élément rmiportnumber de votre connexion est affiché dans la console d'administration en tant que BOOTSTRAP_ADDRESS.
Avertissement : Sous UNIX, l'utilisation de l'option -mot de passe peut entraîner des risques pour la sécurité. En effet, les informations de mot de passe deviennent visibles pour le programme d'état du système. C'est le cas de la commande ps qui peut être appelée par un autre utilisateur pour afficher tous les processus en cours d'exécution. N'utilisez pas cette option si ce genre d'exposition pose un problème. Pour parer à ce risque, vous pouvez :- Définir les informations d'utilisateur et de mot de passe dans le fichier soap.client.props pour le connecteur SOAP, dans le fichier sas.client.props pour le connecteur JSR160RMI ou le connecteur RMI ou dans le fichier ipc.client.props pour le connecteur Inter-Process Communications (IPC). Les fichiers soap.client.props, sas.client.props et ipc.client.props se trouvent dans le répertoire des propriétés de votre profil du serveur d'applications.
- Attendez que l'outil wsadmin demande les informations de connexion à l'utilisateur plutôt que de les fournir dans un fichier de propriétés.
- Connexion RMI avec sécurité
- A l'aide de Jacl :
wsadmin -conntype RMI -port rmiportnumber -user userid -password password
wsadmin.sh -conntype RMI -port rmiportnumber -user userid -password password
Avec Jython :
wsadmin -lang jython -conntype RMI -port rmiportnumber -user userid -password password
wsadmin.sh -lang jython -conntype RMI -port rmiportnumber -user userid -password password
L'élément rmiportnumber de votre connexion est affiché dans la console d'administration en tant que BOOTSTRAP_ADDRESS.
Avertissement : Sous UNIX, l'utilisation de l'option -mot de passe peut entraîner des risques pour la sécurité. En effet, les informations de mot de passe deviennent visibles pour le programme d'état du système. C'est le cas de la commande ps qui peut être appelée par un autre utilisateur pour afficher tous les processus en cours d'exécution. N'utilisez pas cette option si ce genre d'exposition pose un problème. Pour parer à ce risque, vous pouvez :- Définir les informations d'utilisateur et de mot de passe dans le fichier soap.client.props pour le connecteur SOAP, dans le fichier sas.client.props pour le connecteur JSR160RMI ou le connecteur RMI ou dans le fichier ipc.client.props pour le connecteur Inter-Process Communications (IPC). Les fichiers soap.client.props, sas.client.props et ipc.client.props se trouvent dans le répertoire des propriétés de votre profil du serveur d'applications.
- Attendez que l'outil wsadmin demande les informations de connexion à l'utilisateur plutôt que de les fournir dans un fichier de propriétés.
- Mode opératoire local pour effectuer une unique commande
- Avec Jacl :
wsadmin -conntype NONE -c "$AdminApp uninstall app"
ouwsadmin.sh -conntype NONE -c "\$AdminApp uninstall app"
wsadmin.sh -conntype NONE -c '$AdminApp uninstall app'
Avec Jython :
wsadmin -lang jython -conntype NONE -c "AdminApp.uninstall('app')"
ouwsadmin.sh -lang jython -conntype NONE -c "\AdminApp.uninstall('app')"
wsadmin.sh -lang jython -conntype NONE -c 'AdminApp.uninstall('app')'