YKFCSTAT (gets FlashCopy® information)

Business Continuity Manager Web API Reference Guide

Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

Applies to TrueCopy, TrueCopy with the HyperSwap attribute, and Universal Replicator.

This command acquires FlashCopy® information related to the specified volume from the storage system.

If the specified volume is not found, or if an I/O error occurs and the storage system information cannot be acquired, this command creates an error message and returns a return code other than 0.

This command can be used for storage systems on which FlashCopy® Mirror Version 2 is installed.

Request body format

{ "action":"submit",
   "cliname":"YKFCSTAT",
   "operands":"
     DEVN(device-number)
   "
}

Parameters specified in the request body

DEVN(device-number) ~ <4- or 5- digit hexadecimal number>((00000-3FFFF))

Specify a device number for the volume from which the FlashCopy® information will be acquired.

Usually, you specify the P-VOL of TrueCopy or Universal Replicator, which is the target volume of FlashCopy®.

When multiple subchannel sets are used, specify this parameter as a 5-digit number by adding the 1-digit subchannel set ID before the device number. If the subchannel set ID is omitted, 0 is assumed.

This parameter can be specified for locally connected devices only. It cannot be specified for Non Gen'ed volumes.

Return code

If the CLI command has finished running, the return code of the CLI command is set in the rc key of the response. If an error occurs before the CLI command is run, the BCM Web API server sets the return code.

The following table lists and describes the return codes of the YKFCSTAT command.

Table. YKFCSTAT command return code list

Return code

Meaning

-3

The module cannot be loaded. Possible causes are as follows:

  • The library dataset has not been linked.

  • The module is protected by the RACF program control function.

-1

An interruption occurred during execution.

0

The command completed normally.

32

  • One or more I/O error was encountered.

  • A change in an I/O configuration definition was detected.

40

An error occurred while a REXX variable was being written.

44

Termination due to processing errors.

48

Termination due to invalid parameters.

128

The command terminated abnormally. Alternatively, the user does not have permission to execute this command.

For details about return codes set by the BCM Web API server, see Return codes set by the BCM Web API server.