Identifying attributes and operations for running objects using the wsadmin scripting tool

Use scripting to identify attributes and operations for running objects.

See the topic about starting the wsadmin scripting client.

Use the attributes or operations commands of the Help object to find information on a running MBean in the server.

Tasks

1. Specify a running object.

2. Use the attributes command to display the attributes of the running object:
   • Jacl:

     $Help attributes MBeanObjectName
     

   • Jython:

     Help.attributes(MBeanObjectName)
     

   Attribute	Definition
   $	Jacl operator for substituting a variable name with its value
   Help	is the object that provides general help and information for running MBeans in the connected server process
   attributes	is a Help command
   MBeanObjectName	is the string representation of the MBean object name that is obtained in step 2

3. Use the operations command to find out the operations supported by the MBean:
   • Jacl:

     $Help operations MBeanObjectname
     

     or

     $Help operations MBeanObjectname operationName
     

   • Jython:

     Help.operations(MBeanObjectname)
     

     or

     Help.operations(MBeanObjectname, operationName)
     

   Attribute	Definition
   $	Jacl operator for substituting a variable name with its value
   Help	is the object that provides general help and information for running MBeans in the connected server process
   operations	Help command
   MBeanObjectname	is the string representation of the MBean object name that is obtained in step number 2
   operationName	(optional) is the specified operation from which we want to obtain detailed information

   If we do not provide the operationName value, all the operations supported by the MBean return with the signature for each operation. If we specify the operationName value, only the operation specified returns and it contains details which include the input parameters and the return value.

   To display the operations for the server MBean, use the following example:

   • Jacl:

     set server [$AdminControl completeObjectName type=Server,name=server1,*]
     $Help operations $server
     

   • Jython:

     server = AdminControl.completeObjectName('type=Server,name=server1,*')
     print Help.operations(server)
     

   To display detailed information about the stop operation, use the following example:

   • Jacl:

     $Help operations $server stop
     

   • Jython:

     print Help.operations(server, 'stop')
     

Related:

Help object for scripted administration

Start the wsadmin scripting client

wsadmin AdminControl

Commands for the AdminControl object

Commands for the Help object