Script (MQSC) Command Reference: DEFINE NAMELIST

DEFINE NAMELIST

Use DEFINE NAMELIST to define a list of names. This is most commonly a list of cluster names or queue names.
Notes:

On UNIX systems, the command is valid only on AIX, HP-UX, Linux and Solaris.

Synonym: DEF NL
DEFINE NAMELIST
 
>>-DEFINE NAMELIST(name)---------------------------------------->
 
   .-CMDSCOPE(' ')------------. (1) (1)
>--+--------------------------+--------------------------------->
   |                     (2)  |
   +-CMDSCOPE(qmgr-name)------+
   |             (2)          |
   '-CMDSCOPE(*)--------------'
 
   .-QSGDISP(QMGR)-------. (1)
>--+---------------------+-------+------------------+----------->
   |               (2)   |       '-| define attrs |-'
   +-QSGDISP(COPY)-------+
   |                (2)  |
   '-QSGDISP(GROUP)------'
 
>--+--------------------+--------------------------------------><
   '-| namelist attrs |-'
 
Define attrs
 
                            .-NOREPLACE-.
|--+---------------------+--+-----------+-----------------------|
   '-LIKE(namelist-name)-'  '-REPLACE---'
 
Namelist attrs
 
                (3)
   .-DESCR(' ')------.
|--+-----------------+--+-----------------------+--------------->
   '-DESCR(string)---'  |        .-,--------.   |
                        |        V          |   |
                        '-NAMES(---+------+-+-)-'
                                   '-name-'
 
                  (1) (3)
   .-NLTYPE(NONE)----------.
>--+-----------------------+------------------------------------|
   +-NLTYPE(QUEUE)---------+
   +-NLTYPE(Q)-------------+
   +-NLTYPE(CLUSTER)-------+
   '-NLTYPE(AUTHINFO)------'
 
 
Notes:

Valid only on z/OS.
Valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
This is the default supplied with WebSphere MQ, but your installation might have changed it.

Parameter descriptions

The parameter descriptions also apply to the ALTER NAMELIST command, with the following exceptions:

The LIKE parameter applies only to the DEFINE NAMELIST command.
The REPLACE and NOREPLACE parameter applies only to the DEFINE NAMELIST command.
The variations in the CMDSCOPE and QSGDISP parameters between the ALTER NAMELIST and DEFINE NAMELIST commands are described.
(name)

Name of the list. This is required.
The name must not be the same as any other namelist name currently defined on this queue manager (unless REPLACE or ALTER is specified). See Rules for naming WebSphere MQ objects.

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.
CMDSCOPE must be blank, or the local queue manager, if QSGDISP is set to 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 it was entered, only if you are using a shared queue 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.

DESCR(string)

Plain-text comment. It provides descriptive information about the namelist when an operator issues the DISPLAY NAMELIST command (see DISPLAY NAMELIST).
It should contain only displayable characters. The maximum length 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.

LIKE(namelist-name)
The name of a namelist, whose parameters will be used to model this definition.
This parameter applies only to the DEFINE NAMELIST command
If this field is not filled in, and you do not complete the parameter fields related to the command, the values are taken from the default definition for namelists on this queue manager.
This is equivalent to specifying:
LIKE(SYSTEM.DEFAULT.NAMELIST)
A default namelist definition is provided, but it can be altered by the installation to the default values required. See Rules for naming WebSphere MQ objects.
On WebSphere MQ for z/OS, the queue manager searches page set zero for an object with the name you specify. The disposition of the LIKE object is not copied to the object you are defining.
Notes:

QSGDISP (GROUP) objects are not searched.
LIKE is ignored if QSGDISP(COPY) is specified.
NAMES(name, ...)

List of names.
The names can be of any type, but must conform to the rules for naming WebSphere MQ objects, with a maximum length of 48 characters.
An empty list is valid: specify NAMES(). The maximum number of names in the list is 256.

NLTYPE

Indicates the type of names in the namelist.
This parameter is valid only on z/OS.

NONE
The names are of no particular type.

QUEUE or Q
A namelist that holds a list of queue names.

CLUSTER
A namelist that is associated with clustering, containing a list of the cluster names.

AUTHINFO
This namelist is associated with SSL and should contain a list of authentication information object names.

Namelists used for clustering must have NLTYPE(CLUSTER) or NLTYPE(NONE).
Namelists used for SSL must have NLTYPE(AUTHINFO).

QSGDISP
This parameter applies to z/OS only.
Specifies the disposition of the object to which you are applying the command (that is, where it is defined and how it behaves).
QSGDISP ALTER DEFINE

COPY The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(COPY). Any object residing in the shared repository, or any object defined using a command that had the parameters QSGDISP(QMGR), is not affected by this command. The object is defined on the page set of the queue manager that executes the command using the QSGDISP(GROUP) object of the same name as the 'LIKE' object.
GROUP
The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(GROUP). Any object residing on the page set of the queue manager that executes the command (except a local copy of the object) is not affected by this command.
If the command is successful, the following command is generated and sent to all active queue managers in the queue-sharing group so that they refresh local copies on page set zero:
DEFINE NAMELIST(name) 
REPLACE QSGDISP(COPY)
The object definition resides in the shared repository. This is allowed only if the queue manager is in a queue-sharing group.
If the definition is successful, the following command is generated and sent to all active queue managers in the queue-sharing group so that they make or refresh local copies on page set zero:
DEFINE NAMELIST(name) 
REPLACE QSGDISP(COPY)
PRIVATE The object resides on the page set of the queue manager that executes the command, and was defined with QSGDISP(QMGR) or QSGDISP(COPY).
Any object residing in the shared repository is unaffected. Not permitted.

QMGR The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(QMGR). Any object residing in the shared repository, or any local copy of such an object, is not affected by this command.
This is the default value. The object is defined on the page set of the queue manager that executes the command.
This is the default value.
REPLACE and NOREPLACE

Whether the existing definition (and on z/OS, with the same disposition) is to be replaced with this one. This is optional. The default is NOREPLACE. Any object with a different disposition is not changed.
This parameter applies only to the DEFINE NAMELIST command

REPLACE

The definition should replace any existing definition of the same name. If a definition does not exist, one is created.

NOREPLACE

The definition should not replace any existing definition of the same name.
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.

QSGDISP	ALTER	DEFINE
COPY	The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(COPY). Any object residing in the shared repository, or any object defined using a command that had the parameters QSGDISP(QMGR), is not affected by this command.	The object is defined on the page set of the queue manager that executes the command using the QSGDISP(GROUP) object of the same name as the 'LIKE' object.
GROUP	The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(GROUP). Any object residing on the page set of the queue manager that executes the command (except a local copy of the object) is not affected by this command. If the command is successful, the following command is generated and sent to all active queue managers in the queue-sharing group so that they refresh local copies on page set zero: DEFINE NAMELIST(name) REPLACE QSGDISP(COPY)	The object definition resides in the shared repository. This is allowed only if the queue manager is in a queue-sharing group. If the definition is successful, the following command is generated and sent to all active queue managers in the queue-sharing group so that they make or refresh local copies on page set zero: DEFINE NAMELIST(name) REPLACE QSGDISP(COPY)
PRIVATE	The object resides on the page set of the queue manager that executes the command, and was defined with QSGDISP(QMGR) or QSGDISP(COPY). Any object residing in the shared repository is unaffected.	Not permitted.
QMGR	The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(QMGR). Any object residing in the shared repository, or any local copy of such an object, is not affected by this command. This is the default value.	The object is defined on the page set of the queue manager that executes the command. This is the default value.