Responses returned by YKFENCE

Business Continuity Manager Web API Reference Guide

Version
9.8.8
File Size
1.6 MB
Audience
anonymous
Part Number
MK-96HC137-00

The following describes the unique response items returned by YKFENCE. For details about response items common to each command, see Responses common to all CLI commands.

This response outputs only summary information for the entire copy group. To obtain the copy pair status of each copy pair or copy group, run YKGETGRP.

If you specify the TO(PRIMARY) parameter for the operands key, only the fence statuses of P-VOLs are obtained, so the fence statuses of S-VOLs (the secSoftFenceCt key and the secSPIDFenceCt key) are not output. If you specify TO(SECONDARY) for the operands key, only the fence statuses of S-VOLs are obtained, so the fence statuses of P-VOLs (the priSoftFenceCt key and the priSPIDFenceCt key) are not output.

Response body (when the QUERY parameter is specified)

{ "servletKey":"USERID-01-aaaaaaaa",
  "ver":"0100",
  "appData":{
    "bcmVer":"098800",
    "vendor":"hitachi",
    "rc":0,
    "bcmMsg":[
    ],
    "action":"submit",
    "cliname":"YKFENCE",
    "operands":"QUERY",
    "prefix":"USERID.PREFIX",
    "copyGroup":{
      "ID":"CGID",
      "updateID":"FFFFFFFFFFFFFFFF",
      "pairCt":5,
      "priSoftFenceCt":0,
      "priSPIDFenceCt":0,
    }
  },
  "reused":false, "timeout":false
}

Key

Format

Description

prefix

string or undefined

Dataset prefix of the copy group definition file

copyGroup

object or undefined

Copy group object

ID

string

Copy group ID

updateID

string

Last update ID

pairCt

number or undefined

Number of copy pairs

priSoftFenceCt#1

number or undefined

Number of volumes with the soft fence status in the primary site

secSoftFenceCt#2

number or undefined

Number of volumes with the soft fence status in the secondary site

priSPIDFenceCt#1

number or undefined

Number of volumes with the SPID fence status in the primary site

secSPIDFenceCt#2

number or undefined

Number of volumes with the SPID fence status in the secondary site

Note: The items in the preceding table are output when the rc key value is 0.

#1

If you specified the TO(SECONDARY) parameter for the operands key, this is not output.

#2

If you did not specify the TO(SECONDARY) parameter for the operands key, this is not output.

Response body (when the SOFTFENCE or SOFTUNFENCE parameter is specified)

{ "servletKey":"USERID-01-aaaaaaaa",
"ver":"0100",
"appData":{
    "bcmVer":"098800",
    "vendor":"hitachi",
    "rc":0,
    "bcmMsg":[
    ],
    "action":"submit",
    "cliname":"YKFENCE",
    "operands":"SOFTFENCE",
    "prefix":"USERID.PREFIX",
    "copyGroup":{
      "ID":"3DC.TC",
      "updateID":"FFFFFFFFFFFFFFFF"
    }
  },
  "reused":false, "timeout":false
}

Key

Format

Description

prefix

string or undefined

Prefix of the copy group definition file

copyGroup

object or undefined

Copy group object

ID

string

Copy group ID

updateID

string

Last update ID