The Help object for scripted administration

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.

The following public methods are available for the Help object:

AdminApp
Provides a summary of all of the available methods for the AdminApp object.

Parameters: none

Usage:

• Jacl:

  $Help AdminApp

• Jython:

  print Help.AdminApp()

AdminConfig
Provides a summary of all of the available methods for the AdminConfig object.

Parameters: none

Usage:

• Jacl:

  $Help AdminConfig

• Jython:

  print Help.AdminConfig()

AdminControl
Provides a summary of all of the available methods for the AdminControl object.

Parameters: none

Usage:

• Jacl:

  $Help AdminControl

• Jython:

  print Help.AdminControl()

all
Provides a summary of the information that the MBean defines by name.

Parameters: name

Example usage:

• Jacl:

  $Help all [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]

• Jython:

  print Help.all(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

Example output:

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

attributes
Provides a summary of all of the attributes that the MBean defines by name.

Parameters: name

Example usage:

• Jacl:

  $Help attributes [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]

• Jython:

  print Help.attributes(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

Example output:

Attribute Type Access 

ringBufferSize java.lang.Integer RW 

traceSpecification java.lang.String RW

classname
Provides a class name that the MBean defines by name.

Parameters: name

Example usage:

• Jacl:

  $Help classname [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]

• Jython:

  print Help.classname(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

Example output:

javax.management.modelmbean.RequiredModelMBean

constructors
Provides a summary of all of the constructors that the MBean defines by name.

Parameters: name

Example usage:

• Jacl:

  $Help constructors [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]

• Jython:

  print Help.constructors(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

Example output:

Constructors

description
Provides a description that the MBean defines by name.

Parameters: name

Example usage:

• Jacl:

  $Help description [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]

• Jython:

  print Help.description(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

Example output:

Managed object for overall server process.

help
Provides a summary of all of the available methods for the help object.

Parameters: none

Usage:

• Jacl:

  $Help help

• Jython:

  print Help.help()

message
Displays information for a message ID.

Parameters: message ID

Example usage:

• Jacl:

  $Help message CNTR0005W

• Jython:

  Help.message('CNTR0005W')

Example output:

Explanation: The container was unable to passivate an enterprise bean due 
  to exception {2}
User action: Take action based upon message in exception {2}

notifications
Provides a summary of all the notifications that the MBean defines by name.

Parameters: name

Example usage:

• Jacl:

  $Help notifications [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]

• Jython:

  print Help.notifications(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

Example output:

Notification 

websphere.messageEvent.audit 

websphere.messageEvent.fatal 

websphere.messageEvent.error 

websphere.seriousEvent.info 

websphere.messageEvent.warning 

jmx.attribute.changed

operations
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.

Parameters: name, opname

Example usage with name parameter:

• Jacl:

  $Help operations [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]

• Jython:

  print Help.operations(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

Example output:

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)

Example usage with name and opname parameters:

• Jacl:

  $Help operations [$AdminControl queryNames type=TraceService,
    process=server1,node=pongo,*] processDumpString

• Jython:

  print Help.operations(AdminControl.queryNames('type=TraceService,
    process=server1,node=pongo,*'), 'processDumpString')

Example output:

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.