Differences between administering an IBM MQ Appliance and an IBM MQ installation
The IBM® MQ Appliance provides an environment to configure and manage the resources that are required for your IBM MQ system.
Many IBM MQ administrative concepts and commands are supported on the appliance, although some differences do exist.
Control commands on the IBM MQ Appliance
You can use the IBM MQ control commands on the IBM MQ Appliance command line. However, not all of the control commands are supported and some of the control commands have different parameters to the IBM MQ equivalent.
To use the IBM MQ control commands, you must enter the IBM MQ administration mode by entering the command mqcli on the command line. You can exit the IBM MQ administration mode by entering the command exit.
The following example shows how to enter the IBM MQ
administration mode and create a queue manager:
mqa# mqcli
mqa(mqcli)# crtmqm QM1
MQ Appliance queue manager created. Creating or replacing default objects for queue manager 'QM1'.
Default objects statistics : 79 created. 0 replaced. 0 failed. Completing setup.
Setup completed.
mqa(mqcli)# exit
mqa#
Unsupported commands
The commands that are not supported are listed in the following table:
For authorization commands, command server commands, and security policy commands,
you can use the equivalent PCF or MQSC commands. For more information about the equivalent PCF and
MQSC commands, see Comparing command
sets in the IBM MQ documentation.
| Command | Comment |
|---|---|
| crtmqcvx | Use of exits is not supported on the appliance. See Exits and services on the IBM MQ Appliance. |
| crtmqenv | Use the mqcli command line environment setmqvar (set mq variable) command. |
| dltmqinst | See Upgrading and downgrading firmware. |
| dmpmqaut | Replaced by IBM MQ Console (see IBM MQ Console: Working with queue manager authority records - CD only) or authority record configuration using
runmqsc (for example, SET AUTHREC) see runmqsc (run MQSC commands). |
| dmpmqmsg | Use from an external system, connecting as a client. |
| dspmqaut | Replaced by IBM MQ Console (see IBM MQ Console: Working with queue manager authority records - CD only) or authority record configuration using
runmqsc (for example, SET AUTHREC) see runmqsc (run MQSC commands). |
| dspmqcsv | External control of some queue manager components is not supported on the IBM MQ Appliance. |
| dspmqfls | IBM MQ file access is not supported on the appliance. |
| dspmqinst | See Upgrading and downgrading firmware |
| dspmqspl | Replaced by the SET/DISPLAY POLICY configuration using runmqsc, see runmqsc (run MQSC commands), see Configuring IBM MQ Advanced Message Security.
|
| dspmqtrc | Appliance side tracing is for IBM use only. |
| endmqcsv | External control of some queue manager components is not supported on the IBM MQ Appliance. |
| endmqweb | You cannot start or stop the mqweb server manually on the appliance. |
| migmbbrk | Migration tools for versions of IBM MQ earlier than V8 are not applicable to IBM MQ Appliance queue managers. |
| rcdmqimg | Linear logging is not supported on the IBM MQ Appliance. |
| rcmqobj | Linear logging is not supported on the IBM MQ Appliance. |
| runmqchi | External control of some queue manager components is not supported on the IBM MQ Appliance. |
| runmqchl | External control of some queue manager components is not supported on the IBM MQ Appliance. |
| runmqdlq |
Use a dead letter queue handler connected as a client from a remote system. As an example, the amqsdlq sample can be compiled and linked as a client application to provide the same behavior as the runmqdlq program. See Dead-letter queue handler sample. |
| runmqlsr | Listeners must be started by way of queue manager administration. You can use the IBM MQ Console, see IBM MQ Console: Working with listeners - CD only, or use runmqsc, see runmqsc (run MQSC commands). |
| runmqtmc, runmqtrm | Use runmqtmc (the client form of this command) from a remote MQ server or client installation, on which the triggered application runs. |
| setmqaut | Replaced by IBM MQ Console (seeIBM MQ Console: Working with queue manager authority records - CD only ) or authority record configuration using
runmqsc (for example, SET AUTHREC) see runmqsc (run MQSC commands). |
| setmqenv | Use the mqcli command line environment setmqvar (set mq variable) command. |
| setmqinst | See Upgrading and downgrading firmware |
| setmqm | See Upgrading and downgrading firmware. |
| setmqspl | Replaced by the SET/DISPLAY POLICY configuration using runmqsc, see runmqsc (run MQSC commands), see Configuring IBM MQ Advanced Message Security.
|
| setmqprd | See Upgrading and downgrading firmware |
| strmqcfg | Run IBM MQ Explorer from an external system. |
| strmqcsv | External control of some queue manager components is not supported on the IBM MQ Appliance. |
| strmqweb | You cannot start or stop the mqweb server manually on the appliance. |
Unsupported queue manager parameters
The appliance does not support the queue manager security parameter CONNAUTH CHCKLOCL.
Supported commands
The IBM MQ commands that you can use on the IBM MQ Appliance are listed in the following table.
| Command | Comments |
|---|---|
| crtmqm (create queue manager) | Create queue manager. The following parameters are not supported:
|
| dltmqm (delete queue manager) | Delete queue manager. The following parameter is not supported:
|
| dmpmqcfg (dump queue manager configuration) | Dump queue manager configuration |
| dspmq (display queue managers) | Display queue managers. The following parameters are not supported:
|
| dspmqrte (display route information) | Display route |
| dspmqtrn (display incomplete transactions) | Display transactions |
| dspmqver (display version information) | Display version and build information. The following parameter is not supported:
The -p parameter supports only the values 1, 64, and 128. The output of this command is not the same as for the IBM MQ dspmqver command. Information about the operating system, installation details, and data paths are not displayed. That is, only the name, version, level, and build type information is displayed. |
| dspmqweb | Display information about the configuration of the mqweb server. The mqweb server is used to support the IBM MQ Console and administrative REST API. |
| endmqm (end queue manager) | End queue manager. The following parameters are not supported:
|
| endmqtrc (end trace) | End trace |
| mqrc | IBM MQ return code |
| rcrmqobj (re-create object) | Generate a client channel definition table (CCDT) |
| rsvmqtrn (resolve transactions) | Resolve transaction |
| runmqras | Run diagnostics collection. The following parameters are not supported:
|
| runmqsc (run MQSC commands) | Run MQSC commands. The following parameters are not supported:
|
| runswchl | Switch cluster channel |
| strmqm (start queue manager) | Start queue manager. The following parameters are not supported:
|
| strmqtrc (Start trace) | Start trace |
| setmqvar (set mq variable) | Add or remove an environment variable for the appliance or for a specified queue manager |
| setmqweb | Add or remove an mqweb server configuration property. |
New commands
New IBM MQ commands that are specific to the IBM MQ Appliance are listed in the following table:
| Command | Description |
|---|---|
| dspmqerr (display mq error log) | Display the IBM MQ error log files. |
| crthagrp (create HA group) | Create a high availability (HA) group of appliances. |
| dsphagrp (display HA group status) | Display the status of the appliances in the high availability (HA) group. |
| makehaprimary (make HA appliance primary) | Specifies that an appliance is the 'winner' when resolving a partitioned situation in the high availability group. |
| prepareha (prepare appliance for HA group) | Prepare an appliance to be part of an HA group that uses a unique, generated key for communication between appliances. |
| sethagrp (set HA group) | Pause and resume an appliance in a high availability group. |
| crtdrprimary | Augment an existing queue manager to become the primary queue manager in a disaster recovery configuration. |
| crtdrsecondary | Create a secondary version of a queue manager on the recovery appliance in a disaster recovery configuration. |
| makedrprimary | Switch a disaster recovery queue manager to have the primary role in the disaster recovery configuration. |
| makedrsecondary | Prevent a queue manager on an appliance in a disaster recovery configuration from starting, and specifies that it has the secondary role. |
| dltdrprimary | Remove a queue manager currently in the primary role from DR control. |
| dltdrsecondary | Remove a queue manager currently in the secondary role from DR control and delete it. |
| dspmqini (display mq ini) | Display attributes from the qm.ini or mqat.ini file of a specified queue manager. |
| dspmqvar (display mq variables) | Display environment variables set for a specified queue manager. |
| setmqini (set mq ini) | Add or remove an attribute from the qm.ini file of a specified queue manager. Set a value for an attribute in the mqat.ini file. |
| addcert | Add the public part of a certificate to the keystore of a specific queue manager. |
| createcert (create certificate) | Create a self-signed certificate for a queue manager. |
| createcertrequest (create certificate request) | Create a certificate request for a queue manager. |
| deletecert (delete certificate) | Delete a certificate from the keystore of a specific queue manager. |
| deletecertrequest (delete certificate request) | Delete a certificate request that was previously issued from a specific queue manager. |
| detailcert (detail certificate) | Show detailed information about a certificate for a specific queue manager. |
| detailcertrequest (detail certificate request) | Show detailed information about a certificate request for a specific queue manager. |
| keybackup | Back up the queue manager key repository to a file. |
| keyrestore | Restore a key repository |
| listcert (list certificate) |
List the certificates that are held in the keystore of a specific queue manager. |
| listcertrequest (list certificate request) | List the certificate requests that are outstanding in the keystore of a specific queue manager. |
| receivecert (receive certificate) | Receive a certificate signed by a Certificate Authority (CA) as the result of a previous request. |
| recreatecertrequest (re-create certificate request) | Re-create a certificate request for a specific queue manager. |
| usercreate (create user) | Create user IDs for messaging users. |
| userdelete (delete user) | Delete a messaging user. |
| usermodify (modify user) | Modify user IDs for messaging users. |
| userlist (list users) | List the messaging users. |
| groupcreate (create user group) | Add user groups for messaging users. |
| groupdelete (delete user group) | Delete user groups for messaging users. |
| grouplist (list user groups) | List groups for messaging users. |
| userbackup (back up users) | Back up messaging users. |
| userrestore (restore user) | Restore messaging users. |