mqsilist command - Windows, Linux, and AIX systems

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.

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).

You can control whether the mqsilist command uses SSL for connections to an integration node or server, by using the --https and --no-https parameters. If you always want to use SSL for the connection, specify the --https parameter. If you do not want to use SSL for the connection, specify the --no-https parameter. If you specify neither the --https nor --no-https parameter, the mqsilist command attempts to connect first using HTTPS and then without using HTTPS if the first attempt falls.

integrationNodeName

This parameter identifies the name of a specific integration node. To connect to a remote integration node by name, you must also specify the --admin-host and (optionally) the --admin-port parameters.

--integration-node-file integrationNodeFileName | -n 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.

--admin-host host --admin-port port | -i ipAddress -p 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 the --integration-node-file (-n) integrationNodeFileName parameter in the same command.

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

• --admin-host host (or -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.

• --admin-port port (or -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 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.

--https

(Optional) Specifies that HTTPS will be used for the connection to the integration node or server. If neither --https nor --no-https is specified, the connection is tried first with HTTPS and then without using HTTPS if the first attempt fails.

The --https parameter is valid only if the --admin-host parameter is specified.

--no-https

(Optional) Specifies that HTTPS will not be used for the connection to the integration node or server. If neither --https nor --no-https is specified, the connection is tried first with HTTPS and then without using HTTPS if the first attempt fails.

The --no-https parameter is valid only if the --admin-host parameter is specified.

--cacert cacertFile

(Optional) Specifies the path to the certificate file (in either PEM, P12, or JKS format) to be used to verify the integration node or server. If no cacert file is specified and default admin-ssl is enabled, the cacert file defaults to the default pem file for admin-ssl.

• The --cacert parameter is valid only if HTTPS is used for the connection, so it cannot be set together with the --no-https parameter. You can set --cacert when the --https parameter has been set or when neither the --https nor --no-https parameter has been set (in which case SSL is used by default).
• The --cacert parameter can be set only if the --admin-host parameter is specified.

--cacert-password cacertPassword

(Optional) The password for password-protected cacert files.

• The --cacert-password parameter is valid only if HTTPS is used for the connection and if the --cacert parameter has been set. You cannot set it together with the --no-https parameter.
• The --cacert-password parameter can be set only if the --admin-host parameter is specified.

--insecure

(Optional) Specifies that the certificate that is returned by the integration node or server will not be verified.

• The --insecure parameter is valid only if HTTPS is used for the connection, so it cannot be set together with the --no-https parameter. You can set --insecure when the --https parameter has been set or when neither the --https nor --no-https parameter has been set (in which case SSL is used by default).
• The --insecure parameter can be set only if the --admin-host parameter is specified.

mqsilist INODE 

Message BIP1286I is generated.