ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzamy_5.4.0.1/50/admin/wsaobjhelp.htm

69 lines
2.5 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><strong>AdminConfig</strong><br>
Provides a summary of all of the available methods for the AdminConfig object.</p>
<p><strong>AdminControl</strong><br>
Provides a summary of all of the available methods for the AdminControl object.</p>
<p><strong>all</strong><br>
Provides a summary of the information that the MBean defines by name.</p>
<p><strong>attributes</strong><br>
Provides a summary of all of the attributes that the MBean defines by name.</p>
<p><strong>classname</strong><br>
Provides a class name that the MBean defines by name.</p>
<p><strong>constructors</strong><br>
Provides a summary of all of the constructors that the MBean defines by name.</p>
<p><strong>description</strong><br>
Provides a description that the MBean defines by name.</p>
<p><strong>help</strong><br>
Provides a summary of all of the available methods for the help object.</p>
<p><strong>message</strong><br>
Displays information for a message ID.</p>
<p>Parameters: message ID</p>
<p>Example usage:</p>
<pre>$Help message WASX7015E</pre>
<p>Example output:</p>
<pre> Explanation: An error occurred during the interactive execution of the
specified command.
User action: Examine the accompanying exception information to determine the
appropriate action.</pre>
<p><strong>notifications</strong><br>
Provides a summary of all the notifications that the MBean defines by name.</p>
<p><strong>operations</strong><br>
Provides a summary of all of the operations that the MBean defines by name.</p>
<p><strong>operations</strong><br>
Provides the signature of the opname operation for the MBean defined by name.</p>
</body>
</html>