IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

mqsicacheadmin command

Use the mqsicacheadmin command to provide information about the global cache and complete basic administration.

Supported platforms

Windows systems.
Linux and UNIX systems.
z/OS®. Run this command by customizing and submitting BIPCCAD; see Contents of the broker PDSE

Purpose

The mqsicacheadmin command provides information about the global cache that is embedded in a broker. For example, you can find out the size of a map, list the hosts that are participating in the cache, and clear data from a map.

This command provides a subset of the commands that are available in the xscmd utility that is provided with WebSphere® eXtreme Scale. For more information about these commands, and the information that is returned, see WebSphere eXtreme Scale product documentation.

Usage notes

Before you run the mqsicacheadmin command, ensure that the broker is running and that the global cache is available. To provide the requested information, the command connects to the cache components.
Before you run this command, ensure that for all integration servers that host cache components, the enableJMX parameter is set to true. This parameter must be enabled so that the integration servers can provide administration information about the global cache. (For more information, see Parameter values for the cachemanager component.) When you use the default cache topology, or an XML policy file, this parameter is set to true automatically.
You do not need to restart the broker for this command to take effect. For example, the clearGrid command is effective immediately, and clears all the data for the specified map.
If you try to connect to a remote broker by specifying a connection parameter file (.broker), the command attempts to use WebSphere MQ Java™ client code. This option is not supported on z/OS, and returns the following error:
```
BIP1046E: Unable to connect with the broker (name)

The reported reason code is MQRC_ENVIRONMENT_ERROR. 
```
You must specify a local queue manager.

Syntax


>>-mqsicacheadmin--+------------+------------------------------->
                   '-BrokerName-'   

>--+-----------------------------+-- -c --command--------------->
   +- -cep --connectionEndPoints-+                  
   '- -n --brokerFileName--------'                  

>--+---------------+-------------------------------------------><
   '- -m --mapName-'

Parameters

BrokerName

(Optional) The name of the local broker to modify. If you do not specify this parameter, you must specify either the connectionEndPoints or brokerFileName parameter instead.

-cep connectionEndPoints

(Optional) The connection details for the cache catalog server that is running in the broker. The format of this parameter is hostName:listenerPort. If you do not specify this parameter, you must specify either the brokerName or brokerFileName parameter instead.

-n brokerFileName

(Optional) The file that contains the remote broker connection parameters (*.broker). If you do not specify this parameter, you must specify either the brokerName or connectionEndPoints parameter instead.

-c command

(Required) The command to run against the embedded cache. The following values are valid for this command.

clearGrid: Clears all data from the specified map in the embedded cache. This command has immediate effect and does not require a broker restart.
showMapSizes: Displays the sizes of all maps in the embedded cache.
placementServiceStatus: Displays the status of the ObjectGrid placement operation.
routetable: Displays the current routing table for all WebSphere eXtreme Scale shards and partitions in the embedded cache.
showPlacement: Lists all container servers and their shards in the embedded cache.
listHosts: Lists all hosts participating in the embedded cache.
"setTraceSpec -spec WebSphere eXtreme Scale_component": Sets the trace specification. This command has immediate effect and does not require a broker restart.; Use this command option only under instruction from IBM Support.; Double quotation marks must be used as shown.
"setCatTraceSpec -spec WebSphere eXtreme Scale_component": Sets the trace specification for all the catalog servers that are known by this process. This command has immediate effect and does not require a broker restart.; Use this command option only under instruction from IBM Support.; Double quotation marks must be used as shown.
getTraceSpec: Displays the trace specification.

-m mapName: (Optional) The name of the map against which to run the command. This parameter is required if the command clearGrid. For all other commands, this parameter is ignored.

Responses

In addition to standard command responses, the following responses are returned by this command.

BIP7186 Usage information for the mqsicacheadmin command
BIP7187 Output from the mqsicacheadmin command
BIP7188 Unable to determine connection parameters for the catalog servers in the global cache

Authorization

For information about platform-specific authorizations, see the following topics:

If you have enabled broker administration security, you must also set up the authority detailed in Tasks and authorizations for administration security.

Examples

Always enter the command on a single line; in some examples, line breaks have been added to enhance readability.

The following example displays the sizes of all maps in the embedded cache:

mqsicacheadmin brokerName -c showMapSizes

The following example uses the -cep parameter to connect to a catalog server, and displays the routing table for each WebSphere eXtreme Scale shard:

mqsicacheadmin -cep server.company.com:2800 -c routetable

The following example clears all data from the map named "myMap":

mqsicacheadmin brokerName -c clearGrid -m myMap

The following example sets the trace specification for all catalog and container servers that are known by this process:

mqsicacheadmin brokerName -c "setTraceSpec -spec ObjectGrid*=fine=enabled"

The following example sets the trace specification for all catalog servers that are known by this process:

mqsicacheadmin brokerName -c "setCatTraceSpec -spec ObjectGrid*=fine=enabled"

The following example displays the trace specification for all the catalog servers that are known by this process:

mqsicacheadmin brokerName -c getTraceSpec

bn23783_.htm |

Last updated Friday, 21 July 2017