See information about the latest product version
mqsireportresourcestats command
Use the mqsireportresourcestats command to display current statistics gathering options for resources in the broker.
Supported platforms
- Windows systems
- Linux and UNIX systems
- z/OS®. Run this command by customizing and submitting BIPRPRS; see Contents of the broker PDSE
Purpose
Use this command to view the status of statistics collection for the resource types listed in Resource statistics data.
You can run this command only if the broker is running.
Syntax
>>-mqsireportresourcestats--| brokerSpec |----------------------> >--+--------------------------+--+-------------------+----------> '- -e --executionGroupName-' '- -d --detailLevel-' >--+-------------------+--+---------------------+-------------->< '- -w --timeoutSecs-' '- -v --traceFileName-' brokerSpec |--+- brokerName ----------------+------------------------------| +- -n --brokerFileName--------+ | .-------------------------. | | V | | '-----+- -i --ipAddress-+---+-' +- -p --port------+ '- -q --qMgr------'
Parameters
- brokerSpec
- (Required) You must specify at least one parameter
to identify the target broker for this command, in one of the following
forms:
- brokerName
- This parameter identifies the name of a locally defined broker. You cannot use this option if the broker is on a remote computer.
- -n brokerFileName
- This parameter identifies the name of a file that contains the
connection details for a local or remote broker.
Use this option if multiple users want to connect to the same broker, or if you are using advanced connection parameters such as SSL.
To create this file, right-click the broker in the WebSphere® Message Broker Explorer and select Export *.broker file. When prompted, navigate to the location in which you want to save the file and enter the file name; the extension .broker is appended automatically when you click Save. Include the location (path) and file name when you specify this parameter. You must ensure that the location is accessible when you run this command.
If you want to run a command that uses SSL to administer a remote broker over a secured channel, you must specify the keystore and truststore password for the connection using the IBM_JAVA_OPTIONS environment variable. See Resolving problems when running commands for further information.
- -i ipAddress, -p port, -q qMgr
- These parameters identify the connection details for the broker.
Use this option for connections to remote brokers that do not require advanced connection parameters.
If you choose this option, you must specify at least one of these three parameters; the order in which you specify them is insignificant. You cannot specify each parameter more than once.
Parameters that you omit assume default values:
- -i ipAddress: The host name or the IP address of the computer on which the broker is running. If you do not specify this parameter, a value that represents the local computer is used.
- -p port: The TCP port on which the broker's queue manager is listening. If you do not specify this parameter, the value 1414 is used.
- -q qMgr: The name of the broker's queue manager. If you do not specify this parameter, a value that represents the default queue manager on the local computer is used.
- You cannot connect to a remote queue manager on z/OS; see Usage note.
- -d detailLevel
- The detailLevel specified controls how much
information to display. Valid values are:
- 0
- Display combined information. This option is identical to previous versions of mqsireportresourcestats.
- 1
- Display a summary of configurable settings per execution group. This option is the default.
- 2
- Display detailed information, including non-configurable settings.
- -e executionGroupName
- (Optional) The name of the execution group for which
resource statistics collection status is reported.
If you do not specify -e, resource statistics status is reported for all execution groups on the broker.
- -w timeoutSecs
- (Optional) This parameter specifies the time in seconds that the utility waits to ensure that the command completed; the default value is 60.
- -v traceFileName
- (Optional) This parameter sends internal debug trace information to the specified file.
Usage note
If you try to connect to a remote broker by specifying the i, p, and q parameters, or by using 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.
Authorization
- Security requirements for Linux and UNIX platforms
- Security requirements for Windows systems
- Security requirements for z/OS
Responses
- 0
- The command completed successfully.
- 2
- (Failure) The broker received the deployment request but was unable to process it successfully. See the messages issued from the utility (or the Administration log) for more information.
- 9
- (Failure) The request has been submitted to the broker, but no response was received before the timeout expired.
- 10
- (Failure) Another user or application canceled the request operation before the broker was able to process it.
- 98
- The broker is not running.
- 99
- One or more of the parameters that you specified is invalid.
If the command completes successfully, one report message per resource type is returned for each execution group specified by the command. Each message has the general format:
BIP8940I Statistics settings for resource type type in execution group execution_group_name is state. [measurement]
where:
- type is the resource type. For more information about the resource types for which statistics can be requested, see Resource statistics.
- state can be active or inactive
- measurement is a repeating field that depends on the resource type; for example, TotalSocketsOpened is returned for resource type Sockets. Details of all the measurements reported are provided in Resource statistics data.
Examples
Request a report for the execution group default on broker BrokerA for statistics collection for all resources:
mqsireportresourcestats BrokerA -e default
Request a report for all execution groups on broker BrokerA for statistics collection for all resources:
mqsireportresourcestats BrokerA