FCESTABLISH (FlashCopy establish)

Use request type FCESTABLISH to establish a FlashCopy® relationship. This invokes ANTRQST ILK=ESSRVCS REQUEST=FCESTABLISH.

SDEVN(sdevn)
Specifies the hexadecimal device number of a local CKD device that will be used as the FlashCopy source. SDEVN is mutually exclusive with REMOTE(YES) and OPENDVCS(YES).
TDEVN(tdevn)
Specifies the hexadecimal device number of a local CKD device that will be used as the FlashCopy target. TDEVN is mutually exclusive with REMOTE(YES) and OPENDVCS(YES).
DEVN(devn)
Specifies the hexadecimal device number of a local CKD device that will be used as an access for an inband request, with REMOTE(YES), or fixed block request, with OPENDVCS(YES).

If you use OPENDVCS(YES) without REMOTE(YES), DEVN must specify a CKD access volume located in the same subsystem cluster as the fixed block device identified by SOURCE in this command.

If you use OPENDVCS(YES) with REMOTE(YES), DEVN must specify a CKD access volume located in the same subsystem cluster as the PPRC primary device that is paired with the PPRC secondary that is specified as the FlashCopy source.

If you use REMOTE(YES) without OPENDVCS(YES), DEVN must specify the PPRC primary device that is paired with the PPRC secondary that is specified as the FlashCopy source.

SRCSERIAL(srcserial)
Specifies the 10-digit hexadecimal storage control serial number for the FlashCopy source. SRCSERIAL is required when DEVN is specified.
SRCLSS(srclss)
Specifies the 2-digit hexadecimal logical subsystem number for the FlashCopy source. SRCLSS is required when DEVN is specified.
SRCDVC(srcdvc)
Specifies the 2-digit hexadecimal value for the FlashCopy source device (either connection address or logical unit number). SRCDVC is required when DEVN is specified.
SRCSSID(srcssid)
When REMOTE(YES) is specified without OPENDVCS(YES), this specifies the 4-digit hexadecimal value for the subsystem where the FlashCopy is to occur. This must be the same value as that specified for SSID on the PPRC secondary volume on the PPRC establish pair command.
TGTSERIAL(tgtserial)
Specifies the 10-digit hexadecimal storage control serial number for the FlashCopy target. TGTSERIAL is required when either DEVN or TGTUCB(NO) is specified.
TGTLSS(tgtlss)
Specifies the 2-digit hexadecimal logical subsystem number for the FlashCopy target. TGTLSS is required when either DEVN or TGTUCB(NO) is specified.
TGTDVC(tgtdvc)
Specifies the 2-digit hexadecimal value for the FlashCopy target device (either connection address or logical unit number). TGTDVC is required when either DEVN or TGTUCB(NO) is specified.
SRCEXTNA()
Indicates that all tracks of the source device are active in the FlashCopy relationship (this is a full volume request). Either SRCEXTNA or SRCEXTN is required when SDEVN is specified. SRCEXTNA is mutually exclusive with SRCEXTN.

This corresponds to the ANTRQST keyword SRCEXTENTS, with a value of ALL.

SRCEXTN(srcextent,srcextent,srcextent,srcextent)
Indicates track address ranges on the source CKD volume that is active in this FlashCopy relationship. Each extent range consists of a starting track address and an ending track address. Each source extent range must have a related target extent range, specified in the TGTEXTN keyword, identifying the same number of tracks. The tracks identified in the source extent fields must be valid for the source device.

Either SRCEXTNA or SRCEXTN is required when SDEVN is specified. SRCEXTN is mutually exclusive with SRCEXTNA.

Supply the value for SRCEXTN in SUPERZAP format, using a comma between every 4 digits. For example, to copy source tracks 01110002 through 011100C, use SRCEXTN(0111,0002,0111,000C). To specify multiple source extent ranges, make each range a separate keyword. For instance to copy source tracks 01110002 through 011100C as well as tracks 02220003 through 0222000D, you would use this:

SRCEXTN(0111,0002,0111,000C) 
SRCEXTN(0222,0003,0222,000D) 
instead of this:
SRCEXTN(0111,0002,0111,000C,0222,0003,0222,000D)

You can supply up to 40 extent ranges on a single FCESTABLSIH request.

This corresponds to the ANTRQST keyword SRCEXTENTS.

TGTEXTNA()
Indicates that this establish is a full volume request. Either TGTEXTNA or TGTEXTN is required when SDEVN is specified. TGTEXTNA is mutually exclusive with TGTEXTN.

This corresponds to the ANTRQST keyword TGTEXTENTS with a value of ALL.

TGTEXTN(tgtextent,tgtextent,tgtextent,tgtextent)
Indicates track address ranges on the target CKD volume that is active in this FlashCopy relationship. Each extent range consists of a starting track address and an ending track address. Each target extent range must have a related source extent range, specified with the SRCEXTN keyword, identifying the same number of tracks. The tracks identified in the target extent fields must be valid for the target device.

Either TGTEXTNA or TGTEXTN is required when TDEVN is specified. TGTEXTN is mutually exclusive with TGTEXTNA

Supply the value for TGTEXTN in SUPERZAP format, with a comma between every 4 digits. For example, to copy to target tracks 01110002 through 011100C, you would use TGTEXTN(0111,0002,0111,000C). To supply multiple source extent ranges, specify each range as a separate keyword. For instance, to copy to target tracks 01110002 through 011100C as well as to tracks 02220003 through 0222000D, you would use this:

TGTEXTN(0111,0002,0111,000C) 
SRCEXTN(0222,0003,0222,000D) 
instead of this:
TGTEXTN(0111,0002,0111,000C,0222,0003,0222,000D)

You can supply up to 40 extent ranges on a single FCESTABLSIH request.

This corresponds to the ANTRQST keyword TGTEXTENTS.

OPENDVCS(NO | YES)
Specifies whether Open System (fixed block) devices or CKD devices are addressed by this command.
NO
The required parameters (SDEVN and TDEVN) identify CKD devices. This is the default.
YES
The required parameters (DEVN, SRCSERIAL, SRCLSS, SRCSSID, SRCDVC, TGTSERIAL, TGTLSS, TGTDVC) identify fixed block devices using a CKD access device.
REMOTE(NO | YES)
Indicates whether the request is for a subsystem that is not directly attached to the issuing processor.
NO
The request is directed to a device on a subsystem locally attached to the issuing processor. This is the default.
YES
The request is directed to a remote subsystem using inband subsystem functions. When you specify REMOTE(YES), the request must be for a full volume.

With an inband request for a CKD secondary device, the DEVN keyword must identify a PPRC primary device in a subsystem accessible by the host processor issuing the request, and the FlashCopy source device must be the PPRC secondary of that DEVN.

With an inband request for an Open System (fixed block) secondary device, the DEVN keyword must identify an online CKD device located in the same subsystem cluster as the fixed block device of the PPRC primary that is paired with the PPRC secondary that is designated as the FlashCopy source.

INCREMENTAL(NO | YES | YTW)
Specifies whether the FlashCopy establish relationship remains active after the initial copy is complete. If the FlashCopy relationship remains active, subsequent changes are tracked, and future FlashCopy operations require only a subset of the volume to be copied.
NO
The FlashCopy relationship ends after the background copy has completed, when MODE(COPY) is specified, or all source and target tracks have been updated, when MODE(NOCOPY) is specified. This is the default.
YES
The FlashCopy relationship remains in effect after the request has completed. Subsequent changes are tracked so that future FlashCopy operations are performed incrementally. This relationship continues until explicitly terminated with a FlashCopy Withdraw request.
YTW
The FlashCopy relationship remains in effect after the request has completed. Subsequent changes are tracked so that future FlashCopy operations are performed incrementally. This relationship continues until it is ended explicitly with a FlashCopy Withdraw request.
Note: The FlashCopy target is writable while the incremental relationship is active. Any writes done to the target during this period are overwritten if a subsequent increment is done, keeping the target a true copy of the source. If the relationship is reversed, the changes made to the target are reflected on the source.
TGTPPRIM(NO | YES)
Specifies whether the target in the FlashCopy relationship can be the primary in a PPRC pair.
NO
The target in this FlashCopy relationship cannot be the primary in a PPRC pair. This is the default.
YES
The target in this FlashCopy relationship can be the primary in a PPRC pair. This request proceeds normally to the specified target but the hardware ignores the PPRC status of the target.
MODE(COPY | NOCOPY | NO2CPY | ASYNC)
Specifies the type of FlashCopy relationship to be started for this pair of volumes.
COPY
Establish a FlashCopy relationship between the source device and the target device. The request will start a background copy of all tracks within the specified extents from the source volume to the target volume. When the background copy completes, the FlashCopy relationship terminates. The target volume extents contain the same data as the source volume extents when the FlashCopy relationship was first established.
NOCOPY
Establish a FlashCopy relationship between the source device and the target device. The program does not do a background copy of tracks from the source volume to the target volume. Processing of data on the source volume is the same as if the source volume were not in a FlashCopy relationship. Records read from the target volume within the specified extents will have the same data as the related source volume records at the time the FlashCopy relationship was established.

When a FlashCopy NOCOPY relationship is ended, the track data on the target device is unpredictable and should not be used. If updates occur to source device tracks in the FlashCopy NOCOPY relationship, a copy of the source tracks from the point in time of the FlashCopy establish may or may not be written to the target device.

Tracks may be copied from the source to the target volume even if the source track is not changed. This includes the track that contains the volume label. Therefore, to avoid duplicate volume serial problems when the target device is later varied online, IBM® recommends that you label the target volume again after withdrawing a volume-level FlashCopy NOCOPY relationship.

NO2CPY
Initiate a background copy from the source device to the target device. When a MODE=NOCOPY relationship already exists between the source and the target, this relationship ends when the background copy is completed. There must be an existing FlashCopy relationship between the source and the target. If one does not exist, none will be created.
ASYNC
Indicates that this is being established to a volume set that is currently, or will be, part of a Global Mirror session.
ONLINTGT(NO | YES)
Indicates whether the FlashCopy Establish should continue if the specified target device is in an online state to any system.
NO
Fail the FlashCopy Establish if the target device is online to any system. This is the default.
YES
Continue the FlashCopy Establish if the target device is online to any system.
ACTION(FREEZE | FRR)
Specifies an action that is to occur during the FlashCopy establish request.
FREEZE
The FlashCopy source volume is to be part of a FlashCopy consistency group. The FlashCopy relationship is established between the source and target volumes, or extents, and all I/O to the source volume is held, resulting in a long busy, until one of the following conditions is met:
  • A FlashCopy withdraw with action THAW is processed by the LSS where the volume resides
  • A two-minute timer has expired. The two-minute timer can be adjusted using the ESS Specialist GUI.
FRR
Fast Reverse Restore. This reverses the direction of the FlashCopy relationship when change recording is active, restoring the source volume to the state it was in when it last flashed to the target. Changed tracks are copied back from the target to the source. At the completion of Fast Reverse Restore, the original target volume is no longer usable.
If you specify ACTION, the following are ignored:
  • INCREMENTAL(YES)
  • MODE(ASYNC)
  • MODE(NO2CPY)
  • SRCEXTN
  • TGTEXTN
SETGTOK(NO | YES)
Specifies whether the target of the specified full volume relationship can be a space efficient volume.
NO
The target cannot be a space efficient volume. This is the default.
YES
The target can be a space efficient volume. If an out-of-pace condition occurs, the relationship is failed.
MSGREQ(YES | NO)
Specifies whether to wait for FlashCopy Establish initialization to complete.
NO
Do not wait. This is the default.
YES
Wait. MSGREQ(YES) is ignored if MODE(NOCOPY) or MODE(NO2CPY) is specified.
TGTUCB(YES | NO)
Specifies whether an MVS device number is used to address the target. The values are:
YES
The SDEVN and TDEVN keywords are used to identify the source and target devices in the relationship. The MVS device numbers are used in the SDEVN and TDEVN keywords to address the source and target devices. This is the default.
NO
The MVS device number is specified in the SDEVN keyword to identify the source. The serial number, LSS, and CCA are specified in the TGTSERIAL, TGTLSS, and TGTDVC keywords to address the target device.

TGTUCB(NO) is not applicable when either OPENDVCS(YES) or REMOTE(YES) is specified.

PRESMIR(PREF | REQ | NO)
Indicates the handling of the request based on whether the specified target is a PPRC primary device. PRESMIR(PREF) and PRESMIR(REQ) are mutually exclusive with REMOTE(YES) and ACTION(FRR).

TGTPPRIM(YES) is required with PRESMIR(PREF) or PRESMIR(REQ).

REQ
If the specified target device is a Metro Mirror primary device, the pair must not go into a duplex pending state as the result of this FCESTABLISH request.
PREF
If the specified target device is a Metro Mirror primary device, it would be preferable that the pair does not go into a duplex pending state as a result of the FCESTABLISH request, but if a Preserve Mirror operation cannot be accomplished, the establish request should still be performed.
NO
The FCESTABLISH request is to be performed without considering a Preserve Mirror operation. This is the default.
WAITTIME(waittime | 0)
Specifies how long in seconds SDM will wait for a request to complete. A value of zero specifies that the request should not be timed.

If the wait time expires before the request is complete, the program returns a return code of 7039 (RQST_WAITTIME_EXPIRED). For more information about RQST_WAITTIME_EXPIRED, refer to the ANTRQSTL macro.

SUBCHSET(subchset | 0)
Specifies the subchannel set in which the command is to be issued. The subchannel set where the I/O will be issued is the subchannel set as defined in the Hardware Configuration Dialog (HCD). The valid values are determined by what is supported by the host system's processor and configured for the device.

If you omit the parameter, the command is issued to the device that is logically in subchannel set 0. If a swap has occurred, this could be the device that was defined in an alternate subchannel set in the I/O configuration (IODF), with HCD.

TSUBCHSET(tsubchset | 0)
Specifies which subchannel set is to be used to get information about the target device specified with the TDEVN parameter. This is the subchannel set for the device as defined in the Hardware Configuration Dialog (HCD). The values are determined by what is currently supported by the host system's processor and configured for the device.

If you omit the parameter, the device that is currently logically in subchannel set 0 will be used. If a swap has occurred, this could be the device that was defined in an alternate subchannel set in the I/O configuration (IODF), via HCD.