Responses returned by YKQRYDEV

Business Continuity Manager Web API Reference Guide

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

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

Response body

{ "servletKey":"USERID-01-aaaaaaaa",
  "ver":"0100",
  "appData":{
    "bcmVer":"099100",
    "vendor":"Hitachi Vantara, Ltd.",
    "rc":0,
    "bcmMsg":[
    ],
    "action":"submit",
    "cliname":"YKQRYDEV",
    "operands":"DEVN(A000)",
    "devInfo":{
      "SSID":"1122",
      "serialNum":"11111",
      "CUNum":"11",
      "CCA":"22",
      "cyls":3339,
      "hostStatus":"ONLINE",
      "DKC":{
        "model":"VSP5100",
        "microcode":"700000FF",
        "IFType":"3131",
        "PPInfo":"00000000"
      },
      "VOL":{
        "attr":"NORMAL"
      },
      "pair":{
        "TC":[
          {
            "pri":{
              "SSID":"1122",
              "serialNum":"11111",
              "CUNum":"11",
              "CCA":"22"
            },
            "sec":{
              "SSID":"1122",
              "serialNum":"11111",
              "CUNum":"11",
              "CCA":"22"
            },
            "state":"DUPLEX",
             "timestampMode":true,
             "diffManage":"D"
          }
        ],
        "SI":[
        ],
        "UR":[
        ]
      },
      "path":{
        "DKC":{
          "sec":{
            "model":"VSPG1500",
            "serialNum":"11111"
          },
          "pathGroup":[
            {
              "PATHID":"11",
              "path":[
                {
                  "status":"NO PATH",
                  "priPort":"11",
                  "secPort":"22"
                }
              ]
            }
          ]
        }
      },
      "PSN":{
        "physicalSerialNum":"11111",
        "LDKCNum":"0" 
      }
    }
  },
  "reused":false, "timeout":false
}

Key

Format

Description

devInfo#9

object or undefined

Device object

SSID#9

string

SSID of the volume

serialNum#9

string

Storage system serial number of the volume

CUNum#9

string

Control unit number of the volume

CCA#9

string

Command control address of the volume

cyls#9

string

Volume capacity (the number of cylinders)

hostStatus#9

string

Status of host connection

  • ONLINE

  • OFFLINE

DKC#9

object

Storage system object

model#9

string

Storage system model

  • VSPG1000

  • VSPG1500

  • VSPF1500

  • VSP5100

  • VSP5200

  • VSP5500

  • VSP5600

  • VSP5100H

  • VSP5200H

  • VSP5500H

  • VSP5600H

microcode#9

string

DKCMAIN microcode version

IFType#9

string

Interface version

PPInfo#9

string

Information of installed program product

vol

object or undefined

Volume attribute object

attr#1

string

Volume attribute

  • NORMAL

  • JOURNAL

  • COMMAND

cdev

object or undefined

Command device object

status

string or undefined

Status of command device (CDEV)

APID

string or undefined

APID

pair

object or undefined

Copy pair object

TC

object array

Array of TrueCopy copy pair objects

pri

object

P-VOL object

SSID

string

SSID of P-VOL

serialNum

string

Storage system serial number of P-VOL

CUNum

string

Control unit number of P-VOL

CCA

string

Command control address of P-VOL

sec

object

S-VOL object

SSID

string

SSID of S-VOL

serialNum

string

Storage system serial number of S-VOL

CUNum

string

Control unit number of S-VOL

CCA

string

Command control address of S-VOL

CT

object

Consistency group object

ID#3 #10

string or undefined

Consistency group ID

openMF#3 #10

string or undefined

Use of the Open/MF Consistency Preservation function.

  • Y

  • N

consLost

string

Data inconsistency in the TrueCopy copy pair (CONSLOST status)

  • Y: The copy process of the related FlashCopy® was interrupted.

  • N: Normal status

fenceLevel#4

string or undefined

Fence level

  • NEVER

  • STATUS

  • DATA

freezeScpMode#4 #5

string or undefined

Freeze SCP

  • Y

  • N

initPace#11

string or undefined

Copy pace

  • SLOW

  • NORMAL

matchingPerCent#6 #11

number or undefined

Copy pair matching rate

map

string

Difference management unit

  • CYL

  • TRK

path

string

Status of path

  • Active

  • Inactive

protectMode#5

string or undefined

Protect mode

  • PROTECT

  • PERMIT

State

string

Status of TrueCopy copy pair

  • PENDING (01)

  • DUPLEX (02)

  • SUSPOP (03)

  • SUSPOP (04)

  • SWAPPING (04)

  • SUSPOP (05)

  • SUSPCU (06)

  • SUSPER (07)

  • SUSPCU (08)

  • SUSPER (09)

  • SUSPOP (0A)

  • MTIR (10)

  • SUSPER (50)

  • SUSPER (A0)

timestampMode#17

boolean or undefined

Timestamp transfer mode used by the TC ATTIME Suspend function

  • true: Timestamp transfer mode is enabled
  • false: Timestamp transfer mode is not enabled

diffManage#17

string or undefined

Type of the differential-data management method

  • D: Drives are used to manage differential data.
  • S: Shared memory is used to manage differential data.

SI

object array

Array of ShadowImage copy pair objects

pri

object

P-VOL object

SSID

string

SSID of P-VOL

serialNum

string

Storage system serial number of P-VOL

CUNum

string

Control unit number of P-VOL

CCA

string

Command control address of P-VOL

sec

object

S-VOL object

SSID

string

SSID of S-VOL

serialNum

string

Storage system serial number of S-VOL

CUNum

string

Control unit number of S-VOL

CCA

string

Command control address of S-VOL

AT

object or undefined

ATTIME suspend object

genID#12

string or undefined

Generation ID

presetMode#18

string or undefined

The ATTIME Suspend function that was run

  • NORMAL: NORMAL ATTIME suspend was performed.

  • TC: TC ATTIME suspend was performed.

  • NONSUSPENDABLE: A NORMAL ATTIME suspend or TC ATTIME suspend was run, but the suspension could not be performed due to a ShadowImage copy pair that cannot be suspended.

status

string

ATTIME status

  • Notset: The ATTIME suspend time is not set.

  • PRESET: The ATTIME suspend time is set but suspend has not been performed.

  • SUSPEND (TIMESTAMP): Suspend was performed because the ATTIME suspend time elapsed.

  • SUSPEND (TIMEOUT): Suspend was performed because a timeout occurred.

SplitMode#19

string or undefined

Suspend mode that is to be used or was used by the ATTIME Suspend function (whether the S-VOL that is undergoing transition to the suspend status can be referenced or updated)

  • STEADY: The S-VOL can be referenced or updated after copying has been completed.

  • QUICK: The S-VOL can be referenced or updated even during copying.

TCStatus#18

string or undefined

Status of the TrueCopy copy group when the ShadowImage copy group was suspended

  • DUPLEX: All TrueCopy copy pairs were in the DUPLEX status and the S-VOL of the TrueCopy copy pairs was the P-VOL of ShadowImage copy pairs when the suspension was performed.

  • NOTIMESTAMP: TrueCopy copy pairs were not in timestamp transfer mode.

  • UNEXPECTED: Some TrueCopy copy pairs were not in the DUPLEX status when the suspension was performed. Alternatively, the S-VOL of some TrueCopy copy pairs was not the P-VOL of the ShadowImage copy pairs.

If presetMode is not TC, the value is not output.

time#2 #12

string or undefined

ATTIME suspend time (yyyymmdd hh:mm:ss.nnnnnn)

tout#12

string or undefined

Timeout value (minutes)

trem#12

string or undefined

Time remaining until timeout (minutes)

pairCt#12

number or undefined

Number of copy pairs in the consistency group

duplexCt#12

number or undefined

Number of Duplex copy pairs in the consistency group to which the specified device belongs

pendingCt#12

number or undefined

Number of copy pairs made by full copy

resyncCt#12

number or undefined

Number of Resync copy pairs in the consistency group to which the specified device belongs

suspendErCt#12

number or undefined

Number of failure suspended copy pairs

suspendOpCt#12

number or undefined

Number of suspended copy pairs

transCt#12

number or undefined

Number of suspending copy pairs

ATUR

object or undefined

UR ATTIME suspend object

rJnl#13

string or undefined

Remote journal group ID

genID#13

string or undefined

Generation ID (hexadecimal number: 00-FF)

splitMode#13

string or undefined

Suspend mode used by the UR ATTIME Suspend function.

(This indicates whether secondary volumes transitioning to the suspend status can be accessed or updated.)

  • STEADY: Volumes can be accessed or updated after the copy operation is completed.

  • QUICK: Volumes can be accessed or updated even while the copy operation is in progress.

status

string

ATTIME suspend status

  • Notset: The ATTIME suspend time is not set.

  • PRESET: The ATTIME suspend time is set, but suspend has not been performed.

  • SUSPEND (TIMESTAMP): Suspend was performed because the ATTIME suspend time elapsed.

  • SUSPEND (TIMEOUT): Suspend was performed because a timeout occurred.

  • SUSPEND (NOIO): Suspend was performed because no update journal was detected.

SIStatus#13

string or undefined

ShadowImage copy group status

  • WAITING: Suspend processing has not been started.

  • SUSPENDING: Suspend processing is ongoing.

  • SUSPEND: Suspend processing ended normally.

  • ERROR: Suspend processing ended abnormally.

URStatus#14

string or undefined

The status of the Universal Replicator copy group when the ShadowImage copy group is suspended.

  • DUPLEX: When suspend was performed, all Universal Replicator copy pairs were in DUPLEX status.

  • UNEXPECTED: When a suspend was performed, some Universal Replicator copy pairs were not in DUPLEX status.

errorCode#13

string or undefined

Error code (hexadecimal number: 0000-FFFF)

time#2 #13

string or undefined

ATTIME suspend information (yyyymmdd hh:mm:ss.nnnnnn)

tout#13

string or undefined

Timeout value since the command is issued (minutes)

tout2#13

string or undefined

Timeout value since the ATTIME suspend time (minutes)

trem#13

string or undefined

Time remaining until timeout (minutes)

CTTime#2 #13

string or undefined

Consistency time for the Universal Replicator copy group at suspension (yyyymmdd hh:mm:ss.nnnnnn)

CT

object

Consistency group object

ID

string or undefined

Consistency group ID

initPace

string

Copy pace

  • SLOW

  • NORMAL

  • FAST

matchingPerCent

number

Copy pair matching rate

protectMode

string

Protect mode

  • PROTECT

  • PERMIT

state

string

Status of ShadowImage copy pair

  • PENDING (01)

  • DUPLEX (02)

  • TRANS (03)

  • SUSPOP (04)

  • PENDING (05)

  • SUSPER (06)

  • SUSPVS (07)

  • REVRSY (08)

  • TRANS (09)

diffManage#17

string or undefined

Type of the differential-data management method

  • D: Drives are used to manage differential data.

  • S: Shared memory is used to manage differential data.

UR

object array or undefined

Array of Universal Replicator copy pair objects

pri

object

P-VOL object

SSID

string

SSID

serialNum

string

Storage system serial number

CUNum

string

Control unit number

CCA

string

Command control address

sec

object

S-VOL object

SSID

string

SSID

serialNum

string

Storage system serial number

CUNum

string

Control unit number

CCA

string

Command control address

CT

object

Consistency group object

ID

string

Master journal number

subID

string

Remote journal number

status

string

C/T status

jnlTime#15

string or undefined

Consistency time acquired from the journal (TOD or disk controller time)

svolTime#15

string or undefined

Consistency time acquired from the volume (TOD or disk controller time)

time#15

string or undefined

Consistency time acquired in accordance with the storage system's system option mode (TOD or disk controller time)

timerType

string

Consistency group timer type

  • SYSTEM

  • LOCAL

  • NONE

errorLevel#7

string

Error level in Universal Replicator

  • GROUP

  • VOLUME

exctgID

string

EXCTG ID

exctgRegistFlag

string

EXCTG registration flag

  • 0

  • 1

If the EXCTG function is applied, 1 is set only when the journal group that has the applicable volume has been registered in EXCTG.

exctgRegistFlag2#8

string or undefined

EXCTG registration flag for pair target journal group

  • 0

  • 1

If the EXCTG function is applied, 1 is set only when the journal group that has the pair target volume of the applicable volume, has been registered in EXCTG.

matchingPerCent#6

number or undefined

Copy pair matching rate

pathID#7

string

Path group ID

protectMode

string

Protect mode

  • PROTECT

  • PERMIT

state

string

Existence of Universal Replicator copy pair

  • PENDING (01)

  • DUPLEX (02)

  • SUSPOP (04)

  • SWAPPING(04)

  • SUSPOP (05)

  • SUSPCU (06)

  • SUSPER (07)

  • SUSPCU (08)

  • SUSPER (09)

  • TRANS (60)

  • TRANS (61)

  • HOLD (70)

  • HOLDER (71)

  • HOLDTRNS (72)

  • HOLDER (73)

  • NODELTA (74)

diffManage#17

string or undefined

Type of the differential-data management method

  • D: Drives are used to manage differential data.

  • S: Shared memory is used to manage differential data.

path#9

object

Logical path object

CU#16

object array or undefined

Array of inter-control unit logical path objects

type

string

Path type

  • ESCON

  • FIBRE

sec

object

Secondary storage system object

model

string

Model of secondary storage system

  • VSPG1000 (VSP G1000, VSP G1500, or VSP F1500)

  • VSP5000 (VSP 5100, VSP 5200, VSP 5500, VSP 5600, VSP 5100H, VSP 5200H, VSP 5500H, or VSP 5600H)

serialNum

string

Serial number of secondary storage system

SSID1

string

SSID1 of secondary storage system

SSID2

string

SSID2 of secondary storage system

SSID3

string

SSID3 of secondary storage system

SSID4

string

SSID4 of secondary storage system

P2S

object array

Array of physical path objects in the inter-control unit logical path

status

string

Status of physical path

  • NO PATH

  • ESTABLISHED

  • INIT FAILED

  • TIME OUT

  • NO RESOURCES AT PRI

  • NO RESOURCES AT SEC

  • SERIAL# MISMATCH

  • CONFIG ERROR

priPort

string

Initiator port number (for ESCON, link address)

secPort

string

Target port number (for ESCON, link address)

secCUNum

string

Secondary control unit number

DKC#16

object or undefined

Inter-disk controller logical path object

sec

object

Secondary storage system object

model

string

Model of secondary storage system

  • VSPG1000 (VSP G1000, VSP G1500, or VSP F1500)

  • VSP5000 (VSP 5100, VSP 5200, VSP 5500, VSP 5600, VSP 5100H, VSP 5200H, VSP 5500H, or VSP 5600H)

serialNum

string

Serial number of secondary storage system

pathGroup

object array

Array of physical path objects in the inter-disk controller logical path of the corresponding path group ID

pathID

string

Path group ID

path

object array

Array of physical path objects

status

string

Status of physical path

  • NO PATH

  • ESTABLISHED

  • INIT FAILED

  • TIME OUT

  • NO RESOURCES AT PRI

  • NO RESOURCES AT SEC

  • SERIAL# MISMATCH

  • CONFIG ERROR

priPort

string

Initiator port number

secPort

string

Target port number

PSN

object or undefined

PSN object

physicalSerialNum

string

Physical DKC serial number

LDKCNum

string

Logical disk controller number

#1

When the emulation type of the journal volume is OPEN-V, NORMAL is displayed.

#2

Displayed in GMT.

#3

Information is output for TrueCopy with consistency group ID specified.

#4

Information is output for TrueCopy.

#5

This is not output for a PPRC copy pair.

#6

If copy pairs are in the suspend status, the displayed values correspond to the amounts written to the P-VOL after the suspension, and do not include the amounts written to the S-VOL. When these copy pairs are resynchronized, the values might change, because the values corresponding to the amounts written to the P-VOL and S-VOL are adjusted when the differential copy is performed.

#7

When the copy type is Universal Replicator and the corresponding attribute settings are supported, information is displayed.

This is not output if information could not be acquired.

#8

Information is output for P-VOL when the status for the Universal Replicator copy pair is PENDING or DUPLEX.

#9

This is output if the value of the rc key is 0.

#10

This is not output if the group is not a consistency group.

#11

This is not output for S-VOLs.

#12

This is not output if the NORMAL ATTIME suspend time or TC ATTIME suspend time is not set.

#13

This is not output if the UR ATTIME suspend time is not set.

#14

This is not output if the UR ATTIME suspend time is not set or the suspend function has not been run.

#15

This is not output for P-VOLs.

#16

This is not output if the PATH parameter is not specified.

#17

This is not output if the version of Business Continuity Manager is earlier than 9.9.0 or the volume of the storage system used does not support the function that can get the differential-data management type.

#18

This is not output if the status key is Notset or PRESET.

#19

This is not output if the status key is Notset.