SDM API invocation

The following topic describes how the ANTRQST macro is used to invoke the four different Advanced Copy Services functions. To request a particular function, you must specify the REQUEST parameter with the invocation of the ANTRQST macro. Each different value of the REQUEST parameter requires additional subparameters to be specified.
ANTRQST ILK=ESSRVCS
Specifying the ILK parameter with the ESSRVCS value on the ANTRQST macro allows invocation of the Advanced Copy Services functions of FlashCopy®, Global Mirror for ESS, and Metro/Global Mirror or ESS. The following values may be specified on the REQUEST parameter to request FlashCopy, Global Mirror for ESS, and Metro/Global Mirror for ESS functions.
  • The FCQUERY value specified on the REQUEST parameter allows you to determine the status of a FlashCopy relationship.
  • The FCWITHDRAW value specified on the REQUEST parameter allows you to remove (withdraw) a FlashCopy relationship.
  • The QFRVOLS value specified on the REQUEST parameter allows you to determine whether the source and target devices are capable and eligible for fast replication operations such as FlashCopy and Snapshot.
  • The QHA value specified on the REQUEST parameter allows you to query a device and determine where path groups are established. The device is considered online where path groups are established. This might be useful, for example, when a FlashCopy or Peer-to-Peer Remote Copy establish command fails due to an online target. Data returned from QHA is mapped by the ANTQHA macro in hlq.MACLIB.
  • The RQUERY value specified on the REQUEST parameter allows you to determine the status of a Global Mirror operation. The value specified on the ACTION subparameter indicates the type of status information that is being requested.
  • The RSESSION value specified on the REQUEST parameter allows you to either start, stop, pause, or resume a Global Mirror session.
  • The RVOLUME value specified on the REQUEST parameter allows you to add and remove volumes in a Global Mirror session.
  • The STATESAVE value specified on the REQUEST parameter allows you to take a state save or a non-disruptive state save.
ANTRQST ILK=PPRC
Specifying the ILK parameter with the PPRC value on the ANTRQST macro allows invocation of the Advanced Copy Services functions of Metro Mirror for ESS, Global Copy for ESS, and Metro/Global Copy for ESS. The following values may be specified on the REQUEST parameter to request Metro Mirror for ESS, Global Copy for ESS, and Metro/Global Copy for ESS functions.
  • The FENCE value specified on the REQUEST parameter allows you to prevent unintended access, through Soft Fence, of a device, a set of devices in a Logical Subsystem (LSS), or all devices in an LSS.
  • The PESTPATH value specified on the REQUEST parameter allows you to establish ESCON® or FCP (fibre channel protocol) paths between primary (source) site and recovery (target) site logical subsystems or storage controls. A Metro Mirror for ESS session or a Global Copy for ESS session will become active if request is successful.
  • The PESTPAIR value specified on the REQUEST parameter allows you to specify a pair of primary (source) and recovery (target) volumes (devices) for active Metro Mirror for ESS session or Global Copy for ESS session.
  • The PDELPAIR value specified on the REQUEST parameter allows you to remove a Metro Mirror for ESS or Global Copy for ESS volume pair from an active session.
  • The PDELPATH value specified on the REQUEST parameter allows you to remove all established ESCON or FCP paths between primary site and recovery site logical subsystems or storage controls for an active Metro Mirror for ESS or Global Copy for ESS session.
  • The PQUERY value specified on the REQUEST parameter allows you to determine the status of a Metro Mirror for ESS or Global Copy for ESS session and its paths and volume pairs.
  • The PSUSPEND value specified on the REQUEST parameter allows you to suspend a volume pair for an active Metro Mirror for ESS or Global Copy for ESS session.
  • The PFREEZE value specified on the REQUEST parameter allows you to stop all I/O operations on multiple volume pairs that have been established in an active Metro Mirror for ESS or Global Copy for ESS session whose path has been established to emulate 3990 Critical Volume mode for CGROUP automation.
  • The PRUN value specified on the REQUEST parameter allows you to resume I/O operations on multiple volume pairs in an active Metro Mirror for ESS or Global Copy for ESS session whose path has been established to emulate 3990 Critical Volume mode for CGROUP automation.
  • The PRECOVER value specified on the REQUEST parameter allows the recovery site to gain control of a target device on its logical subsystem or storage control. The request forces the target device into a simplex state.
  • Start of changeThe PSETCHAR value specified on the REQUEST parameter allows you to set the characteristics of a PPRC volume pair, including whether the pair is to be used for a Preserve Mirror function in a Multi-Target Mirror configuration. End of change
ANTRQST ILK=SNAPSHOT
Specifying the ILK parameter with the SNAPSHOT value on the ANTRQST macro allows invocation of the Advanced Copy Services function of SnapShot. The following values may be specified on the REQUEST parameter to request SnapShot functions.
  • The SDVCINFO value specified on the REQUEST parameter allows you to obtain information about a RAMAC Virtual Array (RVA) device.
  • The SQRYDVCS value specified on the REQUEST parameter allows you to obtain a list of RVA devices that are attached to a host.
  • The SQRYSSYS value specified on the REQUEST parameter allows you to obtain a list of RVA subsystems attached to a host.
  • The SSNAP value specified on the REQUEST parameter allows you to snap (quickly copy) functional tracks from one RVA device to another.
  • The SRELEASE value specified on the REQUEST parameter allows you to release functional tracks on an RVA device.
ANTRQST ILK=XRC
Specifying the ILK parameter with the XRC value on the ANTRQST macro allows invocation of the Advanced Copy Services function of Global Mirror for System z®. The following values may be specified on the REQUEST parameter to request Global Mirror for System z functions.
  • The XSTART value specified on the REQUEST parameter allows you to start a Global Mirror for System z session.
  • The XADD value specified on the REQUEST parameter allows you to add primary (source) and secondary (target) volume pairs to an active Global Mirror for System z session.
  • The XCOUPLE value specified on the REQUEST parameter allows you couple together multiple Global Mirror for System z sessions to be managed by a single master session.
  • The XSET value specified on the REQUEST parameter allows you to set operational and environmental values for managing Global Mirror for System z sessions.
  • The XSCSTATS value specified on the REQUEST parameter allows you to obtain statistics on storage controls in a system.
  • The XCONTIME value specified on the REQUEST parameter allows you to obtain the current consistency time for a Global Mirror for System z session.
  • The XSUSPEND value specified on the REQUEST parameter allows you to suspend copying either volume pairs in a Global Mirror for System z session or to suspend an entire Global Mirror for System z session.
  • The XADVANCE value specified on the REQUEST parameter allows you to copy data from Global Mirror for System z sessions' journals to target volumes without relabling target volumes. This function can be done for either active or suspended Global Mirror for System z sessions.
  • The XRECOVER value specified on the REQUEST parameter allows you to copy data from inactive Global Mirror for System z sessions' journals to target volumes where the target volumes are relabelled (made ready to be used on the recovery site).
  • The XDEL value specified on the REQUEST parameter allows you to delete (remove) volume pairs from an active Global Mirror for System z session.
  • The XEND value specified on the REQUEST parameter allows you to end an active Global Mirror for System z session.