Commandes utilisables avec l'objet AdminControl et les outils de script de wsadmin

L'objet AdminControl permet d'appeler des commandes opérationnelles qui gèrent des objets pour le serveur d'applications.

Un grand nombre de commandes AdminControl disposent de plusieurs signatures afin qu'elles puissent effectuer des appels en mode raw à l'aide de paramètres définis par JMX (Java Management Extensions) ou à l'aide de chaînes pour les paramètres. Outre les commandes opérationnelles, l'objet AdminControl supporte certaines commandes d'utilitaire pour le traçage, la reconnexion à un serveur et la conversion des types de données.

Eviter les incidents Eviter les incidents: Lors de l'utilisation de commandes disponibles dans l'objet AdminControl au sein de topologies de grande taille, recherchez et interrogez process=dmgr et type=Cluster. Cette méthode de recherche est plus efficace moins longue et évite de faire des recherches dans tous les noeuds.gotcha

completeObjectName

La commande completeObjectName permet de créer une représentation de chaîne d'une valeur ObjectName complète en fonction d'un fragment. Cette commande ne communique pas avec le serveur pour trouver une valeur ObjectName correspondante. Si le système détecte plusieurs éléments MBeans qui correspondent au fragment, la commande renvoie le premier.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom de l'objet à exécuter. (ObjectName)
modèle
Indique le nom du modèle à utiliser. Par exemple, le modèle peut être type=Server,*. (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande ne renvoie pas de sortie.

Exemples

  • Avec Jacl :
    set serverON [$AdminControl completeObjectName node=mynode,type=Server,*] 
  • A l'aide de Jython :
    serverON = AdminControl.completeObjectName('node=mynode,type=Server,*')

getAttribute

La commande getAttribute renvoie la valeur de l'attribut pour le nom fourni.

Si vous utilisez la commande getAttribute pour déterminer l'état d'une application, l'une des valeurs suivantes est renvoyée :
  • 0 - qui indique que l'application est en cours de démarrage
  • 1 - qui indique que l'application a démarré
  • 2 - qui indique que l'application est en cours d'arrêt
  • 3 - qui indique que l'application s'est arrêtée
  • 4 - qui indique que l'application n'a pas pu démarrer

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (ObjectName)
attribute
Indique le nom de l'attribut à interroger. (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant la valeur de l'attribut interrogé, comme dans l'exemple suivant :
'DeploymentManager'

Exemples

  • Avec Jacl :
    set objNameString [$AdminControl completeObjectName WebSphere:type=Server,*] 
    $AdminControl getAttribute $objNameString processType 
  • A l'aide de Jython :
    objNameString = AdminControl.completeObjectName('WebSphere:type=Server,*') 
    print AdminControl.getAttribute(objNameString, 'processType')

getAttribute_jmx

La commande getAttribute_jmx renvoie la valeur de l'attribut pour le nom fourni.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (ObjectName)
attribute
Indique le nom de l'attribut à interroger. (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant la valeur de l'attribut interrogé, comme dans l'exemple suivant :
'DeploymentManager'

Exemples

  • Avec Jacl :
    set objNameString [$AdminControl completeObjectName WebSphere:type=Server,*] 
    set objName [java::new javax.management.ObjectName $objNameString]
    $AdminControl getAttribute_jmx $objName processType
  • A l'aide de Jython :
    objNameString = AdminControl.completeObjectName('WebSphere:=type=Server,*') 
    import  javax.management  as  mgmt 
    objName =  mgmt.ObjectName(objNameString) 
    print AdminControl.getAttribute_jmx(objName, 'processType')

getAttributes

La commande getAttributes renvoie les valeurs d'attribut des noms fournis.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (ObjectName)
attribute
Indique les noms des attributs à interroger. (java.lang.String[] ou java.lang.Object[])

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant la valeur de l'attribut interrogé, comme dans l'exemple suivant :
'[ [cellName myCell01] [nodeName myCellManager01] ]'

Exemples

  • Avec Jacl :
    set objNameString [$AdminControl completeObjectName WebSphere:type=Server,*] 
    $AdminControl getAttributes $objNameString "cellName nodeName"
  • A l'aide de Jython avec des attributs de chaîne :
    objNameString = AdminControl.completeObjectname('WebSphere:type=Server,*)
    print AdminControl.getAttributes(objNameString, '[cellName nodeName]')
  • A l'aide de Jython avec des attributs d'objet :
    objNameString = AdminControl.completeObjectname('WebSphere:type=Server,*)
    print AdminControl.getAttributes(objNameString, ['cellName', 'nodeName'])

getAttributes_jmx

La commande getAttributes_jmx renvoie les valeurs d'attribut des noms fournis.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (ObjectName)
attribute
Indique les noms des attributs à interroger. (java.lang.String[] ou java.lang.Object[])

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une liste d'attributs.

Exemples

  • Avec Jacl :
    set objectNameString [$AdminControl completeObjectName WebSphere:type=Server,*]
    set objName [$AdminControl makeObjectName $objectNameString]
    set attrs [java::new {String[]} 2 {cellName nodeName}] 
    $AdminControl getAttributes_jmx $objName $attrs
  • A l'aide de Jython :
    objectNameString = AdminControl.completeObjectName('type=Server,*')
    objName = AdminControl.makeObjectName(objectNameString)
    attrs = ['cellName', 'nodeName']
    print AdminControl.getAttributes_jmx(objName, attrs)

getCell

La commande getCell renvoie le nom de la cellule connectée.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

Cette commande renvoie le nom de la cellule interrogée, comme dans l'exemple suivant :
Mycell

Exemples

  • Avec Jacl :
    $AdminControl getCell
  • A l'aide de Jython :
    print AdminControl.getCell()

getConfigId

La commande getConfigId crée un ID configuration à partir d'un ObjectName ou d'un fragment ObjectName. Chaque MBean ne comporte pas d'objets de configuration correspondants. Si plusieurs MBeans correspondent à un fragment ObjectName, un avertissement est créé et un ID configuration est généré pour le premier MBean détecté.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom de l'objet qui vous intéresse. La chaîne de nom d'objet peut correspondre à un caractère générique, indiqué à l'aide d'un astérisque (*).

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant l'ID configuration concerné.

Exemples

  • Avec Jacl :
    [AIX Solaris HP-UX Linux Windows]
    set threadpoolCID [$AdminControl getConfigId node=mynode,type=ThreadPool,*]  
    [z/OS]
    set serverConfigId [$AdminControl getConfigId node=SY1,type=Server,*]
  • A l'aide de Jython :
    [AIX Solaris HP-UX Linux Windows]
    threadpoolCID = AdminControl.getConfigId('node=mynode,type=ThreadPool,*')
    [z/OS]
    serverConfigId = AdminControl.getConfigId('node=SY1,type=Server,*')

getDefaultDomain

La commande getDefaultDomain renvoie à partir du serveur le nom du domaine par défaut.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant le nom de domaine par défaut concerné, comme dans l'exemple suivant :
WebSphere

Exemples

  • Avec Jacl :
    $AdminControl getDefaultDomain 
  • A l'aide de Jython :
    print AdminControl.getDefaultDomain()

getDomainName

La commande getDomainName renvoie à partir du serveur le nom du domaine.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant le nom de domaine concerné, comme dans l'exemple suivant :
WebSphere

Exemples

  • Avec Jacl :
    $AdminControl getDomainName
  • A l'aide de Jython :
    print AdminControl.getDomainName()

getHost

La commande getHost renvoie le nom de votre hôte.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant le nom de l'hôte concerné, comme dans l'exemple suivant :
myHost

Exemples

  • A l'aide de Jacl :
    $AdminControl getHost
  • A l'aide de Jython :
    print AdminControl.getHost()

getMBeanCount

La commande getMBeanCount renvoie le nombre d'éléments MBeans enregistrés dans le serveur.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une valeur entière contenant le nombre de MBeans enregistrés dans le serveur, comme dans l'exemple suivant :
151

Exemples

  • Avec Jacl :
    $AdminControl getMBeanCount 
  • A l'aide de Jython :
    print AdminControl.getMBeanCount()

getMBeanInfo_jmx

La commande getMBeanInfo_jmx renvoie la structure MBeanInfo JMX (Java Management Extension) qui correspond à une valeur ObjectName. Il n'existe aucune signature de chaîne pour cette commande car l'objet Help affiche la plupart des informations de getMBeanInfo_jmx disponibles.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (ObjectName)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie un objet javax.management.MBeanInfo, comme dans l'exemple suivant :
javax.management.modelmbean.ModelMBeanInfoSupport@10dd5f35

Exemples

  • Avec Jacl :
    set objectNameString [$AdminControl completeObjectName type=Server,*] 
    set objName [$AdminControl makeObjectName $objectNameString]
    $AdminControl getMBeanInfo_jmx $objName 
  • A l'aide de Jython :
    objectNameString = AdminControl.completeObjectName('type=Server,*') 
    objName = AdminControl.makeObjectName(objectNameString)
    print AdminControl.getMBeanInfo_jmx(objName)

getNode

La commande getNode renvoie le nom du noeud connecté.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant le nom du noeud, comme dans l'exemple suivant :
myNode01

Exemples

  • Avec Jacl :
    $AdminControl getNode
  • A l'aide de Jython :
    print AdminControl.getNode()

getObjectInstance

La commande getObjectInstance renvoie l'instance d'objet qui correspond au nom d'objet fourni en entrée.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom de l'objet qui vous intéresse. (ObjectName)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie l'instance d'objet qui correspond au nom d'objet en entrée, comme dans l'exemple suivant :
javax.management.modelmbean.RequiredModelMBean

Exemples

  • Avec Jacl :
    set server [$AdminControl completeObjectName type=Server,*]
    set serverOI [$AdminControl getObjectInstance $server]
    Utilisez l'exemple suivant pour manipuler la valeur de retour de la commande getObjectInstance :
    puts [$serverOI getClassName]
  • A l'aide de Jython :
    server = AdminControl.completeObjectName('type=Server,*')
    serverOI = AdminControl.getObjectInstance(server)
    Utilisez l'exemple suivant pour manipuler la valeur de retour de la commande getObjectInstance :
    print serverOI.getClassName()

getPort

La commande getPort renvoie le nom du port utilisé pour la connexion de scriptage.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie le numéro du port que le système utilise pour établir la connexion de scriptage, comme dans l'exemple suivant :
8877

Exemples

  • Avec Jacl :
    $AdminControl getPort
  • A l'aide de Jython :
    print AdminControl.getPort()

getPropertiesForDataSource (déconseillée)

La commande getPropertiesForDataSource est obsolète et il n'existe aucun remplacement. Cette commande évalue de façon incorrecte la disponibilité d'un service de configuration lorsque l'exécution est en mode connecté.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie le message suivant :
WASX7389E : Opération non prise en charge - La commande getPropertiesForDataSource n'est pas prise en charge.

Exemples

  • Avec Jacl :
    set ds [lindex [$AdminConfig list DataSource] 0] 
    $AdminControl getPropertiesForDataSource $ds
  • A l'aide de Jython :
    ds = AdminConfig.list('DataSource')
    
    # extrait le séparateur de ligne 
    import  java.lang.System  as sys
    lineSeparator = sys.getProperty('line.separator')
    
    dsArray = ds.split(lineSeparator)
    print AdminControl.getPropertiesForDataSource(dsArray[0])

getType

La commande getType renvoie le type de connexion utilisé pour la connexion de scriptage.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant le type de la connexion de scriptage, comme dans l'exemple suivant :
SOAP

Exemples

  • Avec Jacl :
    $AdminControl getType
  • A l'aide de Jython :
    print AdminControl.getType()

help

La commande help renvoie un texte d'aide général relatif à l'objet AdminControl.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

commande
Indique la commande pour laquelle renvoyer des informations d'aide. Les majuscules et minuscules ne sont pas différenciées pour le nom de la commande.

Exemple de sortie

La commande renvoie une chaîne détaillant des options spécifiques pour la commande help, comme dans l'exemple suivant :
WASX7027I : L'objet
AdminControl permet la manipulation des MBeans s'exécutant dans un processus WebSphere Application Server. Le nombre et le type de MBeans 
accessibles au client de scriptage dépendent du serveur auquel le client est connecté.  
Si le client est connecté à un gestionnaire de déploiement, tous les MBeans s'exécutant dans celui-ci 
sont visibles, ainsi que ceux qui s'exécutent dans les agentsthat de noeud connectés à ce gestionnaire de déploiement,
 et tous ceux qui s'exécutent dans les serveurs d'applications sur ces noeuds.

Les commandes suivantes sont prises en charge par AdminControl. Vous pouvez obtenir des informations plus détaillées sur ces 
commandes en utilisant la commande "help" d'AdminControl et en spécifiant comme argument le nom 
de la commande qui vous intéresse.

Nombre de ces commandes supportent deux jeux différents de signatures : un qui accepte et renvoie des chaînes (String), et un 
autre jeu de bas niveau qui fonctionne avec des objets JMX tels que ObjectName et AttributeList. Dans la plupart des cas, les 
signatures de type String sont les plus utiles, mais les versions de type objet JMX sont également fournies.  Chaque
version de commande avec signature de type objet JMX comporte le suffixe "_jmx". Il existe donc une commande "invoke" ainsi qu'une 
commande "invoke_jmx".

completeObjectName		Renvoie la version String d'un nom d'objet en utilisant le nom de modèle fourni
getAttribute_jmx			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_jmx			Reçoit un ObjectName et un tableau de noms d'attribut, et renvoie un objet AttributeList
getAttributes Reçoit la version String d'un ObjectName et des noms d'attribut et renvoie un String de paires nom-valeur
getCell         			Renvoie le nom de cellule du serveur connecté
getConfigId     			Reçoit la version String d'un ObjectName et renvoie l'ID config de l'objet de configuration 
										correspondant, s'il y en un.
getDefaultDomain			Renvoie "WebSphere"
getDomainName   Renvoie "WebSphere"
getHost         Renvoie une représentation String de l'hôte connecté
getMBeanCount   Renvoie le nombre de beans enregistrés
getMBeanInfo_jmx			Selon l'ObjectName, renvoie une structure MBeanInfo pour MBean
getNode         			Renvoie le nom de noeud du serveur connecté
getPort         Renvoie une représentation String du port utilisé
getType         			Renvoie une représentation String du type de connexion utilisé
help									Affiche les informations d'aide
invoke_jmx      			Selon l'ObjectName, le nom de la commande, le tableau de paramètres et la signature, appelle la commande sur 
										le MBean indiqué
invoke          			Appelle une commande sur le MBean spécifié
isRegistered_jmx			Associé à la valeur true si ObjectName est enregistré
isRegistered    Associé à la valeur true si la version String ObjectName est enregistrée
makeObjectName  Renvoie un ObjectName généré avec la chaîne indiquée
queryNames_jmx  			En fonction de la valeur ObjectName et QueryExp, extrait un ensemble d'objets ObjectName correspondant.
queryNames En fonction de la version String d'un ObjectName, extrait une chaîne (String) ObjectNames.
reconnect       			reconnecte le processus au serveur setAttribute_jmx En fonction de l'objet ObjectName et Attribute, 
										définissez l'attribut pour le MBean indiqué
setAttribute    			En fonction de la version String de l'élément ObjectName, du nom de l'attribut et de la valeur de l'attribut, définissez l'attribut pour 
										le MBean indiqué
setAttributes_jmx			En fonction de l'objet ObjectName et AttributeList, définissez des attributs pour le MBean spécifié
startServer     			Démarre le serveur dont le nom a été reçu.
stopServer      			Arrête le serveur dont le nom est reçu en argument.
testConnection  			Teste la connexion à un objet DataSource 
trace           			Définit la spécification de trace wsadmin
Si vous indiquez une commande spécifique à l'aide de la commande help, l'outil wsadmin renvoie une aide détaillée sur la commande, comme dans l'exemple suivant :
WASX7043I: Commande : getAttribute
Arguments : nom de l'objet, attribut
Description : Renvoie une valeur pour "attribut" pour le MBean
décrit par "nom de l'objet".

Exemples

  • Avec Jacl :
    $AdminControl help 
    $AdminControl help getAttribute 
  • A l'aide de Jython :
    print AdminControl.help()
    print AdminControl.help('getAttribute')

invoke

Utilisez la commande invoke pour appeler une opération MBean spécifique en fonction du nombre de paramètres requis par cette opération. Si cette contrainte n'est pas suffisante pour sélectionner une opération unique, utilisez invoke_jmx. Les paramètres fournis sont convertis en types d'objets requis par la signature de l'opération sélectionnée avant l'appel de l'opération. Toute valeur renvoyée est convertie en représentation de chaîne.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné.
operation
Indique l'opération à appeler.

Paramètres facultatifs

arguments
Indique les arguments requis pour l'opération. Si aucun argument n'est requis pour l'opération qui vous intéresse, vous pouvez omettre le paramètre arguments.

Le paramètre arguments est une chaîne unique. Chaque argument de la chaîne peut contenir des espaces.

Exemple de sortie

La commande renvoie une chaîne affichant le résultat de l'appel.

Exemples

  • Avec Jacl :
    set objNameString [$AdminControl completeObjectName WebSphere:type=Server,*] 
    $AdminControl invoke $objNameString stop
    set objNameString [$AdminControl completeObjectName WebSphere:type=DynaCache,*] 
    $AdminControl invoke $mbean getCacheStatistics {"DiskCacheSizeInMB ObjectsReadFromDisk4000K RemoteObjectMisses"}
    Eviter les incidents Eviter les incidents: Vérifiez que la variable du mbean, $mbean, est définie avant d'émettre la commande précédente.gotcha
  • A l'aide de Jython :
    objNameString = AdminControl.completeObjectName('WebSphere:type=Server,*') 
    print AdminControl.invoke(objNameString, 'stop')
    objNameString = AdminControl.completeObjectName("WebSpheretype=DynaCache,*") 
    	AdminControl.invoke(dc, "getCacheStatistics", '["DiskCacheSizeInMB ObjectReadFromDisk4000K
     RemoteObjectMisses"]')
  • Avec une liste Jython :
    objNameString = AdminControl.completeObjectName("WebSphere:type=DynaCache,*") 
    AdminControl.invoke(dc, "getCacheStatistics", [["DiskCacheSizeInMB", "ObjectReadFromDisk4000K", 
    "RemoteObjectMisses"]])

invoke_jmx

La commande invoke_jmx appelle l'opération d'objet en adaptant la liste des paramètres à la signature. La commande renvoie le résultat de l'appel.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (ObjectName)
operation
Indique l'opération à appeler. (java.lang.String)

Paramètres facultatifs

arguments
Indique les arguments requis pour l'opération. Si aucun argument n'est requis pour l'opération qui vous intéresse, vous pouvez omettre le paramètre arguments. (java.lang.String[] or java.lang.Object[])

Exemple de sortie

La commande renvoie une chaîne affichant le résultat de l'appel.

Exemples

  • Avec Jacl :
    set objNameString [$AdminControl completeObjectName WebSphere:type=TraceService,*] 
    set objName [java::new javax.management.ObjectName $objNameString] 
    set parms [java::new {java.lang.Object[]} 1 com.ibm.ejs.sm.*=all=disabled] 
    set signature [java::new {java.lang.String[]} 1 java.lang.String] 
    $AdminControl invoke_jmx $objName $parms $signature
  • A l'aide de Jython :
    objNameString = AdminControl.completeObjectName('WebSphere:type=TraceService,*') 
    import  javax.management  as  mgmt 
    objName =  mgmt.ObjectName(objNameString) 
    parms = ['com.ibm.ejs.sm.*=all=disabled'] 
    signature = ['java.lang.String'] 
    print AdminControl.invoke_jmx(objName, parms, signature)

isRegistered

La commande isRegistered permet de déterminer si un nom d'objet spécifique est enregistré.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet qui vous intéresse. (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une valeur booléenne pour l'objet qui vous intéresse. Si la valeur ObjectName est enregistrée dans le serveur, la valeur est 1, comme dans l'exemple suivant :
wsadmin>s = AdminControl.queryNames( 'type=Server,*' ).splitlines()[ 0 ]
wsadmin>AdminControl.isRegistered( s )
1
wsadmin>

Si la valeur ObjectName n'est pas enregistrée dans le serveur, la valeur est 0.

Exemples

  • Avec Jacl :
    set objNameString [$AdminControl completeObjectName WebSphere:type=Server,*] 
    $AdminControl isRegistered $objNameString 
  • A l'aide de Jython :
    objNameString = AdminControl.completeObjectName('WebSphere:type=Server,*') 
    print AdminControl.isRegistered(objNameString)

isRegistered_jmx

La commande isRegistered_jmx permet de déterminer si un nom d'objet spécifique est enregistré.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet qui vous intéresse. (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une valeur booléenne pour l'objet qui vous intéresse. Si la valeur ObjectName est enregistrée dans le serveur, la valeur est true, comme dans l'exemple suivant :
true

Exemples

  • Avec Jacl :
    set objectNameString [$AdminControl completeObjectName type=Server,*]
    set objName [$AdminControl makeObjectName $objNameString]
    $AdminControl isRegistered_jmx $objName 
  • A l'aide de Jython :
    objectNameString = AdminControl.completeObjectName('type=Server,*')
    objName = AdminControl.makeObjectName(objectNameString)
    print AdminControl.isRegistered_jmx(objName)

makeObjectName

La commande makeObjectName crée une valeur ObjectName en fonction de l'entrée des chaînes. Cette commande ne communique pas avec le serveur, ce qui fait que la valeur ObjectName en résultant peut ne pas exister. Si la chaîne fournie contient un ensemble supplémentaire de guillemets, elles sont supprimées. Si la chaîne ne commence pas par un domaine JMX (Java Management Extensions) ou par une chaîne suivie de deux points, alors la chaîne WebSphere Application Server s'ajoute au nom.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet qui vous intéresse. (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie un objet Objectname construit à partir de la chaîne de nom d'objet.

Exemples

  • Avec Jacl :
    set objectNameString [$AdminControl completeObjectName type=Server,node=mynode,*]
    set objName [$AdminControl makeObjectName $objNameString]
  • A l'aide de Jython :
    objectNameString = AdminControl.completeObjectName('type=Server,node=mynode,*')
    objName = AdminControl.makeObjectName(objectNameString)

queryMBeans

La commande queryMBeans renvoie une liste d'instances d'objet qui correspond au nom d'objet fourni.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet qui vous intéresse. (ObjectName)

Paramètres facultatifs

requête
Indique l'expression de requête. (QueryExp)

Exemple de sortie

La commande renvoie une liste d'instances d'objet pour le nom d'objet spécifié, comme dans l'exemple suivant :
WebSphere:name=PlantsByWebSphere,process=server1,platform=dynamicproxy,node=Goodog,
J2EEName=PlantsByWebSphere,Server=server1,version=6.1.0.0,type=Application,
mbeanIdentifier=cells/GooddogNode02Cell/applications/PlantsByWebSphere.ear/
deployments/PlantsByWebSphere/deployment.xml#ApplicationDeployment_1126623343902,
cell=GooddogNode02Cell

Exemples

  • Avec Jacl :
    set apps [$AdminControl queryMBeans type=Application,*]
    Utilisez l'exemple suivant pour manipuler la valeur de retour de la commande queryMBeans :
    set appArray [$apps toArray]
    set app1 [java::cast javax.management.ObjectInstance [$appArray get 0]]
    puts [[$app1 getObjectName] toString]
    L'exemple suivant spécifie le nom d'objet et l'expression de requête :
    set apps [$AdminControl queryMBeans type=Application,* [java::null]]
    Utilisez l'exemple suivant pour manipuler la valeur de retour de la commande queryMBeans :
    set appArray [$apps toArray]
    set app1 [java::cast javax.management.ObjectInstance [$appArray get 0]]
    puts [[$app1 getObjectName] toString] 
  • A l'aide de Jython :
    apps = AdminControl.queryMBeans('type=Application,*')
    Utilisez l'exemple suivant pour manipuler la valeur de retour de la commande queryMBeans :
    appArray = apps.toArray()
    app1 = appArray[0]
    print app1.getObjectName().toString()
    L'exemple suivant spécifie le nom d'objet et l'expression de requête :
    apps = AdminControl.queryMBeans('type=Application,*',None)
    Utilisez l'exemple suivant pour manipuler la valeur de retour de la commande queryMBeans :
    appArray = apps.toArray()
    app1 = appArray[0]
    print app1.getObjectName().toString()

queryNames

La commande queryNames renvoie une liste de chacun des objets ObjectName basés sur le modèle de nom.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet qui vous intéresse. Vous pouvez indiquer un caractère générique pour le paramètre de nom d'objet, à l'aide de l'astérisque (*). (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant les ObjectNames correspondant au nom d'objet en entrée, comme dans l'exemple suivant :
WebSphere:cell=BaseApplicationServerCell,
name=server1,mbeanIdentifier=server1,
type=Server,node=mynode,process=server1 

Exemples

  • Avec Jacl :
    $AdminControl queryNames WebSphere:type=Server,* 
  • A l'aide de Jython :
    print AdminControl.queryNames('WebSphere:type=Server,*')

queryNames_jmx

La commande queryNames_jmx renvoie une liste de chacun des objets ObjectName basés sur le modèle de nom et les conditions de requête indiquées.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet qui vous intéresse. Vous pouvez indiquer un caractère générique pour le paramètre de nom d'objet, à l'aide de l'astérisque (*). (ObjectName)
requête
Indique l'expression de requête à utiliser. (javax.management.QueryExp)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie une chaîne contenant les ObjectNames correspondant au nom d'objet en entrée, comme dans l'exemple suivant :
[WebSphere:cell=BaseApplicationServerCell,name=server1,mbeanIdentifier=
server1,type=Server,node=mynode,process=server1] 

Exemples

  • Avec Jacl :
    set objectNameString [$AdminControl completeObjectName type=Server,*]
    set objName [$AdminControl makeObjectName $objNameString]
    set null [java::null]
    $AdminControl queryNames_jmx $objName $null
  • A l'aide de Jython :
    objectNameString = AdminControl.completeObjectName('type=Server,*')
    objName = AdminControl.makeObjectName(objectNameString)
    print AdminControl.queryNames_jmx(objName, None)

reconnect

La commande reconnect permet la reconnexion au serveur et la suppression d'informations du cache local.

Objet cible

Aucune.

Paramètres obligatoires

Aucune.

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie un message affichant l'état de l'opération, comme dans l'exemple suivant :
WASX7074I : Reconnexion terminée du connecteur SOAP à l'hôte myhost.

Exemples

  • Avec Jacl :
    $AdminControl reconnect 
  • A l'aide de Jython :
    print AdminControl.reconnect()

setAttribute

La commande setAttribute permet de définir la valeur d'attribut pour le nom fourni.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (java.lang.String)
nom_attribut
Indique le nom de l'attribut à définir. (java.lang.String)
valeur_attribut
Indique la valeur de l'attribut qui vous intéresse. (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande ne renvoie pas de sortie.

Exemples

  • Avec Jacl :
    set objNameString [$AdminControl completeObjectName WebSphere:type=TraceService,*] 
    $AdminControl setAttribute $objNameString traceSpecification com.ibm.*=all=disabled 
  • A l'aide de Jython :
    objNameString = AdminControl.completeObjectName('WebSphere:type=TraceService,*') 
    print AdminControl.setAttribute(objNameString, 'traceSpecification',  'com.ibm.*=all=disabled')

setAttribute_jmx

La commande setAttribute_jmx permet de définir la valeur d'attribut pour le nom fourni.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (ObjectName)
attribute
Indique le nom de l'attribut à définir. (Attribut)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande ne renvoie pas de sortie.

Exemples

  • Avec Jacl :
    set objectNameString [$AdminControl completeObjectName WebSphere:type=TraceService,*] 
    set objName [$AdminControl makeObjectName $objectNameString]
    set attr [java::new javax.management.Attribute traceSpecification com.ibm.*=all=disabled] 
    $AdminControl setAttribute_jmx $objName $attr 
  • A l'aide de Jython :
    objectNameString = AdminControl.completeObjectName('WebSphere:type=TraceService,*')
    import  javax.management  as  mgmt
    objName = AdminControl.makeObjectName(objectNameString)
    attr = mgmt.Attribute('traceSpecification', 'com.ibm.*=all=disabled')
    print AdminControl.setAttribute_jmx(objName, attr)

setAttributes

La commande setAttributes permet de définir les valeurs d'attribut des noms d'objet fournis.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (Chaîne)
attributes
Indique les noms des attributs à définir. (java.lang.String[] ou java.lang.Object[])

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie la liste des noms d'objet qui sont correctement définis par l'appel de commande, comme dans l'exemple suivant :
'[traceSpecification com.ibm.ws.*=all=enabled]'

Exemples

  • Avec Jacl :
    set objNameString [$AdminControl completeObjectName WebSphere:type=TraceService,*] 
    $AdminControl setAttributes $objNameString {{traceSpecification com.ibm.ws.*=all=enabled}} 
  • A l'aide de Jython avec des attributs de chaîne :
    objNameString = AdminControl.completeObjectName('WebSphere:type=TraceService,*') 
    AdminControl.setAttributes(objNameString, '[[traceSpecification "com.ibm.ws.*=all=enabled"]]')
  • A l'aide de Jython avec des attributs d'objet :
    objNameString = AdminControl.completeObjectName('WebSphere:type=TraceService,*') 
    print AdminControl.setAttributes(objNameString, [['traceSpecification', 'com.ibm.ws.*=all=enabled']])

setAttributes_jmx

La commande setAttributes_jmx permet de définir les valeurs d'attribut des noms d'objet fournis.

Objet cible

Aucune.

Paramètres obligatoires

nom_objet
Indique le nom d'objet du MBean concerné. (Chaîne)
attributes
Indique les noms des attributs à définir. (javax.management.AttributeList)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie la liste d'attributs des noms d'objet qui sont correctement définis par l'appel de commande, comme dans l'exemple suivant :
'[traceSpecification com.ibm.ws.*=all=enabled]'

Exemples

  • Avec Jacl :
    set objectNameString [$AdminControl completeObjectName WebSphere:type=TraceService,*] 
    set objName [$AdminControl makeObjectName $objectNameString] 
    set attr [java::new javax.management.Attribute traceSpecification com.ibm.ws.*=all=enabled] 
    set alist [java::new javax.management.AttributeList] 
    $alist add $attr 
    $AdminControl setAttributes_jmx $objName $alist
  • A l'aide de Jython :
    objectNameString = AdminControl.completeObjectName('WebSphere:type=TraceService,*')
    import  javax.management  as  mgmt 
    objName = AdminControl.makeObjectName(objectNameString) 
    attr = mgmt.Attribute('traceSpecification', 'com.ibm.ws.*=all=enabled') 
    alist = mgmt.AttributeList() 
    alist.add(attr)
    print AdminControl.setAttributes_jmx(objName, alist)

startServer

La commande startServer permet de démarrer le serveur d'applications spécifié, en le localisant dans la configuration. Cette commande utilise le temps d'attente par défaut. Utilisez les instructions suivantes pour déterminer les paramètres à utiliser :
  • Si le processus de scriptage est rattaché à un serveur Agent de noeud, vous devez indiquer le nom du serveur. Vous pouvez également indiquer les paramètres de délai d'attente et de nom de noeud facultatifs.
  • Si le processus de scriptage est rattaché à un processus du gestionnaire de déploiement, vous devez indiquer le nom du serveur et le nom du noeud. Vous pouvez également indiquer le paramètre de délai d'attente facultatif.

Objet cible

Aucune.

Paramètres obligatoires

nom de serveur
Indique le nom du serveur à démarrer. (java.lang.String)

Paramètres facultatifs

nom de noeud
Indique le nom du noeud concerné. (java.lang.String)
délai_attente
Indique le délai d'attente, en nombre de secondes, pendant lequel le processus de démarrage attend le démarrage du serveur. Le délai d'attente par défaut est de 1200 secondes. (java.lang.String)

Exemple de sortie

Serveur lancé. Attente du statut d'initialisation. Le serveur server1 est prêt pour l'e-business ; l'ID de processus est 1932.

Exemples

Avec Jacl :
  • L'exemple suivant spécifie uniquement le nom du serveur à démarrer :
    $AdminControl startServer server1
  • L'exemple suivant spécifie le nom du serveur à démarrer et le délai d'attente :
    $AdminControl startServer server1 100
  • L'exemple suivant spécifie le nom du serveur à démarrer et le nom du noeud :
    $AdminControl startServer server1 myNode
  • L'exemple ci-dessous spécifie le nom du serveur, le nom du noeud et le délai d'attente :
    $AdminControl startServer server1 myNode 100
En langage Jython :
  • L'exemple suivant spécifie uniquement le nom du serveur à démarrer :
    AdminControl.startServer('server1')
  • L'exemple suivant spécifie le nom du serveur à démarrer et le délai d'attente :
    AdminControl.startServer('server1', 100)
  • L'exemple suivant spécifie le nom du serveur à démarrer et le nom du noeud :
    AdminControl.startServer('server1', 'myNode')
  • L'exemple ci-dessous spécifie le nom du serveur, le nom du noeud et le délai d'attente :
    AdminControl.startServer('server1', 'myNode', 100)

stopServer

La commande stopServer permet d'arrêter le serveur d'applications spécifié. Lorsque la commande stopServer s'exécute sans les indicateurs immédiate ou d'arrêt, le serveur termine tous les travaux en cours mais n'accepte aucun nouveau travail une fois qu'il démarre le processus d'arrêt. Utilisez les options suivantes pour déterminer les paramètres à utiliser :
  • Utilisez les paramètres de nom de serveur et de nom de noeud pour arrêter un serveur dans un noeud spécifique.
  • Utilisez les paramètres de nom de serveur et d'indicateur immédiat pour arrêter le serveur immédiatement. Si ce paramètre n'est pas spécifié, le système arrête le serveur de façon normale.
  • Utilisez les paramètres de nom de serveur, de nom de noeud et d'indicateur immédiat pour arrêter immédiatement un serveur d'un noeud spécifique.
Eviter les incidents Eviter les incidents: Un message d'erreur est émis uniquement si vous indiquez le nom du serveur lorsque vous tentez d'arrête ce serveur.gotcha

Objet cible

Aucune.

Paramètres obligatoires

nom de serveur
Indique le nom du serveur à démarrer. (java.lang.String)

Paramètres facultatifs

nom de noeud
Indique le nom du noeud concerné. (java.lang.String)
indicateur immédiat
Arrête le serveur immédiatement si la valeur est immediate. Si l'indicateur immédiat est spécifié, le serveur ne termine pas le traitement des travaux en cours, n'accepte aucun nouveau travail et met fin au processus serveur. (java.lang.String)
indicateur d'arrêt
Indique que le processus serveur doit être arrêté par le système d'exploitation. (Chaîne)

Exemple de sortie

Cette commande renvoie un message indiquant si le serveur s'arrête correctement, comme dans l'exemple suivant :
WASX7337I : Fonction d'arrêt appelée pour le serveur "server1". Attente de l'arrêt du serveur.
'WASX7264I : Arrêt terminé pour le serveur "server1" sur le noeud "myNode"'

Exemples

Avec Jacl :
  • L'exemple suivant spécifie uniquement le nom du serveur à arrêter :
    $AdminControl stopServer server1
  • L'exemple suivant spécifie le nom du serveur à arrêter et indique que le serveur doit s'arrêter immédiatement :
    $AdminControl stopServer server1 immediate
  • L'exemple suivant spécifie le nom du serveur à arrêter et le nom du noeud :
    $AdminControl stopServer server1 myNode
  • L'exemple ci-dessous spécifie le nom du serveur, le nom du noeud et indique que le serveur doit s'arrêter immédiatement :
    $AdminControl stopServer server1 myNode immediate
En langage Jython :
  • L'exemple suivant spécifie le nom du serveur à arrêter et indique que le serveur doit s'arrêter immédiatement :
    AdminControl.stopServer('server1','immediate')
  • L'exemple suivant spécifie le nom du serveur à arrêter et le nom du noeud :
    AdminControl.stopServer('server1','myNode')
  • L'exemple ci-dessous spécifie le nom du serveur, le nom du noeud et indique que le serveur doit s'arrêter immédiatement :
    AdminControl.stopServer('server1','myNode','immediate')

testConnection

La commande testConnection permet de tester une connexion de source de données. Cette commande fonctionne avec la source de données résidant dans le référentiel de configuration. Si la source de données à tester se trouve dans l'espace de travail temporaire comportant la mise à jour du référentiel, vous devez enregistrer cette mise à jour dans le référentiel de configuration avant d'exécuter la commande. Utilisez cette commande avec l'ID configuration qui correspond à la source de données et aux types d'objet WAS40DataSource.

Objet cible

Aucune.

Paramètres obligatoires

ID_configuration
Indique l'ID configuration de l'objet source de données qui vous intéresse. (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande renvoie un message indiquant une connexion qui a abouti ou une connexion accompagnée d'un avertissement. Si la connexion échoue, une exception est générée à partir du serveur pour indiquer l'erreur. Par exemple :
WASX7217I
: Connexion réussie à la source de données fournie.

Exemples

  • Avec Jacl :
    set ds [lindex [$AdminConfig list DataSource] 0] 
    $AdminControl testConnection $ds
  • En langage Jython :
    # extrait le séparateur de ligne 
    import  java.lang.System  as sys
    lineSeparator = sys.getProperty('line.separator')
    ds = AdminConfig.list('DataSource').split(lineSeparator)[0]
    print AdminControl.testConnection(ds)

trace

La commande trace permet de paramétrer la spécification de trace pour le processus de scriptage sur la valeur que vous indiquez.

Objet cible

Aucune.

Paramètres obligatoires

spécification_trace
Indique la trace à activer pour le processus de scriptage. (java.lang.String)

Paramètres facultatifs

Aucune.

Exemple de sortie

La commande ne renvoie pas de sortie.

Exemples

  • Avec Jacl :
    $AdminControl trace com.ibm.ws.scripting.*=all=enabled
  • En langage Jython :
    print AdminControl.trace('com.ibm.ws.scripting.*=all=enabled')

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



Icône d'horodatage Dernière mise à jour: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rxml_admincontrol
Nom du fichier : rxml_admincontrol.html