YKFENCE (sets and resets the soft fence, and getting the soft fence status)

Business Continuity Manager Web API Reference Guide
Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

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

Sets the soft fence for, or resets the soft fence of, a volume within the specified copy group. In addition, this command acquires the soft fence status and the SPID fence status.

Request body format

{ "action":"submit",
   "cliname":"YKFENCE",
   "operands":"
     [GROUP(copy-group-ID)]
     [△1{SOFTFENCE|SOFTUNFENCE|QUERY}]
     [△1TO({PRIMARY|SECONDARY})]
   "
}

Parameters specified in the request body

GROUP(copy-group-ID) ~ <GROUP string>

Specify the ID of the target copy groups that are loaded. If only one copy group is loaded, you can omit this parameter.

{SOFTFENCE|SOFTUNFENCE|QUERY}

Specifies the operation for the volume. The default value is QUERY.

SOFTFENCE

Sets the soft fence for a volume.

SOFTUNFENCE

Resets the soft fence of a volume.

QUERY

Acquires a volume's soft fence status and the SPID fence status, and sets it to the copy group structure.

Specifies the volume that is to be the target of the fence operation. The default value is PRIMARY.

PRIMARY

Targets the P-VOL at the time the copy pair was defined.

SECONDARY

Targets the S-VOL at the time the copy pair was defined.

Notes

  • The YKFENCE command cannot be executed on a Non Gen'ed volume or on a remote storage system volume.

  • The YKFENCE command is directly issued to the volume that is to be the target of the fence operation even if the command is set to be issued via a command device (YKLOAD with VIACDEV specified).

Responses

See Responses returned by YKFENCE.

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 YKFENCE command.

Table. YKFENCE 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 terminated normally.

4

Acquisition of the fence status was skipped for a volume, because the volume does not exist in the storage system.

32

The fence operation could not be performed on one or more volumes because the ANTRQST macro detected an error.

36

Invalid or missing data in a REXX variable structure.

40

An error occurred while a REXX variable was being written.

44

The command terminated due to processing errors. For example, this includes the following case:

  • A GETMAIN error has occurred.

48

The command terminated due to invalid parameters. For example, as in the following case:

  • A Non Gen'ed volume or a remote storage system volume existed.

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