Responses returned by YKLISTID

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 YKLISTID. 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":"YKLISTID",
    "operands":"",
    "prefix":"USERID.PREFIX",
    "config":[
      {
        "type":"GROUP",
        "ID":"3DC.TC",
        "load":"force"
      },
      {
        "type":"HDA",
        "ID":"11111 LOCAL",
        "load":"false"
      },
      {
        "type":"ROUTE",
        "ID":"ROUTEID",
        "load":"true"
      }
    ]
  },
  "reused":false, "timeout":false
}

Key	Format	Description
`prefix`	string or undefined	Dataset prefix of the configuration file
`config`	object array or undefined	Array of the configuration file objects
`type`	string	Type of the configuration file `GROUP`: Copy group definition file `ROUTE`: Route list definition file `HDA`: Disk configuration definition file `PATH`: Path set definition file
`ID`	string	If the value of the `type` key is not `HDA`, the copy group ID, route list ID, or path set ID is output. If the value of the `type` key is `HDA`, "`serial number of the storage system` `device address domain ID`" are output.
`load`	string	Whether the configuration file was loaded on the BCM Web API server `YES`: The file was loaded. `force`: The file was forcibly loaded by `YKGETGRP LOADGROUP(FORCE)`. `false`: The file was not loaded. If the value of the `type` key is `HDA`, this is always `false`.

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