Set Archive on z/OS

Use the Set Archive (MQCMD_SET_ARCHIVE) to dynamically change certain archive system parameter values initially set by the system parameter module at queue manager startup.


Required parameters

    ParameterType (MQCFIN)
    Parameter type (parameter identifier: MQIACF_SYSP_TYPE). Specifies how the parameters are to be reset:

      MQSYSP_TYPE_INITIAL
      The initial settings of the archive system parameters. MQSYSP_TYPE_INITIAL resets all the archive system parameters to the values set at queue manager startup.

      MQSYSP_TYPE_SET
      MQSYSP_TYPE_SET indicates that you intend to change one, or more, of the archive system parameter settings.


Optional parameters

    AllocPrimary (MQCFIN)
    Primary space allocation for DASD data sets (parameter identifier: MQIACF_SYSP_ALLOC_PRIMARY).

    Specifies the primary space allocation for DASD data sets in the units specified in the AllocUnits parameter.

    Specify a value greater than zero. This value must be sufficient for a copy of either the log data set or its corresponding BSDS, whichever is the larger.

    AllocSecondary (MQCFIN)
    Secondary space allocation for DASD data sets (parameter identifier: MQIACF_SYSP_ALLOC_SECONDARY).

    Specifies the secondary space allocation for DASD data sets in the units specified in the AllocUnits parameter.

    Specify a value greater than zero.

    AllocUnits (MQCFIN)
    Allocation unit (parameter identifier: MQIACF_SYSP_ALLOC_UNIT). Specifies the unit in which primary and secondary space allocations are made. The value can be any of the following values:

      MQSYSP_ALLOC_BLK
      Blocks.

      MQSYSP_ALLOC_TRK
      Tracks.

      MQSYSP_ALLOC_CYL
      Cylinders.

    ArchivePrefix1 (MQCFST)
    Specifies the prefix for the first archive log data set name (parameter identifier: MQCACF_SYSP_ARCHIVE_PFX1).

    The maximum length of the string is MQ_ARCHIVE_PFX_LENGTH.

    ArchivePrefix2 (MQCFST)
    Specifies the prefix for the second archive log data set name (parameter identifier: MQCACF_SYSP_ARCHIVE_PFX2).

    The maximum length of the string is MQ_ARCHIVE_PFX_LENGTH.

    ArchiveRetention (MQCFIN)
    Archive retention period (parameter identifier: MQIACF_SYSP_ARCHIVE_RETAIN).

    Specifies the retention period, in days, to be used when the archive log data set is created. Specify a value in the range zero through 9999.

    For more information, see Discarding archive log data sets.

    ArchiveUnit1 (MQCFST)
    Specifies the device type or unit name of the device that is used to store the first copy of the archive log data set (parameter identifier: MQCACF_SYSP_ARCHIVE_UNIT1).

    Specify a device type or unit name of 1-8 characters.

    If you archive to DASD, we can specify a generic device type with a limited volume range.

    The maximum length of the string is MQ_ARCHIVE_UNIT_LENGTH.

    ArchiveUnit2 (MQCFST)
    Specifies the device type or unit name of the device that is used to store the second copy of the archive log data set (parameter identifier: MQCACF_SYSP_ARCHIVE_UNIT2).

    Specify a device type or unit name of 1-8 characters.

    If this parameter is blank, the value set for the ArchiveUnit1 parameter is used.

    The maximum length of the string is MQ_ARCHIVE_UNIT_LENGTH.

    ArchiveWTOR (MQCFIN)
    Specifies whether a message is to be sent to the operator and a reply is received before attempting to mount an archive log data set (parameter identifier: MQIACF_SYSP_ARCHIVE_WTOR).

    Other IBM MQ users might be forced to wait until the data set is mounted, but they are not affected while IBM MQ is waiting for the reply to the message.

    The value can be any of the following values:

      MQSYSP_YES
      A message is to be sent and a reply received before an attempt to mount an archive log data set.

      MQSYSP_NO
      A message is not to be sent and a reply received before an attempt to mount an archive log data set.

    BlockSize (MQCFIN)
    Block size of the archive log data set (parameter identifier: MQIACF_SYSP_BLOCK_SIZE).

    The block size you specify must be compatible with the device type you specify in the ArchiveUnit1 and ArchiveUnit2 parameters.

    Specify a value in the range 4 097 through 28 672. The value you specify is rounded up to a multiple of 4 096.

    This parameter is ignored for data sets that are managed by the storage management system (SMS).

    Catalog (MQCFIN)
    Specifies whether archive log data sets are cataloged in the primary integrated catalog facility (parameter identifier: MQIACF_SYSP_CATALOG). The value can be:

      MQSYSP_YES
      Archive log data sets are cataloged.

      MQSYSP_NO
      Archive log data sets are not cataloged.

    CommandScope (MQCFST)
    Command scope (parameter identifier: MQCACF_COMMAND_SCOPE). 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 processed on the queue manager on which it was entered.
    • a queue manager name. The command is processed 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 processed 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.

    Compact (MQCFIN)
    Specifies whether data written to archive logs is to be compacted (parameter identifier: MQIACF_SYSP_COMPACT).

    This parameter applies to a 3480 or 3490 device that has the improved data recording capability (IDRC) feature. When this feature is turned on, hardware in the tape control unit writes data at a much higher density than normal, allowing for more data on each volume. Specify MQSYSP_NO if you do not use a 3480 device with the IDRC feature or a 3490 base model, except for the 3490E. Specify MQSYSP_YES if we want the data to be compacted.

    The value can be:

      MQSYSP_YES
      Data is to be compacted.

      MQSYSP_NO
      Data is not to be compacted.

    Protect (MQCFIN)
    Protection by external security manager (ESM) (parameter identifier: MQIACF_SYSP_PROTECT).

    Specifies whether archive log data sets are protected by ESM profiles when the data sets are created.

    If you specify MQSYSP_YES, ensure that:

    • ESM protection is active for IBM MQ.
    • The user ID associated with the IBM MQ address space has authority to create these profiles.
    • The TAPEVOL class is active if we are archiving to tape.

    otherwise, offload processing fails. The value can be any of the following values:

      MQSYSP_YES
      Data set profiles are created when logs are offloaded.

      MQSYSP_NO
      Profiles are not created.

    QuiesceInterval (MQCFIN)
    Maximum time allowed for the quiesce (parameter identifier: MQIACF_SYSP_QUIESCE_INTERVAL).

    Specifies the maximum time, in seconds, allowed for the quiesce.

    Specify a value in the range 1 through 999.

    RoutingCode (MQCFIL)
    z/OS routing code list (parameter identifier: MQIACF_SYSP_ROUTING_CODE).

    Specifies the list of z/OS routing codes for messages about the archive log data sets to the operator.

    Specify up to 14 routing codes, each with a value in the range zero through 16. We must specify at least one code.

    TimeStampFormat (MQCFIN)
    Time stamp included (parameter identifier: MQIACF_SYSP_TIMESTAMP).

    Specifies whether the archive log data set name has a time stamp in it.

    The value can be:

      MQSYSP_YES
      Names include a time stamp. The archive log data sets are named: 
      arcpfxi.cyyddd.T hhmmsst.A nnnnnnn
      where c is 'D' for the years up to and including 1999 or 'E' for the year 2000 and later, and arcpfxi is the data set name prefix specified by ArchivePrefix1 or ArchivePrefix2. arcpfxi can have up to 19 characters.

      MQSYSP_NO
      Names do not include a time stamp. The archive log data sets are named: 
      arcpfxi.A nnnnnnn

      Where arcpfxi is the data set name prefix specified by ArchivePrefix1 or ArchivePrefix2. arcpfxi can have up to 35 characters.

      MQSYSP_EXTENDED
      Names include a time stamp. The archive log data sets are named: 
      arcpfxi.D yyyyddd.T hhmmsst.A nnnnnnn

      Where arcpfxi is the data set name prefix specified by ArchivePrefix1 or ArchivePrefix2. arcpfxi can have up to 17 characters.

Parent topic: Definitions of the Programmable Command Formats