mqiptAdmin (administer MQIPT)

Issue an administrative command to an active instance of IBM® MQ Internet Pass-Thru (MQIPT).

Purpose

Use the mqiptAdmin command to issue an administrative command to an active instance of MQIPT.

Usage notes

The mqiptAdmin command connects to the active instance of MQIPT to administer using one of the following methods:

by making a network connection to a command port
by connecting to a local instance of MQIPT without using the command port.

An MQIPT command port might be configured to accept only TLS connections. When connecting to a TLS command port, the -s parameter to the mqiptAdmin command must be specified.

In order for mqiptAdmin to be authorized to connect to a local instance of MQIPT without using the command port, the MQIPT instance must be running on the same system and under the same user ID as mqiptAdmin. Alternatively, on AIX® and Linux®, mqiptAdmin can be run as root.

Note: The mqiptAdmin command is compatible with previous versions of MQIPT, but the command cannot be used to administer versions of MQIPT that are a higher version that the version of the mqiptAdmin command. In an environment that includes different versions of MQIPT, use the latest version of the mqiptAdmin command.

Syntax

Deprecated syntax

Keywords and parameters

-list: Display the names of all local instances of MQIPT that support local administration without the command port.; On AIX and Linux, if mqiptAdmin is running as root, all local active instances of MQIPT are displayed. Otherwise, only instances of MQIPT that are running under the same user ID as mqiptAdmin are displayed.
-refresh: Refresh an active instance of MQIPT to bring any configuration changes into effect.
-stop: Stops the instance of MQIPT.; MQIPT closes all connections, stops listening for incoming connections, and then exits. The stop command is ignored if the mqipt.conf file specifies RemoteShutDown=false.
-status: Display information about the connection thread pool usage. The information is displayed in the MQIPT console output. This parameter is intended for use by IBM Support.
-n mqipt_name: The name of a local instance of MQIPT to administer. This parameter must be specified to administer a local instance of MQIPT without using a command port.
-r hostname:port: The host name and command port of an instance of MQIPT to administer using the command port. This parameter is optional. If neither the -n nor -r parameters are specified, mqiptAdmin connects to localhost, port 1881.
-s: Secure the connection to MQIPT using TLS. This parameter must be specified to connect to a TLS command port.
-p properties_file: The name of a file containing configuration properties that are necessary to connect to MQIPT using TLS. The name of the properties file can also be specified by setting the MQS_MQIPTADM_PROP_FILE environment variable.; For the list of properties that can be specified in the properties file, see mqiptAdmin properties.
-sm: Specifies that a FIPS compliant cryptographic library is used for encryption.

Return codes

Table 1. Return code identifiers and descriptions
Return code	Description
0	Command successful.
>0	Command not successful.