ALTER QMGR

Use ALTER QMGR to alter the queue manager parameters for the local queue manager.

Synonym: ALT QMGR 

ALTER QMGR
 
>>-ALTER QMGR--+----------------+--+-------+-------------------->
               '-| qmgr attrs |-'  '-FORCE-'
 
   .-CMDSCOPE(' ')------------. (3)
>--+--------------------------+--------------------------------><
   |                     (2)  |
   +-CMDSCOPE(qmgr-name)------+
   |             (2)          |
   '-CMDSCOPE(*)--------------'
 
Qmgr attrs
 
|--+------------------------------+--+---------------------+---->
   |                     (1)      |  |                (7)  |
   '-AUTHOREV(-+-ENABLED------+-)-'  '-CCSID(integer)------'
               '-DISABLED-----'
 
>--+---------------------------+-------------------------------->
   |                      (5)  |
   '-CHAD(-+-DISABLED-+-)------'
           '-ENABLED--'
 
>--+-----------------------------+--+-----------------------+--->
   |                        (5)  |  |                  (8)  |
   '-CHADEV(-+-DISABLED-+-)------'  '-CHADEXIT(string)------'
             '-ENABLED--'
 
>--+-----------------------+--+-----------------------+--------->
   |                  (8)  |  |                  (8)  |
   '-CLWLDATA(string)------'  '-CLWLEXIT(string)------'
 
>--+-----------------------+------------------------------------>
   |                  (8)  |
   '-CLWLLEN(integer)------'
 
>--+-------------------------------+--+---------------+--------->
   |                          (3)  |  '-DEADQ(string)-'
   '-CONFIGEV(-+-ENABLED--+-)------'
               '-DISABLED-'
 
>--+------------------+--+---------------+---------------------->
   '-DEFXMITQ(string)-'  '-DESCR(string)-'
 
                               (3)
>--+-------------------------+---------------------------------->
   '-EXPRYINT(-+-OFF-----+-)-'
               '-integer-'
 
>--+--------------------------+--------------------------------->
   |                     (3)  |
   '-IGQ(-+-DISABLED-+-)------'
          '-ENABLED--'
 
>--+----------------------------+--+----------------------+----->
   |                       (3)  |  |                 (3)  |
   '-IGQAUT(-+-DEF-----+-)------'  '-IGQUSER(string)------'
             +-CTX-----+
             +-ONLYIGQ-+
             '-ALTIGQ--'
 
>--+--------------------------+--+-------------------------+---->
   '-INHIBTEV(-+-ENABLED--+-)-'  '-LOCALEV(-+-ENABLED--+-)-'
               '-DISABLED-'                 '-DISABLED-'
 
>--+-------------------+--+-----------------------+------------->
   '-MAXHANDS(integer)-'  |                  (5)  |
                          '-MAXMSGL(integer)------'
 
>--+-------------------+--+-------------------------+----------->
   '-MAXUMSGS(integer)-'  '-PERFMEV(-+-ENABLED--+-)-'
                                     '-DISABLED-'
 
>--+--------------------------+--+-------------------------+---->
   '-REMOTEEV(-+-ENABLED--+-)-'  |                    (8)  |
               '-DISABLED-'      '-REPOS(clustername)------'
 
>--+----------------------+--+-----------------------+---------->
   |                 (8)  |  |                  (6)  |
   '-REPOSNL(nlname)------'  '-SSLCRLNL(nlname)------'
 
>--+----------------------+--+----------------------+----------->
   |                 (4)  |  |                 (6)  |
   '-SSLCRYP(string)------'  '-SSLKEYR(string)------'
 
>--+------------------------+--+--------------------------+----->
   |                   (3)  |  '-STRSTPEV(-+-ENABLED--+-)-'
   '-SSLTASKS(integer)------'              '-DISABLED-'
 
>--+------------------+-----------------------------------------|
   '-TRIGINT(integer)-'

Notes:

  1. Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.

  2. Valid only on z/OS.

  3. Valid only on AIX, HP-UX, Linux, and Solaris.

  4. Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.

  5. Valid only on AIX, HP-UX, Linux, OS/400, Solaris, Windows, and z/OS.

  6. Valid only on AIX, Compaq NSK, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.

  7. Valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.

 

Parameter descriptions

The parameters you specify override the current values. Attributes that you do not specify are unchanged.

Notes:

  1. If you do not specify any parameters, the command completes successfully, but no queue manager options are changed.

  2. Changes made using this command persist when the queue manager is stopped and restarted.

FORCE
Specify this to force completion of the command if both of the following are true:

  • The DEFXMITQ parameter is specified

  • An application has a remote queue open, the resolution for which would be affected by this change

If FORCE is not specified in these circumstances, the command is unsuccessful.

 

Queue manager parameters

AUTHOREV
Whether authorization (Not Authorized) events are generated:

ENABLED
Authorization events are generated.

DISABLED
Authorization events are not generated. This is the queue manager's initial default value.

CCSID(integer)
The coded character set identifier for the queue manager. The CCSID is the identifier used with all character string fields defined by the API. It does not apply to application data carried in the text of messages unless the CCSID in the message descriptor is set to the value MQCCSI_Q_MGR when the message is put to a queue.

Specify a value in the range 1 through 65 535. The CCSID must specify a value that is defined for use on your platform, and use a character set that is appropriate to the platform.

If you use this parameter to change the CCSID, applications that are running when the change is applied continue to use the original CCSID. Because of this, stop and restart all running applications before you continue. This includes the command server and channel programs. To do this, stop and restart the queue manager after making the change.

This parameter is valid only on AIX, Compaq NSK, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows. See the WebSphere MQ Application Programming Guide for details of the supported CCSIDs for each platform.

CHAD
Whether receiver and server-connection channels can be defined automatically:

DISABLED
Auto-definition is not used. This is the queue manager's initial default value.

ENABLED
Auto-definition is used.

Cluster-sender channels can always be defined automatically, regardless of the setting of this parameter.

This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.

CHADEV
Whether channel auto-definition events are generated.

DISABLED
Auto-definition events are not generated. This is the queue manager's initial default value.

ENABLED
Auto-definition events are generated.

This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.

CHADEXIT(string)
Auto-definition exit name.

If this name is nonblank, the exit is called when an inbound request for an undefined receiver, server-connection, or cluster-sender channel is received. It is also called when starting a cluster-receiver channel.

CLWLDATA(string)
Cluster workload exit data. The maximum length of the string is 32 characters.

This string is passed to the cluster workload exit when it is called.

CLWLEXIT(string)
Cluster workload exit name.

If this name is nonblank, the exit is called when a message is put to a cluster queue. The format and maximum length of the name depends on the environment:

It is of the form libraryname(functionname). The maximum length is 128 characters.

CLWLLEN(integer)
The maximum number of bytes of message data that is passed to the cluster workload exit.

Specify a value in the range zero through 999 999 999 on other platforms

The initial default value is 100.

CMDSCOPE
This parameter applies to z/OS only and specifies how the command is executed when the queue manager is a member of a queue-sharing group.

' '
The command is executed on the queue manager on which it was entered. This is the default value.

qmgr-name
The command is executed on the queue manager you specify, providing the queue manager is active within the queue-sharing group.

You can specify a queue manager name, other than the queue manager on which the command was entered, only if you are using a queue-sharing group environment and if the command server is enabled.

*
The command is executed on the local queue manager and is also passed to every active queue manager in the queue-sharing group. The effect of this is the same as entering the command on every queue manager in the queue-sharing group.

CONFIGEV
Whether configuration events are generated:

ENABLED
Configuration events are generated. After setting this value, issue REFRESH QMGR TYPE(CONFIGEV) commands for all objects to bring the queue manager configuration up-to-date.

DISABLED
Configuration events are not generated. This is the queue manager's initial default value.

DEADQ(string)
The local name of a dead-letter queue (or undelivered-message queue) on which messages that cannot be routed to their correct destination are put.

The queue named must be a local queue. See Rules for naming WebSphere MQ objects.

DEFXMITQ(string)
Local name of the default transmission queue on which messages destined for a remote queue manager are put, if there is no other suitable transmission queue defined.

The queue named must be a local transmission queue. See Rules for naming WebSphere MQ objects.

DESCR(string)
Plain-text comment. It provides descriptive information about the queue manager.

It should contain only displayable characters. The maximum length of the string is 64 characters. In a DBCS installation, it can contain DBCS characters (subject to a maximum length of 64 bytes).

Note:
If characters are used that are not in the coded character set identifier (CCSID) for this queue manager, they might be translated incorrectly if the information is sent to another queue manager.

EXPRYINT
Specifies how often queues are scanned to discard expired messages:

OFF
Queues are not scanned. No internal expiry processing is performed. This is the default.

integer
The approximate interval in seconds at which queues are scanned. Each time that the expiry interval is reached, the queue manager looks for candidate queues that are worth scanning to discard expired messages.

The queue manager maintains information about the expired messages on each queue, and therefore whether a scan for expired messages is worthwhile. So, only a selection of queues is scanned at any time.

The value must be in the range 1 through 99 999 999. The minimum scan interval used is 5 seconds, even if you specify a lower value.

Note:
You must set the same EXPRYINT value for all queue managers within a queue-sharing group that support this attribute.

Changes to EXPRYINT take effect when the current interval expires, unless the new interval is less than the unexpired portion of the current interval, in which case a scan is scheduled immediately and the new interval value takes immediate effect.

This parameter is supported only on z/OS.

IGQ
Whether intra-group queuing is used.

ENABLED
Message transfer between queue managers within a queue-sharing group uses the shared transmission queue (SYSTEM.QSG.TRANSMIT.QUEUE).

DISABLED
Message transfer between queue managers within a queue-sharing group uses non-shared transmission queues and channels. This is the same mechanism used for message transfer between queue managers that are not part of a queue-sharing group. This is the default value.

If intra-group queuing has been enabled, but the intra-group queuing agent has stopped for some reason, you can issue ALTER QMGR IGQ(ENABLED) to restart it.

IGQAUT
Specifies the type of authority checking and, therefore, the user IDs, to be used by the IGQ agent (IGQA). This establishes the authority to put messages to a destination queue.

DEF
Indicates that the default user ID should be used to establish authority to put messages to a destination queue. This is the default value.

For one user ID check, this involves using the user ID (referred to as QSGSEND) of the queue manager within the queue-sharing group that put the messages to the SYSTEM.QSG.TRANSMIT.QUEUE.

For two user ID checks, this involves using the QSGSEND user ID and the IGQ user ID.

CTX
Indicates that the user ID from the UserIdentifier field in the message descriptor, of a message on the SYSTEM.QSG.TRANSMIT.QUEUE, should be used to establish authority to put messages to a destination queue.

For one user ID check, this involves using the QSGSEND user ID.

For two user ID checks, this might involve using the QSGSEND user ID, the IGQ user ID and the alternate user id (referred to as ALT) taken from the UserIdentifier field in the message descriptor of a message on the SYSTEM.QSG.TRANSMIT.QUEUE.

ONLYIGQ
Indicates that only the IGQ user ID should be used to establish authority to put messages to a destination queue.

For all ID checks, this involves using the IGQ user ID.

ALTIGQ
Indicates that the IGQ user ID and the ALT user ID should be used to establish authority to put messages to a destination queue.

For one user ID check, this uses the IGQ user ID.

For two user ID checks, this uses the IGQ user ID and the ALT user ID.

IGQUSER
Nominates a user ID (referred to as the IGQ user ID) to be used by the IGQ agent (IGQA) to establish authority to put messages to a destination queue.

Notes:

  1. As the receiving queue manager has authority to all queues it can access, this means that security checking might not be performed for this user ID type.

  2. As the default value of blanks has a special meaning, you cannot use IGQUSER to specify a real user ID of blanks.

INHIBTEV
Whether inhibit (Inhibit Get and Inhibit Put) events are generated:

ENABLED
Inhibit events are generated.

DISABLED
Inhibit events are not generated. This is the queue manager's initial default value.

LOCALEV
Whether local error events are generated:

ENABLED
Local error events are generated.

DISABLED
Local error events are not generated. This is the queue manager's initial default value.

MAXHANDS(integer)
The maximum number of open handles that any one task can have at the same time.

This is a value in the range zero through 999 999 999.

Note:
On MQSeries for Compaq NonStop Kernel, this parameter is ignored.

MAXMSGL(integer)
The maximum length of messages allowed on queues for this queue manager.

This is in the range 32 KB through 100 MB. The default is 4 MB (4 194 403 bytes).

If you reduce the maximum message length for the queue manager, also reduce the maximum message length of the SYSTEM.DEFAULT.LOCAL.QUEUE definition, and all other queues connected to the queue manager. This ensures that the queue manager's limit is not less than that of any of the queues associated with it. If you do not do this, and applications inquire only the value of the queue's MAXMSGL, they might not work correctly.

This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, and Windows.

MAXUMSGS(integer)
The maximum number of uncommitted messages within a syncpoint.

This is a limit on

  • The number of messages that can be retrieved, plus

  • The number of messages that can be put

within any single syncpoint. It does not apply to messages that are put or retrieved outside syncpoint.

The number includes any trigger messages and report messages generated within the same unit of recovery.

Specify a value in the range 1 through 999 999 999.

Note:
On MQSeries for Compaq NonStop Kernel, this parameter is ignored.

PERFMEV
Whether performance-related events are generated:

ENABLED
Performance-related events are generated.

DISABLED
Performance-related events are not generated. This is the queue manager's initial default value.

REMOTEEV
Whether remote error events are generated:

ENABLED
Remote error events are generated.

DISABLED
Remote error events are not generated. This is the queue manager's initial default value.

REPOS(clustername)
The name of a cluster for which this queue manager provides a repository manager service. The maximum length is 48 characters conforming to the rules for naming WebSphere MQ objects.

No more than one of the resultant values of REPOS can be nonblank.

REPOSNL(nlname)
The name of a namelist of clusters for which this queue manager provides a repository manager service.

No more than one of the resultant values of REPOSNL can be nonblank.

If both REPOS and REPOSNL are blank, or REPOS is blank and the namelist specified by REPOSNL is empty, this queue manager does not have a full repository, but might be a client of other repository services that are defined in the cluster.

This parameter is valid only on AIX, Compaq OpenVMS, HP-UX, Linux, OS/2 Warp, OS/400, Solaris, Windows, and z/OS.

SSLCRLNL(nlname)
The name of a namelist of authentication information objects to be used for Certificate Revocation List (CRL) checking by the queue manager.

If SSLCRLNL is blank, CRL checking is not invoked.

Changes to SSLCRLNL, or to the names in a previously specified namelist, or to previously referenced authentication information objects, become effective either:

  • When a new channel process is started.

  • For channels that run as threads of the channel initiator when the channel initiator is restarted.

  • For channels that run as threads of the listener when the listener is restarted.

SSLCRYP(string)
Sets the name of the parameter string required to configure the cryptographic hardware present on the system.

The string can have one of the following values:

  • GSK_ACCELERATOR_RAINBOW_CS_OFF

  • GSK_ACCELERATOR_RAINBOW_CS_ON

  • GSK_ACCELERATOR_NCIPHER_NF_OFF

  • GSK_ACCELERATOR_NCIPHER_NF_ON

  • GSK_PKCS11=<the PKCS #11 driver path and filename>;<the PKCS #11 token label>;<the PKCS #11 token password>;

The strings containing RAINBOW enable or disable the Rainbow cryptographic hardware. If the Rainbow cryptographic hardware is present, it is enabled by default.

The strings containing NCIPHER enable or disable the nCipher cryptographic hardware. If the nCipher cryptographic hardware is present, it is enabled by default.

To use cryptographic hardware that is accessed using the PKCS #11 interface, specify the string containing PKCS11. The PKCS #11 driver path is an absolute path to the shared library providing support for the PKCS #11 card. The PKCS #11 driver filename is the name of the shared library. An example of the value required for the PKCS #11 driver path and filename is /usr/lib/pkcs11/PKCS11_API.so

The maximum length of the string is 256 characters. The default value is blank.

If you specify a string that does not begin with one of the cryptographic strings listed above, you get an error. If you specify the GSK_PKCS11 string, the syntax of the other parameters is also checked.

When the SSLCRYP value is changed, the cryptographic hardware parameters specified become the ones used for new SSL connection environments. The new information becomes effective:

  • When a new channel process is started.

  • For channels that run as threads of the channel initiator, when the channel initiator is restarted.

  • For channels that run as threads of the listener, when the listener is restarted.

SSLKEYR(string)
The name of the SSL key repository.

The maximum length of the string is 256 characters.

The format of the name is of the form pathname/keyfile, where keyfile is specified without the suffix (.kdb), and identifies a GSKit key database file. The default value is /var/mqm/qmgrs/QMGR/ssl/key, where QMGR is replaced by the queue manager name.

The syntax of this parameter is validated to ensure that it contains a valid, absolute, directory path.

If SSLKEYR is blank, or is set to a value that does not correspond to a key ring or key database file, channels using SSL fail to start.

Changes to SSLKEYR become effective either:

  • When a new channel process is started.

  • For channels that run as threads of the channel initiator when the channel initiator is restarted.

  • For channels that run as threads of the listener, when the listener is restarted.

SSLTASKS(integer)
The number of server subtasks to use for processing SSL calls. To use SSL channels, have at least two of these tasks running.

This parameter is valid only on z/OS.

This is in the range zero through 9999. To avoid problems with storage allocation, do not set the SSLTASKS parameter to a value greater than 50.

Changes to this parameter will be effective when the channel initiator is restarted.

STRSTPEV
Whether start and stop events are generated:

ENABLED
Start and stop events are generated. This is the queue manager's initial default value.

DISABLED
Start and stop events are not generated.

TRIGINT(integer)
A time interval expressed in milliseconds.

The TRIGINT parameter is relevant only if the trigger type (TRIGTYPE) is set to FIRST (see DEFINE QLOCAL for details). In this case trigger messages are normally generated only when a suitable message arrives on the queue, and the queue was previously empty. Under certain circumstances, however, an additional trigger message can be generated with FIRST triggering even if the queue was not empty. These additional trigger messages are not generated more often than every TRIGINT milliseconds. See the WebSphere MQ Application Programming Guide for more information.

Specify a value in the range zero through 999 999 999.

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.