Programming Interface Information
Programming Interface Information

REXX support for the ANTRQST API

This section describes using the REXX programming language with the ANTRQST API.

The program ANTTREXX allows a REXX exec to use the ANTRQST API. The function that is available with ANTTREXX is described in Table 1.
Table 1. Functions Supported by ANTTREXX
Function (ILK) Request Types Purpose Refer To

ESSRVCS

(FlashCopy®, Global Mirror and DIAG)
FCESTABLISH Establish a FlashCopy relationship FCESTABLISH (FlashCopy establish)
  FCQUERY Query a FlashCopy relationship FCQUERY (FlashCopy query)
  FCWITHDRAW Remove (withdraw) a FlashCopy relationship FCWITHDRAW (FlashCopy withdraw)
  LEVEL Query the level of ANTRQST that is installed on the system LEVEL (query ANTRQST level)
  QHA Query a device and determine where path groups are established QHA (Query where path groups are established)
  RQUERY Query a Global Mirror session RQUERY (Global Mirror query)
  RSESSION Control a Global Mirror session RSESSION (control a Global Mirror session)
  RVOLUME Manage volumes for Global Mirror RVOLUME (Global Mirror manage volumes)
  STATESAVE Request a state save (standard or non-disruptive) STATESAVE (Request State Save)

PPRC

(peer-to-peer remote copy)
FENCE Start of changePrevent unintended access of a device through Soft Fence, or to prevent any hosts from bringing a device online through SPID Fence. Can be applied to a device, a set of devices in a Logical Subsystem (LSS), or all devices in an LSS. This invokes ANTRQST ILK=PPRC REQUEST=FENCE.End of change FENCE (PPRC prevent unintended access through Soft Fence)
LEVEL Query the level of ANTRQST that is installed on the system LEVEL (query ANTRQST level)
PDELPAIR Delete a PPRC volume pair PDELPAIR (PPRC delete volume pair)
PDELPATH Delete a PPRC path PDELPATH (PPRC delete path)
PESTPAIR Establish a PPRC volume pair PESTPAIR (PPRC establish volume pair)
PESTPATH Establish a PPRC path PESTPATH (PPRC establish path)
PFREEZE Perform a PPRC freeze, to control volume groups PFREEZE (PPRC control volume groups)
PQSCSTAT Query storage controller status PQSCSTAT (Query storage controller)
PQUERY Query PPRC status PQUERY (PPRC query)
PRECOVER Recover data on the recovery system PRECOVER (PPRC recover data on the recovery system)
PRUN Perform a PPRC run, to control volume groups PRUN (PPRC control volume group)
PSETCHAR Set characteristics of a PPRC volume pair PSETCHAR (PPRC set characteristics of volume pair)
PSUSPEND Suspend a PPRC volume pair PSUSPEND (PPRC suspend volume pair)

XRC

(extended remote copy)
LEVEL Query the level of ANTRQST that is installed on the system LEVEL (query ANTRQST level)
XADD Add XRC volume pairs XADD (XRC add volume pair)
XADVANCE Recover an XRC session XADVANCE (XRC recover)
XCONTIME Query the current XRC consistency time XCONTIME (XRC consistency time)
XCOUPLE Manage connections between a local XRC session and a master XRC session XCOUPLE (couple XRC connections)
XDEL Delete pairs of volumes from an XRC session XDEL (XRC delete volume pair)
XEND End an XRC session XEND (XRC end)
XQUERY Returns status information on an XRC session XQUERY (XRC query)
XRECOVER Recover an XRC session XRECOVER (XRC recover)
XSCSTATS Provide XRC statistics XSCSTATS (XRC statistics)
XSET Change tuning values for an XRC session XSET (XRC session parameters)
XSTART Start up an XRC session XSTART (XRC start)
XSTATUS Query XRC status XSTATUS (XRC status)
XSUSPEND Suspend an XRC session or suspend volume pairs in an XRC session XSUSPEND (XRC suspend)
- WAIT Perform a wait (invoke STIMER) WAIT (perform a wait)
With just a few exceptions, the keywords you use with ANTTREXX are the same as the keywords you use with ANTRQST. Some keywords, such as ECB and ASYNCH, are not applicable to the REXX environment, so are not valid for the ANTTREXX program. See Table 2 for details.
Table 2. Keyword Differences between ANTTREXX and ANTQRST
ANTQRST Keyword For Request Type ANTTREXX
ALET FCQUERY, FCWITHDRAW, QFRVOLS, PQUERY, QHA, XCONTIME Not supported
ASYNCH Any Not supported
ECB Any Not supported
RETINFO FCESTABLISH, FCQUERY, FCWITHDRAW, FENCE, QHA The results are returned, but you do not use the keyword
SRCEXTENTS FCESTABLISH, FCWITHDRAW Use SRCEXTN or, to specify a value of ALL, SRCEXTNA()
TGTEXTENTS FCESTABLISH, FCWITHDRAW Use TGTEXTN or, to specify a value of ALL, TGTEXTNA()
WAITTIME FENCE, QHA Not supported
End of Programming Interface Information
End of Programming Interface Information