Configuring an environment for the Remote DKC Control function

Business Continuity Manager Web API Reference Guide
Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

The following is an example of configuring an environment for the Remote DKC Control function by using Figure 1.

To configure an environment for the Remote DKC Control function, perform the following procedure.

  1. Establish a logical path between the command devices.
  2. Create configuration files (the route list definition file and command device definition file) for the Remote DKC Control function (YKDEFRMT).
  3. Check the content of the configuration files for the Remote DKC Control function (YKDSPRMT).
  4. Register the command devices (YKBLDRMT).

Establishing a logical path between the command devices

Use Storage Navigator or another tool to establish a logical path between the command devices.

Creating configuration files for the Remote DKC Control function (YKDEFRMT)

Create configuration files (the route list definition file and command device definition file) for the Remote DKC Control function.

Request line
PUT https://IP-address-of-the-z/OSMF-server/zosmf/tsoApp/app/USERID-38-aabcaaaf/YKAPI
Request body
For the cliname key, specify YKDEFRMT. For the CLIPARMS key array, specify the parameters of YKDEFRMT by using no more than 80 characters.
{cliname":"YKDEFRMT", "CLIPARMS":[
"PREFIX USERID.PREFIX",
"DAD LOCAL",
"ROUTEID ROUTE01",
"ROUTE APID(1001)",
"CDEV DAD(LOCAL) DEVN(1101) SN(11111) CU(11) CCA(11) SSID(1111)",
"CDEV DAD(MID) SN(22222) CU(22) CCA(11) SSID(2211)",
"CDEV DAD(REMOTE) SN(33333) CU(33) CCA(11) SSID(3311)",
"ROUTE APID(1002)",
"CDEV DAD(LOCAL) DEVN(1102) SN(11111) CU(11) CCA(12) SSID(1111)",
"CDEV DAD(MID) SN(22222) CU(22) CCA(12) SSID(2211)",
"CDEV DAD(REMOTE) SN(33333) CU(33) CCA(12) SSID(3311)"
] }

  • For each route (command device line), specify the ROUTE parameter and the CDEV parameter.

  • To register multiple command device lines for one host, specify the ROUTE parameter and the CDEV parameter for each command device line.

  • To share a command device line among multiple hosts, specify the ROUTE parameter and the CDEV parameter for each host that has a different DADID.

  • The PREFIX, DAD, and ROUTEID parameters can be omitted because their values are the same as those of the default parameters.

Response body
{"servletKey":"USERID-38-aabcaaaf","ver":"0100",
"appData":{"bcmVer":"099100", "vendor":"Hitachi Vantara, Ltd.", "rc":0, "bcmMsg":[], "action":"submit", "cliname":"YKDEFRMT", "operands":""}, "reused":false, "timeout":false}

The return code of the CLI command is output to the rc key.

The message output by a CLI command is output to the bcmMsg key. However, depending on the error type, the tsoData key might be output instead of the bcmMsg key, and the message might be output to the DATA key in the TSO MESSAGE key in that output key.

Checking the content of the configuration files for the Remote DKC Control function (YKDSPRMT)

Request line
PUT https://IP-address-of-the-z/OSMF-server/zosmf/tsoApp/app/USERID-38-aabcaaaf/YKAPI
Request body
For the cliname key, specify YKDSPRMT. For the CLIPARMS key array, specify the parameters of YKDSPRMT by using no more than 80 characters.
{"cliname":"YKDSPRMT","CLIPARMS":[
"PREFIX USERID.PREFIX", 
"DAD LOCAL",
"ROUTEID ROUTE01"
]}
The PREFIX, DAD, and ROUTEID parameters can be omitted because their values are the same as those of the default parameters.
Response body
The contents of the defined route list and command devices are displayed.
{"servletKey":"USERID-38-aabcaaaf","ver":"0100","appData":{
"bcmVer":"099100", "vendor":"Hitachi Vantara, Ltd.", "rc":0, "bcmMsg":[], "action":"submit", 
"cliname":"YKDSPRMT", 
"operands":"", "prefix":"USERID.PREFIX", "DADID":"LOCAL",  "routeID":"ROUTE01", "route":[
 { "cdevline":[
   {"APID":"1001", "cdev":[
     {"serialNum":"11111","SSID":"1111","CUNum":"11","CCA":"11","devn":"01101",
       "DADID":"LOCAL", "status":"N/A" },
     {"serialNum":"22222","SSID":"2211","CUNum":"22","CCA":"11",
       "DADID":"MID","status":"N/A"},
     {"serialNum":"33333","SSID":"3311","CUNum":"33","CCA":"11",
       "DADID":"REMOTE","status":"N/A"}
   ] },
   {"APID":"1002", "cdev":[
     {"serialNum":"11111","SSID":"1111","CUNum":"11","CCA":"12","devn":"01102",
       "DADID":"LOCAL", "status":"N/A" },
     {"serialNum":"22222","SSID":"2211","CUNum":"22","CCA":"12",
       "DADID":"MID","status":"N/A"},
     {"serialNum":"33333","SSID":"3311","CUNum":"33","CCA":"12",
       "DADID":"REMOTE","status":"N/A"}
   ] }
] }   ] }   ]
}, "reused":false, "timeout":false}

Registering command devices (YKBLDRMT)

Register the command devices in the route that originates from the primary site DAD (DADID: LOCAL).

To register the command devices in the route that originates from the remote site (DADID: REMOTE), register them from the remote site.

Request line
PUT https://IP-address-of-the-z/OSMF-server/zosmf/tsoApp/app/USERID-38-aabcaaaf/YKAPI
Request body
For the cliname key, specify YKBLDRMT. For the CLIPARMS key array, specify the parameters of YKBLDRMT by using no more than 80 characters.
{cliname":"YKBLDRMT","CLIPARMS":[
"PREFIX USERID.PREFIX",
"DAD LOCAL",
"ROUTEID ROUTE01"
]}
The PREFIX, DAD, and ROUTEID parameters can be omitted because their values are the same as those of the default parameters.
Example of a response body
{"servletKey":"USERID-38-aabcaaaf","ver":"0100",
"appData":{"bcmVer":"099100", "vendor":"Hitachi Vantara, Ltd.", "rc":0, "bcmMsg":[], "action":"submit", "cliname":"YKBLDRMT", "operands":""}, "reused":false, "timeout":false}

Checking the registration status of the command devices (YKDSPRMT)

Check the registration status of the command devices in the route that originates from the primary site.

To check the registration status of the command devices in the route that originates from the remote site, run the following from the remote site.

Request line
PUT https://IP-address-of-the-z/OSMF-server/zosmf/tsoApp/app/USERID-38-aabcaaaf/YKAPI
Request body

For the cliname key value, specify YKDSPRMT. For the CLIPARMS key value array, specify STATUS YES (displays the registration status of command devices).

{"cliname":"YKDSPRMT", "CLIPARMS":[
"PREFIX USERID.PREFIX",
"DAD LOCAL",
"ROUTEID ROUTE01",
"STATUS YES"
] }

The PREFIX, DAD, and ROUTE parameters can be omitted because their values are the same as those of the default parameters.

Response body

The registration status of each command device in the route that originates from the primary site is output to the status key value.

{"servletKey":"USERID-38-aabcaaaf","ver":"0100","appData":{
"bcmVer":"099100", "vendor":"Hitachi Vantara, Ltd.", "rc":0, "bcmMsg":[], "action":"submit", 
"cliname":"YKDSPRMT",
"prefix":"USERID.PREFIX", "DADID":"LOCAL",  "routeID":"ROUTE01", "route":[
{"cdevline":[
 {"APID":"1001", "cdev":[
     {"serialNum":"11111","SSID":"1111","CUNum":"11","CCA":"11","devn":"01101",
      "DADID":"LOCAL", "status":"N/A" },
     {"serialNum":"22222","SSID":"2211","CUNum":"22","CCA":"11",
      "DADID":"MID","status":"N/A"},
     {"serialNum":"33333","SSID":"3311","CUNum":"33","CCA":"11",
      "DADID":"REMOTE","status":"N/A"}
 ] },
 {"APID":"1002", "cdev":[
     {"serialNum":"11111","SSID":"1111","CUNum":"11","CCA":"12","devn":"01102",
      "DADID":"LOCAL", "status":"N/A" },
     {"serialNum":"22222","SSID":"2211","CUNum":"22","CCA":"12",
      "DADID":"MID","status":"N/A"},
     {"serialNum":"33333","SSID":"3311","CUNum":"33","CCA":"12",
      "DADID":"REMOTE","status":"N/A"}
 ] }
] }   ] }   ]
}, "reused":false, "timeout":false}