Change, Copy, and Create Namelist

The Change Namelist command changes existing namelist definitions. The Copy and Create Namelist commands create new namelist definitions - the Copy command uses attribute values of an existing namelist definition.

The Change Namelist (MQCMD_CHANGE_NAMELIST) command changes the specified attributes of an existing IBM MQ namelist definition. For any optional parameters that are omitted, the value does not change.

The Copy Namelist (MQCMD_COPY_NAMELIST) command creates an IBM MQ namelist definition, using, for attributes not specified in the command, the attribute values of an existing namelist definition.

The Create Namelist (MQCMD_CREATE_NAMELIST) command creates an IBM MQ namelist definition. Any attributes that are not defined explicitly are set to the default values on the destination queue manager.


Required parameter (Change and Create Namelist)

    NamelistName (MQCFST)
    The name of the namelist definition to be changed (parameter identifier: MQCA_NAMELIST_NAME).

    The maximum length of the string is MQ_NAMELIST_NAME_LENGTH.


Required parameters (Copy Namelist)

    FromNamelistName (MQCFST)
    The name of the namelist definition to be copied from (parameter identifier: MQCACF_FROM_NAMELIST_NAME).

    This parameter specifies the name of the existing namelist definition that contains values for the attributes not specified in this command.

    On z/OS, the queue manager searches for an object with the name you specify and a disposition of MQQSGD_Q_MGR or MQQSGD_COPY to copy from. This parameter is ignored if a value of MQQSGD_COPY is specified for QSGDisposition . In this case, an object with the name specified by ToNamelistName and the disposition MQQSGD_GROUP is searched for to copy from.

    The maximum length of the string is MQ_NAMELIST_NAME_LENGTH.

    ToNamelistName (MQCFST)
    To namelist name (parameter identifier: MQCACF_TO_NAMELIST_NAME).

    This parameter specifies the name of the new namelist definition. If a namelist definition with this name exists, Replace must be specified as MQRP_YES.

    The maximum length of the string is MQ_NAMELIST_NAME_LENGTH.


Optional parameters (Change, Copy, and Create Namelist)

    CommandScope (MQCFST)
    Command scope (parameter identifier: MQCACF_COMMAND_SCOPE). This parameter applies to z/OS only. Specifies how the command is executed when the queue manager is a member of a queue sharing group. We can specify one of the following:

    • blank (or omit the parameter altogether). The command is executed on the queue manager on which it was entered.
    • a queue manager name. The command is executed on the queue manager you specify, providing it is active within the queue sharing group. If you specify a queue manager name other than the queue manager on which it was entered, we must be using a queue sharing group environment, and the command server must be enabled.
    • an asterisk (*). The command is executed on the local queue manager and is also passed to every active queue manager in the queue sharing group.

    The maximum length is MQ_QSG_NAME_LENGTH.

    NamelistDesc (MQCFST)
    Description of namelist definition (parameter identifier: MQCA_NAMELIST_DESC).

    This parameter is a plain-text comment that provides descriptive information about the namelist definition. It must contain only displayable characters.

    If characters are used that are not in the coded character set identifier (CCSID) for the queue manager on which the command is executing, they might be translated incorrectly.

    The maximum length of the string is MQ_NAMELIST_DESC_LENGTH.

    NamelistType (MQCFIN)
    Type of names in the namelist (parameter identifier: MQIA_NAMELIST_TYPE). This parameter applies to z/OS only. Specifies the type of names in the namelist. The value can be any of the following values:

      MQNT_NONE
      The names are of no particular type.

      MQNT_Q
      A namelist that holds a list of queue names.

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

      MQNT_AUTH_INFO
      The namelist is associated with TLS, and contains a list of authentication information object names.

    Names (MQCFSL)
    The names to be placed in the namelist (parameter identifier: MQCA_NAMES).

    The number of names in the list is given by the Count field in the MQCFSL structure. The length of each name is given by the StringLength field in that structure. The maximum length of a name is MQ_OBJECT_NAME_LENGTH.

    QSGDisposition (MQCFIN)
    Disposition of the object within the group (parameter identifier: MQIA_QSG_DISP). 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). The value can be any of the following values:

    QSGDisposition Change Copy, Create
    MQQSGD_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 parameter MQQSGD_COPY. Any object residing in the shared repository, or any object defined using a command that had the parameters MQQSGD_Q_MGR, is not affected by this command. The object is defined on the page set of the queue manager that executes the command using the MQQSGD_GROUP object of the same name as the ToNameListName object (for Copy) or NameListName object (for Create).
    MQQSGD_GROUP The object definition resides in the shared repository. The object was defined using a command that had the parameter MQQSGD_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 MQSC 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 Change for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.     		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 MQSC 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)
    The Copy or Create for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
    MQQSGD_PRIVATE The object resides on the page set of the queue manager that executes the command, and was defined with MQQSGD_Q_MGR or MQQSGD_COPY. Any object residing in the shared repository is unaffected. Not permitted.
    MQQSGD_Q_MGR 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 parameter MQQSGD_Q_MGR. Any object residing in the shared repository, or any local copy of such an object, is not affected by this command. This value is the default value. The object is defined on the page set of the queue manager that executes the command. This value is the default value.

    Replace (MQCFIN)
    Replace attributes (parameter identifier: MQIACF_REPLACE). If a namelist definition with the same name as ToNamelistName exists, this definition specifies whether it is to be replaced. The value can be:

      MQRP_YES
      Replace existing definition.

      MQRP_NO
      Do not replace existing definition.

Parent topic: Definitions of the Programmable Command Formats