Identifying attributes and operations for running objects with the wsadmin tool

 

Identifying attributes and operations for running objects with the wsadmin tool

Before starting this task, the wsadmin tool must be running. See the Starting the wsadmin scripting client article for more information.

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

  1. Specify a running object.

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

    • Using Jacl:
      $Help attributes MBeanObjectName

    • Using Jython:
      Help.attributes(MBeanObjectName)

    where:

    $ is a 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 obtained in step 2

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

    • Using Jacl:
      $Help operations MBeanObjectname
      or
      $Help operations MBeanObjectname operationName

    • Using Jython:
      Help.operations(MBeanObjectname)
      or
      Help.operations(MBeanObjectname, operationName)

    where:

    $ is a 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 is a Help command
    MBeanObjectname is the string representation of the MBean object name obtained in step number 2
    operationName (optional) is the specified operation for which you want to obtain detailed information
    If you do not provide the operationName, all operations supported by the MBean return with the signature for each operation. If you specify operationName, only the operation that you specify 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:

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

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

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

    • Using Jacl:
      $Help operations $server stop

    • Using Jython:
      print Help.operations(server, 'stop')




Related concepts
AdminControl object for scripted administration
Help object for scripted administration

Related reference
Commands for the AdminControl object
Commands for the Help object