SET ARCHIVE on z/OS

Use the MQSC command SET ARCHIVE to dynamically change certain archive system parameter values initially set by your system parameter module at queue manager startup.


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 12CR. For an explanation of the source symbols, see Use commands on z/OS®.

Synonym: SET ARC

SET ARCHIVE

SET ARCHIVE DEFAULTparameter block
  • CMDSCOPE(' ')CMDSCOPE(qmgr-name)
  • 1
  • CMDSCOPE(*)1
  • Parameter BlockALCUNIT(CYLTRKBLK
  • )
  • ARCPFX1(string)
  • ARCPFX2(string)
  • ARCRETN(integer)
  • ARCWRTC(string)
  • ARCWTOR(string)
  • BLKSIZE(integer)
  • CATALOG(NOYES)
  • COMPACT(NOYES)
  • PRIQTY(integer)
  • PROTECT(NOYES
  • )
  • QUIESCE(integer)
  • SECQTY(integer)
  • TSTAMP(NOYESEXT
  • )
  • UNIT(string)
  • UNIT2(string)
  • Notes:

    • 1 Valid only when the queue manager is a member of a queue sharing group.


    Usage notes for SET ARCHIVE

    1. The new values will be used at the next archive log offload.
    2. The queue manager picks up the values in ZPARM, so the SET ARCHIVE values you used in the previous cycle are lost.

      To permanently change the values, either change the CSQ6SYSP parameters and regenerate the parameter module, or put the SET ARCHIVE commands into a data set in the CSQINP2 concatenation.


    Parameter descriptions for SET ARCHIVE

      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 cannot be used for commands issued from the first initialization input data set CSQINP1.

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

        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 you are using a queue sharing group environment and if the command server is enabled.

        We cannot use CMDSCOPE( qmgr-name) for commands issued from the first initialization input data set, CSQINP1.

        *
        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 this is the same as entering the command on every queue manager in the queue sharing group.

        We cannot use CMDSCOPE(*) for commands issued from CSQINP1.

      DEFAULT
      Resets all the archive system parameters to the values set at queue manager startup.


    Parameter block

    For a full description of these parameters, see Use CSQ6ARVP.

    Parameter block is any one or more of the following parameters to change:

      ALCUNIT
      Specifies the unit in which primary and secondary space allocations are made. Specify one of:

        CYL
        Cylinders

        TRK
        Tracks

        BLK
        Blocks

      ARCPFX1
      Specifies the prefix for the first archive log data set name.

      See the TSTAMP parameter for a description of how the data sets are named and for restrictions on the length of ARCPFX1.

      ARCPFX2
      Specifies the prefix for the second archive log data set name.

      See the TSTAMP parameter for a description of how the data sets are named and for restrictions on the length of ARCPFX2.

      ARCRETN
      Specifies the retention period, in days, to be used when the archive log data set is created.

      The parameter must be in the range zero - 9999.

      For more information about discarding archive log data sets, see Discarding archive log data sets.

      ARCWRTC
      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 1 through 16. You must specify at least one code. Separate codes in the list by commas, not by blanks.

      For more information about z/OS routing codes, see the MVS Routing and Descriptor Codes manual.

      ARCWTOR
      Specifies whether a message is to be sent to the operator and a reply received before attempting to mount an archive log data set.

      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.

      Specify either:

        YES
        The device needs a long time to mount archive log data sets. For example, a tape drive. (The synonym is Y.)

        NO
        The device does not have long delays. For example, DASD. (The synonym is N.)

      BLKSIZE
      Specifies the block size of the archive log data set. The block size you specify must be compatible with the device type you specify in the UNIT parameter.

      The parameter must be 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 subsystem (SMS).

      CATALOG
      Specifies whether archive log data sets are cataloged in the primary integrated catalog facility (ICF) catalog. Specify either:

        NO
        Archive log data sets are not cataloged. (The synonym is N.)

        YES
        Archive log data sets are cataloged. (The synonym is Y.)

      COMPACT
      Specifies whether data written to archive logs is to be compacted. This option applies only 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 NO if we do not use a 3480 device with the IDRC feature or a 3490 base model, with the exception of the 3490E. Specify YES if you want the data to be compacted. Specify either:

        NO
        Do not compact the data sets. (The synonym is N.)

        YES
        Compact the data sets. (The synonym is Y.)

      PRIQTY
      Specifies the primary space allocation for DASD data sets in ALCUNITs.

      The value must be 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.

      PROTECT
      Specifies whether archive log data sets are to be protected by discrete ESM (external security manager) profiles when the data sets are created. Specify either:

        NO
        Profiles are not created. (The synonym is N.)

        YES
        Discrete data set profiles are created when logs are offloaded. (The synonym is Y.) If you specify YES:

        • ESM protection must be active for IBM MQ.
        • The user ID associated with the IBM MQ address space must have authority to create these profiles.
        • The TAPEVOL class must be active if you are archiving to tape.
        Otherwise, offloads will fail.

      QUIESCE
      Specifies the maximum time in seconds allowed for the quiesce when an ARCHIVE LOG command is issued with MODE QUIESCE specified.

      The parameter must be in the range 1 through 999.

      SECQTY
      Specifies the secondary space allocation for DASD data sets in ALCUNITs.

      The parameter must be greater than zero.

      TSTAMP
      Specifies whether the archive log data set name has a time stamp in it. Specify either:

        NO
        Names do not include a time stamp. (The synonym is N.) The archive log data sets are named: 
        arcpfxi.A nnnnnnn

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

        YES
        Names include a time stamp. (The synonym is Y.) 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 ARCPFX1 or ARCPFX2. arcpfxi can have up to 19 characters.

        EXT
        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 ARCPFX1 or ARCPFX2. arcpfxi can have up to 17 characters.

      UNIT
      Specifies the device type or unit name of the device that is used to store the first copy of the archive log data set.

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

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

      UNIT2
      Specifies the device type or unit name of the device that is used to store the second copy of the archive log data sets.

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

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