mqsilist command - Windows, Linux, and AIX systems

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

Syntax

Some parameters have alternative long names; for example: -p and --admin-port are alternative parameter names of the port number for the administration REST API. The long names available are listed in the Parameters section.

Syntax for use with integration nodes

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

Syntax for use with independent integration servers

Read syntax diagramSkip visual syntax diagram mqsilist -n integrationNodeFileName -i ipAddress -p port -a  -d detailLevel -k applicationName -r  -v traceFileName -w timeoutSecs -y libraryName

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 AIX® systems).

Parameters

integrationNodeName
This parameter identifies the name of a specific integration node. To connect to a remote integration node by name, you must also specify -i and (optionally) -p.
-n integrationNodeFileName | --integration-node-file integrationNodeFileName
This parameter identifies the name of a .broker file that contains the connection details for an integration node or independent integration server. 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.

The file can be used to connect to an independent integration server. The connection details must not include a node name (integrationNodeName) and the host and port must be for an independent integration server.

Use this option if multiple users want to connect to the same integration node or integration server, or if you are using advanced connection parameters such as SSL. To learn more about how to create and use a .broker file, see Connecting to an integration node by creating a .broker file.

You can run a command that uses SSL to administer a remote integration node or integration server 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 | --admin-host ipAddress, --admin-port port
These parameters identify a host and port for an integration node or independent integration server, for connections that do not require advanced connection parameters.

To connect to a specific remote integration node by name, you can add the prefix integrationNodeName. You cannot use -n integrationNodeFileName in the same command.

For an integration node, any parameters that you omit assume default values.

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

    To connect to an independent integration server, the value is the host that you specified in the adminRestApiHost property in the server.conf.yaml configuration file for the integration server.

    If you want to connect to a secured integration node or 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.

    To connect to an independent integration server, the value is the port that you set for the adminRestApiPort property in the server.conf.yaml configuration file. By default adminRestApiPort is set to 7600.

Other parameters:

-a | --all-integration-nodes
(Optional) List all the integration nodes that are installed on the local computer, in all installations.

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

-d detailLevel | --detail detailLevel
(Optional) Specify the level of detail to be returned; the default value is 1.
  • 1 returns a one-line summary for each resource.
  • 2 returns detailed information about each resource.
Note that in previous versions of IBM® App Connect Enterprise and IBM Integration Bus, the 0 parameter returned the local integration node name and the names of the associated queue managers. From IBM App Connect Enterprise Version 11.0 onwards, the 0 parameter returns the same level of information as the 1 parameter.
-e integrationServerName | --integration-server 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 | --application applicationOrServiceName
(Optional) This parameter lists the deployed objects that are configured for an application or a service. If you use this parameter against an integration node, you must also specify an integration server by using the -e parameter.
-r | --recursive
(Optional) Run the command recursively; display information about subcomponents.
-v traceFileName | --trace traceFileName
(Optional) This parameter sends internal debug trace information about a command to the specified file.
-w timeoutSecs | --timeout-seconds 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 | --library libraryName
(Optional) This parameter lists the deployed objects that are configured for a library. If you use this parameter against an integration node, 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 App Connect Enterprise, the -q parameter for this command was available 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 returns information for a specific remote integration node:
mqsilist INODE -i tcp://hostname.example.com -p 7906
mqsilist INODE --admin-host tcp://hostname.example.com --admin-port 7906
The following example returns information for an independent integration server identified by the hostname my.host and port 7600:
mqsilist -i my.host -p 7600
mqsilist --admin-host my.host --admin-port 7600
An example of information for an independent integration server:
BIP1275I: Application 'AppConnectToIIB' on integration server 'ISIPL101' is running.
BIP1275I: Application 'OnPremLogger' on integration server 'ISIPL101' is running.
BIP1275I: Application 'Transformation_Map' on integration server 'ISIPL101' is running.
BIP1877I: REST API 'CustomerDatabaseV1' on integration server 'ISIPL101' is running.
BIP1877I: REST API 'LeadXML' on integration server 'ISIPL101' is running.
BIP1877I: REST API 'LeadXML2ACoIC' on integration server 'ISIPL101' is running.
BIP1875I: Service 'TemperatureConverter' on integration server 'ISIPL101' is running.
BIP8071I: Successful command completion.

The following commands show examples of use for the default integration server of the integration node, IBNODE:

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

Message BIP1286I is generated.