ANTRQST and ANTRQSTL macros – call to the system data mover API

This topic describes the application program call to the z/OS System Data Mover (SDM) application programming interface (API).

The environment, programming requirements, common invocation parameters, input and output register information are summarized, followed by the macro syntax and individual parameter descriptions. An example of the ANTRQST and ANTRQSTL macros in assembler follows the descriptions of the associated return and reason codes.

This topic also contains a description of the ANTQFRVL macro (for more information, see ANTQFRVL macro).

Latest Updates to These Macros

Every effort has been made to provide you with the most accurate and current information for the ANTRQST and ANTRQSTL macros at the time of availability. To stay informed about the latest functional changes and additions, refer to the extensive documentation at the top of the latest copy of these macros. Each copy of the ANTRQST and ANTRQSTL macros contain the corresponding documentation for that release level.

This information is edited for clarity, and descriptions might not match the wording in the ANTRQST and ANTRQSTL macros.

For a information on using the REXX programming language to invoke ANTRQST, see REXX support for the ANTRQST API.

For additional information, go to DFSMS SDM Copy Services on the Web: http://www.ibm.com/systems/storage/software/sms/sdm/index.html

Table 1 shows how various z/OS functions are addressed by the ANTRQST macro.

Table 1. How the ANTRQST Macro Relates to Major Functions
ILK Syntax Description

ESSRVCS
(FlashCopy®,
Global Mirror and DIAG)

Syntax for ILK=ESSRVCS REQUEST=LEVEL
REQUEST=FCESTABLISH
REQUEST=FCQUERY
REQUEST=FCWITHDRAW
REQUEST=QFRVOLS
REQUEST=QHA
REQUEST=RSESSION
REQUEST=RVOLUME
REQUEST=RQUERY
REQUEST=STATESAVE
 

PPRC
(peer-to-peer
remote copy)

Syntax for ILK=PPRC REQUEST=FENCE
REQUEST=LEVEL
REQUEST=PDELPAIR
REQUEST=PDELPATH
REQUEST=PESTPAIR
REQUEST=PESTPATH
REQUEST=PFREEZE
REQUEST=PQSCSTAT
REQUEST=PQUERY
REQUEST=PRECOVER
REQUEST=PRUN
Start of changeREQUEST=PSETCHAREnd of change
REQUEST=PSUSPEND
 

SNAPSHOT
(Snapshot)

Syntax for ILK=SNAPSHOT REQUEST=LEVEL
REQUEST=SDVCINFO
REQUEST=SQRYDVCS
REQUEST=SQRYSSYS
REQUEST=SRELEASE
REQUEST=SSNAP
 

XRC
(extended
remote copy)

Syntax for ILK=XRC REQUEST=LEVEL
REQUEST=XADD
REQUEST=XADVANCE
REQUEST=XCONTIME
REQUEST=XCOUPLE
REQUEST=XDEL
REQUEST=XEND
REQUEST=XQUERY
REQUEST=XRECOVER
REQUEST=XSET
REQUEST=XSCSTATS
Subparameters for REQUEST=XSTART
Subparameters for REQUEST=XSTATUS
REQUEST=XSUSPEND