Befehle für das Objekt "Help" mit wsadmin-Scripting
Sie können die Scripting-Sprachen Jython und Jacl verwenden, um mit dem Tool wsadmin allgemeine Hilfeinformationen und dynamische Onlineinformationen zu den derzeit aktiven MBeans zu suchen. Verwenden Sie das Objekt "Help" zur Unterstützung, wenn Sie Scripts mit dem Objekt AdminControl schreiben und ausführen.
AdminApp
Verwenden Sie den Befehl AdminApp, um eine Zusammenfassung zu jeder verfügbaren Methode für das Objekt "AdminApp" anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
Ohne.
Optionale Parameter
Ohne.
Beispielausgabe
WASX7095I: Mit dem Objekt AdminApp können Sie Anwendungsobjekte bearbeiten.
Sie können unter anderem Objekte installieren, deinstallieren, bearbeiten
und auflisten. Die meisten Befehle, die
von AdminApp unterstützt werden, können in zwei Modi ausgeführt werden: Im Standardmodus kommuniziert
AdminApp mit dem Produkt, um die Tasks auszuführen. Im lokalen Modus findet keine Kommunikation mit einem
Server statt. Der lokale Ausführungsmodus wird aktiviert, indem der Scripting-Client
ohne verbundenen Server mit der Befehlszeilenoption "-conntype NONE"
oder durch Konfigurieren der Eigenschaft "com.ibm.ws.scripting.connectionType=NONE"
in der Datei "wsadmin.properties" aufgerufen wird.
Die folgenden Befehle werden von AdminApp unterstützt. Weitere Informationen
zu den einzelnen Befehlen erhalten Sie, wenn Sie den Befehl "help" von
AdminApp verwenden und den Namen des gewünschten Befehls als Argument angeben.
deleteUserAndGroupEntries Löscht alle Benutzer-/Gruppeninformationen für alle Rollen und alle
Benutzer-/Kennwortinformationen für die RunAS-Rollen für eine bestimmte Anwendung.
edit Editiert die Eigenschaften einer Anwendung.
editInteractive Editiert die Eigenschaften einer Anwendung interaktiv.
export Exportiert eine Anwendung in eine Datei.
exportDDL Exportiert eine DDL aus einer Anwendung in ein Verzeichnis.
help Zeigt Hilfetext an.
install Installiert eine Anwendung basierend auf einem Dateinamen und einer Optionszeichenfolge.
installInteractive
Installiert eine Anwendung im Dialogmodus basierend auf einem Dateinamen und einer
Optionszeichenfolge.
isAppReady Prüft, ob die Anwendung zur Ausführung bereit ist.
list Listet alle installierten Anwendungen (alle Anwendungen oder Anwendungen
in einem bestimmtem Zielbereich) auf.
listModules Listet die Module in einer angegebenen Anwendung auf.
options Zeigt die verfügbaren Optionen für eine bestimmte Datei oder
im Allgemeinen an.
publishWSDL Veröffentlicht WSDL-Dateien für eine bestimmte Anwendung.
taskInfo Zeigt ausführliche Informationen zur
Installationstask für eine bestimmte Datei an
uninstall Deinstalliert eine Anwendung basierend auf einem Anwendungsnamen
und einer Optionszeichenfolge.
updateAccessIDs Aktualisiert die Bindungsinformationen für Benutzer/Gruppen
mit der Zugriffs-ID aus der Benutzerregistry für eine
bestimmte Anwendung.
view Zeigt die angegebene Anwendung oder das angegebene Modul an.
Beispiele
- Mit Jacl:
$Help AdminApp
- Mit Jython:
print Help.AdminApp()
AdminConfig
Verwenden Sie den Befehl AdminConfig, um eine Zusammenfassung zu jeder verfügbaren Methode für das Objekt "AdminConfig" anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
Ohne.
Optionale Parameter
Ohne.
Beispielausgabe
WASX7053I: Die folgenden Funktionen werden
von AdminConfig unterstützt:
create Erstellt ein Konfigurationsobjekt, wenn ein Typ, ein übergeordnetes
Objekt und eine Liste mit Attributen angegeben werden.
create Erstellt ein Konfigurationsobjekt, wenn ein Typ, ein übergeordnetes
Objekt, eine Liste von Attributen und ein Attributname für das neue
Objekt vorhanden ist.
remove Löscht das angegebene Konfigurationsobjekt.
Objekt
list Listet alle Konfigurationsobjekte eines bestimmten Typs auf.
list Listet alle Konfigurationsobjekte eines bestimmten Typs auf, die im
angegebenen Bereich enthalten sind.
show Zeigt alle Attribute eines bestimmten Konfigurationsobjekts an.
show Zeigt die angegebenen Attribute eines angegebenen Konfigurationsobjekts an.
modify Ändert die angegebenen Attribute eines bestimmten Konfigurationsobjekts.
getId Zeigt die Konfigurations-ID eines Objekts auf der Basis einer Containment-Zeichenfolgeversion an.
contents Zeigt die Objekte, die ein bestimmter Typ enthält, an.
parents Zeigt die Objekte, die einen bestimmten Typ enthalten, an.
attributes Zeigt die Attribute für einen bestimmten Typ an.
types Zeigt mögliche Konfigurationstypen an.
help Zeigt Hilfetext an.
Beispiele
- Mit Jacl:
$Help AdminConfig
- Mit Jython:
print Help.AdminConfig()
AdminControl
Verwenden Sie den Befehl AdminControl, um eine Zusammenfassung der help-Befehle und Methoden für den Aufruf eines Verwaltungsbefehls anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
Ohne.
Optionale Parameter
Ohne.
Beispielausgabe
WASX7027I: Die folgenden Funktionen werden von AdminControl unterstützt:
getHost Gibt eine Zeichenfolgedarstellung des Host, zu dem eine Verbindung besteht, zurück.
getPort Gibt die Zeichenfolgedarstellung des verwendeten Port zurück.
getType Gibt die Zeichenfolgedarstellung des verwendeten Verbindungstyps zurück.
reconnect Stellt eine Verbindung zum Server wieder her.
queryNames Ruft eine Gruppe von übereinstimmenden ObjectNames ab, wenn
ObjectName und QueryExp angegeben sind.
queryNames Ruft eine Zeichenfolge von übereinstimmenden ObjectNames ab, wenn
eine Zeichenfolgedarstellung des ObjectName vorhanden ist.
getMBeanCount Gibt die Anzahl der registrierten Beans zurück.
getDomainName Gibt den Wert "WebSphere" zurück.
getDefaultDomain Gibt den Wert "WebSphere" zurück.
getMBeanInfo Gibt die MBeanInfo-Struktur für die MBean zurück, wenn der
ObjectName angegeben ist.
isInstanceOf Hat den Wert "true", wenn ein ObjectName und ein Klassenname
vorhanden ist und die MBean zu dieser Klasse gehört.
isRegistered Hat den Wert "true", wenn der angegebene ObjectName registriert ist.
isRegistered Hat den Wert "true", wenn die angegebene Zeichenfolgeversion des
ObjectName registriert ist.
getAttribute Gibt den Wert des angegebenen Attributs zurück, wenn der ObjectName und
der Attributname angegeben sind.
getAttribute Gibt den Attributwert zurück, wenn eine Zeichenfolgeversion
des ObjectName und ein Attributname angegeben sind.
getAttributes Gibt AttributeList zurück, wenn der ObjectName und der Bereich der
Attributnamen angegeben sind.
getAttributes Gibt Zeichenfolge von Name/Wert-Paaren zurück, wenn eine
Zeichenfolgeversion des ObjectName und Attributnamen angegeben sind.
setAttribute Legt das Attribut für die angegebene MBean fest, wenn
der ObjectName und das Attributobjekt angegeben sind.
setAttribute Legt das Attribut für die angegebene MBean fest, wenn die
Zeichenfolgeversion des ObjectName, des Attributnamens und des
Attributwerts angegeben sind.
setAttributes Legt Attribute für die angegebene MBean fest, wenn der ObjectName
und das AttributeList-Objekt angegeben sind.
invoke Ruft eine Methode für die angegebene MBean auf, wenn der
ObjectName, der Methodenname, der Parameterbereich und die Signatur
angegeben sind.
invoke Ruft eine Methode für die angegebene MBean auf, wenn eine
Zeichenfolgeversion des ObjectName, der Methodenname und eine
Zeichenfolgeversion der Parameterliste angegeben sind.
invoke Ruft eine Methode für die angegebene MBean auf, wenn eine
Zeichenfolgeversion des ObjectName, der Methodenname, eine
Zeichenfolgeversion der Parameterliste und eine
Zeichenfolgeversion des Signaturbereichs angegeben sind.
makeObjectName Gibt einen ObjectName mit der angegebenen Zeichenfolge zurück.
completeObjectName
Gibt eine Zeichenfolgeversion eines Objektnamens zurück, wenn
ein Schablonenname angegeben ist.
trace Definiert die Spezifikation des wsadmin-Trace.
help Zeigt Hilfetext an.
Beispiele
- Mit Jacl:
$Help AdminControl
- Mit Jython:
print Help.AdminControl()
AdminTask
Verwenden Sie den Befehl AdminTask, um eine Zusammenfassung der help-Befehle und Methoden für den Aufruf eines Verwaltungsbefehls anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
Ohne.
Optionale Parameter
Ohne.
Beispielausgabe
WASX8001I: Das AdminTask-Objekt ermöglicht die Ausführung verfügbarer Verwaltungsbefehle.
AdminTask-Befehle arbeiten in zwei Modi: Im Standardmodus kommuniziert AdminTask mit
dem Produkt, um die Task auszuführen. Im lokalen Modus findet keine Kommunikation mit einem Server statt. Der lokale Ausführungsmodus wird
aktiviert, indem der Scripting-Client mit der Befehlszeilenoption "-conntype NONE" aufgerufen wird oder die Eigenschaft
"com.ibm.ws.scripting.connectiontype=NONE" in der Datei wsadmin.properties gesetzt wird.
Die Anzahl der Verwaltungsbefehle variiert und ist von der Produktinstallation
abhängig. Mit den folgenden help-Befehlen können Sie eine Liste der unterstützten
Befehle und der zugehörigen Parameter abrufen:
help -commands Listet alle Verwaltungsbefehle auf.
help -commandGroups Listet alle Verwaltungsbefehlsgruppen auf.
help Befehlsname Zeigt detaillierte Informationen zu dem
angegebenen Befehl an.
help Befehlsname Schrittname
Zeigt detaillierte Informationen zum angegebenen
Schritt des angegebenen Befehls an.
help Befehlsgruppenname Zeigt detaillierte Informationen zu der
angegebenen Befehlsgruppe an.
Es gibt verschiedene Möglichkeiten, einen Verwaltungsbefehl aufzurufen. Dies sind:
Befehlsname Ruft einen Verwaltungsbefehl auf, der kein Argument erfordert.
Befehlsname Zielobjekt Ruft einen Verwaltungsbefehl mit der Zeichenfolge für
das Zielobjekt auf, z. B. den Namen eines Konfigurationsobjekts
für einen Ressourcenadapter. Das erwartete Zielobjekt
variiert je nach aufgerufenem Verwaltungsbefehl.
Mit dem Befehl help können Sie Informationen zum Zielobjekt eines Verwaltungsbefehls abrufen.
Befehlsname Optionen Ruft einen Verwaltungsbefehl mit den angegebenen
Optionszeichenfolgen auf. Mit dieser Syntax wird ein
Verwaltungsbefehl aufgerufen, der kein Zielobjekt
erfordert.
Außerdem dient sie dazu, in den interaktiven
Modus zu wechseln, wenn in der Optionszeichenfolge "-interactive"
angegeben ist.
Befehlsname Zielobjekt Optionen Ruft einen Verwaltungsbefehl mit dem angegebenen
Zielobjekt und den angegebenen Optionszeichenfolgen
auf.
Wenn "-interactive"
in der Optionszeichenfolge enthalten ist, wird in den
Dialogmodus gewechselt. Das Zielobjekt und die
Optionszeichenfolge variieren je nach aufgerufenem
Verwaltungsbefehl. Verwenden Sie
den Befehl help, um Informationen zu Zielobjekt und
Optionen zu erhalten.
Beispiele
- Mit Jacl:
$AdminTask help
- Mit Jython:
print AdminTask.help()
all
Verwenden Sie den Befehl all, um eine Zusammenfassung der Informationen, die die MBean definiert, nach Namen anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
- MBean-Name
- Gibt den Objektnamen an, der die gewünschte MBean darstellt. (String)
Optionale Parameter
Ohne.
Beispielausgabe
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
Attribute 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
Beispiele
- Mit Jacl:
$Help all [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Mit Jython:
print Help.all(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
attributes
Verwenden Sie den Befehl attributes, um eine Zusammenfassung aller Attribute, die die MBean definiert, nach Namen anzuzeigen. Wenn Sie den MBean-Namen angeben, zeigt der Befehl Informationen zu den Attributen, Operationen und Konstruktoren sowie die Beschreibung, Benachrichtigungen und den Klassennamen der angegebenen MBean an. Wenn Sie den MBean-Namen und den Attributnamen angeben, zeigt der Befehl Informationen zum angegebenen Attribut für die angegebene MBean an.
Zielobjekt
Ohne.Erforderliche Parameter
- MBean-Name
- Gibt den Objektnamen an, der die gewünschte MBean darstellt. (String)
Optionale Parameter
- Attributname
- Gibt das gewünschte Attribut an. (String)
Beispielausgabe
Attribute Type Access
ringBufferSize java.lang.Integer RW
traceSpecification string RW
Beispiele
- Mit Jacl:
$Help attributes [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Mit Jython:
print Help.attributes(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
classname
Verwenden Sie den Befehl classname, um einen Klassennamen anzuzeigen, den die MBean definiert, nach Namen anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
- MBean-Name
- Gibt den Objektnamen an, der die gewünschte MBean darstellt. (String)
Optionale Parameter
Ohne.
Beispielausgabe
javax.management.modelmbean.RequiredModelMBean
Beispiele
- Mit Jacl:
$Help classname [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Mit Jython:
print Help.classname(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
constructors
Verwenden Sie den Befehl constructors, um eine Zusammenfassung aller Konstruktoren, die die MBean definiert, nach Namen anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
- MBean-Name
- Gibt den Objektnamen an, der die gewünschte MBean darstellt. (String)
Optionale Parameter
Ohne.
Beispielausgabe
Constructors
Beispiele
- Mit Jacl:
$Help constructors [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Mit Jython:
print Help.constructors(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
description
Verwenden Sie den Befehl description, um eine Beschreibung, die die MBean definiert, nach Namen anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
- MBean-Name
- Gibt den Objektnamen an, der die gewünschte MBean darstellt. (String)
Optionale Parameter
Ohne.
Beispielausgabe
Verwaltetes Objekt für gesamten
Serverprozess.
Beispiele
- Mit Jacl:
$Help description [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Mit Jython:
print Help.description(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
help
Verwenden Sie den Befehl help, um eine Zusammenfassung aller verfügbaren Methoden für das Objekt "Help" anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
Ohne.
Optionale Parameter
Ohne.
Beispielausgabe
WASX7028I: Das Objekt Help dient zu zwei Zwecken:
Erstens, allgemeine Hilfe für die Objekte, die vom Tool wsadmin für das Scripting
bereitgestellt werden: Help, AdminApp, AdminConfig und AdminControl.
Zweitens, ein Verfahren zum Abrufen von Schnittstelleninformationen zu
den im System ausgeführten MBeans bereitstellen. Zu diesem Zweck sind
verschiedene Befehle verfügbar, mit denen Informationen zu den Operationen,
Attributen und anderen Schnittstelleninformationen zu verschiedenen MBeans
abgerufen werden können.
Die folgenden Befehle werden von Help unterstützt.
Weitere Informationen zu den einzelnen Befehlen erhalten Sie, wenn Sie den
Befehl "help" von Help verwenden und den Namen des gewünschten Befehls als Argument angeben.
attributes Gibt Hilfetext für Attribute zurück, wenn eine MBean vorhanden ist.
operations Gibt Hilfetext für Operationen zurück, wenn eine MBean vorhanden ist.
constructors Gibt Hilfetext für Konstruktoren zurück, wenn eine MBean vorhanden ist.
description Gibt Hilfetext für Beschreibung zurück, wenn eine MBean vorhanden ist.
notifications
Gibt Hilfetext für Benachrichtigungen zurück, wenn eine MBean vorhanden ist.
classname Gibt Hilfetext für Klassennamen zurück, wenn eine MBean vorhanden ist.
all Gibt Hilfetext für alle oben genannten Optionen zurück, wenn eine MBean
vorhanden ist.
help Gibt diesen Hilfetext zurück.
AdminControl
Gibt die erweiterte Hilfe für das Objekt "AdminControl" zurück.
AdminConfig Gibt die erweiterte Hilfe für das Objekt "AdminConfig-" zurück.
AdminApp Gibt die erweiterte Hilfe für das Objekt "AdminApp" zurück.
AdminTask Gibt die erweiterte Hilfe für das Objekt "AdminTask" zurück.
wsadmin Gibt die erweiterte Hilfe für das Startprogramm des wsadmin-Scripts zurück.
message Gibt die Erklärung und die Benutzeraktion zurück, wenn eine Nachrichten-ID
angegeben ist.
Beispiele
- Mit Jacl:
$Help help
- Mit Jython:
print Help.help()
message
Verwenden Sie den Befehl message, um Informationen zu einer Nachrichten-ID anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
- Nachrichten-ID
- Gibt die Nachrichten-ID der gewünschten Nachricht an. (String)
Optionale Parameter
Ohne.
Beispielausgabe
Der Container konnte eine Enterprise-Bean nicht aktivieren. Die Ausnahme {2} wurde ausgelöst.
Benutzeraktion: Ergreifen Sie die in der Nachricht zur Ausnahme {2} angegebenen Maßnahmen.
Beispiele
- Mit Jacl:
$Help message CNTR0005W
- Mit Jython:
print Help.message('CNTR0005W')
notifications
Verwenden Sie den Befehl notifications, um eine Zusammenfassung aller Benachrichtigungen, die die MBean definiert, nach Namen anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
- MBean-Name
- Gibt den Objektnamen der gewünschten MBean an. (String)
Optionale Parameter
Ohne.
Beispielausgabe
Notification
websphere.messageEvent.audit
websphere.messageEvent.fatal
websphere.messageEvent.error
websphere.seriousEvent.info
websphere.messageEvent.warning
jmx.attribute.changed
Beispiele
- Mit Jacl:
$Help notifications [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
- Mit Jython:
print Help.notifications(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
operations
Verwenden Sie den Befehl operations mit dem Parameter "MBean-Name", um eine Zusammenfassung aller Operationen, die die MBean definiert, nach Namen anzuzeigen. Geben Sie einen Wert für "MBean-Name" und "Operationsname" an, um die definierte Signatur der Operation für die MBean, nach Namen anzuzeigen.
Zielobjekt
Ohne.Erforderliche Parameter
- MBean-Name
- Gibt den Objektnamen der gewünschten MBean an. (String)
Optionale Parameter
- Operationsname
- Gibt die gewünschte Operation an. (String)
Beispielausgabe
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)
Beschreibung: Den Inhalt des Ringpuffers der Ras-Services in die angegebene Datei schreiben.
Parameter:
Type string
Name dumpString
Description A String in the specified
format to process or null.
Beispiele
- Mit Jacl:
$Help operations [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
$Help operations [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*] processDumpString
- Mit Jython:
print Help.operations(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
print Help.operations(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'), 'processDumpString')