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 arguments

You can define a properties file for the xsadmin utility with WebSphere® eXtreme Scale Client Version 7.1 Fix 1 or later. By creating a properties file, you can save some of the frequently used parameters, such as the user name. The properties that you can add to a properties file are in the following table. If you specify both a property in a properties file and the equivalent command-line argument, the command-line argument value overrides the properties file value.

Table 1. Parameters for the xsadmin utility
Command Line Argument Equivalent Property Name in Properties File Description and valid values
-ch n/a

Indicates the JMX host name for the catalog server.

Default:localhost

-containers n/a For each data grid and map set, displays a list of container servers.
-continuous n/a Specify this flag if you want continuous map size results.
-coregroups n/a Displays all core groups for the catalog server.
-dismissLink <catalog_service_domain> n/a

This command-line argument does not apply for WebSphere DataPower® XC10 Appliance configurations.

-dmgr n/a

This command-line argument does not apply for WebSphere DataPower XC10 Appliance configurations.

-empties n/a Specify this flag if you want to show empty containers in the output.
-establishLink <foreign_domain_name> <host1:port1,host2:port2...> n/a

This command-line argument does not apply for WebSphere DataPower XC10 Appliance configurations.

-fnp n/a Filters servers that have no primary shards.
-fh n/a Filters for only this host.
-fc n/a Filters for only this container.
-fp n/a Filters for only this partition.
-fs n/a Filters for only this server.
-fz n/a Filters for only this zone.
-fst n/a Filters for only this shard type. Specify P for primary shards only, A for asynchronous replica shards only, and S for synchronous replica shards only.
-force n/a Forces the action that is in the command, disabling any preemptive prompts. This parameter is useful for running batched commands.
-g n/a Specifies the ObjectGrid name.
-getstatsspec n/a Displays the current trace specification. You can set the trace specification with the -setstatsspec parameter.
-h n/a Displays the help for the xsadmin utility, which includes a list of parameters.
-hosts n/a Displays all of the hosts in the configuration.
-jmxUrl XSADMIN_JMX_URL Specifies the address of a JMX API connector server in the following format: service:jmx:protocol:sap. The protocol and sap variable definitions follow:
protocol
Specifies the transport protocol to be used to connect to the connector server.
sap
Specifies the address at which the connector server is found.
For more information about the format of the JMX service URL, see Class JMXServiceURL (Java 2 Platform SE 5.0).
-l n/a Displays all known data grids and map sets.
-m n/a Specifies the name of the map set.
-mapsizes n/a Displays the size of each map on the catalog server to verify that key distribution is uniform over the shards.
-mbeanservers n/a Displays a list of all MBean server end points.
-nopredetermine n/a Specify this flag if you want to disable predetermination of necessary endpoints.
-overridequorum n/a

This command-line argument does not apply for WebSphere DataPower XC10 Appliance configurations.

-password XSADMIN_PASSWORD Specifies the password to log in to the xsadmin utility. Do not specify the password in your properties file if you want your password to remain secure.
-p n/a

This command-line argument does not apply for WebSphere DataPower XC10 Appliance configurations.

-placementStatus n/a Displays the configured placement and runtime placement of your configuration. You can scope the output to a combination of data grids and map sets, or for the entire configuration:
  • Entire configuration:
    -placementStatus
  • For a specific data grid:
    -placementStatus -g my_grid
  • For a specific map set:
    -placementStatus -m my_mapset
  • For a specific data grid and map set:
    -placementStatus  -g my_grid 
    -m my_mapset
-primaries n/a Displays a list of the primary shards.
-profile n/a Specifies a fully qualified path to the properties file for the xsadmin utility.
-quorumstatus n/a

This command-line argument does not apply for WebSphere DataPower XC10 Appliance configurations.

-releaseShard <container_server_name> <objectgrid_name> <map_set_name> <partition_name> n/a Releases the primary shard from the specified container server.
-reserved n/a Used with the -containers command to display only shards that are reserved.
-reserveShard <container_server_name> <objectgrid_name> <map_set_name> <partition_name> n/a Reserves the primary shard from the specified container server.
-revisions n/a Displays all known revision history.
-routetable n/a Displays the current routing table by simulating a new client connection to the data grid.
-settracespec <trace_string> n/a

This command-line argument does not apply for WebSphere DataPower XC10 Appliance configurations. See Working with the WebSphere DataPower XC10 Appliance log files for more information about configuring trace on the appliance.

-setstatsspec <stats_spec> n/a Enables statistics gathering.
-ssl n/a Indicates that Secure Sockets Layer (SSL) is enabled.
-teardown n/a

This command-line argument does not apply for WebSphere DataPower XC10 Appliance configurations.

-triggerPlacement n/a Forces shard placement to run, ignoring the configured numInitialContainers value in the deployment XML file. You can use this argument when you are performing maintenance on your servers to allow shard placement to continue running, even though the numInitialContainers value is lower than the configured value.
-trustPass XSADMIN_TRUST_PASS Specifies the password for the specified truststore.
-trustPath XSADMIN_TRUST_PATH Specifies a path to the truststore file.

Example: etc/test/security/server.public

-trustType XSADMIN_TRUST_TYPE Specifies the type of truststore.

Valid values: JKS, JCEK, PKCS12, and so on.

-unassigned n/a Displays a list of shards that cannot be placed on the data grid. Shards cannot be placed when the placement service has a constraint that is preventing placement.
-username XSADMIN_USERNAME Specifies the user name to log in to the xsadmin utility.
-v n/a Enables the verbose command-line action. Use this flag if you are using environment variables, a properties file, or both to specify certain command-line arguments, and want to view their values.
-xml n/a Displays an XML representation of the known topology.