Commandes de l'objet Help en utilisant les outils de script wsadmin
Les langages de script Jython ou Jacl permettent d'obtenir une aide générale et des informations dynamiques en ligne concernant les MBeans en cours d'exécution à l'aide de l'outil wsadmin. Utilisez l'objet Help pour écrire et exécuter les scripts avec l'objet AdminControl.
AdminApp
La commande AdminApp permet d'afficher un récapitulatif des méthodes disponibles pour l'objet AdminApp.
Objet cible
Aucun.Paramètres obligatoires
Aucune.
Paramètres facultatifs
Aucune.
Exemple de sortie
WASX7095I: L'objet AdminApp permet de manipuler des objets d'application,
notamment l'installation, la désinstallation, l'édition,
et liste. La plupart des commandes que supporte AdminApp fonctionnent dans deux
modes : le mode par défaut dans lequel AdminApp communique avec le serveur
le produit pour accomplir ses tâches et un mode local dans lequel
aucune communication avec le serveur ne s'opère. Le mode local
est appelé en activant le client de scriptage sans serveur connecté
en utilisant l'option de ligne de commande "-conntype NONE" ou en définissant
la propriété "com.ibm.ws.scripting.connectionType=NONE" dans wsadmin.properties.
Les commandes suivantes sont prises en charge par AdminApp. Vous pouvez obtenir des informations plus détaillées
sur ces commandes en utilisant la commande "help" d'AdminApp et en spécifiant comme argument
nom de la commande qui vous intéresse.
deleteUserAndGroupEntries Supprime toutes les informations utilisateur/groupe de tous les rôles et toutes
les informations nom utilisateur/mot de passe des rôles d'exécution d'une application donnée.
edit Edite les propriétés d'une application.
editInteractive Edite les propriétés d'une application en mode interactif.
export Exporte l'application vers un fichier.
exportDDL Exporte la DDL de l'application
vers un répertoire
help Affiche les informations d'aide.
install Installe une application en recevant pour arguments un nom de fichier et une chaîne d'options.
installInteractive Installe une application en mode interactif en recevant pour arguments
un nom de fichier et une chaîne d'options.
isAppReady vérifie si l'application est prête à s'exécuter
list Répertorie toutes les applications installées, soit toutes les applications, soit les applications d'une portée cible donnée.
listModules Répertorie les modules dans une application indiquée.
options Affiche les options disponibles pour un fichier donné ou au niveau global.
publishWSDL Publie les fichiers WSDL
d'une application donnée
taskInfo Affiche des informations détaillées liées à une tâche
d'installation donnée pour un fichier donné
uninstall Désinstalle une application en recevant comme arguments le
nom de l'application et une chaîne d'options.
updateAccessIDs Met à jour les informations de liaison utilisateur/groupe avec un ID
accès du registre d'utilisateurs pour une application donnée.
view Affiche une application ou un module,
en fonction d'un nom d'application ou de module
Exemples
- A l'aide de Jacl :
$Help AdminApp
- Avec Jython :
print Help.AdminApp()
AdminConfig
La commande AdminConfig permet d'afficher un récapitulatif des méthodes disponibles pour l'objet AdminConfig.
Objet cible
Aucun.Paramètres obligatoires
Aucune.
Paramètres facultatifs
Aucune.
Exemple de sortie
WASX7053I: Les fonctions suivantes sont prises en charge par AdminConfig :
create Crée un objet de configuration
en recevant pour arguments un type, un parent, et une
Liste d'attributs.
create Crée un objet de configuration
en recevant pour arguments un type, un parent, une
liste d'attributs et un nom d'attribut
pour le nouvel objet.
remove Supprime la configuration spécifiée
objet
list Liste tous les objets de configuration
d'un type donné
list Liste tous les objets de configuration
d'un type donné, contenus
dans la portée fournie
show Affiche les attributs spécifiés
d'un objet de configuration
show Affiche les attributs spécifiés
d'un objet de configuration donné
modify Modifie Affiche les attributs spécifiés
d'un objet de configuration donné
getId Affiche l'ID configuration d'un objet,
après avoir reçu la version String
de son chemin d'imbrication.
contents Affiche les objets contenus dans un type donné.
parents Afficher les objets contenant
d'un type donné
attributes Affiche les attributs d'un
type donné
types Affiche les types de configuration
configuration
help Affiche les informations d'aide.
Exemples
- A l'aide de Jacl :
$Help AdminConfig
- Avec Jython :
print Help.AdminConfig()
AdminControl
La commande AdminControl permet d'afficher un récapitulatif des commandes d'aide et la syntaxe des commandes d'administration.
Objet cible
Aucun.Paramètres obligatoires
Aucune.
Paramètres facultatifs
Aucune.
Exemple de sortie
WASX7027I: Les fonctions suivantes sont prises en charge par AdminControl :
getHost Renvoie une représentation String de l'hôte connecté
getPort Renvoie une représentation String du port utilisé
getType Renvoie une représentation String du type de connexion utilisé
reconnect Reconnecte le processus au serveur
queryNames En fonction de la valeur ObjectName et QueryExp, extrait un ensemble ObjectNames.
queryNames En fonction de la version String d'un ObjectName, extrait une chaîne (String) ObjectNames.
getMBeanCount Renvoie le nombre de beans enregistrés
getDomainName Renvoie "WebSphere"
getDefaultDomain Renvoie "WebSphere".
getMBeanInfo Reçoit un ObjectName en argument et renvoie la structure MBeanInfo du MBean correspondant.
isInstanceOf Reçoit un ObjectName et un nom de classe, et renvoie
la valeur true si MBean appartient à cette classe.
isRegistered Associé à la valeur true si ObjectName est enregistré.
isRegistered Associé à la valeur true si la version String ObjectName est enregistrée
getAttribute Reçoit un ObjectName et un nom d'attribut et renvoie la valeur de l'attribut
getAttribute Reçoit la version String d'un ObjectName et un nom d'attribut et renvoie la valeur de l'attribut
getAttributes Reçoit un ObjectName et un tableau de noms d'attribut et renvoie une liste d'attributs
getAttributes Reçoit la version String d'un ObjectName et des noms d'attribut
et renvoie un String de paires nom-valeur
setAttribute Reçoit un ObjectName et un objet AttributeList, et
définit les attributs du MBean spécifié.
setAttribute Reçoit la version String d'un ObjectName, un nom d'attribut et une valeur d'attribut,
définissez l'attribut pour le MBean indiqué
setAttributes Reçoit un ObjectName et un objet AttributeList, et définit les attributs du MBean spécifié.
invoke En fonction de la valeur ObjectName, du nom de la méthode, du tableau de paramètres et d'une signature, appelle la méthode sur le MBean indiqué.
invoke En fonction de la version String d'ObjectName, du nom de la
méthode, de la version String de la liste de paramètres et de la
version String du tableau de signatures, appelle la méthode sur
le MBean indiqué.
invoke En fonction de la version String d'ObjectName, du nom de la
méthode, de la version String de la liste de paramètres et de la
version String du tableau de signatures, appelle la méthode sur le bean géré spécifié.
makeObjectName Renvoie un ObjectName généré avec la chaîne indiquée
completeObjectName Renvoie la version String d'un nom d'objet en utilisant un nom de modèle.
trace Définit la spécification de trace wsadmin
help Affiche les informations d'aide.
Exemples
- A l'aide de Jacl :
$Help AdminControl
- Avec Jython :
print Help.AdminControl()
AdminTask
La commande AdminTask permet d'afficher un récapitulatif des commandes d'aide et la syntaxe des commandes d'administration appelées à l'aide de l'objet AdminTask.
Objet cible
Aucun.Paramètres obligatoires
Aucune.
Paramètres facultatifs
Aucune.
Exemple de sortie
WASX8001I : L'objet AdminTask active l'exécution des commandes d'administration disponibles. Les commandes AdminTask
fonctionnent en deux modes : en mode par défaut, AdminTask communique avec
le produit pour accomplir sa tâche ; Il existe également un mode local
dans lequel aucune communication avec le serveur n'a lieu. Le mode de fonctionnement en local peut être appelé
en affichant le client de scriptage à l'aide de l'option de ligne de commande "-conntype NONE" ou en définissant
la propriété "com.ibm.ws.scripting.connectiontype=NONE" dans le fichier wsadmin.properties.
Le nombre de commandes d'administration varie et dépend
de l'installation du produit. Utilisez les commandes d'aide suivantes pour obtenir une liste des commandes prises en charge et de leurs paramètres :
help -commands Affiche la liste de toutes les commandes d'administration
help -commandGroups Affiche la liste de tous les groupes de commandes d'administration
help commandName affiche des informations détaillées sur la commande spécifiée
help commandName stepName Affiche des informations détaillées sur l'étape spécifiée appartenant à la commande spécifiée
help nom_groupe_commandes Affiche des informations détaillées pour le groupe de commandes indiqué
Vous disposez de plusieurs méthodes pour appeler une commande d'administration. Elles sont indiquées ci-après :
commandName Appelle une commande d'administration qui ne requiert pas d'argument.
commandName targetObject Appelle une commande d'administration avec la chaîne objet cible, par exemple,
le nom d'objet de configuration d'un adaptateur de ressources. L'objet cible varie en fonction de la commande d'administration appelée.
Utilisez la commande help pour obtenir des informations sur l'objet cible d'une commande d'administration.
commandName options appelle une commande d'administration avec les options indiquées. L'utilisation
de cette syntaxe appelle une commande d'administration ne nécessitant pas d'objet cible.
Elle permet également de passer en mode interactif si l'option "-interactive" figure dans la chaîne d'options.
commandName targetObject options appelle une commande d'administration avec l'objet cible
et les chaînes d'options indiqués.
Si "-interactive" est inclus dans la chaîne d'options, vous êtes alors en mode interactif.
L'objet cible et les chaînes d'options varient en fonction de la commande d'administration appelée.
Utilisez la commande help pour obtenir des informations sur l'objet cible et les options.
Exemples
- A l'aide de Jacl :
$AdminTask help
- Avec Jython :
print AdminTask.help()
all
La commande all permet d'afficher un récapitulatif des informations que le MBean définit par nom.
Objet cible
Aucun.Paramètres obligatoires
- Nom du MBean
- Indique le nom d'objet représentant le MBean qui vous intéresse. (Chaîne)
Paramètres facultatifs
Aucune.
Exemple de sortie
Name: WebSphere:cell=pongo,name=TraceService,mbeanIdentifier=cells/pongo/nodes/pongo/servers/server1/
server.xml#TraceService_1,type=TraceService,node=pongo,process=server1
Description: null
Class name: javax.management.modelmbean.RequiredModelMBean
Attribut Type Access
ringBufferSize int RW
traceSpecification java.lang.String RW
Operation
int getRingBufferSize()
void setRingBufferSize(int)
java.lang.String getTraceSpecification()
void setTraceState(java.lang.String)
void appendTraceString(java.lang.String)
void dumpRingBuffer(java.lang.String)
void clearRingBuffer()
[Ljava.lang.String; listAllRegisteredComponents()
[Ljava.lang.String; listAllRegisteredGroups()
[Ljava.lang.String; listComponentsInGroup
(java.lang.String)
[Lcom.ibm.websphere.ras.TraceElementState; getTracedComponents()
[Lcom.ibm.websphere.ras.TraceElementState; getTracedGroups()
java.lang.String getTraceSpecification(java.
lang.String)
void processDumpString(java.lang.String)
void checkTraceString(java.lang.String)
void setTraceOutputToFile(java.lang.String, int, int, java.lang.String)
void setTraceOutputToRingBuffer(int, java.
lang.String)
java.lang.String rolloverLogFileImmediate(java.lang.String, java.lang.String)
Notifications
jmx.attribute.changed
Constructors
Exemples
- A l'aide de Jacl :
$Help all [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Avec Jython :
print Help.all(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
attributes
La commande attributes permet d'afficher un récapitulatif de tous les attributs que le MBean définit par nom. Si vous indiquez le paramètre de nom de MBean, la commande affiche des informations relatives aux attributs, opérations, constructeurs, descriptions, notifications et au nom de classe du MBean spécifié. Si vous spécifiez le nom de MBean et le nom d'attribut, la commande affiche des informations relatives à l'attribut indiqué du MBean spécifié.
Objet cible
Aucun.Paramètres obligatoires
- Nom du MBean
- Indique le nom d'objet représentant le MBean qui vous intéresse. (Chaîne)
Paramètres facultatifs
- nom_attribut
- Indique l'attribut qui vous intéresse. (Chaîne)
Exemple de sortie
Attribut Type Access
ringBufferSize java.lang.Integer RW
traceSpecification string RW
Exemples
- A l'aide de Jacl :
$Help attributes [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Avec Jython :
print Help.attributes(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
classname
La commande classname permet d'afficher un nom de classe que le MBean définit par nom.
Objet cible
Aucun.Paramètres obligatoires
- Nom du MBean
- Indique le nom d'objet représentant le MBean qui vous intéresse. (Chaîne)
Paramètres facultatifs
Aucune.
Exemple de sortie
javax.management.modelmbean.RequiredModelMBean
Exemples
- A l'aide de Jacl :
$Help classname [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Avec Jython :
print Help.classname(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
constructors
La commande constructors permet d'afficher un récapitulatif des constructeurs que le MBean définit par nom.
Objet cible
Aucun.Paramètres obligatoires
- Nom du MBean
- Indique le nom d'objet représentant le MBean qui vous intéresse. (Chaîne)
Paramètres facultatifs
Aucune.
Exemple de sortie
Constructors
Exemples
- A l'aide de Jacl :
$Help constructors [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Avec Jython :
print Help.constructors(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
description
La commande description permet d'afficher une description que le MBean définit par nom.
Objet cible
Aucun.Paramètres obligatoires
- Nom du MBean
- Indique le nom d'objet représentant le MBean qui vous intéresse. (Chaîne)
Paramètres facultatifs
Aucune.
Exemple de sortie
Objet géré pour le processeur serveur global.
Exemples
- A l'aide de Jacl :
$Help description [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Avec Jython :
print Help.description(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
help
La commande help permet d'afficher un récapitulatif de toutes les méthodes disponibles pour l'objet Help.
Objet cible
Aucun.Paramètres obligatoires
Aucune.
Paramètres facultatifs
Aucune.
Exemple de sortie
WASX7028I : L'objet Help a deux objectifs :
Le premier est de fournir des informations d'aide générales pour les objets fournis par l'outil wsadmin
pour le scriptage : Help, AdminApp, AdminConfig et AdminControl.
Le second est de fournir un moyen d'obtenir des informations d'interface sur les MBeans qui s'exécutent dans le
système. A cet effet, une variété de commandes sont disponibles pour vous permettre d'obtenir
des informations sur les opérations, les attributs et d'autres données d'interface
relatives à des MBeans particuliers.
Les commandes suivantes sont prises en charge par Help. Vous pouvez obtenir des informations plus détaillées
sur ces commandes en utilisant la commande "help" de l'objet Help et en spécifiant comme argument le
nom de la commande qui vous intéresse.
attributes Pour un MBean donné, renvoie l'aide sur les attributs.
operations Pour un MBean donné, renvoie l'aide sur les opérations.
constructors Pour un MBean donné, renvoie l'aide sur les constructeurs.
description Pour un MBean donné, renvoie l'aide sur la description.
notifications Pour un MBean donné, renvoie l'aide sur les notifications.
classname Pour un MBean donné, renvoie l'aide sur un nom de classe.
all Pour un MBean donné, renvoie l'aide sur tous les éléments d'aide ci-dessus.
help Renvoie ce texte d'aide.
AdminControl Renvoie le texte d'aide générale sur l'objet AdminControl.
AdminConfig Renvoie le texte d'aide générale sur l'objet AdminConfig
AdminApp Renvoie le texte d'aide générale sur l'objet AdminApp
AdminTask Renvoie le texte d'aide générale sur l'objet AdminTask
wsadmin Renvoie le texte d'aide générale sur le programme de lancement de script wsadmin
message Renvoie une explication et une action à exécuter en fonction d'un ID de message.
Exemples
- A l'aide de Jacl :
$Help help
- Avec Jython :
print Help.help()
message
La commande message affiche des informations relatives à l'ID d'un message.
Objet cible
Aucun.Paramètres obligatoires
- ID_message
- Indique l'ID du message qui vous intéresse. (Chaîne)
Paramètres facultatifs
Aucune.
Exemple de sortie
Explication : Le conteneur n'a pas pu passiver
un bean enterprise en raison de l'exception {2}
Intervention de l'utilisateur : Prenez les mesures nécessaires en vous basant sur le message contenu dans l'exception {2}
Exemples
- A l'aide de Jacl :
$Help message CNTR0005W
- Avec Jython :
print Help.message('CNTR0005W')
notifications
La commande notifications permet d'afficher un récapitulatif de toutes les notifications que le MBean définit par nom.
Objet cible
Aucun.Paramètres obligatoires
- Nom du MBean
- Indique le nom d'objet du MBean concerné. (Chaîne)
Paramètres facultatifs
Aucune.
Exemple de sortie
Notification
websphere.messageEvent.audit
websphere.messageEvent.fatal
websphere.messageEvent.error
websphere.seriousEvent.info
websphere.messageEvent.warning
jmx.attribute.changed
Exemples
- A l'aide de Jacl :
$Help notifications [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Avec Jython :
print Help.notifications(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
operations
La commande operations associé au paramètre de nom de MBean permet d'afficher un récapitulatif de toutes les opérations que le MBean définit par nom. Indiquez une valeur pour le nom de MBean et le nom d'opération afin d'afficher la signature de l'opération pour le MBean défini par nom.
Objet cible
Aucun.Paramètres obligatoires
- Nom du MBean
- Indique le nom d'objet du MBean concerné. (Chaîne)
Paramètres facultatifs
- nom_opération
- Indique l'opération qui vous intéresse. (Chaîne)
Exemple de sortie
Operation
int getRingBufferSize()
void setRingBufferSize(int)
java.lang.String getTraceSpecification()
void setTraceState(java.lang.String)
void appendTraceString(java.lang.String)
void dumpRingBuffer(java.lang.String)
void clearRingBuffer()
[Ljava.lang.String; listAllRegisteredComponents()
[Ljava.lang.String; listAllRegisteredGroups()
[Ljava.lang.String; listComponentsInGroup(java.lang.String)
[Lcom.ibm.websphere.ras.TraceElementState; getTracedComponents()
[Lcom.ibm.websphere.ras.TraceElementState; getTracedGroups()
java.lang.String getTraceSpecification(java.lang.String)
void processDumpString(java.lang.String)
void checkTraceString(java.lang.String)
void setTraceOutputToFile(java.lang.String, int, int, java.lang.String)
void setTraceOutputToRingBuffer(int, java.lang.String)
java.lang.String rolloverLogFileImmediate(java.lang.String, java.lang.String)
void processDumpString(string)
Description : Enregistre le contenu de la mémoire tampon tournante des services Ras dans le fichier indiqué.
Paramètres :
Type string
Name dumpString
Description chaîne (String) au format indiqué à traiter ou null.
Exemples
- A l'aide de Jacl :
$Help operations [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
$Help operations [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*] processDumpString
- Avec Jython :
print Help.operations(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
print Help.operations(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'), 'processDumpString')