See the WebSphere eXtreme Scale Wiki for links to eXtreme Scale Version 7.0 documentation.
If you log in
with your developerWorks ID, you can leave comments and feedback for the development team.
The xsAdmin sample utility allows users to format and display textual information regarding a specified ObjectGrid topology. This sample provides a method for parsing and discovering current deployment data, and can be used as a foundation for writing custom utilities. This topic describes several use-case scenarios for xsAdmin, and provides instructions for running the client.
Before you begin
The xsAdmin sample utility requires ObjectGrid version 6.1.0.3 or later, however version 6.1.0.5 or later is recommended and includes additional features and bug fixes.
About this task
The xsAdmin sample utility is used to provide feedback on the current layout of the grid as well as specific state, such as map content. The layout of the grid in this task consists of a single ObjectGrid, named "ObjectGridA" with one defined map, named "MapA", belonging to the mapset, entitled "MapSetA". This task will walk you through displaying all active containers within a grid, and will then print out filtered metrics regarding the map size of MapA. To see all possible command options, run the xsAdmin utility without any arguments or with the "-help" option.
Launching the client
The following are examples on how to run the xsAdmin tool and the expected output.
Display the on-line help
- Set the JAVA_HOME environment variable:
- cd objectgridRoot/bin
- Launch the xsAdmin.sh utility using the following command:
- The command-line help text is displayed.
Take note on the "required arguments" section of the help message, as the user must pass in only one of the listed options for the utility to work. If no "-g" or "-m" option is specified, xsAdmin will print out information for every grid in the topology.
Display all on-line containers for an ObjectGrid
- Set the JAVA_HOME environment variable:
- cd objectgridRoot/bin
- Launch the xsAdmin.sh utility using the following command:
xsadmin.sh -g ObjectGridA -m MapSetA -containers
xsadmin.bat -g ObjectGridA -m MapSetA -containers
- All container information is displayed.
Results
This administrative utility is provided as a sample only and is not to be
considered a fully supported component of the WebSphere eXtreme Scale product
Connecting to Catalog service at localhost:1099
*** Show all online containers for grid - ObjectGridA & mapset - MapSetA
Host: 192.168.0.186
Container: server1_C-0, Server:server1, Zone:DefaultZone
P:0 Primary
Num containers matching = 1
Total known containers = 1
Total known hosts = 1
Display the number of entries in all maps for an ObjectGrid
- Set the JAVA_HOME environment variable:
- cd objectgridRoot/bin
- Launch the xsAdmin.sh utility using the following command:
- xsadmin.sh -g ObjectGridA -m MapSetA -mapsizes -fm MapA
- xsadmin.bat -g ObjectGridA -m MapSetA -mapsizes -fm MapA
- The size of the specified map is displayed.
Results
This administrative utility is provided as a sample only and is not to be
considered a fully supported component of the WebSphere eXtreme Scale product
Connecting to Catalog service at localhost:1099
************Displaying Results for Grid - ObjectGridA, MapSet - MapSetA*********
*** Listing Maps for server1 ***
Map Name: MapA Partition #: 0 Map Size: 0 Shard Type: Primary
Server Total: 0
Specifying the JMX port for a catalog service.
The xsAdmin sample utility connects to the MBean server running on a catalog server. A catalog server may run in a standalone process, WebSphere Application Server process, or embedded within a custom application process. Use the "-ch" option to specify the catalog service host name, and the "-p" option to specify the catalog service naming port.
- Set the JAVA_HOME environment variable:
- cd objectgridRoot/bin
- Launch the xsAdmin.sh utility using the following command:
- xsadmin.sh -g ObjectGridA -m MapSetA -mapsizes -fm MapA -ch CatalogMachine -p 6645
- xsadmin.bat -g ObjectGridA -m MapSetA -mapsizes -fm MapA -ch CatalogMachine -p 6645
- The size of the specified map is displayed.
Results
This administrative utility is provided as a sample only and is not to be
considered a fully supported component of the WebSphere eXtreme Scale product
Connecting to Catalog service at CatalogMachine:6645
************Displaying Results for Grid - ObjectGridA, MapSet - MapSetA*********
*** Listing Maps for server1 ***
Map Name: MapA Partition #: 0 Map Size: 0 Shard Type: Primary
Server Total: 0
Connecting to a catalog service hosted in a WebSphere Application Server process
The "-dmgr" option is required when connecting to a catalog service hosted by any WebSphere Application Server process or cluster of processes. Use the "-ch" option to specify the host name if not "localhost", and the "-p" option to override the catalog service bootstrap port, which uses the process's BOOTSTRAP_ADDRESS. The -p option is only needed if the BOOTSTRAP_ADDRESS is not set to the default of 9809.
Note: The standalone version of WebSphere eXtreme Scale cannot be used to connect to a catalog service hosted by a WebSphere Application Server process. Use the xsAdmin script included in the wasRoot/bin directory, which is available when the installing WebSphere eXtreme Scale on WebSphere Application Server or WebSphere Network Deployment.
- cd wasRoot/bin
- Launch the xsAdmin.sh utility using the following command:
- xsadmin.sh -g ObjectGridA -m MapSetA -mapsizes -fm MapA -dmgr
- xsadmin.bat -g ObjectGridA -m MapSetA -mapsizes -fm MapA -dmgr
- The size of the specified map is displayed.
Results
This administrative utility is provided as a sample only and is not to be
considered a fully supported component of the WebSphere eXtreme Scale product
Connecting to Catalog service at localhost:9809
************Displaying Results for Grid - ObjectGridA, MapSet - MapSetA*********
*** Listing Maps for server1 ***
Map Name: MapA Partition #: 0 Map Size: 0 Shard Type: Primary
Server Total: 0
Additional Information
© Copyright IBM Corporation 2007,2009. All Rights Reserved.
