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

Note: The xsadmin utility has now been deprecated. Use the xscmd utility instead. The xscmd utility is provided as a supported utility for monitoring and administering your environment. For more information, see Administering with the xscmd utility.

You can define a properties file for the xsadmin utility with Version 7.1 Fix 1 or later. By creating a properties file, you can save some of the frequently used arguments, 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.

For more information about defining a properties file for the xsadmin utility, see Creating a configuration profile for the xsadmin utility.

Table 1. Arguments for the xsadmin utility
Command Line Argument	Equivalent Property Name in Properties File	Description and valid values
-bp	n/a	Indicates the listener port. Default:`2809`
-ch	n/a	Indicates the JMX host name for the catalog server. Default:`localhost`
-clear	n/a	Clears the specified map. Allows the following filters: `-fm`
-containers	n/a	For each data grid and map set, displays a list of container servers. Allows the following filters: `-fnp`
-continuous	n/a	Specify this flag if you want continuous map size results to monitor the data grid. When you run this command with the -mapsizes argument, the map size is displayed every 20 seconds.
-coregroups	n/a	Displays all core groups for the catalog server. This argument is used for advanced diagnostics.
-dismissLink <`catalog_service_domain`>	n/a	Removes a link between 2 catalog service domains. Provide the name of the foreign catalog service domain to which you previously connected with the -establishLink argument.
-dmgr	n/a	Indicates if you are connecting to a WebSphere® Application Server hosted catalog service. Default:`false`
-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	Connects the catalog service domain to a foreign catalog service domain. Use the following format: `-establishLink <foreign_domain_name> <host1:port1,host2:port2...>`. `foreign_domain_name` is the name of the foreign catalog service domain, and `host1:port1,host2:port2...` is a comma-separated list of catalog server host names and Object Request Broker (ORB) ports that are running in this catalog service domain.
-fc	n/a	Filters for only this container. If you are filtering container servers in a WebSphere Application Server Network Deployment environment, use the following format: `<cell_name>/<node_name>/<serverName_containerSuffix>` Use with the following arguments: -mapsizes, -teardown,-revisions
-fh	n/a	Filters for only this host. Use with the following arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec,-routetable
-fm	n/a	Filters only for this map. Use with the following arguments: -clear, -mapsizes
-fnp	n/a	Filters servers that have no primary shards. Use with the following arguments: -containers
-fp	n/a	Filters for only this partition. Use with the following arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec,-routetable
-fs	n/a	Filters for only this server. If you are filtering application servers in a WebSphere Application Server Network Deployment environment, use the following format: `<cell_name>/<node_name>/<server_name>` Use with the following arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec
-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. Use with the following arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec
-fz	n/a	Filters for only this zone. Use with the following arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec,-routetable
-force	n/a	Forces the action that is in the command, disabling any preemptive prompts. This argument is useful for running batched commands.
-g	n/a	Specifies the ObjectGrid name.
-getstatsspec	n/a	Displays the current statistics specification. You can set the statistics specification with the -setstatsspec argument. Allows the following filters: `-fst -fc -fz -fs -fh -fp`
-getTraceSpec	n/a	Displays the current trace specification. You can set the trace specification with the -settracespec argument. Allows the following filters: `-fst -fc -fz -fs -fh -fp`
-h	n/a	Displays the help for the xsadmin utility, which includes a list of arguments.
-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. Allows the following filters: `-fm -fst -fc -fz -fs -fh -fp`
-mbeanservers	n/a	Displays a list of all MBean server end points.
-overridequorum	n/a	Overrides the quorum setting so that container server events are not ignored during a data center failure scenario.
-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	Indicates the JMX port for the catalog server host. Default: 1099 or 9809 for a WebSphere Application Server host, 1099 for stand-alone 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	Displays the status of quorum for the catalog service.
-releaseShard <`container_server_name`> <`objectgrid_name`> <`map_set_name`> <`partition_name`>	n/a	Used in conjunction with the -reserveShard argument. The -releaseShard argument must be invoked after a shard has been reserved and placed. . The -releaseShard argument invokes the ContainerMBean.release() method.
-reserved	n/a	Used with the -containers argument to display only shards that have been reserved with the -reserveShard argument.
-reserveShard <`container_server_name`> <`objectgrid_name`> <`map_set_name`> <`partition_name`>	n/a	Moves a primary shard to the specified container server. The ContainerMBean.reserve() method is invoked by this argument.
-resumeBalancing <`objectgrid_name`> <`map_set_name`>	n/a	Attempts to balance requests. Enables future rebalancing attempts on the specified ObjectGrid and map set.
-revisions	n/a	Displays revision identifiers for a catalog service domain including: each data grid, partition number, partition type (primary or replica), catalog service domain, lifetime ID, and number of data revisions for each specific shard. You can use this argument to determine if an asynchronous replica or linked domain is caught up. This argument invokes the ObjectGridMBean.getKnownRevisions() method. Allows the following filters: `-fst -fc -fz -fs -fh -fp`
-routetable	n/a	Displays the current state of the data grid from a client server perspective. The route table is the information that an ObjectGrid client server uses to communicate with the data grid. Use the route table as a diagnostic aid when you are trying to identify connection problems or `TargetNotAvailable` exceptions. Required arguments: In a stand-alone environment, you must specify the -bp and -p parameters with this argument if you are not using the default values for the bootstrap listener port and JMX port for the catalog server host. Allows the following filters: `-fz -fh -fp`
-settracespec <`trace_string`>	n/a	Enables trace on servers during run time. See the following example: `-setTraceSpec "ObjectGridReplication=all=enabled"` See Collecting trace and Server trace options for more information about the trace strings that you can specify. Allows the following filters: `-fst -fc -fz -fs -fh -fp`
-swapShardWithPrimary <`container_server_name`> <`objectgrid_name`> <`map_set_name`> <`partition_name`>	n/a	Swaps the specified replica shard from the specified container server with the primary shard. By running this command, you can manually balance primary shards when needed.
-setstatsspec <`stats_spec`>	n/a	Enables statistics gathering. This argument invokes the DynamicServerMBean.setStatsSpec and DynamicServerMBean.getStatsSpec methods. For more information, see Enabling statistics. Allows the following filters: `-fm -fst -fc -fz -fs -fh -fp`
-suspendBalancing <`objectgrid_name`> <`map_set_name`>	n/a	Prevents future attempts to balance the specified ObjectGrid and map set.
-ssl	n/a	Indicates that Secure Sockets Layer (SSL) is enabled.
-teardown	n/a	Stops a list or group of catalog and container servers. Allows the following filters: `-fst -fc -fz -fs -fh -fp` Format to provide a list of servers: `server_name_1,server_name_2 ...` To stop all servers in a zone, include the -fz argument: `–fz <zone_name>` To stop all servers on a host, include the -fh argument: `–fh <host_name>`
-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. See Verbose option for the xsadmin utility for more information.
-xml	n/a	Prints the unfiltered output from the PlacementServiceMBean.listObjectGridPlacement() method. The other xsadmin arguments filter the output of this method and organize the data into a more consumable format.