Responses returned by YKQRYPTH

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 YKQRYPTH. 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":"YKQRYPTH",
    "operands":"",
    "prefix":"USERID.PREFIX",
    "pathSet":{
      "ID":"PSETID",
      "UpdateID":"FFFFFFFFFFFFFFFF",
      "description":"pathset",
      "node":[
        {
          "type":"CU",
          "shared":"N",
          "pri":{
            "serialNum":"11111",
            "model":"VSP5100H",
            "IFType":"4040",
            "SSID":"1111",
            "CUNum":"11",
            "CCA":"11",
            "devn":"1111",
            "schSet":"0"
          },
          "sec":{
            "serialNum":"22222",
            "model":"VSP5100HVSP5100H",
            "IFType":"4040",
            "SSID":"2222",
            "CUNum":"22",
            "CCA":"22",
            "devn":"2222",
            "schSet":"0"
          },
          "P2S":{
            "path":[
              {
                "status":"ESTABLISHED",
                "priPort":"11",
                "secPort":"22"
              }
            ],
            "setting":8
          },
          "S2P":{
            "path":[
              {
                "status":"ESTABLISHED",
                "priPort":"22",
                "secPort":"11"
              }
            ],
            "setting":8
          }
        }
      ]
    }
  },
  "reused":false, "timeout":false
}

Key

Format

Description

prefix

string or undefined

Dataset prefix of the path set definition file

pathSet

object or undefined

Path set object

ID

string

Path set ID

updateID

string

Last update ID

description

string or undefined

Descriptions added by the user

node#4

object array

Array of node objects

type

string

Path type

  • CU

  • DKC

shared

string

Existence of sharing

  • Y

  • N

pri

object

Primary site object

serialNum

string

Serial number of primary storage system

model

string

Type of primary storage system

  • VSPG1000

  • VSPG1500

  • VSPF1500

  • VSP5100

  • VSP5200

  • VSP5500

  • VSP5600

  • VSP5100H

  • VSP5200H

  • VSP5500H

  • VSP5600H

IFType

string

Interface version of primary storage system

pathID#1

string or undefined

Primary path group ID

SSID#2

string or undefined

Primary SSID

CUNum#6

string or undefined

Primary SSID

CCA#3

string or undefined

The command control address of the device to which I/Os are issued when path operations are performed on the Primary site where the path is used.

devn#3

string or undefined

The device number of the device to which I/Os are issued when path operations are performed on the Primary site where the path is used.

schSet

string

The subchannel set ID of the device to which I/Os are issued when path operations are performed on the Primary site where the path is used.

sec

object

Secondary site object

serialNum

string

Serial number of secondary storage system

model

string

Type of secondary storage system

  • VSPG1000

  • VSPG1500

  • VSPF1500

  • VSP5100

  • VSP5200

  • VSP5500

  • VSP5600

  • VSP5100H

  • VSP5200H

  • VSP5500H

  • VSP5600H

IFType

string

Interface version of secondary storage system

pathID#1

string or undefined

Secondary path group ID

SSID#2

string or undefined

Secondary SSID

CUNum#6

string or undefined

Secondary control unit number

CCA#3

string or undefined

The command control address of the device to which I/Os are issued when path operations are performed on the Secondary site where the path is used.

devn#3

string or undefined

The device number of the device to which I/Os are issued when path operations are performed on the Secondary site where the path is used.

schSet

string

The subchannel set ID of the device to which I/Os are issued when path operations are performed on the Secondary site where the path is used.

P2S#5

object

Physical path object in the definition from the primary site to the secondary site

path#5

object array

Array of physical path objects in the definition from the primary site to the secondary site

status#5

string or undefined

Status of a logical path

priPort#5

string

The initiator port number of the Primary site of the logical path (on the storage system indicated by Pri.SerialNum)

secPort#5

string

The target port number of the Secondary site of the logical path (on the storage system indicated by Sec.SerialNum)

setting#5

string or undefined

The number of physical paths from the Primary site to the Secondary site set in the storage system (0 to 8)

S2P#7

object

Physical path object in the definition from the secondary site to the primary site

path#7

object array

Array of physical path objects in the definition from the secondary site to the primary site

status#7

string or undefined

Status of a logical path

priPort#7

string

The target port number of the Primary site of the logical path (on the storage system indicated by Pri.SerialNum)

secPort#7

string

The initiator port number of the Secondary site of the logical path (on the storage system indicated by Sec.SerialNum)

setting#7

string or undefined

The number of physical paths from the Secondary site to the Primary site set in the storage system (0 to 8)

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

#1

This is output when the value of the type key is DKC.

#2

This is output when the value of the type key is CU.

#3

If no I/O destination device is specified, this is not output.

#4

If you specified one or more of the following as the value of the operands key, only paths for which all of the values of these operands match the definition values of the path will be output as the object of the node key: PSN, PCU, SSN, SCU, TYPE, and PTID.

#5

If you specified REVERSE as the value of the operands key, this is not output.

#6

If the value of the type key is DKC and no I/O destination device is specified, this is not output.

#7

If you specified FORWARD as the value of the operands key, this is not output.