Subparameters for REQUEST=FCWITHDRAW

REQUEST=FCWITHDRAW
Asks for the Withdraw FlashCopy® relationship function to be executed.
,SDEVN=sdevn
specifies the 2-byte device number of the source device.

For Open System (fixed block) devices, this parameter is invalid. If specified with fixed block devices, this parameter must be set to the null (X'0000') value.

To code: Specify the RS-type name, or address in register (2)-(12), of an optional 2-character input field.

,TDEVN=tdevn
specifies the binary device number of the target device.

For Open System (fixed block) devices, this parameter is invalid. If specified with fixed block devices, this parameter must be set to the null (X'0000') value.

To code: Specify the RS-type name, or address in register (2)-(12), of a required 2-byte input field.

,DEVN=devn
A required input parameter field containing the binary device number to use for I/O. DEVN must be a 4-digit hexadecimal address of a configured device with a UCB on the System z® system issuing the command.

When OPENDVCS=YES is specified, DEVN identifies a CKD access volume located in the same subsystem cluster as the open volume specified as SOURCE in this command.

When OPENDVCS=YES and REMOTE=YES are both specified, DEVN identifies a CKD access volume located in the same subsystem cluster as the PPRC primary paired with the PPRC secondary acting as the FlashCopy source.

When REMOTE=YES is specified for CKD volumes (OPENDVCS=NO is specified or allowed to default), DEVN identifies the PPRC primary device paired with the PPRC secondary acting as FlashCopy source.

When ACTION=THAW is specified, DEVN must identify either a CKD access device for the open device to be thawed, or the CKD volume within the LSS to be thawed.

To code: Specify the RS-type address, or address in register (2)-(12), of a 2-byte field.

,SRCSERIAL=srcserial
When OPENDVCS(YES) or REMOTE(YES) is specified, SRCSERIAL identifies the storage control serial number that can include up to 10 digits, depending on the type of storage control.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 10-character field.

,SRCLSS=srclss
When OPENDVCS=YES or REMOTE=YES is specified, this identifies the two-digit hexadecimal value for the logical subsystem (LSS) for the device (ESS only).
Note: The LSS number is required if the storage control supports logical subsystems (like the ESS) and not allowed if the storage control does not support logical subsystems.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 1-character field.

,SRCDVC=srcdvc
When OPENDVCS=YES or REMOTE=YES is specified, this identifies the two-digit hexadecimal value for the device (either logical unit number or channel connection address).

To code: Specify the RS-type address, or address in register (2)-(12), of a required 1-character field.

,TGTSERIAL=tgtserial
When OPENDVCS=YES or REMOTE=YES is specified, TGTSERIAL identifies the storage control serial number that can include up to 10 digits, depending on the type of storage control.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 10-character field.

,TGTLSS=tgtlss
When OPENDVCS=YES or REMOTE=YES is specified, this identifies the two-digit hexadecimal value for the logical subsystem (LSS) for the device (ESS only).
Note: The LSS number is required if the storage control supports logical subsystems (like the ESS) and not allowed if the storage control does not support logical subsystems.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 1-character field.

,TGTDVC=tgtdvc
When OPENDVCS=YES or REMOTE=YES is specified, this identifies the two-digit hexadecimal value for the device (either logical unit number or channel connection address).

To code: Specify the RS-type address, or address in register (2)-(12), of a required 1-character field.

,TGTUCB=tgtucb
,TGTUCB=YES
is the name (RS-type) or address in register (2)-(12) of a 3-character field that contains YES or NO, indicating whether an MVS device number will be used for target addressability. Yes is the default.
YES
Indicates that the SDEVN and TDEVN keywords are being used to identify the source and target devices in the relationship, using MVS device numbers.
NO
Indicates that an MVS device number will not be used for the target device (TDEVN keyword will not be used). Instead, the SDEVN, TGTSERIAL, TGTLSS, and TGTDVC keywords will be used.
Note: TGTUCB(NO) is not supported when OPENDVCS(YES) or REMOTE(YES) is specified.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 3-character field.

,SRCSSID=srcssid
When REMOTE=YES is specified without OPENDVCS=YES, this is the two-byte binary unsigned SSID of the subsystem where the FlashCopy request is to occur. This must be the same value as that specified for SSID on the PPRC secondary in the PPRC establish pair command.

To code: Specify the RS-type address, or address in register (2)-(12), of an optional half-word field.

,OPENDVCS=opendvcs
,OPENDVCS=NO
Specifies whether Open System (fixed block) devices or CKD devices are addressed by this command. The values are:
NO
The required parameters (SDEVN and TDEVN) identify CKD devices. The default is NO.
YES
Specifies that the required parameters (DEVN, SRCSERIAL, SRCLSS, SRCSSID, SRCDVC, TGTSERIAL, TGTLSS, TGTDVC) identify fixed block devices.

To code: Specify the RS-type address, or address in register (2)-(12), of an optional 3-character field.

,REMOTE=remote
,REMOTE=NO
Specifies whether the request is for a subsystem that is not directly attached to the issuing processor. The values are:
NO
The request is directed to a device on a subsystem locally attached to the issuing processor. The default is NO.
YES
The request is directed to a remote subsystem using Inband subsystem functions. When REMOTE(YES) is specified, the request must be for a full volume.

To code: Specify the RS-type address, or address in register (2)-(12), of an optional 3-character field.

ACTION=action
This is the name (RS-type) or address in register (2)-(12) of an optional 12-byte (character) field that specifies an action to take. Valid values are COMMIT, REVERT, and THAW. There is no default. The value is left-justified and padded on the right with blanks. Valid values are:
COMMIT
This specifies that the last consistency group created by the Global Mirror session is committed to the target's current state, and reverting to the previous consistency group state is no longer possible. See Moving a Global Mirror session to the recovery site in an unplanned outage for guidelines on the use of this option.
REVERT
Specifies that a rollback be performed to the state saved by a previous automatic FlashCopy establish command. The FlashCopy relationship is not removed (withdrawn), the FlashCopy target is rolled back to the previous consistency group created by the Global Mirror session. See Moving a Global Mirror session to the recovery site in an unplanned outage for guidelines on the use of this option.
THAW
Specifies that a FlashCopy consistency group has been formed and application I/O can now take place on all volumes in the LSS where the previous FlashCopy Establish request was issued with the ACTION parameter specified as FREEZE. The DEVN parameter must be specified when ACTION=THAW is specified. SDEVN and TDEVN cannot be used.
If ACTION is specified, any extent specifications are ignored and DDSW is ignored
,RETINFO=retinfo
Is a required 100-character output field that returns detailed information about the results of executing the request. The name of the output field is a name (RS-type) or an address in register (2)-(12). The program returns information about the results of scheduling the request in the RETCODE and RSNCODE fields. Align the area on a word boundary. The first 4-bytes contain the return code. The second 4-bytes contain the reason code. The remainder of the information depends on the return and reason codes. See the coding example about how to coordinate the RETCODE, RSNCODE, and RETINFO fields.
,DDSW=ddsw
,DDSW=NO
Is the name (RS-type) (or address in register (2)-(12) ASM only) of an optional 3-character input field that indicates if the deleted dataspace withdraw function (DDSW) is requested. The DDSW function causes two actions. First, within the specified source extents, all FlashCopy target tracks are immediately withdrawn from their FlashCopy relationship and second, all FlashCopy source tracks in a NOCOPY relationship are changed to a COPY (background copy) relationship. DDSW(YES) requires the source device, SDEVN, to be specified. If DDSW(YES) is specified, the target device parameters, TDEVN and TGTEXTENTS, are ignored.

NO indicates that the DDSW parameter is ignored.

YES indicates that the DDSW function is performed.

The default is NO.

,SRCEXTENTS=srcextents | 0
Is the name (RS-type) (or address in register (2)-(12) ASM only) of an optional variable character input field aligned on a fullword and containing the extent data structure described in this topic. The extents in the extent data structure describe the source tracks on the source volume that participates in the FlashCopy withdraw process. If the SRCEXTENTS parameter is omitted and the source device SDEVN parameter is specified, all source tracks on the source volume participate in the FlashCopy withdraw process.
The following structure describes the extent data:
  • A 4-byte field with a hexadecimal count of the source extent fields in the following list. This count field must have a value of 1 to 110 for devices in an ESS subsystem that supports volume FlashCopy. This count field must have a value of 1 to the maximum allowable extents for a device in an ESS subsystem that supports FlashCopy.

    This field may also contain a 4-character value of ALL. If this value is present, all tracks of the source device participates in the FlashCopy withdraw process.

  • A 4-byte reserved field.
  • A list of source extent fields. Each 8-byte extent field has two extents, the beginning source extent and the ending source extent on the source volume.

    The extent format is CCHH where CC is an unsigned 16-bit binary cylinder number. HH is an unsigned 16-bit binary track number.

    The extents in each source extent field contain the following:
    • A 4-byte beginning source extent.
    • A 4-byte ending source extent.

The default is 0.

, SPACEREL=spacerel | NO
This parameter is the name (RS-type) or address in register (2)-(12) of a three-character field that specifies whether the space-efficient volumes are released. The specified character value is left-justified and padded on the right with blanks.
NO
Indicates that the space is not released if the volume is space efficient. This is the default.
YES
Indicates that, if the target volume is a space-efficient volume, when the withdraw is complete, any physical space for the space efficient volume is released.
Note:
  1. If YES is specified and the target is not a space-efficient volume, the SPACEREL keyword is ignored. The results of the command cause the space-efficient volume become uninitialized and therefore unusable by the system until the volume is re-initialized.
  2. If the request with SPACEREL(YES) is issued to a simplex volume that is a space-efficient volume, any physical space for the volume is released.
  3. The allocated space is released asynchronously so may not be reported immediately.
,TGTEXTENTS=tgtextents | 0
is the name (RS-type) (or address in register (2)-(12) ASM only) of an optional variable character input field aligned on a fullword and containing the extent data structure described in this topic. The extents in the extent data structure describe the target tracks on the target volume that participates in the FlashCopy withdraw process. If the TGTEXTENTS parameter is omitted and the target device TDEVN parameter is specified, all target tracks on the target volume participate in the FlashCopy withdraw process.
The following structure describes the extent data:
  • A 4-byte field with a hexadecimal count of the target extent fields in the following list. This count field must have a value of 1 to 110 for devices in an ESS subsystem that supports volume FlashCopy. This count field must have a value of 1 to the maximum allowable extents for a device in an ESS subsystem that supports FlashCopy.

    This field may also contain a 4-character value of ALL. If this value is present, all tracks of the target device participate in the FlashCopy withdraw process. This value is used only for FlashCopy withdraw target requests.

  • A 4-byte reserved field.
  • A list of target extent fields. Each 8-byte extent field has two extents, the beginning extent and the ending extent on the target volume that is part of this FlashCopy relationship.

    The extent format is CCHH where CC is an unsigned 16-bit binary cylinder number. HH is an unsigned 16-bit binary track number.

    The extents in each target extent field contain the following:
    • A 4-byte beginning target extent.
    • A 4-byte ending target extent.

The default is 0.

,ALET=alet | 0
Is the name (RS-type) (or address in register (2)-(12) ASM only) of an optional fullword input field that specifies the ALET value to use if the SRCBITMAP and TGTBITMAP fields have an ALET value different from the one associated with the caller.

The default is 0.

,ECB=ecb
,ECB=NO_ECB
Is the name (RS-type) (or address in register (2)-(12) ASM only) of an optional fullword input field that SDM posts for an asynchronous request. This field is ignored for synchronous requests.

The default is NO_ECB.

,WAITTIME=waittime | 0
Is the name (RS-type) (or address in register (2)-(12) ASM only) of an optional halfword input field containing how long in seconds SDM waits for a request to complete. A value of zero means do not time the request. If the time expires before the request completes, a value of 7039 (RQST_WAITTIME_EXPIRED - see ANTRQSTL) is returned. If the request is a synchronous request, the value is placed in the return code part of RETINFO. If the request is an asynchronous request, the value is used as the ECB post code.

The default is 0.

Note: 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 relabel the target volume after withdrawing a volume-level FlashCopy NOCOPY relationship.

,SUBCHSET=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 currently supported by the host system's processor and configured for the device.

If you specify a value of X'00' or omit this keyword, the command is issued to the device that is currently 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.

To code: Specify the RS-type name, or address in register (2)-(12), of an optional 1-byte (character) field.

,TSUBCHSET=tsubchset
,TSUBCHSET=0
Used with the TDEVN parameter. tsubchset is the name (RS-type) or address in register (2)-(12) of a 1-character field that specifies the 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 specify a value of X'00' or omit this keyword, the command is issued to the device that is currently 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.