Inquire Archive (Response) on z/OS

The response to the Inquire Archive (MQCMD_INQUIRE_ARCHIVE) command consists of the response header followed by the ParameterType structure and the combination of attribute parameter structures determined by the value of ParameterType.

Always returned:

ParameterType Specifies the type of archive information being returned. The value can be any of the following values:

MQSYSP_TYPE_INITIAL: The initial settings of the archive parameters.
MQSYSP_TYPE_SET: The settings of the archive parameters if they have been altered since their initial setting.
MQSYSP_TYPE_ARCHIVE_TAPE: Parameters relating to the tape unit (if in use). There is one such message per tape unit in use for archive logging.

Returned if ParameterType is MQSYSP_TYPE_INITIAL (one message is returned):

AllocPrimary, AllocSecondary, AllocUnits, ArchivePrefix1, ArchivePrefix2, ArchiveRetention, ArchiveUnit1, ArchiveUnit2, ArchiveWTOR, BlockSize, Catalog, Compact, Protect, QuiesceInterval, RoutingCode, TimeStampFormat

Returned if ParameterType is MQSYSP_TYPE_SET and any value is set (one message is returned):

Returned if ParameterType is MQSYSP_TYPE_ARCHIVE_TAPE (one message is returned for each tape unit in use for archive logging):

DataSetName, LogCorrelId, UnitAddress, UnitStatus, UnitVolser

Response data - archive parameter information

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.

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.

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): 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): 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.

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).
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).
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). The value can be:

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).

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.

Compact (MQCFIN)

Specifies whether data written to archive logs is to be compacted (parameter identifier: MQIACF_SYSP_COMPACT). The value can be any of the following values:

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.

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.

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. There can be 1 - 14 entries in the list.

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.
MQSYSP_NO: Names do not include a time stamp.
MQSYSP_EXTENDED: Names include a time stamp.

Response data - tape unit status information

DataSetName (MQCFST)

Data set name (parameter identifier: MQCACF_DATA_SET_NAME).

Specifies the data set name on the tape volume that is being processed, or was last processed.

The maximum length of the string is MQ_DATA_SET_NAME_LENGTH.

LogCorrelId (MQCFST)

Correlation identifier (parameter identifier: MQCACF_SYSP_LOG_CORREL_ID).

Specifies the correlation ID associated with the user of the tape being processed. This parameter is blank if there is no current user.

The maximum length of the string is MQ_LOG_CORREL_ID_LENGTH.

UnitAddress (MQCFIN): Tape unit address: MQIACF_SYSP_UNIT_ADDRESS).
Specifies the physical address of the tape unit allocated to read the archive log.

UnitStatus (MQCFIN)

Status if the tape unit: MQIACF_SYSP_UNIT_STATUS). The value can be:

MQSYSP_STATUS_BUSY: The tape unit is busy, actively processing an archive log data set.
MQSYSP_STATUS_PREMOUNT: The tape unit is active and allocated for premounting.
MQSYSP_STATUS_AVAILABLE: The tape unit is available, inactive, and waiting for work.
MQSYSP_STATUS_UNKNOWN: The tape unit status us unknown.

UnitVolser (MQCFST): The volume serial number of the tape that is mounted (parameter identifier: MQCACF_SYSP_UNIT_VOLSER).
The maximum length of the string is MQ_VOLSER_LENGTH.