Modifying MBean attributes with the wsadmin tool

• Using the wsadmin tool to retrieve and set MBean attributes
• Using the wsadmin tool to import and export MBean attributes

// This section provides sample commands to start and use the wsadmin tool.
// For illustrative purposes, an operating system command prompt is denoted by the
// hash character, "#", and the wsadmin command prompt is denoted by "wsadmin>". 
//
// There are HCL Compass Web server wsadmin tool scripts that provide several convenience 
// methods and functions.  By default, these scripts are located in the following
// directory:  
// On Windows:  
//      "C:\Program Files\HCL\Compass\CM\scripts" 
// 
//
// Open a command prompt and set your default directory to the location of
// the HCL Compass Web server wsadmin tool scripts.  For example: 
//
// On Windows:
# cd "C:\Program Files\HCL\Compass\CM\scripts"
//
// On the UNIX system and Linux:
# cd /opt/compass/common/CM/scripts
//
// Set the WAS_BIN environment variable to the location of the wsadmin tool 
// by using the syntax appropriate for your preferred shell.  For example:
//
// On Windows:
# set WAS_BIN="C:\Program Files\HCL\Compass\eWAS\bin" 

// On the UNIX system and Linux:
# WAS_BIN=/opt/compass/common/eWAS/bin

// Start the wsadmin tool by specifying the HCL Compass Web server profile name.  
// The default HCL Compass Web server profile name is 'cmprofile'.  For example:
//
// On Windows:
# %WAS_BIN%\wsadmin -profileName cmprofile

// On the UNIX system and Linux:
# $WAS_BIN/wsadmin.sh -profileName cmprofile

// The following wsadmin command loads the HCL Compass Web server wsadmin convenience functions:
wsadmin> source teamAdminUtils.jacl

// The next command is an example of how to display some useful HCL Compass Web server commands. 
// The getTeamServer function is useful for establishing a pointer to the top level 
// TeamServerMBean, and will help get and set individual TeamServerMBean attributes.
//
wsadmin> info proc *Team*
    startTeamEAR stopTeamEAR getTeamServer

// The following command displays the available 'dump' commands for quick and 
// easy viewing of the MBean values:
wsadmin> info proc dump*

   dumpAllServers dumpAll dumpTeamServer dumpCcServers dumpCqServerFactory 
   dumpCcServerFactory dumpCqServers


// The next command uses the convenience command 'getTeamServer' to set up the 
// variable 't', which can then be used to access TeamServerMBean attributes:
wsadmin> set t [getTeamServer]

// Retrieve the TeamServerMBean attribute values using the variable 't':
wsadmin> $AdminControl getAttributes $t

{cqServerFactory WebSphere:cell=testhost2Node01Cell,version=6.1.0.0,spec=1.0,name=CqServerFactoryMBeanId,
    mbeanIdentifier=CqServerFactoryMBeanId,type=stp.management.CqServerFactoryMBean,node=testhost2Node01,
    process=server1}

{oncrpcBufferLimit 100}
{cqLoginSessionWaitTimeout 300}
{oncrpcInterruptLimit 1000}
{sessionReaperThreadDelay 900}
{sessionQueryObjectTimeout 1800}
{oncrpcServers {
{cqLoginSessionTimeout 1800}
{cqFulltextSearchRecordHitLimit 100}
{ejbBufferLimit 100}
{sessionRecordObjectTimeout 10800}
{cqFulltextSearchPageSize 25}
{numberOfActiveSessions 0}
{sessionObjectDefaultTimeout 1800}
{maxProcureServerAttempts 6}
{cqFulltextSearchCacheSize 1000}
{maxCqSessionsPerUser 2}
{totalNumberOfOncrpcServers 0}
{numberOfHttpSessionsCreated 0}
{procureServerInterval 60}



// Following is a more convenient way to retrieve all of the TeamServerMBean attributes:
wsadmin> dumpTeamServer

TeamServerMBean Attributes:
====================

{cqServerFactory WebSphere:cell=testhost2Node01Cell,version=6.1.0.0,spec=1.0,name=CqServerFactoryMBeanId,
    mbeanIdentifier=CqServerFactoryMBeanId,type=stp.management.CqServerFactoryMBean,node=testhost2Node01,
    process=server1}


// Other 'get' convenience commands include: getCqServerFactory, getTeamServer 
// and getOncrpcServers.


// The next command sets up the variable 'cq' for accessing the CqServerFactoryMBean
// attributes. Note that the variable 't' defined in a previous command is used to 
// obtain a pointer to the TeamServerMBean's cqServerFactory attribute value; the 
// variable 'cq' can then be used to access the attributes in the CqServerFactoryMBean:
wsadmin> set cq [$AdminControl getAttribute $t cqServerFactory]

// Following is a more convenient way to set up the variable 'cq':
wsadmin>set cq [getCqServerFactory]

// The next command retrieves the CqServerFactoryMBean attribute values using the
// 'cq' variable defined previously:
wsadmin> $AdminControl getAttributes $cq
. . . 

// The following command sets up the variable 'os' to use for accessing the list of 
// ONCRPC server MBeans, each of which represents a specific ONCRPC backend server.  
// The command uses one of the convenience methods defined in the teamAdminUtils.jacl 
// script that was 'sourced' at the beginning of this session:
wsadmin> set os [$AdminControl invoke $t getOncrpcServers]
        .   .   .   

        // A list of the running oncrpc backend servers is displayed. The first 
        // oncrpc server is at index 0 (zero), the second is at index 1, and so on...


// The next command sets up the variable 'o' for accessing the first oncrpc server MBean 
// displayed in the output from the previous command.  This level of MBean attribute 
// access (that is, specific oncrpc server MBeans) is tricky because the backend oncrpc
// server processes are transient and might be dismissed before you can access them.
wsadmin> set o [getOnc 0]      // '0' is the index number of the first backend server
                               //  listed in the output of the previous command. 

// The following command retrieves the MBean attribute values for the CQ oncrpc server 
// defined by the variable 'o':
wsadmin> $AdminControl getAttributes $o
        {workerThreadCount 16}
        {serverState 1}
        {activeStatefulHttpSessions 0}
        {port 3431}
        {oncrpcCalls 7}
        {recycleServerHttpSessionLimit 500}
        {serverId {HCL Compass - 0
        {serverType HCL Compass}
        {hostname testhost2}
        {activeHttpSessions 0}
        {totalHttpSessions 1}


// The next commands set and then get the recycleServerHttpSessionLimit attribute 
// in the CQ oncrpc server defined previously by the variable 'o':
wsadmin> $AdminControl setAttribute $o recycleServerHttpSessionLimit 501

wsadmin> $AdminControl getAttribute $o recycleServerHttpSessionLimit
     501


// The remaining commands show a few more oncrpc server MBean accesses and their output.
// Remember that the list of ONCRPC servers is transient; using the dump commands such
// as dumpCqServers or dumpAllServers is much more convenient:

wsadmin> listOnc
       "WebSphere:cell=testhost2Node02Cell,version=6.1.0.0,spec=1.0,
       name=Compass - 11,mbeanIdentifier=Compass - 11,
       type=stp.management.CqOncrpcServerMBean,node=testhost2Node02,
       process=server1"
       

// Here are examples of what you see when using the convenience dump commands:
wsadmin> dumpAllServers

ONCRPC Server: Compass - 0
============
{workerThreadCount 10}
{serverState 1}
{activeStatefulHttpSessions 0}
{port 3693}
{oncrpcCalls 1}
{recycleServerHttpSessionLimit 500}
{serverStartTime 1215633895763}
{serverId {HCL Compass - 0
{recycleReasonCode 0}
{serverType HCL Compass}
{hostname testhost2}
{activeHttpSessions 0}
{totalHttpSessions 0}


wsadmin> dumpCqServers
CQRPC Server: HCL Compass - 0
===========
{workerThreadCount 10}
{serverState 1}
{activeStatefulHttpSessions 0}
{port 3693}
{oncrpcCalls 1}
{recycleServerHttpSessionLimit 500}
{serverStartTime 1215633895763}
{serverId {HCL Compass - 0
{recycleReasonCode 0}
{serverType HCL Compass}
{hostname duke2}
{activeHttpSessions 0}
{totalHttpSessions 0}


wsadmin> dumpCqServerFactory
CqServerFactoryMBean Attributes:
==========================
{serverWorkerThreadCount 10}
{recycleServerLifetimeLimit 14400}
{recyclingPeriod 3600}
{recycleServerOncrpcCallLimit 500000}
{recycleServerHttpSessionLimit 500}
{maximumActiveServers 4}
{activeHttpSessionThreshold 40}


wsadmin> dumpAll
     // The output of this command is a dump of all of the MBean attribute values, including
     // all of the currently running backend ONCRPC server processes.

// This wsadmin command loads all of the convenience commands and methods,
// including the importFile and exportToFile commands.  These commands 
// enable retrieving and updating MBean attribute values, and a simple 
// way to capture specific configurations.  If the HCL Compass Web server
// (referred to in previous releases as CM Server) is not functioning
// properly, then you can import a previously captured configuration in
// real time. 
wsadmin> source teamAdminUtils.jacl

// Use the exportToFile command if you want to capture a snapshot of 
// the TeamServerMBean and CqServerFactoryMBean MBeans.  Specify the 
// full path name in which to store the file.  You can edit the resulting
// properties file by using a text editor, and import the file by using
// the importFile command.
// Important: You must use forward slashes in the path name for these commands.
wsadmin> exportToFile C:/temp/CmServer.properties

File "C:/temp/CmServer.properties" does not exist, proceeding with export...
Retrieving MBeans...
Exporting TeamServerMBean.sessionReaperThreadDelay...
Exporting TeamServerMBean.cqLoginSessionTimeout...
Exporting TeamServerMBean.cqLoginSessionWaitTimeout...
Exporting TeamServerMBean.sessionObjectDefaultTimeout...
Exporting TeamServerMBean.sessionQueryObjectTimeout...
Exporting TeamServerMBean.sessionRecordObjectTimeout...
Exporting TeamServerMBean.oncrpcBufferLimit...
Exporting TeamServerMBean.oncrpcInterruptLimit...
Exporting TeamServerMBean.ejbBufferLimit...
Exporting TeamServerMBean.cqFulltextSearchPageSize...
Exporting TeamServerMBean.cqFulltextSearchCacheSize...
Exporting TeamServerMBean.cqFulltextSearchRecordHitLimit...
Exporting TeamServerMBean.procureServerInterval...
Exporting TeamServerMBean.maxProcureServerAttempts...
Exporting TeamServerMBean.maxCqSessionsPerUser...
Exporting CqServerFactoryMBean.serverWorkerThreadCount...
Exporting CqServerFactoryMBean.activeHttpSessionThreshold...
Exporting CqServerFactoryMBean.maximumActiveServers...
Exporting CqServerFactoryMBean.recycleServerHttpSessionLimit...
Exporting CqServerFactoryMBean.recycleServerLifetimeLimit...
Exporting CqServerFactoryMBean.recycleServerOncrpcCallLimit...
Exporting CqServerFactoryMBean.recyclingPeriod...

wsadmin> importFile C:/temp/CmServer.properties

File "C:/temp/CmServer.properties" found, proceeding with import...
Importing value '900' into property sessionReaperThreadDelay in MBean TeamServerMBean
    Old value=900
    New value=900
Importing value '1803' into property cqLoginSessionTimeout in MBean TeamServerMBean
    Old value=1803
    New value=1803
Importing value '300' into property cqLoginSessionWaitTimeout in MBean TeamServerMBean
    Old value=300
    New value=300
Importing value '1800' into property sessionObjectDefaultTimeout in MBean TeamServerMBean
    Old value=1800
    New value=1800
   . . .

// If you try to export to a file that already exists, a time stamp is appended to the
// file name that you specify in the command:
wsadmin> exportToFile C:/temp/CmServer.properties

File "C:/temp/CmServer.properties" already exists; appending date to file name.
exportFilePath is now: C:/temp/CmServer.properties_2008-07-09_16-27-11
Retrieving MBeans...
Exporting TeamServerMBean.sessionReaperThreadDelay...

// Here is what a typical exported file looks like:
C:\> type c:\temp\CmServer.properties
# Export of HCL Compass Web server MBean attributes, created: 2008-07-09_16-22-29
#
#
# TeamServerMBean writable attributes
#
TeamServerMBean.sessionReaperThreadDelay=900
TeamServerMBean.cqLoginSessionTimeout=1803
TeamServerMBean.cqLoginSessionWaitTimeout=300
TeamServerMBean.sessionObjectDefaultTimeout=1800
TeamServerMBean.sessionQueryObjectTimeout=1803
TeamServerMBean.sessionRecordObjectTimeout=10800
TeamServerMBean.oncrpcBufferLimit=100
TeamServerMBean.oncrpcInterruptLimit=1000
TeamServerMBean.ejbBufferLimit=100
TeamServerMBean.cqFulltextSearchPageSize=25
TeamServerMBean.cqFulltextSearchCacheSize=1000
TeamServerMBean.cqFulltextSearchRecordHitLimit=100
TeamServerMBean.procureServerInterval=60
TeamServerMBean.maxProcureServerAttempts=6
TeamServerMBean.maxCqSessionsPerUser=2
#
# CqServerFactoryMBean writable attributes
#
CqServerFactoryMBean.serverWorkerThreadCount=10
CqServerFactoryMBean.activeHttpSessionThreshold=40
CqServerFactoryMBean.maximumActiveServers=4
CqServerFactoryMBean.recycleServerHttpSessionLimit=500
CqServerFactoryMBean.recycleServerLifetimeLimit=14400
CqServerFactoryMBean.recycleServerOncrpcCallLimit=500000
CqServerFactoryMBean.recyclingPeriod=3600