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. The sample utility provides a method for parsing and discovering current deployment data, and can be used as a foundation for writing custom utilities.

Before you begin

  • [Version 2.0.0.3 and later] The xsadmin utility is provided as a sample of how you can create custom utilities for your deployment. The xscmd utility is provided as a supported utility for monitoring and administering your environment. For more information, see Administering with the xscmd utility.
  • The xsadmin utility is included in the WebSphere eXtreme Scale Client installation. See Installing WebSphere eXtreme Scale Client for more information.
  • For the xsadmin utility to display results, you must have data grids created and configured on your appliance. See Administering data grids for more information.

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]
  • xsadmin utility reference
    You can pass arguments to the xsadmin utility with two different methods: with a command-line argument, or with a properties file.
  • xsadmin tool to xscmd tool migration
    In previous releases, the xsadmin tool was a sample command-line utility to monitor the state of the environment. The xscmd tool has been introduced as an officially supported administrative and monitoring command-line tool. If you were previously using the xsadmin tool, consider migrating your commands to the new xscmd tool.
Parent topic: Monitoring