259 lines
9.0 KiB
HTML
259 lines
9.0 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<LINK rel="stylesheet" type="text/css" href="../../../rzahg/ic.css">
|
|
|
|
<title>The Help object for scripted administration</title>
|
|
</head>
|
|
|
|
<BODY>
|
|
<!-- Java sync-link -->
|
|
<SCRIPT LANGUAGE="Javascript" SRC="../../../rzahg/synch.js" TYPE="text/javascript"></SCRIPT>
|
|
|
|
<h5><a name="wsaobjhelp"></a>The Help object for scripted administration</h5>
|
|
|
|
<p>The Help object provides general help and dynamic online information about the MBeans that are running in your application server instance. You can use the Help object when your write and run scripts with the AdminControl object.</p>
|
|
|
|
<p>The following public methods are available for the Help object:</p>
|
|
|
|
<p><strong>AdminApp</strong>
|
|
<br>Provides a summary of all of the available methods for the AdminApp object.</p>
|
|
<p>Parameters: none</p>
|
|
<p>Usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help AdminApp</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.AdminApp()</pre></li>
|
|
</ul>
|
|
|
|
<p><strong>AdminConfig</strong>
|
|
<br>Provides a summary of all of the available methods for the AdminConfig object.</p>
|
|
<p>Parameters: none</p>
|
|
<p>Usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help AdminConfig</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.AdminConfig()</pre></li>
|
|
</ul>
|
|
|
|
<p><strong>AdminControl</strong>
|
|
<br>Provides a summary of all of the available methods for the AdminControl object.</p>
|
|
<p>Parameters: none</p>
|
|
<p>Usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help AdminControl</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.AdminControl()</pre></li>
|
|
</ul>
|
|
|
|
<p><strong>all</strong>
|
|
<br>Provides a summary of the information that the MBean defines by name.</p>
|
|
<p>Parameters: name</p>
|
|
<p>Example usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help all [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.all(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))</pre></li>
|
|
</ul>
|
|
<p>Example output:</p>
|
|
<pre>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</pre>
|
|
|
|
<p><strong>attributes</strong>
|
|
<br>Provides a summary of all of the attributes that the MBean defines by name.</p>
|
|
<p>Parameters: name</p>
|
|
<p>Example usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help attributes [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.attributes(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))</pre></li>
|
|
</ul>
|
|
<p>Example output:</p>
|
|
<pre>Attribute Type Access
|
|
|
|
ringBufferSize java.lang.Integer RW
|
|
|
|
traceSpecification java.lang.String RW</pre>
|
|
|
|
<p><strong>classname</strong>
|
|
<br>Provides a class name that the MBean defines by name.</p>
|
|
<p>Parameters: name</p>
|
|
<p>Example usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help classname [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.classname(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))</pre></li>
|
|
</ul>
|
|
<p>Example output:</p>
|
|
<pre>javax.management.modelmbean.RequiredModelMBean</pre>
|
|
|
|
<p><strong>constructors</strong>
|
|
<br>Provides a summary of all of the constructors that the MBean defines by name.</p>
|
|
<p>Parameters: name</p>
|
|
<p>Example usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help constructors [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.constructors(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))</pre></li>
|
|
</ul>
|
|
<p>Example output:</p>
|
|
<pre>Constructors</pre>
|
|
|
|
<p><strong>description</strong>
|
|
<br>Provides a description that the MBean defines by name.</p>
|
|
<p>Parameters: name</p>
|
|
<p>Example usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help description [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.description(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))</pre></li>
|
|
</ul>
|
|
<p>Example output:</p>
|
|
<pre>Managed object for overall server process.</pre>
|
|
|
|
<p><strong>help</strong>
|
|
<br>Provides a summary of all of the available methods for the help object.</p>
|
|
<p>Parameters: none</p>
|
|
<p>Usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help help</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.help()</pre></li>
|
|
</ul>
|
|
|
|
<p><strong>message</strong>
|
|
<br>Displays information for a message ID.</p>
|
|
<p>Parameters: message ID</p>
|
|
<p>Example usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help message CNTR0005W</pre></li>
|
|
<li>Jython:
|
|
<pre>Help.message('CNTR0005W')</pre></li>
|
|
</ul>
|
|
<p>Example output:</p>
|
|
<pre>Explanation: The container was unable to passivate an enterprise bean due
|
|
to exception {2}
|
|
User action: Take action based upon message in exception {2}</pre>
|
|
|
|
<p><strong>notifications</strong>
|
|
<br>Provides a summary of all the notifications that the MBean defines by name.</p>
|
|
<p>Parameters: name</p>
|
|
<p>Example usage:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help notifications [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.notifications(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))</pre></li>
|
|
</ul>
|
|
<p>Example output:</p>
|
|
<pre>Notification
|
|
|
|
websphere.messageEvent.audit
|
|
|
|
websphere.messageEvent.fatal
|
|
|
|
websphere.messageEvent.error
|
|
|
|
websphere.seriousEvent.info
|
|
|
|
websphere.messageEvent.warning
|
|
|
|
jmx.attribute.changed</pre>
|
|
|
|
<p><strong>operations</strong>
|
|
<br>Provides a summary of all of the operations that the MBean defines by name. If you specify the optional opname parameter, the command provides the signature of the opname operation for the MBean defined by name.</p>
|
|
<p>Parameters: name, opname</p>
|
|
<p>Example usage with name parameter:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help operations [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.operations(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))</pre></li>
|
|
</ul>
|
|
<p>Example output:</p>
|
|
<pre>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)</pre>
|
|
|
|
<p>Example usage with name and opname parameters:</p>
|
|
<ul>
|
|
<li>Jacl:
|
|
<pre>$Help operations [$AdminControl queryNames type=TraceService,
|
|
process=server1,node=pongo,*] processDumpString</pre></li>
|
|
<li>Jython:
|
|
<pre>print Help.operations(AdminControl.queryNames('type=TraceService,
|
|
process=server1,node=pongo,*'), 'processDumpString')</pre></li>
|
|
</ul>
|
|
<p>Example output:</p>
|
|
<pre>void processDumpString(java.lang.String)
|
|
|
|
Description: Write the contents of the Ras services Ring Buffer to the specified file.
|
|
|
|
Parameters:
|
|
|
|
Type java.lang.String
|
|
Name dumpString
|
|
Description a String in the specified format to process or null.</pre>
|
|
|
|
</body>
|
|
</html> |