Optional parameters

DATASET
Specifies that XRC direct the XQUERY output to the sequential data set that is identified by dataset_name. Standard TSO naming conventions apply for dataset_name. The target data set must be a sequential data set and must be large enough to accommodate the XQUERY reports you want to collect. You can specify DATASET with or without DISP; the default is DISP(OLD).
Allocate a data set for the XQUERY function with the following attributes:
    DCB=(RECFM=FB,LRECL=80,BLKSIZE=6400,DSORG=PS)
DISP
Specifies how XRC writes the XQUERY output to the data set, as follows:
MOD
Specifies that XRC append the output to the data set.
OLD
Specifies that XRC clear the data set before it receives output.
SHR
Specifies that XRC clear the data set before it receives output. SHR also allows multiple allocations of the same data set.

If you specify DISP, you must also specify DATASET.

CONFIGURATION
Specifies that XRC generate a configuration report to provide the details of the XRC session configuration. CONFIGURATION is mutually exclusive with the SET, STORAGECONTROL, ENVIRONMENT, and VOLUME parameters (VOLUME, however, is a valid subparameter of CONFIGURATION). If you specify only the CONFIGURATION parameter, XRC generates a report on the entire configuration.

You can use combinations of the ERRORLEVEL, SSID, and VOLUME parameters on a single configuration report. The report will include the volumes that meet all of the specified filters.

ERRORLEVEL
Specifies that the requested report display only volumes that are defined with the specified error level (session, volume, or group_name). If you do not specify ERRORLEVEL, the requested report will contain a list of all volumes which meet the specified report criteria.
SSID
Specifies that the requested report display only volume pairs that are associated with the storage control that matches the specified SSID. If you do not specify SSID, the requested report contains a list of all volumes that meet the specified report criteria. You can request a report that is based on the primary or secondary SSID.
VOLUME
Specifies that the requested report display only volumes that meet the specified volume serial number criteria, as well as any other specified report criteria. The VOLUME parameter has the following options:
  • VOLUME(volser) provides a report of the primary or secondary volume or list of volumes that meet the specified criteria.
  • VOLUME(volser*) provides a report of the primary volumes that match a single volume serial number prefix. Specify the prefix with one to five characters that are followed by an asterisk (wildcard character).
  • VOLUME(ALL) provides a report of all volumes in the session that meet the specified criteria.
  • VOLUME(*) provides a report of all volumes in the session that meet the specified criteria and that also match the character and asterisk (wildcard) pattern specified with (*).

You can specify a maximum of 100 primary or secondary volume serial numbers on a single command. If any volumes in the list are not part of the XRC session, XRC includes the volumes in the report with an indication of this status.

STATUS
Specifies that the requested report display only the volumes with a current status that matches the status qualifier. You may select only one option per report. The options are as follows:
OFL
Specifies that XRC display offline volumes.
ONL
Specifies that XRC display online volumes.
EXTENDER
Specifies a report for storage controls that are connected to a channel extender that provides performance statistics. The standard report shows one line of information for each storage control. EXTENDER is mutually exclusive with SET, VOLUME, CONFIGURATION, SWAP, STORAGECONTROL and ENVIRONMENT.
DETAIL
Specifies that all of the available performance information be displayed.
SET
Specifies a report on the current operational values for the XRC session, which are stored in the state data set. SET is mutually exclusive with the STORAGECONTROL, VOLUME, ENVIRONMENT, and CONFIGURATION parameters.
STORAGECONTROL
Specifies a report for all primary storage controls that have volumes in the XRC session. STORAGECONTROL is mutually exclusive with the SET, VOLUME, ENVIRONMENT, and CONFIGURATION parameters.
FEATURES
Specifies that the requested report display the Licensed Internal Code (LIC) features available to the storage controls.
Start of changeXFEATURESEnd of change
Start of changeSpecifies that the requested report display the Licensed Internal Code (LIC) features available to the storage controls. This should be used instead of FEATURES for newer feature codes.End of change
DETAIL
Specifies that the requested report display information about standard storage controls or Enhanced (Multiple) Reader primary and auxiliary storage controls individually.
VOLUME
Specifies that the requested report display only volumes that meet the specified volume serial number criteria, as well as any other specified report criteria. For example, specifying:
  • VOLUME(volser) displays the primary or secondary volume or list of volumes that meet the specified criteria.
  • VOLUME(volser*) displays the primary volumes that match a single volume serial number prefix. Specify the prefix with one to five characters that are followed by an asterisk (wildcard character).
  • VOLUME(ALL) displays all volumes in the session that meet the specified criteria.
  • VOLUME(*) displays all volumes in the session that meet the specified criteria and that also match the character and asterisk (wildcard) pattern specified with (*).

You can specify a maximum of 100 primary or secondary volume serial numbers on a single command. If any volumes in the list are not part of the XRC session, XRC includes the volumes in the report with an indication of this status. VOLUME is mutually exclusive with the SET, STORAGECONTROL, ENVIRONMENT, and CONFIGURATION parameters.

You can use combinations of the COMMAND, ERRORLEVEL, SCSESSION, SSID, and STATUS parameters on a single volume report. The report will include the volumes that meet all of the specified filters.

ACTIVITY
Specifies that a volume report provides the results of a mirror status verification, including the status of all volumes in the session, the consistency timestamp, and the size (in cylinders) of those in duplex. See Using mirror status verification to check for non-duplex volumes for more information.
DETAIL
Specifies that a volume report provides specific detailed information about device activity level.
PACE
Specifies that a volume report provides statistics on device blocking, write pacing, and primary volume write activity for the most recently completed monitor interval. Statistics for write pacing and activity are displayed only for those storage controls with Licensed Internal Code that supports the write pacing function.
Note: Start of changeWhen workload-based write pacing is in use, the XQUERY VOLUME PACE report may have several times as many lines it does when workload-based write pacing is not in use.End of change
COMMAND
Specifies that XRC report volumes based on the last pending command issued for the volume, as follows:
ALLCOMMANDS
Specifies that XRC report all volumes that have a pending XDELPAIR or XSUSPEND command request.
NOCOMMANDS
Specifies that XRC report all volumes that do not have a pending XDELPAIR or XSUSPEND command request.
ERRORLEVEL
Specifies that the requested report display only volumes that are defined with the specified error level (session, volume, or group_name). If you do not specify ERRORLEVEL, the requested report contains a list of all volumes that meet the specified report criteria.
SCSESSION
Specifies that the requested report display volumes that are associated with the storage control session that is specified by session_name.
SSID
Specifies that the requested report display only volume pairs that are associated with the storage control that matches the specified SSID. If you do not specify SSID, the requested report contains a list of all volumes that meet the specified report criteria. You can request a report that is based on the primary or secondary SSID.
STATUS
Specifies that the volume report display only the listed volumes with a current status that matches the status qualifier. You may select only one option per report. The options are as follows:
BLK
Specifies that XRC display device-blocked volumes.
Note: If you specify ACTIVITY in the VOLUME parameter, the STATUS (BLK) is ignored.
BK2
Specifies that XRC display device-blocked volumes (as with the BLK option) as well as all volumes with a volume residual count that is greater than 64 times the value specified with WrtPacingResidualCnt in the XRC parmlib values. Refer to ANTXIN00 parmlib parameters for more information.
CPY
Specifies that XRC display copy volume pairs.
DUP
Specifies that XRC display duplex volume pairs.
NON
Specifies that XRC display volumes that are not duplex volume pairs. That is, copy, pending, and suspended volume pairs are displayed.
PND
Specifies that XRC display pending volume pairs.
SUS
Specifies that XRC display suspended volume pairs.
SEQ
Specifies that XRC display seqcheck volume pairs.
UTL
Specifies that XRC display utility volumes that you have added with the XRCUTL parameter.
ENVIRONMENT
Specifies to display the current values for fields that you can change using the parmlib support. The ENVIRONMENT parameter cannot be used with the VOLUME, SET, STORAGECONTROL, and CONFIGURATION parameters. The values for the ENVIRONMENT parameter are:
FLAG
Specifies that the query display all changeable values. There are two ways to change FLAG values. The first method is through the use of parmlib support. The second method is through the MVS MODIFY command.
PARM
Specifies that the query display the current settings for the parmlib parameter values. When issued against an inactive or undefined session, the default values for the parameters are displayed.
PATCH
Specifies that the query display the current settings for each patch. When issued against an inactive session, the default values for the patch names are displayed.
MSGROUTEID
Specifies the user ID to which XRC messages that are associated with the processing of this command are routed. If the specified user ID is not logged on, TSO saves messages in the TSO BRODCAST data set and displays them after the next logon.
Note: Messages issued by the initial command parser routine are sent to the user ID that issues the TSO command. If you specify both DATASET and MSGROUTEID, XQUERY output is directed to the data set that is specified with DATASET and not to the MSGROUTEID user ID. Error messages are directed to the MSGROUTEID user ID.
SWAP
Specifies that the requested report should display the host volume information (XRC Primary), swap volume information, volume state, and estimated percentage of data on the volume which would be copied to the XRC secondary if a HyperSwap® and incremental resynchronization were to be performed.

You can use combinations of the ERRORLEVEL, SSID, and VOLUME parameters on a single swap report. The report will include the volumes that meet all of the specified filters.

ERRORLEVEL
Specifies that the requested report display only volumes that are defined with the specified error level (session, volume, or group_name). If you do not specify ERRORLEVEL, the requested report will contain a list of all volumes which meet the specified report criteria.
SSID
Specifies that the requested report display only volume pairs that are associated with the storage control that matches the specified SSID. If you do not specify SSID, the requested report contains a list of all volumes that meet the specified report criteria. You can request a report that is based on the primary or secondary SSID.
VOLUME
Specifies that the requested report display only volumes that meet the specified volume serial number criteria, as well as any other specified report criteria. The VOLUME parameter has the following options:
  • VOLUME(volser) provides a report of the primary or secondary volume or list of volumes that meet the specified criteria.
  • VOLUME(volser*) provides a report of the primary volumes that match a single volume serial number prefix. Specify the prefix with one to five characters that are followed by an asterisk (wildcard character).
  • VOLUME(ALL) provides a report of all volumes in the session that meet the specified criteria.
  • VOLUME(*) provides a report of all volumes in the session that meet the specified criteria and that also match the character and asterisk (wildcard) pattern specified with (*).

You can specify a maximum of 100 primary or secondary volume serial numbers on a single command. If any volumes in the list are not part of the XRC session, XRC includes the volumes in the report with an indication of this status.

STATUS
Specifies that the requested report display only the volumes with a current status that matches the status qualifier. You may select only one option per report. The options are as follows:
OFL
Specifies that XRC display offline volumes.
ONL
Specifies that XRC display online volumes.
For additional information about: