mqsilist command - Windows, Linux, and UNIX systems

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

Syntax

Read syntax diagramSkip visual syntax diagrammqsilist -a integrationNodeSpec -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

If you specify this command with no parameters, a summary is returned for integration nodes that are created in the current installation on this computer.

The current installation is associated with the command console that you opened (on Windows), or the mqsiprofile that is active (on Linux® and UNIX systems).

Parameters

integrationNodeSpec
(Required) 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 specified integration node. To connect to a remote integration node, you must also specify -i and -p.
-n integrationNodeFileName
This parameter identifies the name of a .broker file that contains the connection details for a local or remote integration node. 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.

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. To learn more about creating and using a .broker file, see Connecting to an integration node by creating a .broker file.

If you want to run a command that uses SSL to administer a remote integration node over a secured channel, you must specify the keystore and truststore password for the connection that is using the IBM_JAVA_OPTIONS environment variable. For more information, see Resolving problems when running commands.

-i ipAddress, -p port
These parameters identify the connection details for the integration node.

Use this option for connections to remote integration nodes that do not require advanced connection parameters.

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 secured integration server as a specific user, provide the security credentials as a URI in the following format: tcp://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.
-a
(Optional) List all the integration nodes that are installed on the local computer, in all installations.

If you specify this option on a computer on which you installed versions earlier than Version 7.0, only integration nodes are listed for those versions, if they exist. The level of detail corresponds to -d 0 for these earlier integration nodes, even if you specify (or allow to default) a different level of detail on this command. To view information about other components that you created in earlier versions, you must use the corresponding version of the mqsilist command.

You cannot use this option to list information about remote integration nodes and their resources.

-d detailLevel
(Optional) Specify the level of detail to be returned; the default value is 1.
  • 0 returns only local integration node name and the names of their associated queue managers (this information is the same as the detail provided in previous versions). It no longer supports remote integration nodes ('-i', '-p' and '-q' flags are ignored). Only flags supported with this level are '-a' and '-e'. Note that while they are starting, execution groups might report a PID of 0. This list of local brokers is returned without connecting to a queue manager, and remote broker options are not supported.

    While integration servers are starting, they 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 that is 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

The following example lists all integration nodes that are created in the current installation:
mqsilist -d 0

Message BIP8099I is generated.

The following example returns information for a specific remote integration node:
mqsilist IBNODE -i tcp://hostname.example.com -p 7906
The following example lists the deployed objects that are configured for application myApplication in the default integration server:
mqsilist IBNODE -e default -k myApplication
The following example lists the deployed objects that are configured for library myISLibrary, which is contained in application myApplication, in the default integration server:
mqsilist IBNODE -e default -k myApplication -y myISLibrary
The following example lists the deployed objects that are configured for shared library shlib1, and lists the applications that reference that library:
mqsilist IBNODE -e default -y shlib1
The following example returns detailed information about application myApplication in the default integration server:
mqsilist IBNODE -e default -k myApplication -d2
The following example lists all deployed objects that are configured in application myApplication:
mqsilist IBNODE -e default -k myApplication -r
The following example requests a summary of the integration servers that are defined on a specific integration node. (The -d parameter is not specified and therefore has the default value of 1.)
mqsilist IBNODE 

Message BIP1286I is generated.

Display detailed information about all resources for integration nodes on the local computer:
mqsilist -a -r -d2
Information is given in a series of BIP messages:
  • BIP1280I
  • BIP1286I
  • BIP1288I
  • BIP1290I
  • BIP1285I

When an integration node is a multi-instance integration node in Standby mode, BIP1280I and BIP1292I are generated.

When an integration node is a multi-instance integration node in Active mode, BIP1280I, BIP1292I, and BIP1288I are generated.

When an integration node is a multi-instance integration node that is being started as a WebSphere® MQ service, BIP1296I and BIP1298I are generated.