Administration guide > Monitor the environment > Monitoring with the xsAdmin sample utility



Create a configuration profile for the xsadmin utility

There are many ways for you to customize the sample xsadmin utility for the requirements.

The following sections show you how to create a profile for the xsadmin sample utility for WebSphere eXtreme Scale. With a profile, you can reduce the length of the commands for frequently specified parameters.


Procedure

  1. Before moving on to creating and using a profile, have begun at least a basic deployment of eXtreme Scale. This requires at least one catalog server and at least one container server. For more information, see startOgServer.

  2. Create a configuration properties file and place it at the following path:

    /opt/ibm/WebSphere/wxs71/ObjectGrid/security/<my.properties>

    You can replace <my.properties> with your choice of what to name the file.

    Set the following properties in the file:

    • XSADMIN_TRUST_TYPE=jks

    • XSADMIN_TRUST_PATH=/opt/ibm/WebSphere/wxs71/ObjectGrid/bin/security/key.jks

    • XSADMIN_USERNAME=ogadmin

  3. Run one of the following choices from the command line and observe the output on the screen. The first bullet describes the text from a verbose setting, and the second bullet shows non-verbose output.

    • Verbose command line: ./xsadmin.sh -l -v -password xsadmin -ssl -trustPass ogpass -profile /opt/ibm/WebSphere/wxs71/ObjectGrid/security/<my.properties>

      XSADMIN_USERNAME=<unspecified>
      XSADMIN_PASSWORD=xsadmin
      XSADMIN_TRUST_PATH=<unspecified>
      XSADMIN_TRUST_TYPE=<unspecified>
      XSADMIN_TRUST_PASS=ogpass
      XSADMIN_PROFILE=/opt/ibm/WebSphere/wxs71/ObjectGrid/security/my.properties
      XSADMIN_JMX_HOST=localhost   
      <= NOTE this is default
      XSADMIN_JMX_PORT=portNotSpecified
      <= NOTE this is default
      XSADMIN_JMX_URL=<unspecified>
      XSADMIN_DMGR=false
      <= NOTE this is default
      **********************************
      Properities file specified arguments
      ************************************
      XSADMIN_USERNAME=ogadmin
      XSADMIN_PASSWORD=<unspecified>
      XSADMIN_TRUST_PATH=/opt/ibm/WebSphere/wxs71/ObjectGrid/bin/security/key.jks
      XSADMIN_TRUST_TYPE=jks
      XSADMIN_TRUST_PASS=<unspecified>
      XSADMIN_JMX_HOST=<unspecified>
      XSADMIN_JMX_PORT=<unspecified>
      XSADMIN_JMX_URL=<unspecified>
      XSADMIN_DMGR=<unspecified>
      **********************************
      Environment-specified arguments
      **********************************
      XSADMIN_USERNAME=<unspecified>
      XSADMIN_PASSWORD=<unspecified>
      XSADMIN_TRUST_PATH=<unspecified>
      XSADMIN_TRUST_TYPE=<unspecified>
      XSADMIN_TRUST_PASS=<unspecified>
      XSADMIN_JMX_HOST=<unspecified>
      XSADMIN_JMX_PORT=<unspecified>
      XSADMIN_JMX_URL=<unspecified>
      XSADMIN_DMGR=<unspecified>
      **********************************
      Effective command line arguments
      **********************************
      XSADMIN_USERNAME=ogadmin
      XSADMIN_PASSWORD=xsadmin
      XSADMIN_TRUST_PATH=/opt/ibm/WebSphere/wxs71/ObjectGrid/bin/security/key.jks
      XSADMIN_TRUST_TYPE=jks
      XSADMIN_TRUST_PASS=ogpass
      XSADMIN_PROFILE=/opt/ibm/WebSphere/wxs71/ObjectGrid/security/my.properties
      XSADMIN_JMX_HOST=localhost
      XSADMIN_JMX_PORT=portNotSpecified
      XSADMIN_JMX_URL=<unspecified>
      XSADMIN_DMGR=false
      SSL authentication enabled: true
      **********************************
      Connecting to Catalog service at localhost:1099
      *** Show all 'objectGrid:mapset' names 
      Grid Name  MapSet Name   
      accounting defaultMapSet 
      

    • Non-verbose command line: without -v parameter

      Connect to Catalog service at localhost:1099
      *** Show all 'objectGrid:mapset' names 
      Grid Name  MapSet Name   
      accounting defaultMapSet 
      


Parent topic:

Monitor with the xsAdmin sample utility