Help object for scripted administration:

Help object for scripted administration

The Help object provides general help and dynamic online information about the currently running MBeans.

One can use the Help object as an aid in writing and running scripts with the AdminControl object. Some methods include: attributes, operations, AdminConfig, and AdminControl.

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
Return type	java.lang.String

Example output:

WASX7095I: The AdminApp object allows application objects to
be manipulated -- this includes installing, uninstalling, editing,
and listing. 
The following commands are supported by AdminApp:
edit Edit the properties of an application
editInteractive Edit the properties of an application interactively
export Export application to a file
exportDDL Extract DDL from application to a directory
help Show help information
install Installs an application, given a file name and an option string.
installInteractive
Installs an application in interactive mode, given a
file name and an option string.
list List all installed applications
listModules List the modules in a specified application
options Shows the options available, either for a given file, or in
general.
taskInfo Shows detailed information pertaining to a given install task
for a given file
uninstall Uninstalls an application, given an application name and
an option string

AdminConfig

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

Parameters	none
Return type	java.lang.String

Example output:

WASX7053I: The following functions are supported by AdminConfig: 


create Creates a configuration object, given a type, a parent, and 

a list of attributes 


create Creates a configuration object, given a type, a parent, a 

list of attributes, and an attribute name for the new object 

remove Removes the specified configuration object 

list Lists all configuration objects of a given type 

list Lists all configuration objects of a given type, contained 

within the scope supplied 

show Show all the attributes of a given configuration object 

show Show specified attributes of a given configuration object 

modify Change specified attributes of a given configuration object 

getId Show the configId of an object, given a string version of 

its containment 

contents Show the objects which a given type contains 

parents Show the objects which contain a given type 

attributes Show the attributes for a given type 

types Show the possible types for configuration 

help Show help information

AdminControl

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

Parameters	none
Return type	java.lang.String

Example output:

WASX7027I: The following functions are supported by AdminControl: 


getHost returns String representation of connected host 

getPort returns String representation of port in use 

getType returns String representation of connection type in use 

reconnect reconnects with server 

queryNames Given ObjectName and QueryExp, retrieves set of ObjectNames 

that match. 

queryNames Given String version of ObjectName, retrieves String of 

ObjectNames that match. 

getMBeanCount returns number of registered beans 

getDomainName returns "WebSphere" 

getDefaultDomain returns "WebSphere" 

getMBeanInfo Given ObjectName, returns MBeanInfo structure for MBean 

isInstanceOf Given ObjectName and class name, true if MBean is of that class 

isRegistered true if supplied ObjectName is registered 

isRegistered true if supplied String version of ObjectName is registered 

getAttribute Given ObjectName and name of attribute, returns value of 

attribute 

getAttribute Given String version of ObjectName and name of attribute, 

returns value of attribute 

getAttributes Given ObjectName and array of attribute names, returns 

AttributeList 

getAttributes Given String version of ObjectName and attribute names, 

returns String of name value pairs 

setAttribute Given ObjectName and Attribute object, set attribute for MBean 

specified 

setAttribute Given String version of ObjectName, attribute name and 

attribute value, set attribute for MBean specified 

setAttributes Given ObjectName and AttributeList object, set attributes for 

the MBean specified 

invoke Given ObjectName, name of method, array of parameters and 

signature, invoke method on MBean specified 

invoke Given String version of ObjectName, name of method, String version 

of parameter list, invoke method on MBean specified. 

invoke Given String version of ObjectName, name of method, String version 

of parameter list, and String version of array of signatures, invoke 

method on MBean specified. 

makeObjectName Return an ObjectName built with the given string 

completeObjectName Return a String version of an object name given a 

template name 

trace Set the wsadmin trace specification 

help Show help information

all

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

Parameters	name -- java.lang.String
Return type	java.lang.String

Example output:

Name: WebSphere:cell=pongo,name=TraceService,mbeanIdentifier=cells/pongo/nodes/pongo/servers/servername/server.xml#TraceService_1,type=TraceService,node=pongo,process=servername
   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 -- java.lang.String
Return type	java.lang.String

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 -- java.lang.String
Return type	java.lang.String

Example output:

javax.management.modelmbean.RequiredModelMBean

constructors

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

Parameters	name -- java.lang.String
Return type	java.lang.String

Example output:

Constructors

description

Provides a description that the MBean defines by name.

Parameters	name -- java.lang.String
Return type	java.lang.String

Example output:

Managed object for overall server process.

help

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

Parameters	none
Return type	java.lang.String

WASX7028I: The following functions are supported by Help: 


attributes given an MBean, returns help for attributes 

operations given an MBean, returns help for operations 

given an MBean and an operation name, return signature 

information 

constructors given an MBean, returns help for constructors 

description given an MBean, returns help for description 

notifications given an MBean, returns help for notifications 

class name given an MBean, returns help for class name 

all given an MBean, returns help for all the above 

help returns this help text 

AdminControl returns general help text for the AdminControl object 

AdminConfig returns general help text for the AdminConfig object 

AdminApp returns general help text for the AdminApp object

message

Displays information for a message ID.

Parameters	message ID
Return type	java.lang.String

Example usage:

$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 -- java.lang.String
Return type	java.lang.String

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.

Parameters	name -- java.lang.String
Return type	java.lang.String

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)

operations

Provides the signature of the opname operation for the MBean defined by name.

Parameters	name -- java.lang.String, opname -- java.lang.String
Return type	java.lang.String

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.

AdminApp object for scripted administration
AdminControl object for scripted administration
AdminConfig object for scripted administration

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.