- ,SDEVN=sdevn
- Specifies the 2-byte hexadecimal device number of
the source device. If the field contains the null value (X'0000'),
the parameter is treated as omitted. Device number X'0000' cannot
be used with the FlashCopy FCESTABLISH
request.
For FlashCopy,
the source device can be the same as the target device. In this case,
the source and target extents must be specified, and the extents cannot
overlap.
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 address, or address in register (2)-(12), of an required
2-character input field.
- ,TDEVN=tdevn
- Specifies the 2-byte hexadecimal device number of
the target device. If the field contains the null value (X'0000'),
the parameter is treated as omitted. Device number X'0000' cannot
be used with the FlashCopy
establish request.
For FlashCopy,
the target device can be the same as the source device. In this case,
the source and target extents must be specified, and the extents cannot
overlap.
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 address, or address in register (2)-(12), of an required
2-character input field.
- ,DEVN=devn
- Specifies the binary device number to use for I/O.
When OPENDVCS(YES) is specified for a local FlashCopy relationship (REMOTE(NO) is specified
or allowed to default), DEVN must specify a CKD access volume located
in the same subsystem cluster as the fixed block device identified
by SOURCE in this command.
When OPENDVCS(YES) is specified
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 specified as the FlashCopy source.
When REMOTE(YES)
is specified for CKD volumes (OPENDVCS(NO) is specified or allowed
to default), DEVN must specify the PPRC primary device that is paired
with the PPRC secondary specified as the FlashCopy source.
DEVN must be a
4-digit hexadecimal address of a configured device with a UCB on the System z® system issuing the
command.
To code: Specify the RS-type address, or address
in register (2)-(12), of an optional 2-character 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,
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
- Specifies 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 volume on 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
using a CKD access device.
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.
When specifying an Inband request for a CKD secondary
device, DEVN 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.
When specifying an Inband request for
an Open System (fixed block) secondary device, DEVN must identify
an online CKD System z device
located in the same subsystem cluster as the fixed block device of
the PPRC primary paired with the secondary designated as FlashCopy source.
To code: Specify the RS-type address,
or address in register (2)-(12), of an optional 3-character field.
- ,INCREMENTAL=incremental
- ,INCREMENTAL=NO
- Specifies whether the FlashCopy establish relationship remains
active after initial copy is complete allowing subsequent changes
to be tracked so that future FlashCopy operations
require only a subset of the volume to be copied. The values are:
- 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). The default is NO.
- YES
- The FlashCopy relationship
remains in effect after the request completes. 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 completes. Subsequent changes
are tracked so that future FlashCopy operations
are performed incrementally. This relationship continues until explicitly
terminated with a FlashCopy Withdraw
request. YTW performs the same function as INCREMENTAL=YES except
that YTW allows the target to be writable.
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.
To code: Specify
the RS-type address, or address in register (2)-(12), of an optional
3-character field.
- ,TGTPPRIM=tgtpprim
- ,TGTPPRIM=NO
- Specifies whether the target in the FlashCopy relationship can be the primary
in a PPRC pair. The values are:
- NO
- The target in this FlashCopy relationship
cannot be the primary in a PPRC pair. The default is NO.
- 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.
To code: Specify the RS-type address,
or address in register (2)-(12), of an optional 3-character field.
- ,SRCEXTENTS=srcextents
- Is the extent data structure described in this topic.
The extents in the extent data structure describe the tracks on the
source CKD volume that is active in this FlashCopy relationship.
The structure of the extent data is as follows:
- 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 ESS subsystems that have volume FlashCopy installed. This count field must
have a value of 1 to the maximum allowable number of extents for a
device in ESS subsystems that have FlashCopy installed.
This
field can also contain a 4-character value of ALL. If this value
is present, all tracks of the source device are active in the FlashCopy relationship (full
volume). If this value is present, no other source extent information
is used, and target extent information is ignored.
- 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 volume to be 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 source extent field contain the following:
- A 4-byte beginning source extent.
- A 4-byte ending source extent.
Each source extent field must have a related target extent
field identifying the same number of tracks.
The tracks identified
in the source extent fields must be valid for the source device.
To code: Specify the RS-type address, or address
in register (2)-(12) (ASM only), of a required variable character
input field, aligned on a fullword.
- ,TGTEXTENTS=tgtextents
- Is the extent data structure described in this topic.
The extents in the extent data structure describe the tracks on the
target volume that will be active in this FlashCopy relationship.
The structure
of the extent data is as follows:
- A 4-byte field with a binary count of the target extent fields
in the following list. This count field must have a value of 1 to
110.
This field can also contain a 4-character value
of ALL. This indicates that this establish is a full volume request.
- 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 to be 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 format:
- A 4-byte beginning target extent.
- A 4-byte ending target extent.
To code: Specify the RS-type address, or address
in register (2)-(12), of a required variable character input field,
aligned on a fullword.
- ,RETINFO=retinfo
- Is the name of a required 100-character output field that is used
to return detailed information about the results of executing the
request. 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. The area should align
on a word boundary. The first 4-bytes contain the return code, and
the second 4-bytes contain the reason code. The remainder of the information
is dependent on the return and reason codes. See the coding example
about how to coordinate the RETCODE, RSNCODE, and RETINFO fields.
- ,MODE=mode
- ,MODE=COPY
- Specifies the type of FlashCopy relationship to be started for
this pair of volumes.
COPY requests the program to establish
a FlashCopy relationship
between the source device and the target device. The program starts
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 requests the program to
establish a FlashCopy relationship
between the source device and the target device. The program does
not do a background copy of tracks from source volume to target volume.
Processing of data on the source volume is the same as if the source
volume was 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.
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.
NO2CPY initiates
a background copy from the source to target. When a MODE=NOCOPY relationship
already exists between source and target, this relationship ends when
the background copy is completed. There must be an existing FlashCopy relationship between
source and 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 for ESS session.
The default
is COPY.
To code: Specify the RS-type name, or address
in register (2)-(12), of an optional 6-character input field. The
value is left-justified and padded on the right with blanks. If the
field contains binary zeros, the program uses the default value.
- ,ONLINTGT=onlintgt
- ,ONLINTGT=NO
- Is an optional 3-character input field that contains
a keyword. This keyword specifies whether the FlashCopy Establish should continue if
the specified target device is in an online state to any system. The
name of the input field is a name (RS-type) or address in register
(2)-(12). The value is left-justified and padded on the right with
blanks. If the field contains binary zeros, the program uses the
default.
NO indicates fail the FlashCopy Establish if the target device
is online to any system.
YES indicates continue the FlashCopy Establish if the
target device is online to any system.
The default is NO.
- ACTION=action
- Identifies that an action is to take place during
the FlashCopy establish
request.
- FREEZE
- Specifies that 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 will be held (results 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 time can be adjusted
using the ESS Specialist GUI.)
ACTION=FREEZE is mutually exclusive with MODE(ASYNC).
- FRR
- Specifies Fast Reverse Restore, which is a function to be used
with Global Mirror or Metro/Global Mirror for ESS when recovering
from an outage. This reverses the direction of the FlashCopy relationship, 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.
To code: Specify the
RS-type name, or address in register (2)-(12), of an optional 12-byte
(character) field. The value is left-justified and padded on
the right with blanks.
- SETGTOK=setgtok
- ,SETGTOK=NO
- Specifies whether the target of the specified full
volume relationship can be a space-efficient volume.
NO indicates
that the target cannot be a space-efficient volume. The default is
NO.
YES indicates that the target can be a space-efficient
volume. If an out of space condition occurs, the relationship is failed.
To
code: Specify the RS-type name, or address in register (2)-(12),
of a 3-character field. The specified character value is left-justified
and padded on the right with blanks.
- ,MSGREQ=msgreq
- ,MSGREQ=NO
- Specifies whether to wait for FlashCopy Establish initialization to complete.
NO indicates to not wait.
YES indicates to
wait. Only valid when MODE is COPY.
The default is NO.
To
code: Specify the RS-type name, or address in register (2)-(12),
of an optional 3-character field. The specified character value
is left-justified and padded on the right with blanks. If the field
contains binary zeros, the program uses the default.
- ,ECB=ecb
- ,ECB=NO_ECB
- Is an optional fullword input field that SDM will post for an
asynchronous request. The name of the input field is a name (RS-type)
or address in register (2)-(12). For synchronous requests, the program
ignores this field.
The default is NO_ECB.
- ,WAITTIME=waittime | 0
- Specifies how long in seconds SDM will wait for a request
to complete. A value of zero says to not time the request. If the
time expires before the request is complete, the program returns a
value of 7039 (RQST_WAITTIME_EXPIRED). For more information about
RQST_WAITTIME_EXPIRED, refer to ANTRQSTL. If the request is a synchronous
request, the program returns the value in the return code part of
RETINFO. If the request is an asynchronous request, the program uses
the value as the ECB post code.
The default is 0.
To
code: Specify the RS-type name, or address in register (2)-(12),
of an optional halfword input field. The specified character
value is left-justified and padded on the right with blanks. A value
of zero says to not time the request.
- ,PRESMIR=presmir
- ,PRESMIR=NO
- Specifies the handling of the request based on whether
the specified target is a PPRC primary device. The values are:
NO indicates
that the FCESTABLISH request is to be performed without considering
a Preserve Mirror operation.
REQ indicates that 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 indicates that if the specified target
device is a Metro Mirror primary device, it would be preferable that
the pair not go into a duplex pending state as the result of the FCESTABLISH
request. However, if the duplex pending state cannot be avoided, the
FCESTABLISH request should still be performed.
The default
is NO.
To code: Specify the RS-type name, or address
in register (2)-(12), of an optional 4-character input field.
The specified character value is left-justified and padded on the
right with blanks. A value of zero says to not time the request.
- ,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.