Supported filter list parameters for the HSMRQUE function

DSN=xxxxxxxxxx

Filters on the data set name as contained in the message text

DSNn=xxxxxxxx

Specifies a data set name qualifier

MainView SRM name masking can be used.

HLQ=xxxxxxxx

Contains the high-level qualifier of a data set name

MainView SRM name masking can be used.

HSM_#PEND_G=nnnnn

Contains the total number of pending recall requests

The variable is a number between 0 and 32767. Although this parameter is shown here with an equal sign, it is more likely that a greater-than sign or lesser-than sign will achieve the desired results.

HSM_#PEND_L=nnnnn

Contains the number of pending recall requests on the local system

The variable is a number between 0 and 32767. Although this parameter is shown here with an equal sign, it is more likely that a greater-than sign or lesser-than sign will achieve the desired results.

HSM_#SAME_G=nnnnn

Contains the total number of pending recall requests for the same user

The variable is a number between 1 and 32767. Although this parameter is shown here with an equal sign, it is more likely that a greater-than sign or lesser-than sign will achieve the desired results.

HSM_#SAME_L=nnnnn

Contains the number of pending recall requests that originated on the local system for the same user

The variable is a number between 1 and 32767. Although this parameter is shown here with an equal sign, it is more likely that a greater-than sign or lesser-than sign will achieve the desired results.

HSM_ACTIVE=Y | N

Indicates whether the recall request is currently being processed by DFSMShsm (Y) or still waiting to be processed (N)

This keyword is valid only for function HSMRQUE.

Note: HSM_CANCEL=Y cannot be used with this parameter.

HSM_HOST=xx

Filters on the ID of the DFSMShsm host that is executing the request

The host ID is always available.

HSM_JOBNAM=xxxxxxxx

Filters on the name of the batch job or started task that requested the recall

Note: To filter on TSO ID, use the HSM_USERID keyword.

HSM_MLV=x

Filters the migration level of the volume

The variable can be a 1 or a 2.

HSM_PRTY=nnn

Filters the recall request priority set by DFSMShsm and possibly modified by Return Priority (ARCRPEXT) installation exit

This FLST keyword is valid only for function HSMRQUE.

HSM_SIZE=nnnnnnnnnnnnnnnnnn

Specifies the migrated data set size (0 to 9223372036854775807)

HSM_SOURCE=TSO | TMP | OPER | BATCH | INT

Indicates the source from which a recall request was generated

• TSO (by TSO)

• TMP (by TMP)

• OPER (by operator)

• BATCH (by either batch job or Started Task)

• INT (internally by DFSMShsm)

HSM_TIME=hhmmss

Specifies the elapsed time since the recall was requested

Although this parameter is shown here with an equal sign, it is more likely that a greater-than sign or lesser-than sign will achieve the desired results.

HSM_TIME_EX=hhmmss

Specifies the elapsed time since DFSMShsm started executing the recall request

This keyword is valid only for function HSMRQUE.

Note: HSM_CANCEL=Y cannot be used with this parameter. EVENT ID is the only action that can be used for this parameter.

Although this parameter is shown here with an equal sign, it is more likely that a greater-than sign or lesser-than sign will achieve the desired results.

HSM_TRKS=nnnnnnnnn

Contains the migrated data set size in tracks

The variable is a number between 0 and 2147483647.

HSM_USERID=xxxxxxxx

Specifies the user ID of the recall requestor

MainView SRM masking can be used.

• To filter for requests generated by the operator, use the OPER parameter.
• To filter on job names, use the HSM_JOBNAM keyword.

HSM_WAIT=Y|N

Indicates whether the recall requestor is waiting for the recall completion

LLQ=xxxxxxxx

Specifies the low-level qualifier of a data set name

MainView SRM name masking can be used.

MGMTCLAS=xxxxxxxx

Specifies the name of a DFSMS management class

MainView SRM name masking can be used.

POOL=xxxxxxxx

Specifies the name of a pool associated with the recall request

The pool name is based in the volume in which the data set resided on prior to being migrated.

MainView SRM name masking can be used. Up to 15 values can be specified within parentheses for this parameter when it is used as an action parameter on a SET statement.

REC_TYPE=D | G | U

Specifies the type of pending recall request queue criteria under which you will receive an action notification

Pending recall means a requested recall that is either currently processed or is waiting for execution.

• D—Each pending recall is checked against all function HSMRQUE INC/EXC parameters. Action is issued for every recall satisfying INC/EXC criteria.

• G—All pending recalls are checked against function HSMRQUE INC/EXC parameters representing global statistics for all pending recalls. These parameters are as follows:

  • HSM_#PEND_G is the total number of pending recall requests.

  • HSM_#PEND_L is the number of pending recall requests requested on local system.

  • An action notification is issued only if global statistics for all pending recalls satisfy INC/EXC criteria for parameters outlined above.

• U—For every user that has unfinished recalls in the pending recall queue are checked against the following HSMRQUE INC/EXC parameters:

  • HSM_#SAME_G is the total number of pending recall requests for the same user.

  • HSM_#SAME_L is the number of pending recall requests requested on local system by the same user.

  • HSM_USERID is the user ID of the recall requestor.

An action notification is issued for every user that requested at least one recall that has not yet executed. In other words, one action is issued for every user waiting for at least one recall.

SMSMANAGED=Y | N

SMS=Y | N

Specifies whether the data set was managed by DFSMS before migration

STOGROUP=xxxxxxxx

STORGRP=xxxxxxxx

Specifies the DFSMS storage group name for a data set

MainView SRM name masking can be used.

STORCLAS=xxxxxxxx

Specifies the DFSMS storage class name for a data set

MainView SRM name masking can be used.