Responses returned by YKEWAIT

Business Continuity Manager Web API Reference Guide

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

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. However, if you specify the DEVN parameter for the operands key, information about the pair specified as the value of the DEVN parameter will be output, but summary information will not be output.

Furthermore, the matchingPerCent key and the CTDelta key are not updated by YKEWAIT and thus are not output. To output these values, run YKQUERY.

The following describes the unique response items returned by YKEWAIT. 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.

Response body (when the DEVN parameter is not specified)

{ "servletKey":"USERID-01-aaaaaaaa",
  "ver":"0100",
  "appData":{
    "bcmVer":"099100",
    "vendor":"Hitachi Vantara, Ltd.",
    "rc":0,
    "bcmMsg":[
    ],
    "action":"submit",
    "cliname":"YKEWAIT",
    "operands":"",
    "prefix":"USERID.PREFIX",
    "copyGroup":{
      "ID":"CGID",
      "updateID":"FFFFFFFFFFFFFFFF",
      "description":"CG Description",
      "copyType":"TC",
      "primaryDADID":"DADP",
      "secondaryDADID":"DADR",
      "primarySCHSET":"0",
      "secondarySCHSET":"0",
      "pairCt":5,
      "simplexCt":0,
      "pendingCt":2,
      "duplexCt":3,
      "transitionCt":0,
      "suspendOpCt":0,
      "suspendCuCt":0,
      "suspendVSCt":0,
      "swappingCt":0,
      "reversedCt":0,
      "suspendErCt":0,
      "invalidCt":0,
      "revrsyncCt":0,
      "holdCt":0,
      "holdErCt":0,
      "chkJnlCt":0,
      "holdTrnsCt":0,
      "noDeltaCt":0,
      "conslostCt":0,
      "priOnlineCt":0,
      "secOnlineCt":0
    }
  },
  "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

description

string or undefined

Descriptions added by the user

copyType

string

Copy type

One of SI, TC, or UR is output.

primaryDADID

string

DADID of the P-VOL of the copy group

secondaryDADID

string

DADID of the S-VOL of the copy group

primarySchSet

string

Subchannel set ID of the P-VOL of the copy group

secondarySchSet

string

Subchannel set ID of the S-VOL of the copy group

pairCt

number

Total number of copy pairs for all consistency groups in the copy group

simplexCt

number

Number of copy pairs in SIMPLEX status in the copy group

pendingCt

number

Number of copy pairs in PENDING status in the copy group

duplexCt

number

Number of copy pairs in DUPLEX status in the copy group

transitionCt

number

Number of copy pairs in TRANS status in the copy group

suspendOpCt

number

Number of copy pairs in SUSPOP status in the copy group

suspendCuCt

number

Number of copy pairs in SUSPCU status in the copy group

suspendVsCt

number

Number of copy pairs in SUSPVS status in the copy group

swappingCt#1

number

Number of copy pairs in SWAPPING status in the copy group

reversedCt

number

Number of copy pairs in the copy group whose copy direction is from secondary to primary

suspendErCt

number

Number of copy pairs in SUSPER status in the copy group

invalidCt

number

Number of copy pairs in INVALID status in the copy group

revrsyncCt

number

Number of copy pairs in REVRSY status in the copy group

holdCt

number

Number of copy pairs in HOLD status in the copy group

holdErCt

number

Number of copy pairs in HOLDER status in the copy group

chkJnlCt#2

number

Number of copy pairs in CHKJNL status in the copy group

holdTrnsCt

number

Number of copy pairs in HOLDTRNS status in the copy group

noDeltaCt

number

Number of copy pairs in NODELTA status in the copy group

conslostCt

number

Number of copy pairs in CONSLOST status in the copy group

priOnlineCt

number

Number of online volumes at the primary site in the copy group

secOnlineCt

number

Number of online volumes at the secondary site in the copy group

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

#1

Information can be displayed only when information is obtained from Secondary site.

#2

The value is always 0.

Response body (when the DEVN parameter is specified)

{ "servletKey":"USERID-01-aaaaaaaa",
  "ver":"0100",
  "appData":{
    "bcmVer":"099100",
    "vendor":"Hitachi Vantara, Ltd.",
    "rc":0,
    "bcmMsg":[
    ],
    "action":"submit",
    "cliname":"YKEWAIT",
    "operands":"DEVN(A000,A000)",
    "prefix":"USERID.PREFIX",
    "copyGroup":{
      "ID":"CGID",
      "updateID":"FFFFFFFFFFFFFFFF",
      "description":"CG Description",
      "copyType":"UR",
      "primaryDADID":"DADP",
      "secondaryDADID":"DADR",
      "primarySCHSET":"0",
      "secondarySCHSET":"0",
      "pairCt":5,
      "CTGroup":[
        {
          "groupIndex":1,
          "CTGroupID":"11",
          "subCTGroupID":"21",
          "pair":[
            {
              "pairIndex":1,
              "state":"SIMPLEX",
              "Volser":"",
              "matchingPerCent":0,
              "reversed":"0"
              "pri":{
                "devn":"A000",
                "serialNum":"11111",
                "CUNum":"11",
                "SSID":"1111",
                "CCA":"11",
                "model":"VSPG1000"
              },
              "sec":{
                "devn":"A000",
                "serialNum":"22222",
                "CUNum":"22",
                "SSID":"2211",
                "CCA":"22",
                "model":"VSPG1000"
              }
            }
          ]
        }
      ]
    }
  },
  "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

description

string or undefined

Descriptions added by the user

copyType

string

Copy type

One of SI, TC, or UR is output.

primaryDADID

string

Device address domain ID of the P-VOL of the copy group

secondaryDADID

string

Device address domain ID of the S-VOL of the copy group

primarySchSet

string

Subchannel set ID of the P-VOL of the copy group

secondarySchSet

string

Subchannel set ID of the S-VOL of the copy group

pairCt

number

Total number of copy pairs for all consistency groups in the copy group

CTGroup

object array

Array of copy group object

groupIndex

number

Sequence number of the copy group

CTGroupID#1

string or undefined

Consistency group ID or master journal group ID

subCTGroupID#2

string or undefined

Restore journal group ID

pair

object array

Array of copy pair objects

pairIndex

number

Sequence number of copy pair

state

string

Copy pair status

volser#3

string or undefined

Volume serial number

reversed

string

Whether direction is reverse from Secondary to Primary

  • 1
  • 0

pri

object

P-VOL object

devn

string

Device number of the P-VOL

serialNum

string

Serial number of the primary storage system

CUNum

string

Control unit number of the P-VOL

SSID

string

Primary SSID

CCA

string

Command control address of the P-VOL

model

string

Primary storage system model

sec

object

S-VOL object

devn

string

Device number of the S-VOL

serialNum

string

Serial number of the secondary storage system

CUNum

string

Control unit number of the S-VOL

SSID

string

Secondary SSID

CCA

string

Command control address of the S-VOL

model

string

Secondary storage system model

Note1: The items in the preceding table are output when the rc key value is 8 or less.

#1

Information can be obtained only in the case of a consistency group or a journal group.

#2

Information can be obtained only in the case of a journal group.

#3

If information could not be obtained during the scan, this is not output.