Monitoring with the xsadmin utility

With the xsadmin utility, you can format and display textual information about the data grids that are running on your WebSphere® DataPower® XC10 Appliance.

Before you begin

About this task

The xsadmin utility uses an implementation of Managed Beans (MBeans). You can extend the capabilities of this utility by using the interfaces in the com.ibm.websphere.objectgrid.management package. You can look at the source code of the xsadmin application in the wxs_client_home/samples/xsadmin.jar file in a stand-alone installation, or in the wxs_client_home/optionalLibraries/ObjectGrid/xsadmin.jar file in a WebSphere Application Server installation.

Procedure

  1. Download the active truststore for the appliance to the client. From the WebSphere DataPower XC10 Appliance user interface, click Appliance > Settings > Transport Layer Security > Download active truststore. The default truststore file is the xsatruststore.jks file. The default password for this file is: xc10pass.
  2. On the command line, set the JAVA_HOME environment variable.
    • [Unix] export JAVA_HOME=javaHome
    • [Windows] set JAVA_HOME=javaHome
  3. Go to the bin directory.
    cd wxs_client_home/bin
  4. Run the xsadmin utility. To connect to the appliance, you must include the security arguments for the truststore that you downloaded, the user name and password you use to log in to the appliance, and the host name of your appliance each time you run the command:
    xsadmin.sh -trustPath xsatruststore.jks -trustType jks -ssl -trustPass xc10pass -username xcadmin 
    -password xcadmin -ch myxc10.mycompany.com [additional_xsadmin_parameters]
    You can also create a configuration file to save these parameters. An example of a properties file with the required parameters included follows:
    XSADMIN_TRUST_PATH=xsatruststore.jks
    XSADMIN_TRUST_TYPE=JKS
    XSADMIN_TRUST_PASS=xc10pass
    XSADMIN_USERNAME=xcadmin
    XSADMIN_PASSWORD=xcadmin
    To run the xsadmin utility with the properties file, use the -profile argument to indicate the location of the properties file.
    xsadmin.sh -profile myxc10.properties -ssl -ch myxc10.mycompany.com [additional_xsadmin_parameters]