See information about the latest product version
mqsilist command - z/OS
Use the mqsilist command to list information about one or more brokers and their deployed resources.
Syntax
z/OS command - BIPLIST
>>-mqsilist--+---------------------------------+----------------> '-| brokerSpec |--+-------------+-' '- -e--egName-' >--+-------------------+--+-----------------------+--+------+---> '- -d --detailLevel-' '- -k --applicationName-' '- -r -' >--+---------------------+--+-------------------+---------------> '- -v --traceFileName-' '- -w --timeoutSecs-' >--+-------------------+--------------------------------------->< '- -y --libraryName-' brokerSpec |--+- brokerName ----------------+------------------------------| +- -n --brokerFileName--------+ | .-------------------------. | | V | | '-----+- -i --ipAddress-+---+-' +- -p --port------+ '- -q --qMgr------'
Parameters
- brokerSpec
- 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.
- -n brokerFileName
- This parameter identifies the name of a file that contains the connection details for a local 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.
If you specify a queue manager, it must be defined on the local computer.
If you choose this option, you must specify at least one of these three parameters; the order in which you specify them is irrelevant. 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
- (Optional) Specify the level of detail to be returned; the default
value is 1.
- 0 returns only broker name and the names
of their associated queue managers (this information is the same as
the detail provided in previous versions).
Note that while they are starting, execution groups might report a PID of 0.
- 1 returns a one line summary of each resource.
- 2 returns detailed information about each resource.
- 0 returns only broker name and the names
of their associated queue managers (this information is the same as
the detail provided in previous versions).
- -e egName
- (Optional) Selects an execution group within a broker.
Specify the label of the execution group for which you want to list message flows. The command returns a list
of message flows assigned to the specified
execution group within the broker.
The specified broker must be active for message flow information to be returned.
- -k applicationOrServiceName
- (Optional) This parameter lists the deployed objects that are configured for an application or a service. When you use this parameter, you must also specify an execution group by using the -e parameter.
- -r
- (Optional) Run the command recursively; display information about subcomponents.
- -v traceFileName
- (Optional) This parameter sends internal debug trace information to the specified file.
- -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.
- -y libraryName
- (Optional) This parameter lists the deployed objects that are configured for a library. When you use this parameter, you must also specify an execution group by using the -e parameter. You can also use the -k parameter with this parameter to list the contents of a specific library in the application specified by the -k parameter.
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.
Examples
F MQP1BRK,list
The
following responses are generated:BIP1286I: Execution group 'ello' on broker 'MQP1BRK' is running.
BIP8071I: Successful command completion.
F MQP1BRK,list e='exgrp1'
The
responses generated are in the following form:BIP1288I: Message flow 'simpleflow' on execution group 'ello' is running.
BIP8071I: Successful command completion
F MB8BROKER,list e='default' k='myApplication' y='myEGLibrary'
For examples of running the command by using BIPLIST, and the responses that are generated, see mqsilist command - Windows, Linux, and UNIX systems.