DEFINE NAMELIST

Use the MQSC command DEFINE NAMELIST to define a list of names. This is most commonly a list of cluster names or queue names.


Use MQSC commands

For information on how we use MQSC commands, see Performing local administration tasks using MQSC commands.

We can issue this command from sources 2CR. For an explanation of the source symbols, see Sources from which we can issue MQSC commands on z/OS .

Synonym: DEF NL

Values shown above the main line in the railroad diagram are the defaults supplied with IBM MQ, but your installation might have changed them. See Syntax diagrams.


DEFINE NAMELIST

DEFINE NAMELIST ( name ) CMDSCOPE(' ')CMDSCOPE(qmgr-name)1CMDSCOPE(*)12QSGDISP(QMGR)QSGDISP(COPY)1QSGDISP(GROUP)12define attrsnamelist attrsDefine attrsLIKE(namelist-name)NOREPLACEREPLACENamelist attrsDESCR(' ')DESCR(string)NAMES(,name)NLTYPE(NONE)NLTYPE(QUEUE)NLTYPE(Q)NLTYPE(CLUSTER)NLTYPE(AUTHINFO)2Notes:

  • 1 Valid only on z/OS when the queue manager is a member of a queue sharing group.
  • 2 Valid only on z/OS.


Usage notes

Successful completion of the command does not mean that the action completed. To check for true completion, see the DEFINE NAMELIST step in Check that async commands for distributed networks have finished.


Parameter descriptions for DEFINE NAMELIST

    (name)
    Name of the list.

    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 IBM MQ objects.

    CMDSCOPE
    This parameter applies to z/OS only and specifies how the command runs 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 runs on the queue manager on which it was entered.

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

      We can specify a queue manager name other than the queue manager on which it was entered, only if we are using a shared queue environment and if the command server is enabled.

      *
      The command runs on the local queue manager and is also passed to every active queue manager in the queue sharing group. The effect of specifying * 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 must 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, with parameters that are used to model this definition.

    If this field is not completed and we do not complete the parameter fields related to the command, the values are taken from the default definition for namelists on this queue manager.

    Not completing this parameter 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 IBM MQ objects.

    On z/OS, the queue manager searches page set zero for an object with the name you specify and a disposition of QMGR or COPY. The disposition of the LIKE object is not copied to the object we are defining. Note:
    1. QSGDISP (GROUP) objects are not searched.
    2. 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 IBM 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 TLS and contains a list of authentication information object names.

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

    Namelists used for TLS must have NLTYPE(AUTHINFO).

    QSGDISP
    This parameter applies to z/OS only.

    Specifies the disposition of the object to which we are applying the command (that is, where it is defined and how it behaves).

    QSGDISP DEFINE
    COPY 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 but 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 to attempt to make or refresh local copies on page set zero: 
    DEFINE NAMELIST(name)
REPLACE QSGDISP(COPY)
    The DEFINE for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
    PRIVATE Not permitted.
    QMGR The object is defined on the page set of the queue manager that executes the command.

    REPLACE and NOREPLACE
    Whether the existing definition (and on z/OS, with the same disposition) is to be replaced with this one. Any object with a different disposition is not changed.

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

      NOREPLACE
      The definition does not replace any existing definition of the same name.

Parent topic: MQSC commands


Related information