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 integration node PDSE
Purpose
The mqsicacheadmin command provides information about the global cache that is embedded in an integration node. 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 online.
Usage notes
- Before you run the mqsicacheadmin command, ensure that the integration node 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 integration node 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 integration node 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:
You must specify a local queue manager.BIP1046E: Unable to connect with the integration node (name) The reported reason code is MQRC_ENVIRONMENT_ERROR.
Syntax
Parameters
- integrationNodeName
- (Optional) The name of the local integration node to modify. If
you do not specify this parameter, you must specify either
the connectionEndPoints or integrationNodeFileName parameter
instead.
- -cep connectionEndPoints
- (Optional) The connection details for the cache catalog server
that is running in the integration node. The format of this
parameter is hostName:listenerPort.
If you do not specify this parameter, you must specify either
the integrationNodeName or
integrationNodeFileName parameter
instead.
- -n integrationNodeFileName
- (Optional) The file that contains the remote integration node
connection parameters (*.broker). If
you do not specify this parameter, you must specify either
the integrationNodeName or
connectionEndPoints parameter instead.
- -c command
- (Required) The command to run against the embedded cache. The following values are valid for
this command.
- "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 an integration node restart.
- getTraceSpec
- Displays the trace specification.
Note:You can execute the xscmd command options that are not available with the mqsicacheadmin command, by using a Java command. An example of the Java command that you can use to execute the xscmd teardown option to stop the catalog and container servers follows:
where:java -classpath "[IBM Integration Bus installationPath]/cachesupport/lib/objectgrid.jar" -Dcom.ibm.CORBA.ThreadPool.MinimumSize=32 -Djava.util.logging.manager=com.ibm.ws.bootstrap.WsLogManager -Djava.util.logging.configureByServer=true com.ibm.ws.xs.admin.wxscli.WXSAdminCLI -c teardown -ics -f -hf HostName -cep catalogEndPoints
-c
specifies the xscmd command option to be executed.-ics
includes the names of catalog servers in the filtered list of servers to stop.-hf
specifies the host name where the catalog servers are running.-cep
specifies one or more catalog service endpoints in the format[:][,[: ]]
. For example:localhost:2800
ormyhost1.mycompany.com:2800,myhost2.mycompany.com:2804
-f
forces the command action, and disables any preemptive prompts.
- -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
- 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
- Security requirements for Linux and UNIX platforms
- Security requirements for Windows systems
- Security requirements for z/OS
Examples
Always enter the command on a single line; in some examples, line breaks have been added to enhance readability.
mqsicacheadmin IBNODE -c showMapSizes
mqsicacheadmin -cep server.company.com:2800 -c routetable
mqsicacheadmin IBNODE -c clearGrid -m myMap
mqsicacheadmin IBNODE -c "setTraceSpec -spec ObjectGrid*=fine=enabled"
mqsicacheadmin IBNODE -c "setCatTraceSpec -spec ObjectGrid*=fine=enabled"
mqsicacheadmin IBNODE -c getTraceSpec