As part of the z/OS® component
of 5695DF117, IBM® ships the
following macros in support of the SDM API which an application programmer
needs to be aware of:
- ANTRQST
- The ANTRQST macro is the macro
used by the application program
to invoke the SDM API. This macro then appropriately invokes the other
macros required for the particular Advanced Copy Services function
being requested.
In addition, the ANTRQST macro provides the available
level of SDM API support. If you specify the REQUEST=LEVEL subparameter,
the ANTRQST macro returns in the RETINFO field a number indicating
the level of SDM API support. Reference the prolog of the ANTRQSTL
macro to determine the meaning of the number. The REQUEST=LEVEL subparameter
may be specified with any ILK parameter value.
- ANTFQMAP
- The ANTFQMAP macro provides the
mapping of the data returned
for the FlashCopy® query
requests (ANTRQST ILK=ESSRVCS, REQUEST=FCQUERY,FORMAT=FQMAP).
- ANTPQMAP
- The ANTPQMAP macro provides the
mapping of the data returned
for the Metro Mirror for ESS and Global Copy for ESS query requests
(ANTRQST ILK=PPRC, REQUEST=PQUERY,FORMAT=PQMAP).
- ANTRQMAP
- The ANTRQMAP macro provides the
mapping of the data returned
for the Global Mirror for ESS query requests (ANTRQST ILK=ESSRVCS,
REQUEST=RQUERY,ACTION=actionvalue). The ANTRQMAP macro may be specified
multiple times in your application program. The TYPE parameter of
the ANTRQMAP macro has four different values which are associated
with the actionvalue values that may be specified on the ACTION parameter
of the ANTRQST macro. The values for the TYPE parameter are: STAT4A,
STAT4B, STAT4C, and STAT51. The first 6 characters of the actionvalue
value indicate the value you need to specify on the TYPE parameter
of the ANTRQMAP in order to get the mapping of the data returned by
the SDM API request.
- ANTRQSTL
- The ANTRQSTL macro provides the
parameter declarations needed
by the ANTRQST macro, and it also provides a listing of all the return
codes returned by the SDM API. This macro must accompany the ANTRQST
macro when invoking the SDM API.
In addition, the ANTRQSTL macro
provides documentation of the available level of SDM API support.
Reference the prolog of the ANTRQSTL macro to determine the meaning
of the level number.
Note: You can specify either VERSION1
or VERSION2 for the ILK parameter on the ANTRQSTL macro. IBM recommends that you specify
VERSION2, and it is the default. If you specify VERSION1 for the ILK parameter on either the ANTRQST or ANTRQSTL
macro, you must specify VERSION1 for the ILK parameter on both macros.
The following four macros are provided here
only to indicate that
their prologs will have updates which your current documentation may
not reflect because of service stream updates.You will not have to
program (invoke) these macros since these will be internally invoked
by the ANTRQST macro based on the value you specify on the ILK parameter.
You need to be aware of these macros since the prolog will reflect
the latest documented support for the SDM API.
- ANTRQTA
- The ANTRQTA macro prolog indicates
the parameters that may be
specified when the ANTRQST macro is specified with ILK=XRC. The prolog
also provides a description of the data returned for ILK=XRC requests.
- ANTRQTB
- The ANTRQTB macro prolog indicates
the parameters that may be
specified when the ANTRQST macro is specified with ILK=PPRC. The prolog
also provides a description of the data returned for ILK=PPRC requests.
- ANTRQTC
- The ANTRQTC macro prolog indicates
the parameters that may be
specified when the ANTRQST macro is specified with ILK=SNAPSHOT. The
prolog also provides a description of the data returned for ILK=SNAPSHOT
requests
- ANTRQTD
- The ANTRQTD macro prolog indicates
the parameters that may be
specified when the ANTRQST macro is specified with ILK=ESSRVCS. The
prolog also provides a description of the data returned for ILK=ESSRVCS
requests.
All of these macros might be
updated by the service stream. The
documentation might not reflect
the latest level of support by the SDM API. Therefore, please reference
the prolog of the macros for the latest documentation.