mqsilist command - z/OS®

Use the mqsilist command to list information about one or more integration nodes and their deployed resources.

Syntax

z/OS command - BIPLIST

Read syntax diagramSkip visual syntax diagrammqsilistintegrationNodeSpec e= integrationServerName d= detailLevel k= applicationName r=  v= traceFileName w= timeoutSecs y= libraryName
integrationNodeSpec
Read syntax diagramSkip visual syntax diagram integrationNodeName  n= integrationNodeFileName i= ipAddress -p port i= ipAddress p= port

z/OS console command

Synonym: l

Read syntax diagramSkip visual syntax diagramlistl  e=integrationServerName r=yes d=detailLevel

If you specify this command with no parameters, a list of the integration servers is displayed.

Parameters

integrationNodeSpec
You must specify at least one parameter to identify the target integration node for this command, in one of the following forms:
integrationNodeName
This parameter identifies the name of a locally defined integration node.
n= integrationNodeFileName
This parameter identifies the name of a file that contains the connection details for a local integration node.

Use this option if multiple users want to connect to the same integration node, or if you are using advanced connection parameters such as SSL.

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
These parameters identify the connection details for the integration node.

If you are connecting to a remote integration node, you can additionally prefix integrationNodeName to explicitly set which integration node to connect to. You cannot use -n integrationNodeFileName in the same command.

Parameters that you omit assume default values:

  • i= ipAddress: The host name or IP address of the computer on which the integration node is running. If you do not specify this parameter, a value that represents the local computer is used.

    If you want to connect to a remote host name, provide the security credentials as a URI in the following format: protocol://user:password@hostname. If your password contains URI Reserved characters, you must convert these characters to the percent-encoded format. For more information, see A correct URL and password returns error BIP1939 when you attempt to connect to a remote host name in Resolving problems when running commands.

  • p= port: The port on which the web user interface HTTP connection listener is listening. If you do not specify this parameter, the value 4414 is used.
d= detailLevel
(Optional) Specify the level of detail to be returned; the default value is 1.
  • 0 returns only integration node 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, integration servers might report a PID of 0.

  • 1 returns a one line summary of each resource.
  • 2 returns detailed information about each resource.
e= integrationServerName
(Optional) Selects an integration server within an integration node. Specify the label of the integration server for which you want to list message flows. The command returns a list of message flows assigned to the specified integration server within the integration node.

The specified integration node 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 integration server 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 integration server 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.

Deprecation of the q= parameter

In previous versions of IBM® Integration Bus, you might have used the q= parameter for this command to define a connection to a queue manager. A queue manager connection is no longer used to connect to an integration node. The q= parameter is now deprecated, and is ignored if used. If you use the q= parameter, a BIP1922 warning is displayed.

Examples

Use the console command to request a summary of the integration servers for the integration node. (The d= parameter is not specified and therefore has the default value of 1.)
F MQP1BRK,list
BIP1286I is generated.
Use the console command to list the message flows in the specified integration server:
F MQP1BRK,list e='intserv1'
BIP1288I is generated.
Use the console command to list deployed objects that are configured for library myISLibrary, which is contained in application myApplication, in the default integration server:
F IBNODE,list e='default' k='myApplication' y='myISLibrary'

For examples of running the command by using BIPLIST, and the responses that are generated, see mqsilist command - Windows, Linux, and UNIX systems.